PHP Class Pimcore\Config

Show file Open project: pimcore/pimcore Class Usage Examples

Protected Properties

Property	Type	Description
$configFileCache	array
$environment	string

Public Methods

Method	Description
getAvailablePerspectives ( User $user ) : array	Returns a list of available perspectives for the given user
getEnvironment ( ) : string
getFlag ( $name ) : mixed
getPerspectivesConfig ( ) : mixed \| Zend_Config
getReportConfig ( ) : Zend_Config
getRuntimePerspective ( ) : array	Gets the active perspective for the current user
getStandardPerspective ( ) : array	Returns the standard perspective settings
getSystemConfig ( boolean $forceReload = false ) : mixed \| null \| Zend_Config
getWeb2PrintConfig ( ) : Zend_Config
getWebsiteConfig ( ) : mixed \| Zend_Config
inPerspective ( $runtimeConfig, $key )
locateConfigFile ( $name ) : mixed
setEnvironment ( string $environment )
setFlag ( $name, $value )
setModelClassMappingConfig ( Zend_Config $config ) : void
setPerspectivesConfig ( Zend_Config $config ) : void
setReportConfig ( Zend_Config $config ) : void
setSystemConfig ( Zend_Config $config ) : void
setWeb2PrintConfig ( Zend_Config $config ) : void
setWebsiteConfig ( Zend_Config $config ) : void

Protected Methods

Method	Description
getRuntimeElementTreeConfig ( $name ) : array	Returns the element tree config for the given config name

Method Details

getAvailablePerspectives() public static method

Returns a list of available perspectives for the given user

public static getAvailablePerspectives ( User $user ) : array
$user	Pimcore\Model\User
return	array

getEnvironment() public static method

public static getEnvironment ( ) : string
return	string

getFlag() public static method

public static getFlag ( $name ) : mixed
$name
return	mixed

getPerspectivesConfig() public static method

public static getPerspectivesConfig ( ) : mixed \| Zend_Config
return	mixed \| Zend_Config

getReportConfig() public static method

public static getReportConfig ( ) : Zend_Config
return	Zend_Config

getRuntimeElementTreeConfig() protected static method

Returns the element tree config for the given config name

protected static getRuntimeElementTreeConfig ( $name ) : array
$name
return	array

getRuntimePerspective() public static method

Gets the active perspective for the current user

public static getRuntimePerspective ( ) : array
return	array

getStandardPerspective() public static method

Returns the standard perspective settings

public static getStandardPerspective ( ) : array
return	array

getSystemConfig() public static method

public static getSystemConfig ( boolean $forceReload = false ) : mixed \| null \| Zend_Config
$forceReload	boolean
return	mixed \| null \| Zend_Config

getWeb2PrintConfig() public static method

public static getWeb2PrintConfig ( ) : Zend_Config
return	Zend_Config

getWebsiteConfig() public static method

public static getWebsiteConfig ( ) : mixed \| Zend_Config
return	mixed \| Zend_Config

inPerspective() public static method

public static inPerspective ( $runtimeConfig, $key )

locateConfigFile() public static method

public static locateConfigFile ( $name ) : mixed
$name		- name of configuration file. slash is allowed for subdirectories.
return	mixed

setEnvironment() public static method

public static setEnvironment ( string $environment )
$environment	string

setFlag() public static method

public static setFlag ( $name, $value )
$name
$value

setModelClassMappingConfig() public static method

public static setModelClassMappingConfig ( Zend_Config $config ) : void
$config	Zend_Config
return	void

setPerspectivesConfig() public static method

public static setPerspectivesConfig ( Zend_Config $config ) : void
$config	Zend_Config
return	void

setReportConfig() public static method

public static setReportConfig ( Zend_Config $config ) : void
$config	Zend_Config
return	void

setSystemConfig() public static method

public static setSystemConfig ( Zend_Config $config ) : void
$config	Zend_Config
return	void

setWeb2PrintConfig() public static method

public static setWeb2PrintConfig ( Zend_Config $config ) : void
$config	Zend_Config
return	void

setWebsiteConfig() public static method

public static setWebsiteConfig ( Zend_Config $config ) : void
$config	Zend_Config
return	void

Property Details

$configFileCache protected static property

protected static array $configFileCache
return	array

$environment protected static property

protected static string $environment
return	string