ElementCondition

Type
Class
Namespace
craft\elements\conditions
Inherits
craft\elements\conditions\ElementCondition » craft\base\conditions\BaseCondition » craft\base\Component » craft\base\Model » 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, craft\base\ModelInterface, craft\base\conditions\ConditionInterface, craft\elements\conditions\ElementConditionInterface, yii\base\Arrayable (opens new window), yii\base\Configurable (opens new window), yii\base\StaticInstanceInterface (opens new window)
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait (opens new window), yii\base\StaticInstanceTrait (opens new window)
Extended by
craft\elements\conditions\addresses\AddressCondition, craft\elements\conditions\assets\AssetCondition, craft\elements\conditions\categories\CategoryCondition, craft\elements\conditions\entries\EntryCondition, craft\elements\conditions\tags\TagCondition, craft\elements\conditions\users\UserCondition
Since
4.0.0

ElementCondition provides an element condition.

View source (opens new window)

# Public Properties

Property Description
activeValidators (opens new window) yii\validators\Validator (opens new window) – The validators applicable to the current scenario (opens new window).
addRuleLabel string (opens new window), null (opens new window) – The “Add a rule” button label.
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.
builderHtml string (opens new window) – The HTML for the condition builder, including its outer container element
builderInnerHtml string (opens new window) – The inner HTML for the condition builder, excluding its outer container element
conditionRuleTypes string (opens new window)[], array (opens new window)[]
conditionRules craft\base\conditions\ConditionRuleInterface[] – The rules this condition is configured with
config array (opens new window) – The condition’s portable config
elementType string (opens new window), null (opens new window) – The element type being queried.
errors (opens new window) array (opens new window) – Errors for all attributes or the specified attribute.
fieldContext string (opens new window) – The field context that should be used when fetching custom fields’ condition rule types.
firstErrors (opens new window) array (opens new window) – The first errors.
forProjectConfig boolean (opens new window) – Whether the condition will be stored in the project config
id string (opens new window), null (opens new window) – The ID of the condition builder
iterator (opens new window) ArrayIterator (opens new window) – An iterator for traversing the items in the list.
mainTag string (opens new window) – The condition builder container tag name
name string (opens new window) – The root input name of the condition builder
queryParams string (opens new window)[] – The element query params that available rules shouldn’t compete with.
scenario (opens new window) string (opens new window) – The scenario that this model is in.
selectableConditionRules craft\base\conditions\ConditionRuleInterface[]
sortable
validators (opens new window) ArrayObject (opens new window), yii\validators\Validator (opens new window) – All the validators declared in the model.

# elementType

Type
string (opens new window), null (opens new window)
Default value
null

The element type being queried.

View source (opens new window)

# fieldContext

Type
string (opens new window)
Default value
'global'

The field context that should be used when fetching custom fields’ condition rule types.

See also conditionRuleTypes()

View source (opens new window)

# queryParams

Type
string (opens new window)[]
Default value
[]

The element query params that available rules shouldn’t compete with.

View source (opens new window)

# sortable

Default value
false

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__clone()
__construct() Constructor.
__get() (opens new window) Returns the value of a component property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets the value of a component property.
__unset() (opens new window) Sets a component property to be null.
activeAttributes() (opens new window) Returns the attribute names that are subject to validation in the current scenario.
addConditionRule() Adds a rule to the condition.
addError() (opens new window) Adds a new error to the specified attribute.
addErrors() (opens new window) Adds a list of errors.
addModelErrors() Adds errors from another model, with a given attribute name prefix.
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.
beforeValidate() (opens new window) This method is invoked before validation starts.
behaviors() 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() 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.
getBuilderHtml() Renders the HTML for the condition builder, including its outer container element.
getBuilderInnerHtml() Renders the inner HTML for the condition builder, excluding its outer container element.
getConditionRuleTypes() Returns the available rule types for this condition.
getConditionRules() Returns the rules this condition is configured with.
getConfig() Returns the condition’s portable config.
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.
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.
getSelectableConditionRules() Returns the selectable rules for the condition, indexed by type.
getValidators() (opens new window) Returns all the validators declared in rules() (opens new window).
hasErrors() 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 for this component.
init() 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.
matchElement() Returns whether the given element matches the condition.
modifyQuery() Modifies a given query based on the configured condition rules.
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() 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() Sets the attribute values in a massive way.
setConditionRules() Sets the rules this condition should be configured with.
setScenario() (opens new window) Sets the scenario for the model.
toArray() (opens new window) Converts the model into an array.
trigger() (opens new window) Triggers an event.
validate() (opens new window) Performs the data validation.
validateMultiple() (opens new window) Validates multiple models.

# __construct()

Constructor.

View source (opens new window)

Arguments

# matchElement()

Returns whether the given element matches the condition.

View source (opens new window)

Arguments

Returns

boolean (opens new window)

# modifyQuery()

Modifies a given query based on the configured condition rules.

View source (opens new window)

Arguments

# Protected Methods

Method Description
conditionRuleTypes() Returns the rule types for this condition.
config() Returns the condition’s portable config.
defineBehaviors() Returns the behaviors to attach to this class.
defineRules() 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.
isConditionRuleSelectable() Returns whether the given rule should be selectable by the condition builder.
resolveFields() (opens new window) Determines which fields can be returned by toArray() (opens new window).
validateConditionRule() Ensures that a rule can be added to this condition.

# conditionRuleTypes()

Returns the rule types for this condition.

Conditions should override this method instead of getConditionRuleTypes() so EVENT_REGISTER_CONDITION_RULE_TYPES handlers can modify the class-defined rule types.

Rule types should be defined as either the class name or an array with a class key set to the class name.

View source (opens new window)

Returns

string (opens new window)[], array (opens new window)[]

# config()

Returns the condition’s portable config.

View source (opens new window)

Returns

array (opens new window)

# defineRules()

Since
3.4.0

Returns the validation rules for attributes.

See rules() for details about what should be returned.

Models should override this method instead of rules() so EVENT_DEFINE_RULES handlers can modify the class-defined rules.

View source (opens new window)

Returns

array (opens new window)

# isConditionRuleSelectable()

Returns whether the given rule should be selectable by the condition builder.

View source (opens new window)

Arguments

# Constants

Constant Description
SCENARIO_DEFAULT The name of the default scenario.