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

A criterion that matches content based on one of the user metadata (owner, creator, modifier) More...

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

Public Member Functions

 __construct ($target, $operator, $value)
 Creates a new UserMetadata criterion on $metadata. 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...
 

Public Attributes

const CREATOR = 'creator'
 UserMetadata target: Creator. More...
 
const GROUP = 'group'
 UserMetadata target: Owner user group. More...
 
const MODIFIER = 'modifier'
 UserMetadata target: Modifier. More...
 
const OWNER = 'owner'
 UserMetadata target: Owner user. More...
 
- Public Attributes inherited from eZ\Publish\API\Repository\Values\Content\Query\Criterion
 $operator
 
 $target
 
 $value
 

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...
 

Detailed Description

A criterion that matches content based on one of the user metadata (owner, creator, modifier)

Supported Operators: EQ, IN: Matches the provided user ID(s) against the user IDs in the database

Example: $createdCriterion = new Criterion( Criterion::CREATOR, Operator::IN, array( 10, 14 ) );

Constructor & Destructor Documentation

eZ\Publish\API\Repository\Values\Content\Query\Criterion\UserMetadata::__construct (   $target,
  $operator,
  $value 
)

Creates a new UserMetadata criterion on $metadata.

Exceptions
\InvalidArgumentExceptionIf target is unknown
Parameters
string$targetOne of UserMetadata::OWNER, UserMetadata::GROUP, UserMetadata::CREATED or UserMetadata::MODIFIED
string$operatorOne of the Operator constants
mixed$valueThe match value, either as an array of as a single value, depending on the operator

Member Function Documentation

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

Member Data Documentation

const eZ\Publish\API\Repository\Values\Content\Query\Criterion\UserMetadata::CREATOR = 'creator'

UserMetadata target: Creator.

const eZ\Publish\API\Repository\Values\Content\Query\Criterion\UserMetadata::GROUP = 'group'

UserMetadata target: Owner user group.

const eZ\Publish\API\Repository\Values\Content\Query\Criterion\UserMetadata::MODIFIER = 'modifier'

UserMetadata target: Modifier.

const eZ\Publish\API\Repository\Values\Content\Query\Criterion\UserMetadata::OWNER = 'owner'

UserMetadata target: Owner user.


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