PHP Class Frontend\Core\Engine\Block\Widget

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

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
getCustomTemplate ( ) : string | null
getData ( ) : mixed Get the data
getForId ( Symfony\Component\HttpKernel\KernelInterface $kernel, string $module, string $action, integer | null $id = null ) : string | null
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
getTemplate ( ) : array Get the assigned template.
loadConfig ( ) Load the config file for the requested block.
render ( string $template = null ) : string Get the block content

Private Methods

Method Description
setAction ( string $action = null ) Set the action
setData ( mixed $data ) Set the data
setModule ( string $module ) Set the module

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

public getContent ( ) : string
return string

getCustomTemplate() public method

public getCustomTemplate ( ) : string | null
return string | null

getData() public method

Get the data
public getData ( ) : mixed
return mixed

getForId() public static method

public static getForId ( Symfony\Component\HttpKernel\KernelInterface $kernel, string $module, string $action, integer | null $id = null ) : string | null
$kernel Symfony\Component\HttpKernel\KernelInterface
$module string The module to load.
$action string The action to load.
$id integer | null This is not the modules_extra id but the id of the item itself
return string | null if we have data it is still serialised since it will be unserialized in the constructor

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

getTemplate() public method

Get the assigned template.
public getTemplate ( ) : 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 be stored in it also.
public loadConfig ( )

render() public method

Get the block content
public render ( string $template = null ) : string
$template string
return string