PHP Class Sulu\Component\Content\Metadata\ItemMetadata

Mostrar archivo Open project: sulu/sulu

Public Properties

Property Type Description
$children Item[] Children of this item, f.e. properties, sections or structures.
$description array Description of this property|structure e.g. [["de": "Liste von Artikeln", "en": "List of articles"]].
$name string Name of this item.
$parameters array array( 'placeholder' => 'Enter some text', )
$tags array array( array('name' => 'sulu_search.field', 'type' => 'string') )
$title array The title of this property|structure e.g. [["de": "Artikles", "en": "Articles"]].

Public Methods

Method Description
__construct ( mixed $name = null )
__set ( $field, $value ) Magic setter to catch bad property calls.
addChild ( ItemMetadata $child ) Adds a child item.
getChild ( string $name ) : ItemMetadata Return the named property.
getChildren ( ) : ItemMetadata[] Return the children of this item.
getDescription ( string $locale ) : string Return the description of this property.
getName ( ) : string Return the name of this item.
getParameter ( string $name ) : mixed Return the paramter with the given name.
getParameters ( ) : array Return the parameters for this property.
getTag ( string $tagName ) : array Return the named tag.
getTags ( ) : array Return the tags of this item.
getTitle ( string $locale ) : string Return the localized name of this ItemMetadata or default to the name.
hasChild ( string $name ) : boolean Return true if this structure has the named property, false if it does not.
hasTag ( string $name ) : boolean Return true if this item has the named tag.

Method Details

__construct() public method

public __construct ( mixed $name = null )
$name mixed

__set() public method

Magic setter to catch bad property calls.
public __set ( $field, $value )

addChild() public method

Adds a child item.
public addChild ( ItemMetadata $child )
$child ItemMetadata

getChild() public method

Return the named property.
public getChild ( string $name ) : ItemMetadata
$name string
return ItemMetadata

getChildren() public method

Return the children of this item.
public getChildren ( ) : ItemMetadata[]
return ItemMetadata[]

getDescription() public method

Return the description of this property.
public getDescription ( string $locale ) : string
$locale string
return string

getName() public method

Return the name of this item.
public getName ( ) : string
return string

getParameter() public method

Return the paramter with the given name.
public getParameter ( string $name ) : mixed
$name string
return mixed

getParameters() public method

Return the parameters for this property.
public getParameters ( ) : array
return array

getTag() public method

Return the named tag.
public getTag ( string $tagName ) : array
$tagName string
return array

getTags() public method

Return the tags of this item.
public getTags ( ) : array
return array

getTitle() public method

Return the localized name of this ItemMetadata or default to the name.
public getTitle ( string $locale ) : string
$locale string Localization
return string

hasChild() public method

Return true if this structure has the named property, false if it does not.
public hasChild ( string $name ) : boolean
$name string
return boolean

hasTag() public method

Return true if this item has the named tag.
public hasTag ( string $name ) : boolean
$name string
return boolean

Property Details

$children public_oe property

Children of this item, f.e. properties, sections or structures.
public Item[] $children
return Item[]

$description public_oe property

Description of this property|structure e.g. [["de": "Liste von Artikeln", "en": "List of articles"]].
public array $description
return array

$name public_oe property

Name of this item.
public string $name
return string

$parameters public_oe property

array( 'placeholder' => 'Enter some text', )
public array $parameters
return array

$tags public_oe property

array( array('name' => 'sulu_search.field', 'type' => 'string') )
public array $tags
return array

$title public_oe property

The title of this property|structure e.g. [["de": "Artikles", "en": "Articles"]].
public array $title
return array