eZPublishCommunityProject  2013.6
eZ\Publish\Core\Limitation\ContentTypeLimitationType Class Reference

ContentTypeLimitation is a Content limitation. More...

+ Inheritance diagram for eZ\Publish\Core\Limitation\ContentTypeLimitationType:
+ Collaboration diagram for eZ\Publish\Core\Limitation\ContentTypeLimitationType:

Public Member Functions

 acceptValue (APILimitationValue $limitationValue)
 Accepts a Limitation value and checks for structural validity. More...
 
 buildValue (array $limitationValues)
 Create the Limitation Value. More...
 
 getCriterion (APILimitationValue $value, APIUser $currentUser)
 Returns Criterion for use in find() query. More...
 
 validate (APILimitationValue $limitationValue)
 Makes sure LimitationValue->limitationValues is valid according to valueSchema(). More...
 
 valueSchema ()
 Returns info on valid $limitationValues. More...
 
- Public Member Functions inherited from eZ\Publish\Core\Limitation\AbstractPersistenceLimitationType
 __construct (SPIPersistenceHandler $persistence)
 
- Public Member Functions inherited from eZ\Publish\SPI\Limitation\Type
 evaluate (APILimitationValue $value, APIUser $currentUser, APIValueObject $object, array $targets=array())
 Evaluate permission against content and placement. More...
 

Additional Inherited Members

- Public Attributes inherited from eZ\Publish\SPI\Limitation\Type
const VALUE_SCHEMA_LOCATION_ID = 1
 Constants for valueSchema() return values. More...
 
const VALUE_SCHEMA_LOCATION_PATH = 2
 
- Protected Attributes inherited from eZ\Publish\Core\Limitation\AbstractPersistenceLimitationType
 $persistence
 

Detailed Description

ContentTypeLimitation is a Content limitation.

Member Function Documentation

eZ\Publish\Core\Limitation\ContentTypeLimitationType::acceptValue ( APILimitationValue  $limitationValue)

Accepts a Limitation value and checks for structural validity.

Makes sure LimitationValue object and ->limitationValues is of correct type.

Exceptions
\eZ\Publish\API\Repository\Exceptions\InvalidArgumentExceptionIf the value does not match the expected type/structure
Parameters
\eZ\Publish\API\Repository\Values\User\Limitation$limitationValue

Implements eZ\Publish\SPI\Limitation\Type.

eZ\Publish\Core\Limitation\ContentTypeLimitationType::buildValue ( array  $limitationValues)

Create the Limitation Value.

Parameters
mixed[]$limitationValues
Returns

Implements eZ\Publish\SPI\Limitation\Type.

eZ\Publish\Core\Limitation\ContentTypeLimitationType::getCriterion ( APILimitationValue  $value,
APIUser  $currentUser 
)

Returns Criterion for use in find() query.

Parameters
\eZ\Publish\API\Repository\Values\User\Limitation$value
\eZ\Publish\API\Repository\Values\User\User$currentUser
Returns

Implements eZ\Publish\SPI\Limitation\Type.

eZ\Publish\Core\Limitation\ContentTypeLimitationType::validate ( APILimitationValue  $limitationValue)

Makes sure LimitationValue->limitationValues is valid according to valueSchema().

Make sure acceptValue() is checked first!

Parameters
\eZ\Publish\API\Repository\Values\User\Limitation$limitationValue
Returns
[]

Implements eZ\Publish\SPI\Limitation\Type.

eZ\Publish\Core\Limitation\ContentTypeLimitationType::valueSchema ( )

Returns info on valid $limitationValues.

Returns
mixed[]|int In case of array, a hash with key as valid limitations value and value as human readable name of that option, in case of int on of VALUE_SCHEMA_ constants.

Implements eZ\Publish\SPI\Limitation\Type.


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