Arikaim CMS

AdminTwigExtension extends AbstractExtension
in package
implements GlobalsInterface

Template engine control panel functions, filters and tests (included only in admin poanel).

Table of Contents

Interfaces

GlobalsInterface

Methods

arikaimStore()  : ArikaimStore|null
Create arikaim store instance
createAction()  : object
Create action
createPackageManager()  : PackageManagerInterface|false
Create package manager
getComponentProperties()  : array<string|int, mixed>
Get component properties
getConfigOption()  : mixed|null|false
Get install config data
getFilters()  : array<string|int, mixed>
Template engine filters
getFunctions()  : array<string|int, mixed>
Template engine functions
getGlobals()  : array<string|int, mixed>
Rempate engine global variables
getRelationsMap()  : array<string|int, mixed>|null
Get relatins type map (morph map)
getSchemaDescriptor()  : array<string|int, mixed>
Get schema properties descriptor
getSystemMacroPath()  : string
Get system macro path
getTests()  : array<string|int, mixed>
Template engine tests
getTokenParsers()  : array<string|int, mixed>
Template engine tags
hasModule()  : bool
Return true if module exists
loadJosnConfigFile()  : array<string|int, mixed>|null
Load json config file
system()  : System
Get system info ( control panel access only )

Methods

createAction()

Create action

public createAction(string $name, string $package) : object
Parameters
$name : string
$package : string
Return values
object

createPackageManager()

Create package manager

public createPackageManager(string $packageType) : PackageManagerInterface|false
Parameters
$packageType : string
Return values
PackageManagerInterface|false

getComponentProperties()

Get component properties

public getComponentProperties(string $name, string $language[, array<string|int, mixed>|null $params = [] ][, string|null $type = null ]) : array<string|int, mixed>
Parameters
$name : string
$language : string
$params : array<string|int, mixed>|null = []
$type : string|null = null
Return values
array<string|int, mixed>

getConfigOption()

Get install config data

public getConfigOption(string $key[, mixed $default = null ]) : mixed|null|false
Parameters
$key : string
$default : mixed = null
Return values
mixed|null|false

getFilters()

Template engine filters

public getFilters() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFunctions()

Template engine functions

public getFunctions() : array<string|int, mixed>
Return values
array<string|int, mixed>

getGlobals()

Rempate engine global variables

public getGlobals() : array<string|int, mixed>
Return values
array<string|int, mixed>

getRelationsMap()

Get relatins type map (morph map)

public getRelationsMap() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getSchemaDescriptor()

Get schema properties descriptor

public getSchemaDescriptor(string $schemaClass[, string|null $extension = null ]) : array<string|int, mixed>
Parameters
$schemaClass : string
$extension : string|null = null
Return values
array<string|int, mixed>

getSystemMacroPath()

Get system macro path

public getSystemMacroPath(string $macroName) : string
Parameters
$macroName : string
Return values
string

getTests()

Template engine tests

public getTests() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTokenParsers()

Template engine tags

public getTokenParsers() : array<string|int, mixed>
Return values
array<string|int, mixed>

hasModule()

Return true if module exists

public hasModule(string $name) : bool
Parameters
$name : string
Return values
bool

loadJosnConfigFile()

Load json config file

public loadJosnConfigFile(string $fileName[, string|null $packageName = null ][, string|null $packageType = null ]) : array<string|int, mixed>|null
Parameters
$fileName : string
$packageName : string|null = null
$packageType : string|null = null
Return values
array<string|int, mixed>|null

        
On this page

Search results