TopCustomers

Type
Class
Namespace
craft\commerce\widgets
Inherits
craft\commerce\widgets\TopCustomers » craft\base\Widget » craft\base\SavableComponent » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\SavableComponentInterface, craft\base\WidgetInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, craft\base\SavableComponentTrait, craft\base\WidgetTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Since
3.0

Top Customers widget

View source

# Public Properties

Property Description
activeValidators yii\validators\Validator – The validators applicable to the current scenario.
attributes array – Attribute values (name => value).
behaviors yii\base\Behavior – List of behaviors attached to this component
bodyHtml string, false – The widget’s body HTML, or false if the widget should not be visible.
colspan integer, null – The user’s chosen cospan for the widget
dateCreated DateTime, null – The date that the component was created
dateRange string, null
dateUpdated DateTime, null – The date that the component was last updated
endDate integer, DateTime, null
errors array – Errors for all attributes or the specified attribute.
firstErrors array – The first errors.
id integer, string, null – The component’s ID (could be a temporary one: "new:X")
isNew boolean – Whether the component is new
iterator ArrayIterator – An iterator for traversing the items in the list.
scenario string – The scenario that this model is in.
settings array – The component’s settings.
settingsHtml string, null
startDate integer, DateTime, null
subtitle string, null – The widget’s subtitle
title string – The widget’s title.
type string – Options 'total', 'average'.
validators ArrayObject, yii\validators\Validator – All the validators declared in the model.

# bodyHtml

Type
string, false
Access
Read-only

The widget’s body HTML, or false if the widget should not be visible. (If you don’t want the widget to be selectable in the first place, use isSelectable().)

View source

# dateRange

Type
string, null

View source

# endDate

Type
integer, DateTime, null

View source

# settingsHtml

Type
string, null
Access
Read-only

View source

# startDate

Type
integer, DateTime, null

View source

# subtitle

Type
string, null
Access
Read-only

The widget’s subtitle

View source

# title

Type
string
Access
Read-only

The widget’s title.

View source

# type

Type
string

Options 'total', 'average'.

View source

# Public Methods

Method Description
__call() Calls the named method which is not a class method.
__clone()
__construct() Constructor.
__get() Returns the value of a component property.
__isset() Checks if a property is set, i.e. defined and not null.
__set() Sets the value of a component property.
__unset() Sets a component property to be null.
activeAttributes() Returns the attribute names that are subject to validation in the current scenario.
addError() Adds a new error to the specified attribute.
addErrors() Adds a list of errors.
addModelErrors() Adds errors from another model, with a given attribute name prefix.
afterDelete() Performs actions after a component is deleted.
afterSave() Performs actions after a component is saved.
afterValidate() This method is invoked after validation ends.
attachBehavior() Attaches a behavior to this component.
attachBehaviors() Attaches a list of behaviors to the component.
attributeHints() Returns the attribute hints.
attributeLabels() Returns the attribute labels.
attributes() Returns the list of attribute names.
beforeApplyDelete() Performs actions before a component delete is applied to the database.
beforeDelete() Performs actions before a component is deleted.
beforeSave() Performs actions before a component is saved.
beforeValidate() This method is invoked before validation starts.
behaviors() Returns a list of behaviors that this component should behave as.
canGetProperty() Returns a value indicating whether a property can be read.
canSetProperty() Returns a value indicating whether a property can be set.
className() Returns the fully qualified name of this class.
clearErrors() Removes errors for all attributes or a single attribute.
createValidators() Creates validator objects based on the validation rules specified in rules().
datetimeAttributes() Returns the names of any attributes that should hold DateTime values.
detachBehavior() Detaches a behavior from the component.
detachBehaviors() Detaches all behaviors from the component.
displayName() Returns the display name of this class.
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component.
extraFields() Returns the list of fields that can be expanded further and returned by toArray().
fields() Returns the list of fields that should be returned by default by toArray() when no specific fields are specified.
formName() Returns the form name that this model class should use.
generateAttributeLabel() Generates a user friendly attribute label based on the give attribute name.
getActiveValidators() Returns the validators applicable to the current scenario.
getAttributeHint() Returns the text hint for the specified attribute.
getAttributeLabel() Returns the text label for the specified attribute.
getAttributes() Returns attribute values.
getBehavior() Returns the named behavior object.
getBehaviors() Returns all behaviors attached to this component.
getBodyHtml() Returns the widget's body HTML.
getError() Returns the first error of the specified attribute.
getErrorSummary() Returns the errors for all attributes as a one-dimensional array.
getErrors() Returns the errors for all attributes or a single attribute.
getFirstError() Returns the first error of the specified attribute.
getFirstErrors() Returns the first error of every attribute in the model.
getIsNew() Returns whether the component is new (unsaved).
getIterator() Returns an iterator for traversing the attributes in the model.
getScenario() Returns the scenario that this model is used in.
getSettings() Returns an array of the component’s settings.
getSettingsHtml() Returns the component’s settings HTML.
getSubtitle() Returns the widget’s subtitle.
getTitle() Returns the widget’s title.
getValidators() Returns all the validators declared in rules().
hasErrors() Returns a value indicating whether there is any validation error.
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event.
hasMethod() Returns a value indicating whether a method is defined.
hasProperty() Returns a value indicating whether a property is defined for this component.
icon() Returns the path to the widget’s SVG icon, or the actual SVG contents.
iconPath() Returns the path to the widget’s SVG icon.
init() Initializes the object.
instance() Returns static class instance, which can be used to obtain meta information.
isAttributeActive() Returns a value indicating whether the attribute is active in the current scenario.
isAttributeRequired() Returns a value indicating whether the attribute is required.
isAttributeSafe() Returns a value indicating whether the attribute is safe for massive assignments.
isSelectable() Returns whether the component should be selectable in component Type selects.
load() Populates the model with input data.
loadMultiple() Populates a set of models with the data from end user.
maxColspan() Returns the widget’s maximum colspan.
off() Detaches an existing event handler from this component.
offsetExists() Returns whether there is an element at the specified offset.
offsetGet() Returns the element at the specified offset.
offsetSet() Sets the element at the specified offset.
offsetUnset() Sets the element value at the specified offset to null.
on() Attaches an event handler to an event.
onUnsafeAttribute() This method is invoked when an unsafe attribute is being massively assigned.
rules() Returns the validation rules for attributes.
safeAttributes() Returns the attribute names that are safe to be massively assigned in the current scenario.
scenarios() Returns a list of scenarios and the corresponding active attributes.
setAttributes() Sets the attribute values in a massive way.
setScenario() Sets the scenario for the model.
settingsAttributes() Returns the list of settings attribute names.
toArray() Converts the model into an array.
trigger() Triggers an event.
validate() Validates the component.
validateMultiple() Validates multiple models.

