ElementRelationParamParser

Type
Class
Namespace
craft\elements\db
Inherits
craft\elements\db\ElementRelationParamParser ยป yii\base\BaseObject (opens new window)
Implements
yii\base\Configurable (opens new window)
Since
3.0.0

Parses a relatedTo param on an ElementQuery.

View source (opens new window)

# Public Properties

Property Description
fields craft\base\FieldInterface[], null (opens new window) โ€“ The custom fields that are game for the query.

# fields

Type
craft\base\FieldInterface[], null (opens new window)
Default value
null

The custom fields that are game for the query.

View source (opens new window)

# Public Methods

Method Description
__call() (opens new window) Calls the named method which is not a class method.
__construct() (opens new window) Constructor.
__get() (opens new window) Returns the value of an object property.
__isset() (opens new window) Checks if a property is set, i.e. defined and not null.
__set() (opens new window) Sets value of an object property.
__unset() (opens new window) Sets an object property to null.
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.
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.
init() (opens new window) Initializes the object.
normalizeRelatedToCriteria() Normalizes an individual relatedTo criteria.
normalizeRelatedToParam() Normalizes a relatedTo param for parse().
parse() Parses a relatedTo element query param and returns the condition that should be applied back on the element query, or false if there's an issue.

# normalizeRelatedToCriteria()

Since
3.6.11

Normalizes an individual relatedTo criteria.

View source (opens new window)

Arguments

Returns

array (opens new window)

Throws

# normalizeRelatedToParam()

Since
3.6.11

Normalizes a relatedTo param for parse().

View source (opens new window)

Arguments

Returns

array (opens new window)

Throws

# parse()

Parses a relatedTo element query param and returns the condition that should be applied back on the element query, or false if there's an issue.

View source (opens new window)

Arguments

Returns

array (opens new window), false (opens new window)

# Constants

Constant Description
DIR_FORWARD
DIR_REVERSE