Skip to content

BaseElementSelectConditionRule ​

Type
Abstract Class
Namespace
craft\base\conditions
Inherits
craft\base\conditions\BaseElementSelectConditionRule » craft\base\conditions\BaseConditionRule » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
Implements
ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\ModelInterface, craft\base\conditions\ConditionRuleInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
Uses traits
craft\base\ClonefixTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
Extended by
craft\elements\conditions\RelatedToConditionRule, craft\elements\conditions\assets\UploaderConditionRule, craft\elements\conditions\entries\AuthorConditionRule, craft\fields\conditions\RelationalFieldConditionRule
Since
4.0.0

BaseElementSelectConditionRule provides a base implementation for element query condition rules that are composed of an element select input.

View source

Public Properties ​

PropertyDescription
activeValidatorsyii\validators\Validator – The validators applicable to the current scenario.
attributesarray – Attribute values (name => value).
autofocusboolean
behaviorsyii\base\Behavior – List of behaviors attached to this component.
conditioncraft\base\conditions\ConditionInterface
configarray – The rule’s portable config
elementIdinteger, null
errorsarray – Errors for all attributes or the specified attribute.
firstErrorsarray – The first errors.
groupLabelstring, null
htmlstring – The rule’s HTML for a condition builder
isNewboolean – Whether the rule is new
iteratorArrayIterator – An iterator for traversing the items in the list.
labelstring
labelHintstring, null
operatorstring – The selected operator.
scenariostring – The scenario that this model is in.
uiLabelstring – The rule’s option label
uidstring, null – UUID
validatorsArrayObject, yii\validators\Validator – All the validators declared in the model.

elementId ​

Type
integer, null
Default value
null

View source

Protected Properties ​

PropertyDescription
reloadOnOperatorChangeboolean – Whether to reload the condition builder when the operator changes

Public Methods ​

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__construct()
__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.
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.
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.
getAutofocus()Returns whether the rule’s type selector should be autofocused.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getCondition()Returns the condition associated with this rule.
getConfig()Returns the rule’s portable config.
getElementId()
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.
getGroupLabel()Returns the optgroup label the condition rule should be grouped under.
getHtml()Returns the rule’s HTML for a condition builder.
getIterator()Returns an iterator for traversing the attributes in the model.
getLabel()Returns the rule’s option label.
getLabelHint()Returns the rule’s option label hint.
getScenario()Returns the scenario that this model is used in.
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.
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.
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.
setAutofocus()Sets whether the rule’s type selector should be autofocused.
setCondition()Sets the condition associated with this rule.
setElementId()
setScenario()Sets the scenario for the model.
supportsProjectConfig()Returns whether the rule is safe to include in conditions that are stored in the project config.
toArray()Converts the model into an array.
trigger()Triggers an event.
validate()Performs the data validation.
validateMultiple()Validates multiple models.

getConfig() ​

Returns the rule’s portable config.

View source

Returns ​

array

Throws ​

getElementId() ​

View source

Arguments ​

  • $parse (boolean) – Whether to parse the value for an environment variable

Returns ​

integer, string, null

setElementId() ​

View source

Arguments ​

Protected Methods ​

MethodDescription
criteria()Returns the criteria that determines which elements can be selected.
defineBehaviors()Returns the behaviors to attach to this class.
defineRules()Returns the validation rules for attributes.
elementType()Returns the element type that can be selected.
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.
inputHtml()Returns the input HTML.
matchValue()Returns whether the condition rule matches the given value.
operatorLabel()Returns the option label for a given operator.
operators()Returns the operators that should be allowed for this rule.
resolveFields()Determines which fields can be returned by toArray().
selectionCondition()Returns the element condition that filters which elements can be selected.
sources()Returns the element source(s) that the element can be selected from.

criteria() ​

Returns the criteria that determines which elements can be selected.

View source

Returns ​

array, null

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

Returns ​

array

elementType() ​

Returns the element type that can be selected.

View source

Returns ​

class-string<\craft\base\ElementInterface>

inputHtml() ​

Returns the input HTML.

View source

Returns ​

string

matchValue() ​

Returns whether the condition rule matches the given value.

View source

Arguments ​

Returns ​

boolean

selectionCondition() ​

Returns the element condition that filters which elements can be selected.

View source

Returns ​

craft\elements\conditions\ElementConditionInterface, null

sources() ​

Returns the element source(s) that the element can be selected from.

View source

Returns ​

array, null

Constants ​

ConstantDescription
OPERATOR_BEGINS_WITH
OPERATOR_CONTAINS
OPERATOR_EMPTY
OPERATOR_ENDS_WITH
OPERATOR_EQ
OPERATOR_GT
OPERATOR_GTE
OPERATOR_IN
OPERATOR_LT
OPERATOR_LTE
OPERATOR_NE
OPERATOR_NOT_EMPTY
OPERATOR_NOT_IN
SCENARIO_DEFAULTThe name of the default scenario.