Copied!

UserMetadata

UserMetadata.php : 33
Extends Criterion
Implements Criterion, FilteringCriterion

A criterion that matches content based on one of the user metadata (owner, group, modifier).

Supported Operators:

  • EQ, IN: Matches the provided user ID(s) against the user IDs in the database.

The following example is a criterion for contents owned by a user with ID 10 or 14:

$createdCriterion = new Criterion\UserMetadata(
    Criterion\UserMetadata::OWNER,
    Criterion\Operator::IN,
    [10, 14]
);

Constants

publicGROUP

UserMetadata.php : 43

UserMetadata target: Owner user group.

 
public mixed GROUP = 'group'

publicMODIFIER

UserMetadata.php : 48

UserMetadata target: Modifier.

 
public mixed MODIFIER = 'modifier'

publicOWNER

UserMetadata.php : 38

UserMetadata target: Owner user.

 
public mixed OWNER = 'owner'

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

UserMetadata.php : 59

Creates a new UserMetadata criterion.

 
public __construct(string $target, string|null $operator, mixed $value)

Parameters

Name Type Default value Description
$target string -

One of UserMetadata::OWNER, UserMetadata::GROUP, or UserMetadata::MODIFIER.
$operator string|null -

The operator the Criterion uses. If null is given, will default to Operator::IN if $value is an array, Operator::EQ if it isn't.
$value mixed -

The match value, either as an array of as a single value, depending on the operator.
Tags
Throws
InvalidArgumentException

If target is unknown

publicgetSpecifications()

UserMetadata.php : 73

Criterion description function.

 
public getSpecifications() : array<int, Specifications>

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

// 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<int, Specifications>