eZPublishCommunityProject  2013.4
eZ\Publish\API\Repository\Values\Content\Query\Criterion\Subtree Class Reference

Criterion that matches content that belongs to a given (list of) Subtree(s) More...

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

Public Member Functions

 __construct ($value)
 Creates a new SubTree 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
 $operator
 
 $target
 
 $value
 

Detailed Description

Criterion that matches content that belongs to a given (list of) Subtree(s)

Content will be matched if it is part of at least one of the given subtree path strings

Constructor & Destructor Documentation

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

Creates a new SubTree criterion.

Parameters
string|string[]$value an array of subtree path strings, eg: /1/2/
Exceptions
InvalidArgumentExceptionif a non path string is given
InvalidArgumentExceptionif the value type doesn't match the operator

Member Function Documentation

static eZ\Publish\API\Repository\Values\Content\Query\Criterion\Subtree::createFromQueryBuilder (   $target,
  $operator,
  $value 
)
static

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

Parameters
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
Returns
CriterionInterface

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

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

Returns
[]

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


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