Exponent v2.4.3
Back to top  

expTemplate

define

"BASE" "../../.."
package

Subsystems

Methods

exdoc This function is a wrapper around self::resolveFilePaths() and returns a list of the basenames, minus the file extensions - if any

buildNameList(string $type, string $name, string $subtype, string $subname) : array
static
node

Subsystems:expTemplate

Arguments

$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)

Response

array

Return list of controller configuration views

find_config_views(array $paths = array(), array $excludes = array()) : array
static

Arguments

$paths

array

$excludes

array

Response

array

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

find_template( $ctl,  $view) : mixed|string
static

Arguments

$ctl

$view

Response

mixed|string

Return list of controller display views available

get_action_views( $ctl,  $action,  $human_readable) : array
static

Arguments

$ctl

$action

$human_readable

Response

array

get_common_template

get_common_template( $view,  $loc,  $controllername = '')
static

Arguments

$view

$loc

$controllername

Return entire list of all controller configuration views available

get_config_templates( $controller,  $loc) : array
static

Arguments

$controller

$loc

Response

array

Return list of attached file display views available

get_filedisplay_views() : array
static

Response

array

get_template_for_action

get_template_for_action( $controller,  $action,  $loc = null)
static

Arguments

$controller

$action

$loc

getFormTemplates

getFormTemplates( $type)
static

Arguments

$type

getModuleViewFile

getModuleViewFile( $name,  $view, boolean $recurse = true) : string
static
deprecated 2.2.0

backward compatibility wrapper

Arguments

$name

$view

$recurse

boolean

Response

string

exdoc

getViewConfigForm( $module,  $view,  $form,  $values) : \form
static
deprecated 2.2.0

backward compatibility wrapper

Arguments

$module

$view

$form

$values

Response

\form

exdoc

getViewConfigOptions( $module,  $view) : array
static
deprecated 2.2.0

backward compatibility wrapper

Arguments

$module

$view

Response

array

Retrieve Module-Independent View File

getViewFile(string $type = "", string $name = "", string $view = "Default") : string
static

Looks in the theme and the /views directory for a .tpl file corresponding to the passed view.

Arguments

$type

string

One of "modules"", "controls"", "forms" or ""

$name

string

The name the object we are requesting a view from

$view

string

The name of the requested view

Response

string

The full filepath of the view template

exdoc

getViewParams( $viewfile) : mixed|null
static
deprecated

previously held view static config variables, e.g., calendar view type

Arguments

$viewfile

Response

mixed|null

helper function for building assoc array of pathnames

glob2keyedArray( $workArray) : array
static

Arguments

$workArray

Response

array

guessControlType

guessControlType( $ddcol,  $default_value = null,  $colname = null)
static

Arguments

$ddcol

$default_value

$colname

listControlTypes

listControlTypes( $include_static = true)
static

Arguments

$include_static

exdoc

listModuleViews(string $module) : array
static

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.

node

Subsystems:Template
deprecated

backward compatibility wrapper

Arguments

$module

string

The classname of the module to get views for.

Response

array

listSimilarControlTypes

listSimilarControlTypes( $type)
static

Arguments

$type

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

resolveFilePaths(string $type, string $name, string $subtype, string $subname) : mixed
static
node

Subsystems:expTemplate

Arguments

$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)

Response

mixed