PHP Interface Sulu\Component\Content\Compat\StructureInterface

Inheritance: extends JsonSerializable
ファイルを表示 Open project: sulu/sulu Interface Usage Examples

Public Methods

Method Description
copyFrom ( Sulu\Component\Content\Compat\StructureInterface $structure ) Copy static values from another structure.
getChanged ( ) : DateTime returns changed DateTime.
getChanger ( ) : integer returns user id of changer.
getChildren ( ) : Sulu\Component\Content\Compat\StructureInterface[] returns children array.
getCreated ( ) : DateTime return created datetime.
getCreator ( ) : integer gets user id of creator.
getHasChildren ( ) : boolean returns true if node has children.
getHasTranslation ( ) : boolean return true if structure translation is valid.
getKey ( ) : string key of template definition.
getLanguageCode ( ) : string returns language of node.
getLocalizedTitle ( string $languageCode ) : string returns title of property.
getNodeName ( ) : string returns node name addicted to the type.
getNodeState ( ) : integer return the published status of the node.
getNodeType ( ) : integer
getPath ( ) : string return the node path.
getProperties ( boolean $flatten = false ) : Sulu\Component\Content\Compat\PropertyInterface[] returns an array of properties.
getPropertiesByTagName ( string $tagName ) : Sulu\Component\Content\Compat\PropertyInterface[] returns properties with given tag name sorted by priority.
getProperty ( $name ) : Sulu\Component\Content\Compat\PropertyInterface returns a property instance with given name.
getPropertyByTagName ( string $tagName, $highest = true ) : Sulu\Component\Content\Compat\PropertyInterface returns a property instance with given tag name.
getPropertyNames ( ) : array returns all property names.
getPropertyValue ( $name ) : mixed return value of property with given name.
getPropertyValueByTagName ( string $tagName ) : mixed returns value of property with given tag name.
getPublished ( ) : DateTime returns first published date.
getPublishedState ( ) : boolean returns true if state of site is "published".
getType ( ) : StructureType Return type of structure.
getUuid ( ) : integer id of node.
getWebspaceKey ( ) : string returns webspace of node.
hasProperty ( string $name ) : boolean checks if a property exists.
hasTag ( string $tag ) : boolean indicates tag exists.
setChanged ( DateTime $changed ) sets changed datetime.
setChanger ( $userId ) sets user id of changer.
setChildren ( Sulu\Component\Content\Compat\StructureInterface[] $children )
setCreated ( DateTime $created ) sets created datetime.
setCreator ( $userId ) sets user id of creator.
setHasChildren ( boolean $hasChildren )
setHasTranslation ( boolean $hasTranslation )
setLanguageCode ( string $language )
setPath ( string $path )
setPublished ( DateTime $published )
setType ( StructureType $type )
setUuid ( $uuid ) sets id of node.
setWebspaceKey ( string $webspace )
toArray ( boolean $complete = true ) : array returns an array of property value pairs.

Method Details

copyFrom() public method

Copy static values from another structure.
public copyFrom ( Sulu\Component\Content\Compat\StructureInterface $structure )
$structure Sulu\Component\Content\Compat\StructureInterface

getChanged() public method

returns changed DateTime.
public getChanged ( ) : DateTime
return DateTime

getChanger() public method

returns user id of changer.
public getChanger ( ) : integer
return integer

getChildren() public method

returns children array.
public getChildren ( ) : Sulu\Component\Content\Compat\StructureInterface[]
return Sulu\Component\Content\Compat\StructureInterface[]

getCreated() public method

return created datetime.
public getCreated ( ) : DateTime
return DateTime

getCreator() public method

gets user id of creator.
public getCreator ( ) : integer
return integer

getHasChildren() public method

returns true if node has children.
public getHasChildren ( ) : boolean
return boolean

getHasTranslation() public method

return true if structure translation is valid.
public getHasTranslation ( ) : boolean
return boolean

getKey() public method

key of template definition.
public getKey ( ) : string
return string

getLanguageCode() public method

