Helper
Class Helper Provides some helper functions.
Table of Contents
Methods
- convertArrayToModifiers() : string
- Returns TEMPLATE with modifiers encoded and concatenated.
- convertModifiersToArray() : mixed
- Returns $template with additional information.
- makeFileName() : string
- Function returns file name formatted by the template.
- splitModifiers() : array<string|int, mixed>
- Returns array of modifiers if any found.
- splitTemplate() : array<string|int, mixed>
- Returns array with two elements.
Methods
convertArrayToModifiers()
Returns TEMPLATE with modifiers encoded and concatenated.
public
static convertArrayToModifiers(mixed $template) : string
Parameters
- $template : mixed
-
Template information as it comes from DB.
Return values
stringconvertModifiersToArray()
Returns $template with additional information.
public
static convertModifiersToArray([mixed $template = null ]) : mixed
TEMPLATE field without modifiers and each modifier as distinct field.
Parameters
- $template : mixed = null
-
Template information as it comes from DB.
Tags
makeFileName()
Function returns file name formatted by the template.
public
static makeFileName(BaseTemplate $ipropTemplates, string $templateName, array<string|int, mixed> $fields, array<string|int, mixed> $file) : string
Parameters
- $ipropTemplates : BaseTemplate
-
Templates to lookup.
- $templateName : string
-
Name of the template to choose from $ipropTemplates.
- $fields : array<string|int, mixed>
-
Array contains fields for processing the template.
- $file : array<string|int, mixed>
-
Array contains information about file in format of $_FILES.
Return values
stringsplitModifiers()
Returns array of modifiers if any found.
public
static splitModifiers(string $modifiers) : array<string|int, mixed>
Parameters
- $modifiers : string
-
Modifiers string. for example: "lt-".
Return values
array<string|int, mixed>splitTemplate()
Returns array with two elements.
public
static splitTemplate(string $template) : array<string|int, mixed>
First with template and second with optional modifiers.
Parameters
- $template : string
-
Template string. For example: "{=this.name}/lt-".