BaseConditionRule
- Type
- Abstract Class
- Namespace
- craft\base\conditions
- Inherits
- craft\base\conditions\BaseConditionRule » 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\ConditionRuleInterface, 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\base\conditions\BaseDateRangeConditionRule, craft\base\conditions\BaseElementSelectConditionRule, craft\base\conditions\BaseLightswitchConditionRule, craft\base\conditions\BaseMultiSelectConditionRule, craft\base\conditions\BaseNumberConditionRule, craft\base\conditions\BaseSelectConditionRule, craft\base\conditions\BaseTextConditionRule, craft\elements\conditions\DateCreatedConditionRule, craft\elements\conditions\DateUpdatedConditionRule, craft\elements\conditions\HasUrlConditionRule, craft\elements\conditions\IdConditionRule, craft\elements\conditions\LevelConditionRule, craft\elements\conditions\RelatedToConditionRule, craft\elements\conditions\SiteConditionRule, craft\elements\conditions\SlugConditionRule, craft\elements\conditions\StatusConditionRule, craft\elements\conditions\TitleConditionRule, craft\elements\conditions\UriConditionRule, craft\elements\conditions\addresses\AdministrativeAreaConditionRule, craft\elements\conditions\addresses\CountryConditionRule, craft\elements\conditions\assets\DateModifiedConditionRule, craft\elements\conditions\assets\FileSizeConditionRule, craft\elements\conditions\assets\FileTypeConditionRule, craft\elements\conditions\assets\FilenameConditionRule, craft\elements\conditions\assets\HasAltConditionRule, craft\elements\conditions\assets\HeightConditionRule, craft\elements\conditions\assets\SavableConditionRule, craft\elements\conditions\assets\UploaderConditionRule, craft\elements\conditions\assets\ViewableConditionRule, craft\elements\conditions\assets\VolumeConditionRule, craft\elements\conditions\assets\WidthConditionRule, craft\elements\conditions\categories\GroupConditionRule, craft\elements\conditions\entries\AuthorConditionRule, craft\elements\conditions\entries\AuthorGroupConditionRule, craft\elements\conditions\entries\ExpiryDateConditionRule, craft\elements\conditions\entries\PostDateConditionRule, craft\elements\conditions\entries\SavableConditionRule, craft\elements\conditions\entries\SectionConditionRule, craft\elements\conditions\entries\TypeConditionRule, craft\elements\conditions\entries\ViewableConditionRule, craft\elements\conditions\tags\GroupConditionRule, craft\elements\conditions\users\AdminConditionRule, craft\elements\conditions\users\CredentialedConditionRule, craft\elements\conditions\users\EmailConditionRule, craft\elements\conditions\users\FirstNameConditionRule, craft\elements\conditions\users\GroupConditionRule, craft\elements\conditions\users\LastLoginDateConditionRule, craft\elements\conditions\users\LastNameConditionRule, craft\elements\conditions\users\UsernameConditionRule, craft\fields\conditions\DateFieldConditionRule, craft\fields\conditions\EmptyFieldConditionRule, craft\fields\conditions\LightswitchFieldConditionRule, craft\fields\conditions\NumberFieldConditionRule, craft\fields\conditions\OptionsFieldConditionRule, craft\fields\conditions\RelationalFieldConditionRule, craft\fields\conditions\TextFieldConditionRule
- Since
- 4.0.0
BaseConditionRule provides a base implementation for condition rules.
View source (opens new window)
# Public Properties
# autofocus
- Type
- boolean (opens new window)
- Default value
null
- Access
- Read-only
View source (opens new window)
# condition
- Type
- craft\base\conditions\ConditionInterface
- Default value
null
View source (opens new window)
# config
- Type
- array (opens new window)
- Default value
null
The rule’s portable config
View source (opens new window)
# groupLabel
- Type
- string (opens new window), null (opens new window)
- Default value
null
- Access
- Read-only
View source (opens new window)
# html
- Type
- string (opens new window)
- Default value
null
The rule’s HTML for a condition builder
View source (opens new window)
# isNew
- Type
- boolean (opens new window)
- Default value
null
Whether the rule is new
View source (opens new window)
# operator
- Type
- string (opens new window)
- Default value
null
The selected operator.
View source (opens new window)
# uiLabel
- Type
- string (opens new window)
- Default value
null
The rule’s option label
View source (opens new window)
# uid
- Type
- string (opens new window), null (opens new window)
- Default value
null
UUID
View source (opens new window)
# Protected Properties
Property | Description |
---|---|
reloadOnOperatorChange | boolean (opens new window) – Whether to reload the condition builder when the operator changes |
# reloadOnOperatorChange
- Type
- boolean (opens new window)
- Default value
false
Whether to reload the condition builder when the operator changes
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() | |
__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. |
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. |
getAutofocus() | Returns whether the rule’s type selector should be autofocused. |
getBehavior() (opens new window) | Returns the named behavior object. |
getBehaviors() (opens new window) | Returns all behaviors attached to this component. |
getCondition() | Returns the condition associated with this rule. |
getConfig() | Returns the rule’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. |
getGroupLabel() | Returns the optgroup label the condition rule should be grouped under. |
getHtml() | Returns the rule’s HTML for a condition builder. |
getIterator() (opens new window) | Returns an iterator for traversing the attributes in the model. |
getLabel() | Returns the rule’s option label. |
getScenario() (opens new window) | Returns the scenario that this model is used in. |
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. |
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. |
setAutofocus() | Sets whether the rule’s type selector should be autofocused. |
setCondition() | Sets the condition associated with this rule. |
setScenario() (opens new window) | 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() (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. |
# getAutofocus()
Returns whether the rule’s type selector should be autofocused.
View source (opens new window)
Returns
# getCondition()
Returns the condition associated with this rule.
View source (opens new window)
Returns
craft\base\conditions\ConditionInterface
# getConfig()
Returns the rule’s portable config.
View source (opens new window)
Returns
Throws
- yii\base\InvalidConfigException (opens new window)
if the rule is misconfigured
# getGroupLabel()
Returns the optgroup label the condition rule should be grouped under.
View source (opens new window)
Returns
string (opens new window), null (opens new window)
# getHtml()
Returns the rule’s HTML for a condition builder.
View source (opens new window)
Returns
# 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 (opens new window)
# setAutofocus()
Sets whether the rule’s type selector should be autofocused.
View source (opens new window)
Arguments
$autofocus
(boolean (opens new window))
# setCondition()
Sets the condition associated with this rule.
View source (opens new window)
Arguments
$condition
(craft\base\conditions\ConditionInterface)
# supportsProjectConfig()
Returns whether the rule is safe to include in conditions that are stored in the project config.
View source (opens new window)
Returns
# Protected Methods
Method | Description |
---|---|
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. |
inputHtml() | Returns the input HTML. |
operatorLabel() | Returns the option label for a given operator. |
operators() | Returns the operators that should be allowed for this rule. |
resolveFields() (opens new window) | Determines which fields can be returned by toArray() (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
# inputHtml()
Returns the input HTML.
View source (opens new window)
Returns
# operatorLabel()
Returns the option label for a given operator.
View source (opens new window)
Arguments
$operator
(string (opens new window))
Returns
# operators()
Returns the operators that should be allowed for this rule.
View source (opens new window)
Returns
# 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. |