PHP 클래스 Frontend\Core\Engine\Base\Block

상속: extends Object
파일 보기 프로젝트 열기: forkcms/forkcms 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$action string The current action
$breadcrumb Frontend\Core\Engine\Breadcrumb The breadcrumb object
$data mixed The data
$header Frontend\Core\Engine\Header The header object
$module string The current module
$pagination array Pagination array

공개 메소드들

메소드 설명
__construct ( Symfony\Component\HttpKernel\KernelInterface $kernel, string $module, string $action, string $data = null )
addCSS ( string $file, boolean $overwritePath = false, boolean $minify = true, boolean $addTimestamp = null ) Add a CSS file into the array
addJS ( string $file, boolean $overwritePath = false, boolean $minify = true, boolean $addTimestamp = null ) Add a javascript file into the array
addJSData ( string $key, mixed $value ) Add data that should be available in JS
createForm ( string | Symfony\Component\Form\FormTypeInterface $type, mixed $data = null, array $options = [] ) : Form Creates and returns a Form instance from the type of the form.
execute ( ) Execute the action If a javascript file with the name of the module or action exists it will be loaded.
getAction ( ) : string Get the action
getContent ( ) : string Get parsed template content.
getModule ( ) : string Get the module
getOverwrite ( ) : boolean Get overwrite mode
getTemplate ( ) : TwigTemplate Get template
getTemplatePath ( ) : string Get template path
redirect ( string $url, integer $code = 302 ) Redirect to a given URL

보호된 메소드들

메소드 설명
loadTemplate ( string $path = null, boolean $overwrite = false ) Load the template
parsePagination ( string $query_parameter = 'page' ) Parse pagination
setMeta ( Meta $meta )
setOverwrite ( boolean $overwrite ) Set overwrite mode
setTemplatePath ( string $path ) Set the path for the template to include or to replace the current one

비공개 메소드들

메소드 설명
setAction ( string $action ) Set the action, for later use
setData ( string $data = null ) Set the data, for later use
setModule ( string $module ) Set the module, for later use

메소드 상세

__construct() 공개 메소드

public __construct ( Symfony\Component\HttpKernel\KernelInterface $kernel, string $module, string $action, string $data = null )
$kernel Symfony\Component\HttpKernel\KernelInterface
$module string The name of the module.
$action string The name of the action.
$data string The data that should be available in this block.

addCSS() 공개 메소드

Add a CSS file into the array
public addCSS ( string $file, boolean $overwritePath = false, boolean $minify = true, boolean $addTimestamp = null )
$file string The path for the CSS-file that should be loaded.
$overwritePath boolean Whether or not to add the module to this path. Module path is added by default.
$minify boolean Should the CSS be minified?
$addTimestamp boolean May we add a timestamp for caching purposes?

addJS() 공개 메소드

Add a javascript file into the array
public addJS ( string $file, boolean $overwritePath = false, boolean $minify = true, boolean $addTimestamp = null )
$file string The path to the javascript-file that should be loaded.
$overwritePath boolean Whether or not to add the module to this path. Module path is added by default.
$minify boolean Should the file be minified?
$addTimestamp boolean May we add a timestamp for caching purposes?

addJSData() 공개 메소드

Add data that should be available in JS
public addJSData ( string $key, mixed $value )
$key string The key whereunder the value will be stored.
$value mixed The value to pass.

createForm() 공개 메소드

Creates and returns a Form instance from the type of the form.
public createForm ( string | Symfony\Component\Form\FormTypeInterface $type, mixed $data = null, array $options = [] ) : Form
$type string | Symfony\Component\Form\FormTypeInterface The built type of the form
$data mixed The initial data for the form
$options array Options for the form
리턴 Symfony\Component\Form\Form

execute() 공개 메소드

Execute the action If a javascript file with the name of the module or action exists it will be loaded.
public execute ( )

getAction() 공개 메소드

Get the action
public getAction ( ) : string
리턴 string

getContent() 공개 메소드

Get parsed template content.
public getContent ( ) : string
리턴 string

getModule() 공개 메소드

Get the module
public getModule ( ) : string
리턴 string

getOverwrite() 공개 메소드

Get overwrite mode
public getOverwrite ( ) : boolean
리턴 boolean

getTemplate() 공개 메소드

Get template
public getTemplate ( ) : TwigTemplate
리턴 Frontend\Core\Engine\TwigTemplate

getTemplatePath() 공개 메소드

Get template path
public getTemplatePath ( ) : string
리턴 string

loadTemplate() 보호된 메소드

Load the template
protected loadTemplate ( string $path = null, boolean $overwrite = false )
$path string The path for the template to use.
$overwrite boolean Should the template overwrite the default?

parsePagination() 보호된 메소드

Parse pagination
protected parsePagination ( string $query_parameter = 'page' )
$query_parameter string

redirect() 공개 메소드

Redirect to a given URL
public redirect ( string $url, integer $code = 302 )
$url string The URL whereto will be redirected.
$code integer The redirect code, default is 302 which means this is a temporary redirect.

setMeta() 보호된 메소드

protected setMeta ( Meta $meta )
$meta Common\Doctrine\Entity\Meta

setOverwrite() 보호된 메소드

Set overwrite mode
protected setOverwrite ( boolean $overwrite )
$overwrite boolean true if the template should overwrite the current template, false if not.

setTemplatePath() 보호된 메소드

Set the path for the template to include or to replace the current one
protected setTemplatePath ( string $path )
$path string The path to the template that should be loaded.

프로퍼티 상세

$action 보호되어 있는 프로퍼티

The current action
protected string $action
리턴 string

$breadcrumb 보호되어 있는 프로퍼티

The breadcrumb object
protected Breadcrumb,Frontend\Core\Engine $breadcrumb
리턴 Frontend\Core\Engine\Breadcrumb

$data 보호되어 있는 프로퍼티

The data
protected mixed $data
리턴 mixed

$header 보호되어 있는 프로퍼티

The header object
protected Header,Frontend\Core\Engine $header
리턴 Frontend\Core\Engine\Header

$module 보호되어 있는 프로퍼티

The current module
protected string $module
리턴 string

$pagination 보호되어 있는 프로퍼티

Pagination array
protected array $pagination
리턴 array