Copied!

DateMetadata

DateMetadata.php : 35
Extends Criterion
Implements Criterion, FilteringCriterion

A criterion that matches content based on one of the date metadata (created or modified).

Supported Operators:

  • EQ, IN: matches content whose date is or belongs to a list of timestamps.
  • GT, GTE: matches content whose date is greater than/greater than or equals the given timestamp.
  • LT, LTE: matches content whose date is lower than/lower than or equals the given timestamp.
  • BETWEEN: matches content whose date is between TWO (included) given timestamps.

The following example is a criterion for contents created yesterday or today:

$createdCriterion = new Criterion\DateMetadata(
    Criterion\DateMetadata::CREATED,
    Criterion\Operator::GTE,
    strtotime('yesterday')
);

Constants

publicCREATED

DateMetadata.php : 39 
public mixed CREATED = 'created'

publicMODIFIED

DateMetadata.php : 37 
public mixed MODIFIED = 'modified'

publicPUBLISHED

DateMetadata.php : 41 
public mixed PUBLISHED = 'published'

publicTARGETS

DateMetadata.php : 50 
public mixed TARGETS = [self::MODIFIED, self::CREATED, self::PUBLISHED, self::TRASHED]

publicTRASHED

DateMetadata.php : 48

To search for contents based on when they have been sent to trash.

 
public mixed TRASHED = 'trashed'

Applies to TrashService::findTrashItems() only.

Properties

public $operator

Criterion.php : 21

The operator used by the Criterion.

 
public string $operator

public $target

Criterion.php : 33

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

 
public string|null $target

public $value

Criterion.php : 28

The value(s) matched by the criteria.

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

public $valueData

Criterion.php : 38

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

 
public Value|null $valueData

Methods

public__construct()

DateMetadata.php : 66

Creates a new DateMetadata criterion.

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

Parameters

Name Type Default value Description
$target string -

One of DateMetadata::CREATED, DateMetadata::MODIFIED, or DateMetadata::TRASHED (applies to TrashService::findTrashItems() only)
$operator string -

One of the Operator constants
$value int|array<string|int, int> -

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

If target is unknown

publicgetSpecifications()

DateMetadata.php : 78

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>