PageViewHelper
extends ViewHelper
in package
This is the PageViewHelper class.
The purpose of this class is to facilitate to Twig the generation of the Page's view output (providing some useful methods).
This class extends ViewHelper, see this class.
Tags
Table of Contents
| $languageSheet | : Language|null | |
|---|---|---|
| $session | : Session|null | |
| $theme | : Theme|null | |
| __construct() | : mixed | |
| contactFormMacro() | This method merges the given arguments, calculates and returns the view parameters for the contactForm. | : array<string|int, mixed> |
| getApplicationTaxesIncluded() | This method returns the setting of 'show taxes included'. | : bool |
| mergeArguments() | This method merges macro arguments with macro associated class properties by reference. | : void |
| newsletterFormMacro() | This method merges the given arguments, calculates and returns the view parameters for the newsletterForm. | : array<string|int, mixed> |
| pageContentMacro() | This method merges the given arguments, calculates and returns the view parameters for the pageContent. | : array<string|int, mixed> |
| sendMailFormMacro() | This method merges the given arguments, calculates and returns the view parameters for the sendMailForm. | : array<string|int, mixed> |
| subpagesMacro() | This method merges the given arguments, calculates and returns the view parameters for the subpages. | : array<string|int, mixed> |
Properties
$languageSheet
protected
Language|null
$languageSheet
= null
$session
protected
Session|null
$session
= null
$theme
protected
Theme|null
$theme
= null
Methods
__construct()
public
__construct(Language $languageSheet, Theme $theme, Session|null $session) : mixed
Parameters
Return values
mixed —contactFormMacro()
This method merges the given arguments, calculates and returns the view parameters for the contactForm.
public
contactFormMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- form
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —getApplicationTaxesIncluded()
This method returns the setting of 'show taxes included'.
public
static getApplicationTaxesIncluded() : bool
Return values
bool —mergeArguments()
This method merges macro arguments with macro associated class properties by reference.
public
static mergeArguments(mixed &$classObject[, array<string|int, mixed> $arguments = [] ]) : void
Parameters
- $classObject : mixed
- $arguments : array<string|int, mixed> = []
Return values
void —newsletterFormMacro()
This method merges the given arguments, calculates and returns the view parameters for the newsletterForm.
public
newsletterFormMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- form
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —pageContentMacro()
This method merges the given arguments, calculates and returns the view parameters for the pageContent.
public
pageContentMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- page
- data
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —sendMailFormMacro()
This method merges the given arguments, calculates and returns the view parameters for the sendMailForm.
public
sendMailFormMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- form
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments
Return values
array<string|int, mixed> —subpagesMacro()
This method merges the given arguments, calculates and returns the view parameters for the subpages.
public
subpagesMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- subpages
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments