OptionsFieldConditionRule

Type

Class

Namespace

craft\fields\conditions

Inherits

craft\fields\conditions\OptionsFieldConditionRule » craft\base\conditions\BaseMultiSelectConditionRule » 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, craft\fields\conditions\FieldConditionRuleInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface

Uses traits

craft\base\ClonefixTrait, craft\fields\conditions\FieldConditionRuleTrait, yii\base\ArrayableTrait, yii\base\StaticInstanceTrait

Since

4.0.0

Options field condition rule.

View source

Public Properties

Property	Description
activeValidators	yii\validators\Validator – The validators applicable to the current scenario.
attributes	array – Attribute values (name => value).
autofocus	boolean
behaviors	yii\base\Behavior – List of behaviors attached to this component.
condition	craft\base\conditions\ConditionInterface
config	array – The rule’s portable config
errors	array – Errors for all attributes or the specified attribute.
exclusiveQueryParams
fieldUid	string – The UUID of the custom field associated with this rule
firstErrors	array – The first errors.
groupLabel	string, null
html	string – The rule’s HTML for a condition builder
isNew	boolean – Whether the rule is new
iterator	ArrayIterator – An iterator for traversing the items in the list.
label	string
labelHint	string, null
operator	string – The selected operator.
scenario	string – The scenario that this model is in.
uiLabel	string – The rule’s option label
uid	string, null – UUID
validators	ArrayObject, yii\validators\Validator – All the validators declared in the model.
values	string[]

Protected Properties

Property	Description
reloadOnOperatorChange	boolean – Whether to reload the condition builder when the operator changes

Public Methods

Method	Description
__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.
getErrorSummary()	Returns the errors for all attributes as a one-dimensional array.
getErrors()	Returns the errors for all attributes or a single attribute.
getExclusiveQueryParams()
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().
getValues()
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.
matchElement()
modifyQuery()
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.
setFieldUid()	Sets the UUID of the custom field associated with this rule.
setScenario()	Sets the scenario for the model.
setValues()
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.

Protected Methods

Method	Description
defineBehaviors()	Returns the behaviors to attach to this class.
defineRules()	Returns the validation rules for attributes.
elementQueryParam()
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.
field()	Returns the custom field associated with this rule.
inputHtml()	Returns the input HTML.
matchFieldValue()
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.
options()
paramValue()	Returns the rule’s value, prepped for craft\helpers\Db::parseParam() based on the selected operator.
resolveFields()	Determines which fields can be returned by toArray().

elementQueryParam()

View source

inputHtml()

Returns the input HTML.

View source

Returns

string

matchFieldValue()

View source

Arguments

• $value

options()

View source

Constants

Constant	Description
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_DEFAULT	The name of the default scenario.