PHP Class Sulu\Component\Webspace\Portal

Mostra file Open project: sulu/sulu Class Usage Examples

Public Methods

Method Description
addEnvironment ( $environment ) Adds an environment to this portal.
addLocalization ( Localization $localization ) Adds the given language to the portal.
getDefaultLocalization ( ) : Localization
getEnvironment ( string $type ) : Sulu\Component\Webspace\Environment Returns the environment with the given type, and throws an exception if the environment does not exist.
getEnvironments ( ) : Sulu\Component\Webspace\Environment[] Returns the environment for this portal.
getKey ( ) : string
getLocalization ( $locale )
getLocalizations ( ) : Localization[] Returns the languages of this portal.
getName ( ) : string Returns the name of the portal.
getWebspace ( ) : Webspace
getXDefaultLocalization ( ) : Localization
setDefaultLocalization ( Localization $defaultLocalization )
setEnvironments ( array $environments ) Sets the environments for this portal.
setKey ( string $key )
setLocalizations ( Localization[] $localizations ) Sets the localizations to this portal.
setName ( string $name ) Sets the name of the portal.
setWebspace ( Webspace $webspace )
setXDefaultLocalization ( Localization $xDefaultLocalization )
toArray ( $depth = null )

Method Details

addEnvironment() public method

Adds an environment to this portal.
public addEnvironment ( $environment )
$environment Environment The environment to add

addLocalization() public method

Adds the given language to the portal.
public addLocalization ( Localization $localization )
$localization Sulu\Component\Localization\Localization

getDefaultLocalization() public method

public getDefaultLocalization ( ) : Localization
return Sulu\Component\Localization\Localization

getEnvironment() public method

Returns the environment with the given type, and throws an exception if the environment does not exist.
public getEnvironment ( string $type ) : Sulu\Component\Webspace\Environment
$type string
return Sulu\Component\Webspace\Environment

getEnvironments() public method

Returns the environment for this portal.
public getEnvironments ( ) : Sulu\Component\Webspace\Environment[]
return Sulu\Component\Webspace\Environment[]

getKey() public method

public getKey ( ) : string
return string

getLocalization() public method

public getLocalization ( $locale )

getLocalizations() public method

Returns the languages of this portal.
public getLocalizations ( ) : Localization[]
return Sulu\Component\Localization\Localization[] The languages of this portal

getName() public method

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

getWebspace() public method

public getWebspace ( ) : Webspace
return Webspace

getXDefaultLocalization() public method

public getXDefaultLocalization ( ) : Localization
return Sulu\Component\Localization\Localization

setDefaultLocalization() public method

public setDefaultLocalization ( Localization $defaultLocalization )
$defaultLocalization Sulu\Component\Localization\Localization

setEnvironments() public method

Sets the environments for this portal.
public setEnvironments ( array $environments )
$environments array

setKey() public method

public setKey ( string $key )
$key string

setLocalizations() public method

Sets the localizations to this portal.
public setLocalizations ( Localization[] $localizations )
$localizations Sulu\Component\Localization\Localization[]

setName() public method

Sets the name of the portal.
public setName ( string $name )
$name string The name of the portal

setWebspace() public method

public setWebspace ( Webspace $webspace )
$webspace Webspace

setXDefaultLocalization() public method

public setXDefaultLocalization ( Localization $xDefaultLocalization )
$xDefaultLocalization Sulu\Component\Localization\Localization

toArray() public method

public toArray ( $depth = null )