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

Visibility

Visibility.php : 23 Copy path

Extends Criterion

Implements FilteringCriterion

A criterion that matches content based on its visibility.

Warning: This Criterion acts on all locations of a Content, so it will include hidden content within the tree you are searching for if content has visible location elsewhere. This is intentional and you should rather use LocationSearch if this is not the behaviour you want.

Constants¶

HIDDEN ¶

Visibility.php : 33 Copy path

Visibility constant: hidden.

public mixed HIDDEN = 1

VISIBLE ¶

Visibility.php : 28 Copy path

Visibility constant: visible.

public mixed VISIBLE = 0

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

Visibility.php : 42 Copy path

Creates a new Visibility criterion.

public __construct(int $value)

Parameters

Name	Type	Default value	Description
$value	int	-	Visibility: self::VISIBLE, self::HIDDEN

getSpecifications() ¶

Visibility.php : 51 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>