PHP Класс Sulu\Component\Content\Metadata\StructureMetadata

TODO: resource, cacheLifetime and view should be removed. They should instead be options.
Наследование: extends ItemMetadata
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$cacheLifetime array
$controller string
$internal boolean
$properties array Same as ItemMetadata::$children but without Sections.
$resource string The resource from which this structure was loaded (useful for debugging).
$view string

Открытые методы

Метод Описание
burnProperties ( ) Populate the $properties property with only those propertires which are not related to the UI (i.e. the sections).
getProperties ( ) : PropertyMetadata[] Return all model properties.
getPropertiesByTagName ( string $tagName ) : PropertyMetadata[] Return all properties with the given tag name.
getProperty ( string $name ) : PropertyMetadata Return a model property.
getPropertyByTagName ( string $tagName, $highest = true ) : PropertyMetadata Return true if the structure contains a property with the given tag name.
getResource ( ) : string Return the resource from which this structure was loaded.
hasProperty ( $name ) : boolean Return true if a property with the given name exists.
hasPropertyWithTagName ( string $tagName ) : boolean Return true if the structure contains a property with the given tag name.
isInternal ( ) : boolean Return if this is an internal structure.

Описание методов

burnProperties() публичный Метод

The data is therefore duplicated, but this does not matter as we only create this data once. This should be called once after creating the structure and (therefore before writing to the cache).
public burnProperties ( )

getProperties() публичный Метод

The "model" set of properties does not include UI elements such as sections.
public getProperties ( ) : PropertyMetadata[]
Результат PropertyMetadata[]

getPropertiesByTagName() публичный Метод

Return all properties with the given tag name.
public getPropertiesByTagName ( string $tagName ) : PropertyMetadata[]
$tagName string
Результат PropertyMetadata[]

getProperty() публичный Метод

Return a model property.
См. также: StructureMetadata::getProperties()
public getProperty ( string $name ) : PropertyMetadata
$name string
Результат PropertyMetadata

getPropertyByTagName() публичный Метод

Return true if the structure contains a property with the given tag name.
public getPropertyByTagName ( string $tagName, $highest = true ) : PropertyMetadata
$tagName string
Результат PropertyMetadata

getResource() публичный Метод

Return the resource from which this structure was loaded.
public getResource ( ) : string
Результат string

hasProperty() публичный Метод

Return true if a property with the given name exists.
public hasProperty ( $name ) : boolean
Результат boolean

hasPropertyWithTagName() публичный Метод

Return true if the structure contains a property with the given tag name.
public hasPropertyWithTagName ( string $tagName ) : boolean
$tagName string
Результат boolean

isInternal() публичный Метод

TODO: Refactor this: https://github.com/sulu-io/sulu/issues/1220
public isInternal ( ) : boolean
Результат boolean

Описание свойств

$cacheLifetime публичное свойство

public array $cacheLifetime
Результат array

$controller публичное свойство

public string $controller
Результат string

$internal публичное свойство

public bool $internal
Результат boolean

$properties публичное свойство

Same as ItemMetadata::$children but without Sections.
См. также: StructureMetadata::burnProperties()
public array $properties
Результат array

$resource публичное свойство

The resource from which this structure was loaded (useful for debugging).
public string $resource
Результат string

$view публичное свойство

public string $view
Результат string