PHP Class Sulu\Component\Content\Metadata\BlockMetadata

TODO: Components are basically Snippets, but Snippets are loaded as Structures
Inheritance: extends PropertyMetadata
Show file Open project: sulu/sulu Class Usage Examples

Public Properties

Property Type Description
$components ComponentMetadata[]
$defaultComponentName string

Public Methods

Method Description
addComponent ( ComponentMetadata $component ) Add a new component.
getComponentByName ( $name ) : ComponentMetadata
getComponents ( ) : ComponentMetadata[] Return the components.
getDefaultComponentName ( ) : string Return the default component name.

Method Details

addComponent() public method

Add a new component.
public addComponent ( ComponentMetadata $component )
$component ComponentMetadata

getComponentByName() public method

public getComponentByName ( $name ) : ComponentMetadata
$name
return ComponentMetadata

getComponents() public method

Return the components.
public getComponents ( ) : ComponentMetadata[]
return ComponentMetadata[]

getDefaultComponentName() public method

Return the default component name.
public getDefaultComponentName ( ) : string
return string

Property Details

$components public property

public ComponentMetadata[] $components
return ComponentMetadata[]

$defaultComponentName public property

public string $defaultComponentName
return string