Copied!

ObjectStateId

ObjectStateId.php : 22
Extends Criterion
Implements FilteringCriterion

A criterion that matches content based on its state.

Supported operators:

  • IN: matches against a list of object state IDs
  • EQ: matches against one object state ID

Properties

public $operator

Criterion.php : 23

The operator used by the Criterion.

public string $operator

public $target

Criterion.php : 37

The target used by the criteria (field, metadata...).

public string $target

public $value

Criterion.php : 30

The value(s) matched by the criteria.

public array<string|int, scalar>|scalar $value

public $valueData

Criterion.php : 44

Additional value data, required by some criterions, MapLocationDistance for instance.

public Value $valueData

Methods

public__construct()

ObjectStateId.php : 32

Creates a new ObjectStateId criterion.

public __construct(int|array<string|int, int> $value)

Parameters

Name Type Default value Description
$value int|array<string|int, int> -

One or more object state IDs that must be matched

Tags
Throws
InvalidArgumentException

if a non numeric id is given

Throws
InvalidArgumentException

if the value type doesn't match the operator

publicgetSpecifications()

ObjectStateId.php : 37

Criterion description function.

public getSpecifications() : array<string|int, Specifications>

Returns the combination of the Criterion's supported operator/value, as an array of Specifications objects

  • Operator is one supported Operator, as an Operator::* constant
  • ValueType is the type of input value this operator requires, either array or single
  • SupportedTypes is an array of types the operator will accept
  • ValueCountLimitation is an integer saying how many values are expected.
// IN and EQ are supported return [ // The EQ operator expects a single value, either as an integer or a string new Specifications( Operator::EQ, Specifications::FORMAT_SINGLE, Specifications::TYPE_INTEGER | Specifications::TYPE_STRING ), // The IN operator expects an array of values, of either integers or strings new Specifications( Operator::IN, Specifications::FORMAT_ARRAY, Specifications::TYPE_INTEGER | Specifications::TYPE_STRING ) ]

Return values

array<string|int, Specifications>