eZPublishCommunityProject  2013.5
eZ\Publish\API\Repository\Values\Content\Query\Criterion\ObjectStateId Class Reference

A criterion that matches content based on its state. More...

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

Public Member Functions

 __construct ($value)
 Creates a new ObjectStateId 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...

Static Public Member Functions

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

Additional Inherited Members

- Public Attributes inherited from eZ\Publish\API\Repository\Values\Content\Query\Criterion

Detailed Description

A criterion that matches content based on its state.

Supported operators:

  • IN: matches against a list of object state IDs
  • EQ: matches against one object state ID

Constructor & Destructor Documentation

eZ\Publish\API\Repository\Values\Content\Query\Criterion\ObjectStateId::__construct (   $value)

Creates a new ObjectStateId criterion.

int|int[]$value One or more object state IDs that must be matched
\InvalidArgumentExceptionif a non numeric id is given
\InvalidArgumentExceptionif the value type doesn't match the operator

Member Function Documentation

static eZ\Publish\API\Repository\Values\Content\Query\Criterion\ObjectStateId::createFromQueryBuilder (   $target,

Creates a new Criterion for $target with operator $operator on $value.

string$targetThe target (field identifier for a field, metadata identifier, etc)
string$operatorThe criterion operator, from Criterion
mixed$valueThe Criterion value, either as an individual item or an array

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

eZ\Publish\API\Repository\Values\Content\Query\Criterion\ObjectStateId::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: