expFramework.php
Tags
Table of Contents
- HEADER_LEVEL = ['h1' => 'h1', 'h2' => 'h2', 'h3' => 'h3', 'h4' => 'h4', 'h5' => 'h5', 'h6' => 'h6']
- renderAction() : bool|mixed|string
- Main module action/display logic/routine; initializes/checks controller before calling action/method
- hotspot() : mixed
- makeLink() : mixed
- redirect_to() : mixed
- flash() : mixed
- flashAndFlow() : mixed
- show_msg_queue() : bool|mixed|string
- Display the message queue
- assign_to_template() : bool
- Assign a variable to the current template
- get_model_for_controller() : mixed
- get_common_template() : controllertemplate
- get_config_templates() : array<string|int, mixed>
- find_config_views() : array<string|int, mixed>
- get_template_for_action() : controllertemplate
- get_action_views() : array<string|int, mixed>
- get_filedisplay_views() : mixed
- object2Array() : mixed
- expUnserialize() : mixed
- expProcessBuffer() : mixed
- callback when the buffer gets flushed. Any processing on the page output just before it gets rendered to the screen should happen here.
- createValidId() : mixed
- Ensure we have a valid html 'id' attribute
- curPageURL() : mixed
- ecom_active() : mixed
- Return status of e-commerce
- framework() : bool
- Return the current framework
- bs2() : bool
- Is the current framework Bootstrap v2 based?
- bs3() : bool
- Is the current framework Bootstrap v3 based?
- bs4() : bool
- Is the current framework Bootstrap v4 based?
- bs5() : bool
- Is the current framework Bootstrap v5 based?
- bs() : bool
- Is the current framework Bootstrap based?
- newui() : bool
- Is the current framework NEWUI and NOT a Bootstrap framework
- gt() : mixed
- glist() : mixed
- handleErrors() : mixed
- called from exponent.php as the ajax error handler
- eDebug() : void
- dumps the passed variable to screen/log, but only if in development mode
- eLog() : void
- dumps the passed variable to a log, but only if in development mode
- get_thumbnail() : string
- Shortcut function to get a phpThumb thumbnail
- isSSL() : bool
- Determine whether we are secure
- strftime_to_date_format() : string
- Equivalent to `date_format_to( $format, 'date' )`
- date_to_strftime_format() : string
- Equivalent to `convert_datetime_format_to( $format, 'strf' )`
- strftime_to_moment_format() : string
- Converts an strftime format to a moment.js format
- expStripSlashes() : mixed|string
- PHP v8.1+ friendly stripslashes() command
Constants
HEADER_LEVEL
public
mixed
HEADER_LEVEL
= ['h1' => 'h1', 'h2' => 'h2', 'h3' => 'h3', 'h4' => 'h4', 'h5' => 'h5', 'h6' => 'h6']
Functions
renderAction()
Main module action/display logic/routine; initializes/checks controller before calling action/method
renderAction([array<string|int, mixed> $parms = array() ]) : bool|mixed|string
Parameters
- $parms : array<string|int, mixed> = array()
Tags
Return values
bool|mixed|string —hotspot()
hotspot([mixed $source = null ]) : mixed
Parameters
- $source : mixed = null
Return values
mixed —makeLink()
makeLink([mixed $params = array() ][, mixed $secure = false ]) : mixed
Parameters
- $params : mixed = array()
- $secure : mixed = false
Return values
mixed —redirect_to()
redirect_to([mixed $params = array() ][, mixed $secure = false ]) : mixed
Parameters
- $params : mixed = array()
- $secure : mixed = false
Return values
mixed —flash()
flash(mixed $name, mixed $msg) : mixed
Parameters
- $name : mixed
- $msg : mixed
Return values
mixed —flashAndFlow()
flashAndFlow(mixed $name, mixed $msg) : mixed
Parameters
- $name : mixed
- $msg : mixed
Return values
mixed —show_msg_queue()
Display the message queue
show_msg_queue([null $name = null ]) : bool|mixed|string
Parameters
- $name : null = null
Return values
bool|mixed|string —assign_to_template()
Assign a variable to the current template
assign_to_template([array<string|int, mixed> $vars = array() ]) : bool
Parameters
- $vars : array<string|int, mixed> = array()
Return values
bool —get_model_for_controller()
get_model_for_controller(mixed $controller_name) : mixed
Parameters
- $controller_name : mixed
Return values
mixed —get_common_template()
get_common_template( $view, $loc[, string $controllername = '' ]) : controllertemplate
Parameters
Tags
Return values
controllertemplate —get_config_templates()
get_config_templates( $controller, $loc) : array<string|int, mixed>
Parameters
Tags
Return values
array<string|int, mixed> —find_config_views()
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()
Tags
Return values
array<string|int, mixed> —get_template_for_action()
get_template_for_action( $controller, $action[, null $loc = null ]) : controllertemplate
Parameters
Tags
Return values
controllertemplate —get_action_views()
get_action_views( $ctl, $action, $human_readable) : array<string|int, mixed>
Parameters
Tags
Return values
array<string|int, mixed> —get_filedisplay_views()
get_filedisplay_views() : mixed
Tags
Return values
mixed —object2Array()
object2Array([mixed $object = null ]) : mixed
Parameters
- $object : mixed = null
Return values
mixed —expUnserialize()
expUnserialize(mixed $serial_str) : mixed
Parameters
- $serial_str : mixed
Return values
mixed —expProcessBuffer()
callback when the buffer gets flushed. Any processing on the page output just before it gets rendered to the screen should happen here.
expProcessBuffer( $buffer) : mixed
Parameters
Return values
mixed —createValidId()
Ensure we have a valid html 'id' attribute
createValidId( $id[, string $value = '' ]) : mixed
Parameters
Return values
mixed —curPageURL()
curPageURL() : mixed
Return values
mixed —ecom_active()
Return status of e-commerce
ecom_active() : mixed
Return values
mixed —framework()
Return the current framework
framework() : bool
Return values
bool —bs2()
Is the current framework Bootstrap v2 based?
bs2([bool $strict = false ]) : bool
Parameters
- $strict : bool = false
Return values
bool —bs3()
Is the current framework Bootstrap v3 based?
bs3([bool $strict = false ]) : bool
Parameters
- $strict : bool = false
-
must be bootstrap3 and NOT newui
Return values
bool —bs4()
Is the current framework Bootstrap v4 based?
bs4([bool $strict = false ]) : bool
Parameters
- $strict : bool = false
-
must be bootstrap4
Return values
bool —bs5()
Is the current framework Bootstrap v5 based?
bs5([bool $strict = false ]) : bool
Parameters
- $strict : bool = false
-
must be bootstrap5
Return values
bool —bs()
Is the current framework Bootstrap based?
bs([bool $strict = false ]) : bool
Parameters
- $strict : bool = false
-
must be bootstrap 2 or 3 or 4 or 5 and NOT newui
Return values
bool —newui()
Is the current framework NEWUI and NOT a Bootstrap framework
newui() : bool
Return values
bool —gt()
gt(mixed $s) : mixed
Parameters
- $s : mixed
Return values
mixed —glist()
glist(mixed $s) : mixed
Parameters
- $s : mixed
Return values
mixed —handleErrors()
called from exponent.php as the ajax error handler
handleErrors( $errno, $errstr, $errfile, $errline) : mixed
Parameters
Return values
mixed —eDebug()
dumps the passed variable to screen/log, but only if in development mode
eDebug(mixed $var[, bool $halt = false ][, bool $disable_log = false ]) : void
Parameters
- $var : mixed
-
the variable to dump
- $halt : bool = false
-
if set to true will halt execution
- $disable_log : bool = false
-
if set to true will disable logging and force to screen
Return values
void —eLog()
dumps the passed variable to a log, but only if in development mode
eLog(mixed $var[, string $type = '' ][, string $path = '' ][, string $minlevel = '0' ]) : void
Parameters
- $var : mixed
-
the variable to log
- $type : string = ''
-
the type of entry to record
- $path : string = ''
-
the pathname for the log file
- $minlevel : string = '0'
Return values
void —get_thumbnail()
Shortcut function to get a phpThumb thumbnail
get_thumbnail( $src) : string
Parameters
Return values
string —isSSL()
Determine whether we are secure
isSSL() : bool
Return values
bool —strftime_to_date_format()
Equivalent to `date_format_to( $format, 'date' )`
strftime_to_date_format(string $strf_format) : string
Parameters
- $strf_format : string
-
A
strftime()date/time format
Return values
string —A date() date/time format
date_to_strftime_format()
Equivalent to `convert_datetime_format_to( $format, 'strf' )`
date_to_strftime_format(string $date_format) : string
Parameters
- $date_format : string
-
A
date()date/time format
Return values
string —A strftime() date/time format
strftime_to_moment_format()
Converts an strftime format to a moment.js format
strftime_to_moment_format(string $strf_format) : string
Parameters
- $strf_format : string
-
A
strftime()date/time format
Return values
string —A moment.js date/time format
expStripSlashes()
PHP v8.1+ friendly stripslashes() command
expStripSlashes( $str) : mixed|string