PHP Class Sulu\Component\Webspace\Segment

Inheritance: implements Sulu\Component\Util\ArrayableInterface
Show file Open project: sulu/sulu Class Usage Examples

Public Methods

Method Description
getKey ( ) : string Returns the key of the segment.
getName ( ) : string Returns the name of the segment.
isDefault ( ) : boolean Returns whether this segment is the default one.
setDefault ( boolean $default ) Sets if this segment is the default one.
setKey ( string $key ) Sets the key of the segment.
setName ( string $name ) Sets the name of the segment.
toArray ( $depth = null )

Method Details

getKey() public method

Returns the key of the segment.
public getKey ( ) : string
return string

getName() public method

Returns the name of the segment.
public getName ( ) : string
return string

isDefault() public method

Returns whether this segment is the default one.
public isDefault ( ) : boolean
return boolean

setDefault() public method

Sets if this segment is the default one.
public setDefault ( boolean $default )
$default boolean

setKey() public method

Sets the key of the segment.
public setKey ( string $key )
$key string

setName() public method

Sets the name of the segment.
public setName ( string $name )
$name string

toArray() public method

public toArray ( $depth = null )