eZPublishCommunityProject  2012.12
eZ\Publish\API\Repository\Values\Content\Query\Criterion\Field Class Reference

The Field Criterion class. More...

+ Inheritance diagram for eZ\Publish\API\Repository\Values\Content\Query\Criterion\Field:
+ Collaboration diagram for eZ\Publish\API\Repository\Values\Content\Query\Criterion\Field:

Public Member Functions

 __construct ($fieldIdentifier, $operator, $value)
 Creates a new Field Criterion. More...
 getSpecifications ()
 Criterion description function. More...
- Public Member Functions inherited from eZ\Publish\API\Repository\Values\Content\Query\Criterion
 __construct ($target, $operator, $value)
 Performs operator validation based on the Criterion specifications returned by {. More...

Additional Inherited Members

- Static Public Member Functions inherited from eZ\Publish\API\Repository\Values\Content\Query\Criterion
static createFromQueryBuilder ($target, $operator, $value)
- Static Public Member Functions inherited from eZ\Publish\API\Repository\Values\Content\Query\CriterionInterface
static createFromQueryBuilder ($target, $operator, $value)
 Creates a new Criterion for $target with operator $operator on $value. More...
- Public Attributes inherited from eZ\Publish\API\Repository\Values\Content\Query\Criterion

Detailed Description

The Field Criterion class.

Provides content filtering based on Fields contents & values.

Constructor & Destructor Documentation

eZ\Publish\API\Repository\Values\Content\Query\Criterion\Field::__construct (   $fieldIdentifier,

Creates a new Field Criterion.

Matches $fieldIdentifier against $value using $operator. $fieldIdentifier is same value as eZ->fieldDefIdentifier

string$fieldIdentifierThe target field identifier
string$operatorThe match operator
mixed$valueThe value to match against

Member Function Documentation

eZ\Publish\API\Repository\Values\Content\Query\Criterion\Field::getSpecifications ( )

Criterion description function.

Returns the combination of the Criterion's supported operator/value, as an array of eZ 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 array( // The EQ operator expects a single value, either as an integer or a string new Specifications( Operator::EQ, Specifications::INPUT_TYPE_SINGLE, array( Specifications::INPUT_VALUE_INTEGER, Specifications::INPUT_VALUE_STRING ), ), // The IN operator expects an array of values, of either integers or strings new Specifications( Operator::IN, Specifications::INPUT_TYPE_ARRAY, array( Specifications::INPUT_VALUE_INTEGER, Specifications::INPUT_VALUE_STRING ) ) )*


Implements eZ\Publish\API\Repository\Values\Content\Query\CriterionInterface.

The documentation for this class was generated from the following file: