expTemplate
in package
This is the class expTemplate...template support methods
Tags
Table of Contents
- buildNameList() : array<string|int, mixed>
- exdoc This function is a wrapper around self::resolveFilePaths() and returns a list of the basenames, minus the file extensions - if any
- find_config_views() : array<string|int, mixed>
- Return list of controller configuration views
- find_template() : mixed|string
- Return the best match template file for the framework, including custom views If we receive a pathname, we'll only look there, otherwise we'll run the 'framework' flow allowing for custom/theme views
- get_action_views() : array<string|int, mixed>
- Return list of controller display views available
- get_common_template() : mixed
- get_config_templates() : array<string|int, mixed>
- Return entire list of all controller configuration views available
- get_filedisplay_views() : array<string|int, mixed>
- Return list of attached file display views available
- get_template_for_action() : mixed
- getFormTemplates() : mixed
- getModuleViewFile() : string
- getViewConfigForm() : form
- exdoc
- getViewConfigOptions() : array<string|int, mixed>
- exdoc
- getViewFile() : string
- Retrieve Module-Independent View File
- getViewParams() : mixed|null
- exdoc
- glob2keyedArray() : array<string|int, mixed>
- helper function for building assoc array of pathnames
- guessControlType() : mixed
- listControlTypes() : array<string|int, mixed>
- exdoc
- listModuleViews() : array<string|int, mixed>
- exdoc
- listSimilarControlTypes() : mixed
- resolveFilePaths() : mixed
- exdoc This function finds the most appropriate version of a file - if given wildcards, files - and returns an array with the file's physical location's full path or, if no file was found, false
Methods
buildNameList()
exdoc This function is a wrapper around self::resolveFilePaths() and returns a list of the basenames, minus the file extensions - if any
public
static buildNameList(string $type, string $name, string $subtype, string $subname) : array<string|int, mixed>
Parameters
- $type : string
-
(to be superseded) type of base resource (= directory name)
- $name : string
-
(hopefully in the future type named) Resource identifier (= class name = directory name)
- $subtype : string
-
type of the actual file (= file extension = (future) directory name)
- $subname : string
-
name of the actual file (= filename name without extension)
Tags
Return values
array<string|int, mixed> —find_config_views()
Return list of controller configuration views
public
static find_config_views([array<string|int, mixed> $paths = array() ][, array<string|int, mixed> $excludes = array() ]) : array<string|int, mixed>
Parameters
- $paths : array<string|int, mixed> = array()
- $excludes : array<string|int, mixed> = array()
Return values
array<string|int, mixed> —find_template()
Return the best match template file for the framework, including custom views If we receive a pathname, we'll only look there, otherwise we'll run the 'framework' flow allowing for custom/theme views
public
static find_template( $ctl, $view) : mixed|string
Parameters
Return values
mixed|string —get_action_views()
Return list of controller display views available
public
static get_action_views( $ctl, $action, $human_readable) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —get_common_template()
public
static get_common_template(mixed $view, mixed $loc[, mixed $controllername = '' ]) : mixed
Parameters
- $view : mixed
- $loc : mixed
- $controllername : mixed = ''
Return values
mixed —get_config_templates()
Return entire list of all controller configuration views available
public
static get_config_templates( $controller, $loc) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —get_filedisplay_views()
Return list of attached file display views available
public
static get_filedisplay_views() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_template_for_action()
public
static get_template_for_action(mixed $controller, mixed $action[, mixed $loc = null ]) : mixed
Parameters
- $controller : mixed
- $action : mixed
- $loc : mixed = null
Return values
mixed —getFormTemplates()
public
static getFormTemplates(mixed $type) : mixed
Parameters
- $type : mixed
Return values
mixed —getModuleViewFile()
public
static getModuleViewFile( $name, $view[, bool $recurse = true ]) : string
Parameters
Tags
Return values
string —getViewConfigForm()
exdoc
public
static getViewConfigForm( $module, $view, $form, $values) : form
Parameters
Tags
Return values
form —getViewConfigOptions()
exdoc
public
static getViewConfigOptions( $module, $view) : array<string|int, mixed>
Parameters
Tags
Return values
array<string|int, mixed> —getViewFile()
Retrieve Module-Independent View File
public
static getViewFile([string $type = "" ][, string $name = "" ][, string $view = "Default" ]) : string
Looks in the theme and the /views directory for a .tpl file corresponding to the passed view.
Parameters
- $type : string = ""
-
One of "modules"", "controls"", "forms" or ""
- $name : string = ""
-
The name the object we are requesting a view from
- $view : string = "Default"
-
The name of the requested view
Return values
string —The full filepath of the view template
getViewParams()
exdoc
public
static getViewParams( $viewfile) : mixed|null
Parameters
Tags
Return values
mixed|null —glob2keyedArray()
helper function for building assoc array of pathnames
public
static glob2keyedArray( $workArray) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —guessControlType()
public
static guessControlType(mixed $ddcol[, mixed $default_value = null ][, mixed $colname = null ]) : mixed
Parameters
- $ddcol : mixed
- $default_value : mixed = null
- $colname : mixed = null
Return values
mixed —listControlTypes()
exdoc
public
static listControlTypes([bool $include_static = true ]) : array<string|int, mixed>
Parameters
- $include_static : bool = true
Tags
Return values
array<string|int, mixed> —listModuleViews()
exdoc
public
static listModuleViews(string $module) : array<string|int, mixed>
Looks through the module's views directory and returns all non-internal views that are found there. Returns an array of all standard view names. This array is unsorted.
Parameters
- $module : string
-
The classname of the module to get views for.
Tags
Return values
array<string|int, mixed> —listSimilarControlTypes()
public
static listSimilarControlTypes(mixed $type) : mixed
Parameters
- $type : mixed
Return values
mixed —resolveFilePaths()
exdoc This function finds the most appropriate version of a file - if given wildcards, files - and returns an array with the file's physical location's full path or, if no file was found, false
public
static resolveFilePaths(string $type, string $name, string $subtype, string $subname) : mixed
Parameters
- $type : string
-
(to be superseded) type of base resource (= directory name)
- $name : string
-
(hopefully in the future type named) Resource identifier (= class name = directory name)
- $subtype : string
-
type of the actual file (= file extension = (future) directory name)
- $subname : string
-
name of the actual file (= filename name without extension)