ElementConditionRuleInterface ​
- Type
- Interface
- Namespace
- craft\elements\conditions
- Extends
- craft\base\conditions\ConditionRuleInterface
- Implemented by
- craft\elements\conditions\DateCreatedConditionRule, craft\elements\conditions\DateUpdatedConditionRule, craft\elements\conditions\HasDescendantsRule, craft\elements\conditions\HasUrlConditionRule, craft\elements\conditions\IdConditionRule, craft\elements\conditions\LevelConditionRule, craft\elements\conditions\RelatedToConditionRule, craft\elements\conditions\SiteConditionRule, craft\elements\conditions\SiteGroupConditionRule, 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\FieldConditionRuleInterface
- Since
- 4.0.0
ElementConditionRuleInterface defines the common interface to be implemented by element condition rule classes.
Public Methods ​
Method | Description |
---|---|
displayName() | Returns the display name of this class. |
extraFields() | Returns the list of additional fields that can be returned by toArray() in addition to those listed in fields(). |
fields() | Returns the list of fields that should be returned by default by toArray() when no specific fields are specified. |
getAutofocus() | Returns whether the rule’s type selector should be autofocused. |
getCondition() | Returns the condition associated with this rule. |
getConfig() | Returns the rule’s portable config. |
getExclusiveQueryParams() | Returns the query param names that this rule should have exclusive control over. |
getGroupLabel() | Returns the optgroup label the condition rule should be grouped under. |
getHtml() | Returns the rule’s HTML for a condition builder. |
getLabel() | Returns the rule’s option label. |
getLabelHint() | Returns the rule’s option label hint. |
instance() | Returns static class instance, which can be used to obtain meta information. |
isSelectable() | Returns whether the component should be selectable in component Type selects. |
matchElement() | Returns whether the given element matches the condition rule. |
modifyQuery() | Modifies the given query with the condition rule. |
setAutofocus() | Sets whether the rule’s type selector should be autofocused. |
setCondition() | Sets the condition associated with this rule. |
supportsProjectConfig() | Returns whether the rule is safe to include in conditions that are stored in the project config. |
toArray() | Converts the object into an array. |
getExclusiveQueryParams()
​
Returns the query param names that this rule should have exclusive control over.
Returns ​
string[]
matchElement()
​
Returns whether the given element matches the condition rule.
Arguments ​
$element
(craft\base\ElementInterface)
Returns ​
modifyQuery()
​
Modifies the given query with the condition rule.