PHP Class Frontend\Core\Engine\Block\Extra

Inheritance: extends Frontend\Core\Engine\Base\Object
Show file Open project: forkcms/forkcms

Protected Properties

Property Type Description
$overwrite boolean Should the template overwrite the current one
$templatePath string The path for the template

Public Methods

Method Description
__construct ( Symfony\Component\HttpKernel\KernelInterface $kernel, string $module, string $action, mixed $data = null )
execute ( ) Execute the action We will build the class name, require the class and call the execute method.
getAction ( ) : string Get the current action REMARK: You should not use this method from your code, but it has to be public so we can access it later on in the core-code
getContent ( ) : string Get the block content
getData ( ) : mixed Get the data
getModule ( ) : string Get the current module REMARK: You should not use this method from your code, but it has to be public so we can access it later on in the core-code
getOverwrite ( ) : boolean Get overwrite mode
getTemplate ( ) : array Get the assigned template.
getTemplatePath ( ) : string Get path for the template
getVariables ( ) : array Get the assigned variables for this block.
loadConfig ( ) Load the config file for the requested block.

Private Methods

Method Description
setAction ( string $action = null ) Set the action
setData ( mixed $data ) Set the data
setModule ( string $module ) Set the module
setOverwrite ( boolean $overwrite ) Set overwrite mode
setTemplatePath ( string $path ) Set the path for the template

Method Details

__construct() public method

public __construct ( Symfony\Component\HttpKernel\KernelInterface $kernel, string $module, string $action, mixed $data = null )
$kernel Symfony\Component\HttpKernel\KernelInterface
$module string The module to load.
$action string The action to load.
$data mixed The data that was passed from the database.

execute() public method

Execute the action We will build the class name, require the class and call the execute method.
public execute ( )

getAction() public method

Get the current action REMARK: You should not use this method from your code, but it has to be public so we can access it later on in the core-code
public getAction ( ) : string
return string

getContent() public method

Get the block content
public getContent ( ) : string
return string

getData() public method

Get the data
public getData ( ) : mixed
return mixed

getModule() public method

Get the current module REMARK: You should not use this method from your code, but it has to be public so we can access it later on in the core-code
public getModule ( ) : string
return string

getOverwrite() public method

Get overwrite mode
public getOverwrite ( ) : boolean
return boolean

getTemplate() public method

Get the assigned template.
public getTemplate ( ) : array
return array

getTemplatePath() public method

Get path for the template
public getTemplatePath ( ) : string
return string

getVariables() public method

Get the assigned variables for this block.
public getVariables ( ) : array
return array

loadConfig() public method

In the config file we have to find disabled actions, the constructor will read the folder and set possible actions Other configurations will also be stored in it.
public loadConfig ( )

Property Details

$overwrite protected property

Should the template overwrite the current one
protected bool $overwrite
return boolean

$templatePath protected property

The path for the template
protected string $templatePath
return string