phpcr/src/PHPCR/NodeType/NodeTypeTemplateInterface.php

Show:

inherited

Table of Contents

This file is part of the PHPCR API and was originally ported from the Java JCR API to PHP by Karsten Dambekalns for the FLOW3 project.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

License: Apache Software License 2.0
Link: http://phpcr.github.com/

\PHPCR\NodeType\NodeTypeTemplateInterface
jump to top

Package: Default

The NodeTypeTemplate interface represents a simple container structure used to define node types which are then registered through the NodeTypeManagerInterface::registerNodeType() method.

NodeTypeTemplateInterface, like NodeTypeInterface, is a subclass of NodeTypeDefinitionInterface so it shares with NodeTypeInterface those methods that are relevant to a static definition. In addition, NodeTypeTemplate provides methods for setting the attributes of the definition. Implementations of this interface need not contain any validation logic.

See the corresponding get methods for each attribute in NodeTypeDefinitionInterface for the default values assumed when a new empty NodeTypeTemplateInterface is created (as opposed to one extracted from an existing NodeTypeInterface).

Parent(s): \PHPCR\NodeType\NodeTypeDefinitionInterface
Api

Methods

getDeclaredChildNodeDefinitions() : array

inherited

Returns an array containing the child node definitions actually declared in this node type.

Inherited from: \PHPCR\NodeType\NodeTypeDefinitionInterface::getDeclaredChildNodeDefinitions()

In implementations that support node type registration, if this NodeTypeDefinition object is actually a newly-created empty NodeTypeTemplate, then this method will return null.

Returns

Type	Description
array	An array of NodeDefinitions.

Details

Api

getDeclaredPropertyDefinitions() : array

inherited

Returns an array containing the property definitions actually declared in this node type.

Inherited from: \PHPCR\NodeType\NodeTypeDefinitionInterface::getDeclaredPropertyDefinitions()

In implementations that support node type registration, if this NodeTypeDefinition object is actually a newly-created empty NodeTypeTemplate, then this method will return null.

Returns

Type	Description
array	An array of PropertyDefinitions.

Details

Api

getDeclaredSupertypeNames() : array

inherited

Returns the names of the supertypes actually declared in this node type.

Inherited from: \PHPCR\NodeType\NodeTypeDefinitionInterface::getDeclaredSupertypeNames()

In implementations that support node type registration, if this NodeTypeDefinition object is actually a newly-created empty NodeTypeTemplate, then this method will return an array containing a single string indicating the node type nt:base.

Returns

Type	Description
array	List of names of declared supertypes.

Details

Api

getName() : string

inherited

Returns the name of the node type.

Inherited from: \PHPCR\NodeType\NodeTypeDefinitionInterface::getName()

In implementations that support node type registration, if this NodeTypeDefinition object is actually a newly-created empty NodeTypeTemplate, then this method will return null.

Returns

Type	Description
string	The name of the node type.

Details

Api

getNodeDefinitionTemplates() : object

Returns a mutable List of NodeDefinitionTemplate objects.

To define a new NodeTypeTemplate or change an existing one, NodeDefinitionTemplate objects can be added to or removed from this list.

Returns

Type	Description
object	A mutable List (implementing \Traversable, \ArrayAccess, and \Countable) of NodeDefinitionTemplate objects

Details

Api

getPrimaryItemName() : string

inherited

Returns the name of the primary item (one of the child items of the nodes of this node type).

Inherited from: \PHPCR\NodeType\NodeTypeDefinitionInterface::getPrimaryItemName()

If this node has no primary item, then this method returns null. This indicator is used by the method NodeInterface::getPrimaryItem().

In implementations that support node type registration, if this NodeTypeDefinitionInterface object is actually a newly-created empty NodeTypeTemplateInterface, then this method will return null.

Returns

Type	Description
string	The name of the primary item.

Details

Api

getPropertyDefinitionTemplates() : object

Returns a mutable List of PropertyDefinitionTemplate objects.

To define a new NodeTypeTemplate or change an existing one, PropertyDefinitionTemplate objects can be added to or removed from this list.

Returns

Type	Description
object	A mutable List (implementing \Traversable, \ArrayAccess, and \Countable) of PropertyDefinitionTemplate objects

