Ibexa >
Contracts >
Core >
Repository >
Values >
Content >
Query >
Criterion >
DateMetadata

DateMetadata

DateMetadata.php : 35 Copy path

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¶

CREATED ¶

DateMetadata.php : 39 Copy path

public mixed CREATED = 'created'

MODIFIED ¶

DateMetadata.php : 37 Copy path

public mixed MODIFIED = 'modified'

PUBLISHED ¶

DateMetadata.php : 41 Copy path

public mixed PUBLISHED = 'published'

TARGETS ¶

DateMetadata.php : 50 Copy path

    
                        public mixed TARGETS = [self::MODIFIED, self::CREATED, self::PUBLISHED, self::TRASHED]

TRASHED ¶

DateMetadata.php : 48 Copy path

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

public mixed TRASHED = 'trashed'

Applies to TrashService::findTrashItems() only.

Properties¶

$operator ¶

Criterion.php : 23 Copy path

The operator used by the Criterion.

public string $operator

$target ¶

Criterion.php : 37 Copy path

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

public string $target

$value ¶

Criterion.php : 30 Copy path

The value(s) matched by the criteria.

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

$valueData ¶

Criterion.php : 44 Copy path

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

public Value $valueData

Methods¶

__construct() ¶

DateMetadata.php : 66 Copy path

Creates a new DateMetadata criterion.

public __construct(string $target, string $operator, mixed $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	mixed	-	The match value, either as an array of as a single value, depending on the operator

getSpecifications() ¶

DateMetadata.php : 78 Copy path

Criterion description function.

public getSpecifications() : array<int, Specifications>

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

Specifications::$operator is a supported Operator constant.
Specifications::$valueFormat is the type of input value this operator requires, either array (Specifications::FORMAT_ARRAY) or single (Specifications::FORMAT_SINGLE).
Specifications::$valueTypes are bitwise flags of types the operator will accept (Specifications::TYPE_BOOLEAN, Specifications::TYPE_INTEGER, and/or Specifications::TYPE_STRING).
Specifications::$valueCount 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<int, Specifications>