The complete official documentation of the plugin can be found here.

Extension of ProductItem class

Plugin adds fields:

• (LabelCollection) label

"label" field in ProductItem object returns LabelCollection object with labels of the product.

Example: render label list on product page

[ProductPage]
slug = "{{ :slug }}"
==

{# Get product item #}s
{% set obProduct = ProductPage.get() %}
<div data-id="{{ obProduct.id }}">
    <h1>{{ obProduct.name }}</h1>

    {# Get list of labels #}
    {% set obLabelList = obProduct.label.active().sort() %}
    {% if obLabelList.isNotEmpty() == true %}
        <ul>
            {% for obLabel in obLabelList %}
                <li>{{ obLabel.name }}</li>
            {% endfor %}
        </ul>
    {% endif %}
</div>

Extension of ProductCollection class

Plugin adds label method. Method applies a filter by the label ID.

    $obList = ProductCollection::make()->label(2);

LabelCollection

The class allows to work with a cached list of labels.

The LabelCollection class is extended from ElementCollection class.

The LabelCollection class returns arrays of LabelItem class objects.

Method List:

sort()

Method sorts the elements of a collection by the "sort_order" field.

    $obList = LabelCollection::make([1,2,10,15])->sort();

active()

Method applies a filter to the field "active" = true for the elements of a collection.

    $obList = LabelCollection::make([1,2,10,15])->active();

product($iProductID)

• $iProductID - product ID

Method applies a filter by the product ID.

    $obList = LabelCollection::make()->product(2);

getByCode($sCode)

Method return LabelItem class object with code value == $sCode.

    $obItem = LabelCollection::make([1,2,10,15])->getByCode('new');

LabelItem class

The class allows to work with a cached data array of Label model.

The LabelItem class is extended from ElementItem class.

Field list

• (int) id
• (string) name
• (string) slug
• (string) code
• \System\Models\File image
• (string) description
• ProductCollection product

Method List:

getPageUrl($sPageCode = 'label'')

• $sPageCode - page file name

The method returns the URL of the page. The method gets LabelPage component attached on the page and compiles parameter :slug to generate the URL.

LabelList component

The component allows to work with LabelCollection class objects.

Method list

make($arElementIDList = null)

Example: render label list

Get collection of labels, apply sorting + filter by flag "active"

{% set obLabelList = LabelList.make().sort().active() %}
{% if obLabelList.isNotEmpty() %}
    <div class="label-list-wrapper">
        {% for obLabel in obLabelList %}
            <div data-id="{{ obLabel.id }}">
                <span>{{ obLabel.name }}</span>
            </div>
        {% endfor %}
    </div>
{% endif %}

LabelPage component

The component allows to work with LabelItem class objects.

Usage example:

[LabelPage]
slug = "{{ :slug }}"
==

{# Get label item #}
{% set obLabel = LabelPage.get() %}
<div data-id="{{ obLabel.id }}">
    <h1>{{ obLabel.name }}</h1>
</div>

LabelData component

The component allows to work with LabelItem class objects.

Usage example:

{# Get label item with ID = 10 #}
{% set obLabel = LabelData.get(10) %}
{% if obLabel.isNotEmpty() %}
    <div data-id="{{ obLabel.id }}">
        <span>{{ obLabel.name }}</span>
    </div>
{% endif %}