CategoryViewHelper
extends ViewHelper
in package
This is the CategoryViewHelper class.
The purpose of this class is to facilitate to Twig the generation of the category'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 | |
| categoriesTreeMacro() | This method merges the given arguments, calculates and returns the view parameters for the CategoriesTree. | : 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 |
| richSnippetsMacro() | This method merges the given arguments, calculates and returns the view parameters for the richSnippets. | : 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 —categoriesTreeMacro()
This method merges the given arguments, calculates and returns the view parameters for the CategoriesTree.
public
categoriesTreeMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- categories
- showName
- showImage
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 —richSnippetsMacro()
This method merges the given arguments, calculates and returns the view parameters for the richSnippets.
public
richSnippetsMacro([array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed>
The array keys of the returned parameters are:
- richSnippets
Parameters
- $arguments : array<string|int, mixed> = []
-
Twig macro arguments