PHP Class Neos\ContentRepository\Domain\Model\NodeTemplate

Inheritance: extends AbstractNodeData
Show file Open project: neos/neos-development-collection Class Usage Examples

Protected Properties

Property Type Description
$identifier string The UUID to use for the new node. Use with care.
$name string The node name which acts as a path segment for its node path

Public Methods

Method Description
getIdentifier ( ) : string Returns the UUID set in this NodeTemplate.
getName ( ) : string Get the name of this node template.
getWorkspace ( ) : void A NodeTemplate is not stored in any workspace, thus this method returns NULL.
setIdentifier ( string $identifier ) : void Allows to set a UUID to use for the node that will be created from this NodeTemplate. Use with care, usually identifier generation should be left to the ContentRepository.
setName ( string $newName ) : void Set the name to $newName

Method Details

getIdentifier() public method

Returns the UUID set in this NodeTemplate.
public getIdentifier ( ) : string
return string

getName() public method

If a name has been set using setName(), it is returned. If not, but the template has a (non-empty) title property, this property is used to generate a valid name. As a last resort a random name is returned (in the form "name-XXXXX").
public getName ( ) : string
return string

getWorkspace() public method

A NodeTemplate is not stored in any workspace, thus this method returns NULL.
public getWorkspace ( ) : void
return void

setIdentifier() public method

Allows to set a UUID to use for the node that will be created from this NodeTemplate. Use with care, usually identifier generation should be left to the ContentRepository.
public setIdentifier ( string $identifier ) : void
$identifier string
return void

setName() public method

Set the name to $newName
public setName ( string $newName ) : void
$newName string
return void

Property Details

$identifier protected property

The UUID to use for the new node. Use with care.
protected string $identifier
return string

$name protected property

The node name which acts as a path segment for its node path
protected string $name
return string