returns language of node.
public getLanguageCode ( ) : string
return string

getLocalizedTitle() public method

returns title of property.
public getLocalizedTitle ( string $languageCode ) : string
$languageCode string
return string

getNodeName() public method

returns node name addicted to the type.
public getNodeName ( ) : string
return string

getNodeState() public method

return the published status of the node.
public getNodeState ( ) : integer
return integer

getNodeType() public method

public getNodeType ( ) : integer
return integer

getPath() public method

return the node path.
public getPath ( ) : string
return string

getProperties() public method

returns an array of properties.
public getProperties ( boolean $flatten = false ) : Sulu\Component\Content\Compat\PropertyInterface[]
$flatten boolean
return Sulu\Component\Content\Compat\PropertyInterface[]

getPropertiesByTagName() public method

returns properties with given tag name sorted by priority.
public getPropertiesByTagName ( string $tagName ) : Sulu\Component\Content\Compat\PropertyInterface[]
$tagName string
return Sulu\Component\Content\Compat\PropertyInterface[]

getProperty() public method

returns a property instance with given name.
public getProperty ( $name ) : Sulu\Component\Content\Compat\PropertyInterface
$name string name of property
return Sulu\Component\Content\Compat\PropertyInterface

getPropertyByTagName() public method

returns a property instance with given tag name.
public getPropertyByTagName ( string $tagName, $highest = true ) : Sulu\Component\Content\Compat\PropertyInterface
$tagName string
$highest
return Sulu\Component\Content\Compat\PropertyInterface

getPropertyNames() public method

returns all property names.
public getPropertyNames ( ) : array
return array

getPropertyValue() public method

return value of property with given name.
public getPropertyValue ( $name ) : mixed
$name string name of property
return mixed

getPropertyValueByTagName() public method

returns value of property with given tag name.
public getPropertyValueByTagName ( string $tagName ) : mixed
$tagName string
return mixed

getPublished() public method

returns first published date.
public getPublished ( ) : DateTime
return DateTime

getPublishedState() public method

returns true if state of site is "published".
public getPublishedState ( ) : boolean
return boolean

getType() public method

Return type of structure.
public getType ( ) : StructureType
return StructureType

getUuid() public method

id of node.
public getUuid ( ) : integer
return integer

getWebspaceKey() public method

returns webspace of node.
public getWebspaceKey ( ) : string
return string

hasProperty() public method

checks if a property exists.
public hasProperty ( string $name ) : boolean
$name string
return boolean

hasTag() public method

indicates tag exists.
public hasTag ( string $tag ) : boolean
$tag string
return boolean

setChanged() public method

sets changed datetime.
public setChanged ( DateTime $changed )
$changed DateTime

setChanger() public method

sets user id of changer.
public setChanger ( $userId )
$userId int id of changer

setChildren() public method

public setChildren ( Sulu\Component\Content\Compat\StructureInterface[] $children )
$children Sulu\Component\Content\Compat\StructureInterface[]

setCreated() public method

sets created datetime.
public setCreated ( DateTime $created )
$created DateTime

setCreator() public method

sets user id of creator.
public setCreator ( $userId )
$userId int id of creator

setHasChildren() public method

public setHasChildren ( boolean $hasChildren )
$hasChildren boolean

setHasTranslation() public method

public setHasTranslation ( boolean $hasTranslation )
$hasTranslation boolean

setLanguageCode() public method

public setLanguageCode ( string $language )
$language string

setPath() public method

public setPath ( string $path )
$path string

setPublished() public method

public setPublished ( DateTime $published )
$published DateTime

setType() public method

public setType ( StructureType $type )
$type StructureType

setUuid() public method

sets id of node.
public setUuid ( $uuid )
$uuid

setWebspaceKey() public method

public setWebspaceKey ( string $webspace )
$webspace string

toArray() public method

returns an array of property value pairs.
Deprecation: Use the serializer instead
public toArray ( boolean $complete = true ) : array
$complete boolean True if result should be representation of full node
return array