Copied!

Dimensions

Dimensions.php : 21

Constants

publicIMAGE_DIMENSIONS_CRITERIA

Dimensions.php : 23
public mixed IMAGE_DIMENSIONS_CRITERIA = ['width', 'height']

Properties

public $criteria

CompositeCriterion.php : 17
public Criterion $criteria

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()

AbstractImageCompositeCriterion.php : 30

Performs operator validation based on the Criterion specifications returned by {@see getSpecifications()}.

public __construct(string $fieldDefIdentifier, array<string|int, mixed> $imageCriteriaData)

Parameters

Name Type Default value Description
$fieldDefIdentifier string - -
$imageCriteriaData array<string|int, mixed> - -
Tags
Throws
InvalidArgumentException

publicgetSpecifications()

CompositeCriterion.php : 24

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>

protectedbuildCriteria()

Dimensions.php : 43
protected buildCriteria(string $fieldDefIdentifier, array<string|int, mixed> $imageCriteriaData) : array<string|int, Criterion>

Parameters

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

Return values

array<string|int, Criterion>

Tags
Throws
InvalidArgumentException

protectedgetMaxValue()

AbstractImageCompositeCriterion.php : 108
protected getMaxValue(array{max?: (numeric)|null} $data) : (numeric)|null

Parameters

Name Type Default value Description
$data array{max?: (numeric)|null} - -

Return values

(numeric)|null

protectedgetMinValue()

AbstractImageCompositeCriterion.php : 98
protected getMinValue(array{min?: (numeric)|null} $data) : numeric-string|int|float

Parameters

Name Type Default value Description
$data array{min?: (numeric)|null} - -

Return values

numeric-string|int|float

protectedgetSupportedCriteria()

Dimensions.php : 31
protected getSupportedCriteria() : array<string|int, string>

Return values

array<string|int, string>

protectedvalidate()

AbstractImageCompositeCriterion.php : 62
protected validate(array<string|int, mixed> $imageCriteriaData, array<string|int, string> $supportedCriteria) : void

Parameters

Name Type Default value Description
$imageCriteriaData array<string|int, mixed> - -
$supportedCriteria array<string|int, string> - -
Tags
Throws
InvalidArgumentException