rex_template
in package
Template Objekt.
Zuständig für die Verarbeitung eines Templates.
Table of Contents
Methods
- __construct() : mixed
- deleteCache() : bool
- exists() : bool
- forKey() : self|null
- generate() : bool
- getCtypes() : array<int, rex_ctype>
- getDefaultId() : int
- getFile() : false|string
- getFilePath() : false|string
- getId() : int
- getKey() : string|null
- getTemplate() : false|string|null
- getTemplatesDir() : string
- getTemplatesForCategory() : array<int, string>
- Returns an array containing all templates which are available for the given category_id.
- hasModule() : bool
- templateIsInUse() : false|string
Methods
__construct()
public
__construct(mixed $templateId) : mixed
Parameters
- $templateId : mixed
deleteCache()
public
deleteCache() : bool
Tags
Return values
boolexists()
public
static exists(int $templateId) : bool
Parameters
- $templateId : int
Return values
boolforKey()
public
static forKey(string $templateKey) : self|null
Parameters
- $templateKey : string
Return values
self|nullgenerate()
public
generate() : bool
Tags
Return values
boolgetCtypes()
public
getCtypes() : array<int, rex_ctype>
Return values
array<int, rex_ctype>getDefaultId()
public
static getDefaultId() : int
Return values
intgetFile()
public
getFile() : false|string
Return values
false|stringgetFilePath()
public
static getFilePath(mixed $templateId) : false|string
Parameters
- $templateId : mixed
Tags
Return values
false|stringgetId()
public
getId() : int
Return values
intgetKey()
public
getKey() : string|null
Return values
string|nullgetTemplate()
public
getTemplate() : false|string|null
Return values
false|string|nullgetTemplatesDir()
public
static getTemplatesDir() : string
Tags
Return values
stringgetTemplatesForCategory()
Returns an array containing all templates which are available for the given category_id.
public
static getTemplatesForCategory(int $categoryId[, bool $ignoreInactive = true ]) : array<int, string>
if the category_id is non-positive all templates in the system are returned. if the category_id is invalid an empty array is returned.
Parameters
- $categoryId : int
- $ignoreInactive : bool = true
Return values
array<int, string>hasModule()
public
static hasModule(array<string|int, mixed> $templateAttributes, mixed $ctype, mixed $moduleId) : bool
Parameters
- $templateAttributes : array<string|int, mixed>
- $ctype : mixed
- $moduleId : mixed
Return values
booltemplateIsInUse()
public
static templateIsInUse(int $templateId, string $msgKey) : false|string
Parameters
- $templateId : int
- $msgKey : string