eZPublishCommunityProject  2012.12
eZ\Publish\SPI\Limitation\Type Interface Reference

This interface represent the Limitation Type. More...

+ Inheritance diagram for eZ\Publish\SPI\Limitation\Type:

Public Member Functions

 acceptValue (APILimitationValue $limitationValue)
 Accepts a Limitation value. More...
 
 buildValue (array $limitationValues)
 Create the Limitation Value. More...
 
 evaluate (APILimitationValue $value, APIUser $currentUser, APIValueObject $object, APIValueObject $target=null)
 Evaluate permission against content and placement. More...
 
 getCriterion (APILimitationValue $value, APIUser $currentUser)
 Returns Criterion for use in find() query. More...
 
 valueSchema ()
 Returns info on valid $limitationValues. More...
 

Public Attributes

const VALUE_SCHEMA_LOCATION_ID = 1
 Constants for valueSchema() return values. More...
 
const VALUE_SCHEMA_LOCATION_PATH = 2
 

Detailed Description

This interface represent the Limitation Type.

Member Function Documentation

eZ\Publish\SPI\Limitation\Type::evaluate ( APILimitationValue  $value,
APIUser  $currentUser,
APIValueObject  $object,
APIValueObject  $target = null 
)

Evaluate permission against content and placement.

Exceptions
\eZ\Publish\API\Repository\Exceptions\InvalidArgumentExceptionIf any of the arguments are invalid Example: If LimitationValue is instance of ContentTypeLimitationValue, and Type is SectionLimitationType.
\eZ\Publish\API\Repository\Exceptions\BadStateExceptionIf value of the LimitationValue is unsupported Example if OwnerLimitationValue->limitationValues[0] is not one of: [ 1, 2 ]
Parameters
\eZ\Publish\API\Repository\Values\User\Limitation$value
\eZ\Publish\API\Repository\Values\User\User$currentUser
\eZ\Publish\API\Repository\Values\ValueObject$object
\eZ\Publish\API\Repository\Values\ValueObject | null$targetThe location, parent or "assignment" value object
Returns
boolean

Member Data Documentation

const eZ\Publish\SPI\Limitation\Type::VALUE_SCHEMA_LOCATION_ID = 1

Constants for valueSchema() return values.

Used in cases where a certain value is accepted but the options are to many to return as a hash of options. GUI should typically present option to browse content tree to select limitation value(s).

const eZ\Publish\SPI\Limitation\Type::VALUE_SCHEMA_LOCATION_PATH = 2

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