PHP Class app\blocks\ConcreptImplementationBlock

Inheritance: implements luya\cms\base\BlockInterface
Show file Open project: luyadev/luya

Public Methods

Method Description
blockGroup ( ) : luya\cms\base\BlockGroup Returns a class of the blocks group.
config ( ) : array Returns the configuration array.
getCacheExpirationTime ( ) The time of cache expiration
getConfigCfgsExport ( ) : array Returns all config cfgs element of key value pairing to pass to the API and frontend.
getConfigPlaceholdersExport ( ) : array Returns all config placeholders element of key value pairing to pass to the API and frontend.
getConfigVarsExport ( ) : array Returns all config vars element of key value pairing to pass to the API and frontend.
getExtraVarValues ( ) : array Returns an array of key value pairing with additional informations to pass to the API and frontend.
getFieldHelp ( ) : array Returns an array with additional help informations for specific field (var or cfg).
getIsCacheEnabled ( ) : boolean Whether cache is enabled for this block or not.
getIsContainer ( ) Whether is an container element or not.
icon ( ) : string Returns the icon based on material icon names
name ( ) Get the name of the block in order to display in administration context.
renderAdmin ( ) : string Get the output in administration context.
renderFrontend ( ) : string Get the output in the frontend context.
setCfgValues ( array $values ) Set the values for element cfgs with an array key value binding.
setEnvOption ( string $key, mixed $value ) Set an environment option informations to the block with key value pairing.
setPlaceholderValues ( array $placeholders ) Set the value from placeholders where the array key is the name of value the content of the placeholder.
setVarValues ( array $values ) Set the values for element vars with an array key value binding.

Method Details

blockGroup() public method

Returns a class of the blocks group.
public blockGroup ( ) : luya\cms\base\BlockGroup
return luya\cms\base\BlockGroup

config() public method

Returns the configuration array.
public config ( ) : array
return array

getCacheExpirationTime() public method

The time of cache expiration
public getCacheExpirationTime ( )

getConfigCfgsExport() public method

Returns all config cfgs element of key value pairing to pass to the API and frontend.
public getConfigCfgsExport ( ) : array
return array

getConfigPlaceholdersExport() public method

Returns all config placeholders element of key value pairing to pass to the API and frontend.
public getConfigPlaceholdersExport ( ) : array
return array

getConfigVarsExport() public method

Returns all config vars element of key value pairing to pass to the API and frontend.
public getConfigVarsExport ( ) : array
return array

getExtraVarValues() public method

Returns an array of key value pairing with additional informations to pass to the API and frontend.
public getExtraVarValues ( ) : array
return array

getFieldHelp() public method

Returns an array with additional help informations for specific field (var or cfg).
public getFieldHelp ( ) : array
return array An array where the key is the cfg/var field var name and the value the helper text.

getIsCacheEnabled() public method

Whether cache is enabled for this block or not.
public getIsCacheEnabled ( ) : boolean
return boolean

getIsContainer() public method

Whether is an container element or not.
public getIsContainer ( )

icon() public method

Returns the icon based on material icon names
public icon ( ) : string
return string

name() public method

Get the name of the block in order to display in administration context.
public name ( )

renderAdmin() public method

Get the output in administration context.
public renderAdmin ( ) : string
return string

renderFrontend() public method

Get the output in the frontend context.
public renderFrontend ( ) : string
return string

setCfgValues() public method

Set the values for element cfgs with an array key value binding.
public setCfgValues ( array $values )
$values array An array where key is the name of the cfg-element and value the content.

setEnvOption() public method

Set an environment option informations to the block with key value pairing.
public setEnvOption ( string $key, mixed $value )
$key string The identifier key.
$value mixed The value for the key.

setPlaceholderValues() public method

Set the value from placeholders where the array key is the name of value the content of the placeholder.
public setPlaceholderValues ( array $placeholders )
$placeholders array An array with placeholders where key is name and the value the content e.g. `['content' => 'The placheholder Content']`.

setVarValues() public method

Set the values for element vars with an array key value binding.
public setVarValues ( array $values )
$values array An array where key is the name of the var-element and value the content.