# displayName()

Returns the display name of this class.

View source

Returns

string – The display name of this class.

# getBodyHtml()

Returns the widget's body HTML.

View source

Returns

string, false – The widget’s body HTML, or false if the widget should not be visible. (If you don’t want the widget to be selectable in the first place, use isSelectable().)

# getSettingsHtml()

Returns the component’s settings HTML.

An extremely simple implementation would be to directly return some HTML:

return '<textarea name="foo">'.$this->foo.'</textarea>';

For more complex settings, you might prefer to create a template, and render it via craft\web\View::renderTemplate(). For example, the following code would render a template located at src/templates/_settings.html, passing the settings to it:

return Craft::$app->view->renderTemplate('plugin-handle/_widget-settings', [
    'widget' => $this
]);

If you need to tie any JavaScript code to your settings, it’s important to know that any name= and id= attributes within the returned HTML will probably get namespaced, however your JavaScript code will be left untouched. For example, if getSettingsHtml() returns the following HTML:

<textarea id="foo" name="foo"></textarea>
<script type="text/javascript">
    var textarea = document.getElementById('foo');
</script>

…then it might actually look like this before getting output to the browser:

<textarea id="namespace-foo" name="namespace[foo]"></textarea>
<script type="text/javascript">
    var textarea = document.getElementById('foo');
</script>

As you can see, that JavaScript code will not be able to find the textarea, because the textarea’s id= attribute was changed from foo to namespace-foo. Before you start adding namespace- to the beginning of your element ID selectors, keep in mind that the actual namespace is going to change depending on the context. Often they are randomly generated. So it’s not quite that simple.

Thankfully, craft\web\View service provides a couple handy methods that can help you deal with this:

So here’s what a getSettingsHtml() method that includes field-targeting JavaScript code might look like:

public function getSettingsHtml()
{
    // Come up with an ID value for 'foo'
    $id = Craft::$app->getView()->formatInputId('foo');
    // Figure out what that ID is going to be namespaced into
    $namespacedId = Craft::$app->view->namespaceInputId($id);
    // Render and return the input template
    return Craft::$app->view->renderTemplate('plugin-handle/_widget-settings', [
        'id'           => $id,
        'namespacedId' => $namespacedId,
        'widget'       => $this
    ]);
}

And the _widget-settings.twig template might look like this:

<textarea id="{{ id }}" name="foo">{{ widget.foo }}</textarea>
<script type="text/javascript">
    var textarea = document.getElementById('{{ namespacedId }}');
</script>

The same principles also apply if you’re including your JavaScript code with craft\web\View::registerJs().

View source

Returns

string, null

# getSubtitle()

Returns the widget’s subtitle.

View source

Returns

string, null – The widget’s subtitle

# getTitle()

Returns the widget’s title.

View source

Returns

string – The widget’s title.

# icon()

Returns the path to the widget’s SVG icon, or the actual SVG contents.

View source

Returns

string, null

# init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

# isSelectable()

Returns whether the component should be selectable in component Type selects.

View source

Returns

boolean – Whether the component should be selectable in component Type selects.

# Protected Methods

Method Description
allowMultipleInstances() Returns whether the widget can be selected more than once.
defineRules() Returns the validation rules for attributes.
extractFieldsFor() Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id".
extractRootFields() Extracts the root field names from nested fields.
resolveFields() Determines which fields can be returned by toArray().

# Constants

Constant Description
SCENARIO_DEFAULT The name of the default scenario.