Revenue

Type: Class
Namespace: craft\commerce\widgets
Inherits: craft\commerce\widgets\Revenue » craft\base\Widget (opens new window) » craft\base\SavableComponent (opens new window) » craft\base\Component (opens new window) » craft\base\Model (opens new window) » yii\base\Model (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements: ArrayAccess (opens new window), IteratorAggregate (opens new window), craft\base\ComponentInterface (opens new window), craft\base\SavableComponentInterface (opens new window), craft\base\WidgetInterface (opens new window), yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits: craft\base\ClonefixTrait (opens new window), craft\base\SavableComponentTrait (opens new window), craft\base\WidgetTrait (opens new window), yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Since: 2.0

Class Revenue

# Public Properties

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

# `bodyHtml`

Type: string (opens new window), false (opens new window)
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 (opens new window)

# `dateRange`

Type: string (opens new window)

View source (opens new window)

# `settingsHtml`

Type: string (opens new window), null (opens new window)
Access: Read-only

View source (opens new window)

# Public Methods

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

# `displayName()`

Returns the display name of this class.

View source (opens new window)

Returns

string (opens new window) – The display name of this class.

# `getBodyHtml()`

Returns the widget's body HTML.

View source (opens new window)

Returns

string (opens new window), false (opens new window) – 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() (opens new window). 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 (opens new window), 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 (opens new window) service provides a couple handy methods that can help you deal with this:

craft\web\View::namespaceInputId() (opens new window) will give you the namespaced version of a given ID.
craft\web\View::namespaceInputName() (opens new window) will give you the namespaced version of a given input name.
craft\web\View::formatInputId() (opens new window) will format an input name to look more like an ID attribute value.

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() (opens new window).

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# `iconPath()`

Returns the path to the widget’s SVG icon.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# `isSelectable()`

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

View source (opens new window)

Returns

boolean (opens new window) – Whether the component should be selectable in component Type selects.

# Protected Methods

Method	Description
allowMultipleInstances() (opens new window)	Returns whether the widget can be selected more than once.
defineRules() (opens new window)	Returns the validation rules for attributes.
extractFieldsFor() (opens new window)	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() (opens new window)	Extracts the root field names from nested fields.
resolveFields() (opens new window)	Determines which fields can be returned by toArray() (opens new window).

# Constants

Constant	Description
`SCENARIO_DEFAULT`	The name of the default scenario.

← Orders ProductTypeNotFoundException →

Revenue

# Public Properties

# bodyHtml

# dateRange

# settingsHtml

# Public Methods

# displayName()

Returns

# getBodyHtml()

Returns

# getSettingsHtml()

Returns

# iconPath()

Returns

# isSelectable()

Returns

# Protected Methods

# Constants

# `bodyHtml`

# `dateRange`

# `settingsHtml`

# `displayName()`

# `getBodyHtml()`

# `getSettingsHtml()`

# `iconPath()`

# `isSelectable()`