Details

Api

hasOrderableChildNodes() : boolean

inherited

Determines if nodes of this type must support orderable child nodes.

Inherited from: \PHPCR\NodeType\NodeTypeDefinitionInterface::hasOrderableChildNodes()

Returns true if nodes of this type must support orderable child nodes; returns false otherwise. If a node type returns true on a call to this method, then all nodes of that node type must support the method NodeInterface::orderBefore(). If a node type returns false on a call to this method, then nodes of that node type may support NodeInterface::orderBefore(). Only the primary node type of a node controls that node's status in this regard. This setting on a mixin node type will not have any effect on the node.

In implementations that support node type registration, if this NodeTypeDefinitionInterface object is actually a newly-created empty NodeTypeTemplateInterface, then this method will return false.

Returns

Type	Description
boolean	True, if nodes of this type must support orderable child nodes, else false.

Details

Api

isAbstract() : boolean

inherited

Reports if this is an abstract node type.

Inherited from: \PHPCR\NodeType\NodeTypeDefinitionInterface::isAbstract()

Returns true if this is an abstract node type; returns false otherwise. An abstract node type is one that cannot be assigned as the primary or mixin type of a node but can be used in the definitions of other node types as a superclass.

In implementations that support node type registration, if this NodeTypeDefinition object is actually a newly-created empty NodeTypeTemplate, then this method will return false.

Returns

Type	Description
boolean	True, if the current type is abstract, else false.

Details

Api

isMixin() : boolean

inherited

Reports if this is a mixin node type.

Inherited from: \PHPCR\NodeType\NodeTypeDefinitionInterface::isMixin()

Returns true if this is a mixin type; returns false if it is primary. In implementations that support node type registration, if this NodeTypeDefinition object is actually a newly-created empty NodeTypeTemplate, then this method will return false.

Returns

Type	Description
boolean	True if this is a mixin type, else false;

Details

Api

isQueryable() : boolean

inherited

Determins if the node type is queryable.

Inherited from: \PHPCR\NodeType\NodeTypeDefinitionInterface::isQueryable()

Returns true if the node type is queryable, meaning that the available-query-operators, full-text-searchable and query-orderable attributes of its property definitions take effect.

If a node type is declared non-queryable then these attributes of its property definitions have no effect.

Returns

Type	Description
boolean	True, if the node type is queryable, else false.

Details

Api
See: \PHPCR\NodeType\PropertyDefinition::getAvailableQueryOperators()
See: \PHPCR\NodeType\PropertyDefinition::isFullTextSearchable()
See: \PHPCR\NodeType\PropertyDefinition::isQueryOrderable()

setAbstract(boolean $abstractStatus) : void

Sets the abstract flag of the node type.

Parameters

Name	Type	Description
$abstractStatus	boolean	Whether this type is abstract.

Details

Api

setDeclaredSuperTypeNames(array $names) : void

Sets the names of the supertypes of the node type.

Parameters

Name	Type	Description
$names	array	The name of the node supertype to be set.

Details

Api

setMixin(boolean $mixin) : void

Sets the mixin flag of the node type.

Parameters

Name	Type	Description
$mixin	boolean	Whether this type is a mixin type (or a primary type).

Details

Api

setName(string $name) : void

Sets the name of the node type.

Parameters

Name	Type	Description
$name	string	The name of the node type to be set.

Details

Api

setOrderableChildNodes(boolean $orderable) : void

Sets the orderable child nodes flag of the node type.

Parameters

Name	Type	Description
$orderable	boolean	Whether nodes of this type can have orderable children

Details

Api

setPrimaryItemName(string $name) : void

Sets the name of the primary item.

Parameters

Name	Type	Description
$name	string	The name of the primary item.

Details

Api

setQueryable(bool $queryable) : void

Sets the queryable status of the node type.

Parameters

Name	Type	Description
$queryable	bool	Whether this node is queryable.

Details

Api

phpcr/src/PHPCR/NodeType/NodeTypeTemplateInterface.php

\PHPCR\NodeType\NodeTypeTemplateInterfacejump to top

Methods

\PHPCR\NodeType\NodeTypeTemplateInterface
jump to top