PHP Class Jackalope\NodeType\ItemDefinition

Inheritance: implements PHPCR\NodeType\ItemDefinitionInterface

Show file Open project: jackalope/jackalope Class Usage Examples

Protected Properties

Property	Type	Description
$declaringNodeType	string	Name of the declaring node type.
$factory	Jackalope\FactoryInterface	The factory to instantiate objects
$isAutoCreated	boolean	Whether this item is autocreated.
$isMandatory	boolean	Whether this item is mandatory.
$isProtected	boolean	Whether this item is protected.
$name	string	Name of this node type.
$nodeTypeManager	NodeTypeManager
$onParentVersion	integer	On parent version constant

Public Methods

Method	Description
__construct ( Jackalope\FactoryInterface $factory, array $definition, NodeTypeManager $nodeTypeManager )	Create a new item definition.
getDeclaringNodeType ( )	{@inheritDoc}
getName ( )	{@inheritDoc}
getOnParentVersion ( )	{@inheritDoc}
isAutoCreated ( )	{@inheritDoc}
isMandatory ( )	{@inheritDoc}
isProtected ( )	{@inheritDoc}

Protected Methods

Method	Description
fromArray ( array $data )	Load item definition from an array.

Method Details

__construct() public method

TODO: document this format. Property and Node add more to this.

public __construct ( Jackalope\FactoryInterface $factory, array $definition, NodeTypeManager $nodeTypeManager )
$factory	Jackalope\FactoryInterface	the object factory
$definition	array	The property definition data as array
$nodeTypeManager	NodeTypeManager

fromArray() protected method

Overwritten for property and node to add more information, with a call to this parent method for the common things.

protected fromArray ( array $data )
$data	array	An array with the fields required by ItemDefinition

getDeclaringNodeType() public method

{@inheritDoc}

public getDeclaringNodeType ( )

getName() public method

{@inheritDoc}

public getName ( )

getOnParentVersion() public method

{@inheritDoc}

public getOnParentVersion ( )

isAutoCreated() public method

{@inheritDoc}

public isAutoCreated ( )

isMandatory() public method

{@inheritDoc}

public isMandatory ( )

isProtected() public method

{@inheritDoc}

public isProtected ( )

Property Details

$declaringNodeType protected property

Name of the declaring node type.

protected string $declaringNodeType
return	string

$factory protected property

The factory to instantiate objects

protected FactoryInterface,Jackalope $factory
return	Jackalope\FactoryInterface

$isAutoCreated protected property

Whether this item is autocreated.

protected bool $isAutoCreated
return	boolean

$isMandatory protected property

Whether this item is mandatory.

protected bool $isMandatory
return	boolean

$isProtected protected property

Whether this item is protected.

protected bool $isProtected
return	boolean

$name protected property

Name of this node type.

protected string $name
return	string

$nodeTypeManager protected property

protected NodeTypeManager,Jackalope\NodeType $nodeTypeManager
return	NodeTypeManager

$onParentVersion protected property

On parent version constant

protected int $onParentVersion
return	integer