CWIS Developer Documentation
|
Top-level framework for web applications. More...
Application Framework | |
const | FT_OTHER = 0 |
File type other than CSS, image, or JavaScript. More... | |
const | FT_CSS = 1 |
CSS file type. More... | |
const | FT_IMAGE = 2 |
Image (GIF/JPG/PNG) file type. More... | |
const | FT_JAVASCRIPT = 3 |
JavaScript file type. More... | |
static | AddObjectDirectory ($Dir, $Prefix="", $ClassPattern=NULL, $ClassReplacement=NULL) |
Add directory to be searched for object files when autoloading. More... | |
static | DefaultUserInterface ($UIName=NULL) |
Get/set name of current default user interface. More... | |
static | ActiveUserInterface ($UIName=NULL) |
Get/set name of current active user interface. More... | |
static | GetFileType ($FileName) |
Determine type of specified file based on the file name. More... | |
AddImageDirectories ($Dir, $SearchLast=FALSE, $SkipSlashCheck=FALSE) | |
Add additional directory(s) to be searched for image files. More... | |
AddIncludeDirectories ($Dir, $SearchLast=FALSE, $SkipSlashCheck=FALSE) | |
Add additional directory(s) to be searched for user interface include (CSS, JavaScript, common PHP, common HTML, etc) files. More... | |
AddInterfaceDirectories ($Dir, $SearchLast=FALSE, $SkipSlashCheck=FALSE) | |
Add additional directory(s) to be searched for user interface (HTML/TPL) files. More... | |
AddFunctionDirectories ($Dir, $SearchLast=FALSE, $SkipSlashCheck=FALSE) | |
Add additional directory(s) to be searched for function ("F-") files. More... | |
SetBrowserDetectionFunc ($DetectionFunc) | |
Specify function to use to detect the web browser type. More... | |
AddUnbufferedCallback ($Callback, $Parameters=array()) | |
Add a callback that will be executed after buffered content has been output and that won't have its output buffered. More... | |
TemplateLocationCacheExpirationInterval ($NewInterval=DB_NOVALUE) | |
Get/set UI template location cache expiration period in minutes. More... | |
ClearTemplateLocationCache () | |
Clear template location cache. More... | |
ObjectLocationCacheExpirationInterval ($NewInterval=DB_NOVALUE) | |
Get/set object file location cache expiration period in minutes. More... | |
ClearObjectLocationCache () | |
Clear object (class) file location cache. More... | |
UrlFingerprintingEnabled ($NewValue=DB_NOVALUE) | |
Get/set whether URL fingerprinting is enabled. More... | |
ScssSupportEnabled ($NewValue=DB_NOVALUE) | |
Get/set whether SCSS compilation support is enabled. More... | |
GenerateCompactCss ($NewValue=DB_NOVALUE) | |
Get/set whether generating compact CSS (when compiling SCSS) is enabled. More... | |
UseMinimizedJavascript ($NewValue=DB_NOVALUE) | |
Get/set whether minimized JavaScript will be searched for and used if found. More... | |
JavascriptMinimizationEnabled ($NewValue=DB_NOVALUE) | |
Get/set whether the application framework will attempt to generate minimized JavaScript. More... | |
RecordContextInCaseOfCrash ($BacktraceOptions=0, $BacktraceLimit=0) | |
Record the current execution context in case of crash. More... | |
LoadPage ($PageName) | |
Load page PHP and HTML/TPL files. More... | |
GetPageName () | |
Get name of page being loaded. More... | |
GetPageLocation () | |
Get the URL path to the page without the base path, if present. More... | |
GetPageUrl () | |
Get the full URL to the page. More... | |
SetJumpToPage ($Page, $Delay=0, $IsLiteral=FALSE) | |
Set URL of page to autoload after PHP page file is executed. More... | |
JumpToPageIsSet () | |
Report whether a page to autoload has been set. More... | |
HtmlCharset ($NewSetting=NULL) | |
Get/set HTTP character encoding value. More... | |
DoNotMinimizeFile ($File) | |
Specify file(s) to not attempt to minimize. More... | |
UseBaseTag ($NewValue=NULL) | |
Get/set whether or not to use the "base" tag to ensure relative URL paths are correct. More... | |
SuppressHTMLOutput ($NewSetting=TRUE) | |
Suppress loading of HTML files. More... | |
GetUserInterfaces ($FilterExp=NULL) | |
Get list of available user interfaces and their labels. More... | |
GetUserInterfacePaths ($FilterExp=NULL) | |
Get list of available user interfaces and the relative paths to the base directory for each interface. More... | |
AddPostProcessingCall ($FunctionName, &$Arg1=self::NOVALUE, &$Arg2=self::NOVALUE, &$Arg3=self::NOVALUE, &$Arg4=self::NOVALUE, &$Arg5=self::NOVALUE, &$Arg6=self::NOVALUE, &$Arg7=self::NOVALUE, &$Arg8=self::NOVALUE, &$Arg9=self::NOVALUE) | |
Add function to be called after HTML has been loaded. More... | |
AddEnvInclude ($FileName) | |
Add file to be included to set up environment. More... | |
GUIFile ($FileName) | |
Search UI directories for specified image or CSS file and return name of correct file. More... | |
PUIFile ($FileName) | |
Search UI directories for specified interface (image, CSS, JavaScript etc) file and print name of correct file with leading path. More... | |
IncludeUIFile ($FileNames, $AdditionalAttributes=NULL) | |
Search UI directories for specified JavaScript or CSS file and print HTML tag to load file, using name of correct file with leading path. More... | |
DoNotUrlFingerprint ($Pattern) | |
Specify file or file name pattern to exclude from URL fingerprinting. More... | |
RequireUIFile ($FileName) | |
Add file to list of required UI files. More... | |
LoadFunction ($Callback) | |
Attempt to load code for function or method if not currently available. More... | |
GetElapsedExecutionTime () | |
Get time elapsed since constructor was called. More... | |
GetSecondsBeforeTimeout () | |
Get remaining available (PHP) execution time. More... | |
Page Caching | |
PageCacheEnabled ($NewValue=DB_NOVALUE) | |
Enable/disable page caching. More... | |
PageCacheExpirationPeriod ($NewValue=DB_NOVALUE) | |
Get/set page cache expiration period in seconds. More... | |
DoNotCacheCurrentPage () | |
Prevent the current page from being cached. More... | |
AddPageCacheTag ($Tag, $Pages=NULL) | |
Add caching tag for current page or specified pages. More... | |
ClearPageCacheForTag ($Tag) | |
Clear all cached pages associated with specified tag. More... | |
ClearPageCache () | |
Clear all pages from page cache. More... | |
GetPageCacheInfo () | |
Get page cache information. More... | |
Logging | |
const | LOGLVL_TRACE = 6 |
TRACE error logging level. More... | |
const | LOGLVL_DEBUG = 5 |
DEBUG error logging level. More... | |
const | LOGLVL_INFO = 4 |
INFO error logging level. More... | |
const | LOGLVL_WARNING = 3 |
WARNING error logging level. More... | |
const | LOGLVL_ERROR = 2 |
ERROR error logging level. More... | |
const | LOGLVL_FATAL = 1 |
FATAL error logging level. More... | |
const | LOGFILE_MAX_LINE_LENGTH = 2048 |
Maximum length for a line in the log file. More... | |
LogSlowPageLoads ($NewValue=DB_NOVALUE, $Persistent=FALSE) | |
Get/set whether logging of long page load times is enabled. More... | |
SlowPageLoadThreshold ($NewValue=DB_NOVALUE, $Persistent=FALSE) | |
Get/set how long a page load can take before it should be considered "slow" and may be logged. More... | |
LogHighMemoryUsage ($NewValue=DB_NOVALUE, $Persistent=FALSE) | |
Get/set whether logging of high memory usage is enabled. More... | |
HighMemoryUsageThreshold ($NewValue=DB_NOVALUE, $Persistent=FALSE) | |
Get/set what percentage of max memory (set via the memory_limit PHP configuration directive) a page load can use before it should be considered to be using high memory and may be logged. More... | |
LogError ($Level, $Msg) | |
Write error message to log. More... | |
LogMessage ($Level, $Msg) | |
Write status message to log. More... | |
LoggingLevel ($NewValue=DB_NOVALUE) | |
Get/set logging level. More... | |
LogFile ($NewValue=NULL) | |
Get/set log file name. More... | |
GetLogEntries ($Limit=0) | |
Get log entries, in reverse chronological order. More... | |
Event Handling | |
const | EVENTTYPE_DEFAULT = 1 |
Default event type. More... | |
const | EVENTTYPE_CHAIN = 2 |
Result chaining event type. More... | |
const | EVENTTYPE_FIRST = 3 |
First response event type. More... | |
const | EVENTTYPE_NAMED = 4 |
Named result event type. More... | |
const | ORDER_FIRST = 1 |
Run hooked function first (i.e. More... | |
const | ORDER_MIDDLE = 2 |
Run hooked function after ORDER_FIRST and before ORDER_LAST events. More... | |
const | ORDER_LAST = 3 |
Run hooked function last (i.e. More... | |
RegisterEvent ($EventsOrEventName, $EventType=NULL) | |
Register one or more events that may be signaled. More... | |
IsRegisteredEvent ($EventName) | |
Check if event has been registered (is available to be signaled). More... | |
IsHookedEvent ($EventName) | |
Check if an event is registered and is hooked to. More... | |
HookEvent ($EventsOrEventName, $Callback=NULL, $Order=self::ORDER_MIDDLE) | |
Hook one or more functions to be called when the specified event is signaled. More... | |
UnhookEvent ($EventsOrEventName, $Callback=NULL, $Order=self::ORDER_MIDDLE) | |
Unhook one or more functions that were previously hooked to be called when the specified event is signaled. More... | |
SignalEvent ($EventName, $Parameters=NULL) | |
Signal that an event has occured. More... | |
IsStaticOnlyEvent ($EventName) | |
Report whether specified event only allows static callbacks. More... | |
EventWillNextRunAt ($EventName, $Callback) | |
Get date/time a periodic event will next run. More... | |
GetKnownPeriodicEvents () | |
Get list of known periodic events. More... | |
Task Management | |
const | PRIORITY_HIGH = 1 |
Highest priority. More... | |
const | PRIORITY_MEDIUM = 2 |
Medium (default) priority. More... | |
const | PRIORITY_LOW = 3 |
Lower priority. More... | |
const | PRIORITY_BACKGROUND = 4 |
Lowest priority. More... | |
static | GetTaskCallbackSynopsis ($TaskInfo) |
Get printable synopsis for task callback. More... | |
QueueTask ($Callback, $Parameters=NULL, $Priority=self::PRIORITY_LOW, $Description="") | |
Add task to queue. More... | |
QueueUniqueTask ($Callback, $Parameters=NULL, $Priority=self::PRIORITY_LOW, $Description="") | |
Add task to queue if not already in queue or currently running. More... | |
TaskIsInQueue ($Callback, $Parameters=NULL) | |
Check if task is already in queue or currently running. More... | |
GetTaskQueueSize ($Priority=NULL) | |
Retrieve current number of tasks in queue. More... | |
GetQueuedTaskList ($Count=100, $Offset=0) | |
Retrieve list of tasks currently in queue. More... | |
GetQueuedTaskCount ($Callback=NULL, $Parameters=NULL, $Priority=NULL, $Description=NULL) | |
Get number of queued tasks that match supplied values. More... | |
GetRunningTaskList ($Count=100, $Offset=0) | |
Retrieve list of tasks currently in queue. More... | |
GetOrphanedTaskList ($Count=100, $Offset=0) | |
Retrieve list of tasks currently in queue. More... | |
GetOrphanedTaskCount () | |
Retrieve current number of orphaned tasks. More... | |
ReQueueOrphanedTask ($TaskId, $NewPriority=NULL) | |
Move orphaned task back into queue. More... | |
DeleteTask ($TaskId) | |
Remove task from task queues. More... | |
GetTask ($TaskId) | |
Retrieve task info from queue (either running or queued tasks). More... | |
TaskExecutionEnabled ($NewValue=DB_NOVALUE) | |
Get/set whether automatic task execution is enabled. More... | |
MaxTasks ($NewValue=DB_NOVALUE) | |
Get/set maximum number of tasks to have running simultaneously. More... | |
IsRunningInBackground () | |
Determine whether currently running inside a background task. More... | |
GetCurrentBackgroundPriority () | |
Determine current priority if running in background. More... | |
GetNextHigherBackgroundPriority ($Priority=NULL) | |
Get next higher possible background task priority. More... | |
GetNextLowerBackgroundPriority ($Priority=NULL) | |
Get next lower possible background task priority. More... | |
Clean URL Support | |
AddCleanUrl ($Pattern, $Page, $GetVars=NULL, $Template=NULL) | |
Add clean URL mapping. More... | |
CleanUrlIsMapped ($Path) | |
Report whether clean URL has already been mapped. More... | |
GetCleanUrlForPath ($Path) | |
Get the clean URL mapped for a path. More... | |
GetUncleanUrlForPath ($Path) | |
Get the unclean URL for mapped for a path. More... | |
GetCleanUrl () | |
Get the clean URL for the current page if one is available. More... | |
GetUncleanUrl () | |
Get the unclean URL for the current page. More... | |
AddPrefixForAlternateDomain ($Domain, $Prefix) | |
Add an alternate domain for the site which should map to a path tree under the main site URL. More... | |
Server Environment | |
static | SessionLifetime ($NewValue=NULL) |
Get/set session timeout in seconds. More... | |
static | HtaccessSupport () |
Determine if .htaccess files are enabled. More... | |
static | UrlFingerprintingRewriteSupport () |
Determine if rewrite support for URL fingerprinting is available. More... | |
static | ScssRewriteSupport () |
Determine if SCSS rewrite support is available. More... | |
static | JsMinRewriteSupport () |
Determine if rewrite support for JavaScript minification is available. More... | |
static | RootUrl () |
Get portion of current URL through host name, with no trailing slash (e.g. More... | |
static | RootUrlOverride ($NewValue=self::NOVALUE) |
Get/set root URL override. More... | |
static | BaseUrl () |
Get current base URL (the part before index.php) (e.g. More... | |
static | FullUrl () |
Get current full URL, before any clean URL remapping and with any query string (e.g. More... | |
static | PreferHttpHost ($NewValue=NULL) |
Get/set whether to prefer $_SERVER["HTTP_HOST"] (if available) over $_SERVER["SERVER_NAME"] when determining the current URL. More... | |
static | BasePath () |
Get current base path (usually the part after the host name). More... | |
static | GetScriptUrl () |
Retrieve SCRIPT_URL server value, pulling it from elsewhere if that variable isn't set. More... | |
static | WasUrlRewritten ($ScriptName="index.php") |
Determine if the URL was rewritten, i.e., the script is being accessed through a URL that isn't directly accessing the file the script is in. More... | |
static | GetFreeMemory () |
Get current amount of free memory. More... | |
static | GetPhpMemoryLimit () |
Get PHP memory limit in bytes. More... | |
MaxExecutionTime ($NewValue=DB_NOVALUE, $Persistent=FALSE) | |
Get/set maximum PHP execution time. More... | |
Utility | |
DownloadFile ($FilePath, $FileName=NULL, $MimeType=NULL) | |
Send specified file for download by user. More... | |
GetLock ($LockName, $Wait=TRUE) | |
Get an exclusive ("write") lock on the specified name. More... | |
ReleaseLock ($LockName) | |
Release lock with specified name. More... | |
Backward Compatibility | |
const | PAGECACHETAGIDOFFSET = 100000 |
const | MIN_GC_PROBABILITY = 0.01 |
const | OUTPUT_MODIFICATION_THRESHOLD = 0.10 |
Threshold below which page output modifications are considered to have failed. More... | |
const | NOVALUE = ".-+-.NO VALUE PASSED IN FOR ARGUMENT.-+-." |
FindCommonTemplate ($BaseName) | |
Preserved for backward compatibility for use with code written prior to October 2012. More... | |
OnCrash () | |
Called automatically at program termination to ensure output is written out. More... | |
Top-level framework for web applications.
Definition at line 14 of file ApplicationFramework.php.
|
static |
Get/set name of current active user interface.
Any "SPTUI--" prefix is stripped out for backward compatibility in CWIS.
string | $UIName | Name of new active user interface. (OPTIONAL) |
Definition at line 1184 of file ApplicationFramework.php.
ApplicationFramework::AddCleanUrl | ( | $Pattern, | |
$Page, | |||
$GetVars = NULL , |
|||
$Template = NULL |
|||
) |
Add clean URL mapping.
This method allows a "clean URL" (usually a purely structural URL that does not contain a query string and is more human-friendly) to be specified and mapped to a particular page, with segments of the clean URL being extracted and put into $_GET variables, as if they had been in a query string. IMPORTANT: If the $Template parameter is used to automagically swap in clean URLs in page output, the number of variables specified by $GetVars should be limited, as X variables causes X! regular expression replacements to be performed on the output.
string | $Pattern | Regular expression to match against clean URL, with starting and ending delimiters. |
string | $Page | Page (P= value) to load if regular expression matches. |
array | $GetVars | Array of $_GET variables to set using matches from regular expression, with variable names for the array indexes and variable value templates (with $N as appropriate, for captured subpatterns from matching) for the array values. (OPTIONAL) |
mixed | $Template | Template to use to insert clean URLs in HTML output. $_GET variables value locations should be specified in the template via the variable name preceded by a "$". This value may alternatively be a callback, in which case the callback will be called in a fashion similar to preg_replace_callback(), except with a second parameter containing the original $Pattern, a third parameter containing $Page, and a fourth parameter containing the full pattern (with "href=" etc) being matched. |
Definition at line 3104 of file ApplicationFramework.php.
ApplicationFramework::AddEnvInclude | ( | $FileName | ) |
Add file to be included to set up environment.
This file is loaded right before the PHP file.
string | $FileName | Name of file to be included. |
Definition at line 1366 of file ApplicationFramework.php.
ApplicationFramework::AddFunctionDirectories | ( | $Dir, | |
$SearchLast = FALSE , |
|||
$SkipSlashCheck = FALSE |
|||
) |
Add additional directory(s) to be searched for function ("F-") files.
Specified directory(s) will be searched, in order, before the default directories or any other directories previously specified. If a directory is already present in the list, it will be moved to front to be searched first (or to the end to be searched last, if SearchLast is set). SearchLast only affects whether added directories are searched before or after those currently in the list; when multiple directories are added, they are always searched in the order they appear in the array. The token "%ACTIVEUI%" may be included in the directory names, and will be replaced with the canonical name of the currently active UI when searching for files.
string | $Dir | String with directory or array with directories to be searched. |
bool | $SearchLast | If TRUE, the directory(s) are searched after the entries current in the list, instead of before. (OPTIONAL, defaults to FALSE) |
bool | $SkipSlashCheck | If TRUE, check for trailing slash will be omitted. (OPTIONAL, defaults to FALSE) |
Definition at line 340 of file ApplicationFramework.php.
ApplicationFramework::AddImageDirectories | ( | $Dir, | |
$SearchLast = FALSE , |
|||
$SkipSlashCheck = FALSE |
|||
) |
Add additional directory(s) to be searched for image files.
Specified directory(s) will be searched, in order, before the default directories or any other directories previously specified. If a directory is already present in the list, it will be moved to front to be searched first (or to the end to be searched last, if SearchLast is set). SearchLast only affects whether added directories are searched before or after those currently in the list; when multiple directories are added, they are always searched in the order they appear in the array. The token "%ACTIVEUI%" may be included in the directory names, and will be replaced with the canonical name of the currently active UI when searching for files.
string | $Dir | String with directory or array with directories to be searched. |
bool | $SearchLast | If TRUE, the directory(s) are searched after the entries current in the list, instead of before. (OPTIONAL, defaults to FALSE) |
bool | $SkipSlashCheck | If TRUE, check for trailing slash will be omitted. (OPTIONAL, defaults to FALSE) |
Definition at line 258 of file ApplicationFramework.php.
ApplicationFramework::AddIncludeDirectories | ( | $Dir, | |
$SearchLast = FALSE , |
|||
$SkipSlashCheck = FALSE |
|||
) |
Add additional directory(s) to be searched for user interface include (CSS, JavaScript, common PHP, common HTML, etc) files.
Specified directory(s) will be searched, in order, before the default directories or any other directories previously specified. If a directory is already present in the list, it will be moved to front to be searched first (or to the end to be searched last, if SearchLast is set). SearchLast only affects whether added directories are searched before or after those currently in the list; when multiple directories are added, they are always searched in the order they appear in the array. The token "%ACTIVEUI%" may be included in the directory names, and will be replaced with the canonical name of the currently active UI when searching for files.
string | $Dir | String with directory or array with directories to be searched. |
bool | $SearchLast | If TRUE, the directory(s) are searched after the entries current in the list, instead of before. (OPTIONAL, defaults to FALSE) |
bool | $SkipSlashCheck | If TRUE, check for trailing slash will be omitted. (OPTIONAL, defaults to FALSE) |
Definition at line 286 of file ApplicationFramework.php.
ApplicationFramework::AddInterfaceDirectories | ( | $Dir, | |
$SearchLast = FALSE , |
|||
$SkipSlashCheck = FALSE |
|||
) |
Add additional directory(s) to be searched for user interface (HTML/TPL) files.
Specified directory(s) will be searched, in order, before the default directories or any other directories previously specified. If a directory is already present in the list, it will be moved to front to be searched first (or to the end to be searched last, if SearchLast is set). SearchLast only affects whether added directories are searched before or after those currently in the list; when multiple directories are added, they are always searched in the order they appear in the array. The token "%ACTIVEUI%" may be included in the directory names, and will be replaced with the canonical name of the currently active UI when searching for files.
string | $Dir | String with directory or array with directories to be searched. |
bool | $SearchLast | If TRUE, the directory(s) are searched after the entries current in the list, instead of before. (OPTIONAL, defaults to FALSE) |
bool | $SkipSlashCheck | If TRUE, check for trailing slash will be omitted. (OPTIONAL, defaults to FALSE) |
Definition at line 313 of file ApplicationFramework.php.
|
static |
Add directory to be searched for object files when autoloading.
Directories are searched in the order they are added. The token "%ACTIVEUI%" may be included in the directory names, and will be replaced with the canonical name of the currently active UI when searching for files.
string | $Dir | Directory to be searched. |
string | $Prefix | Leading prefix to be stripped from file names when comparing them against objects (e.g. "Axis--"). (OPTIONAL) |
mixed | $ClassPattern | Pattern string or array of pattern strings to run on class name via preg_replace(). (OPTIONAL) |
mixed | $ClassReplacement | Replacement string or array of replacement strings to run on class name via preg_replace(). (OPTIONAL) |
Definition at line 225 of file ApplicationFramework.php.
Referenced by PluginManager\UninstallPlugin().
ApplicationFramework::AddPageCacheTag | ( | $Tag, | |
$Pages = NULL |
|||
) |
Add caching tag for current page or specified pages.
string | $Tag | Tag string to add. |
array | $Pages | List of pages. (OPTIONAL, defaults to current page) |
Definition at line 1787 of file ApplicationFramework.php.
ApplicationFramework::AddPostProcessingCall | ( | $FunctionName, | |
& | $Arg1 = self::NOVALUE , |
||
& | $Arg2 = self::NOVALUE , |
||
& | $Arg3 = self::NOVALUE , |
||
& | $Arg4 = self::NOVALUE , |
||
& | $Arg5 = self::NOVALUE , |
||
& | $Arg6 = self::NOVALUE , |
||
& | $Arg7 = self::NOVALUE , |
||
& | $Arg8 = self::NOVALUE , |
||
& | $Arg9 = self::NOVALUE |
||
) |
Add function to be called after HTML has been loaded.
The arguments are optional and are saved as references so that any changes to their value that occured while loading the HTML will be recognized.
string | $FunctionName | Name of function to be called. |
mixed | $Arg1 | First argument to be passed to function. (OPTIONAL, REFERENCE) |
mixed | $Arg2 | Second argument to be passed to function. (OPTIONAL, REFERENCE) |
mixed | $Arg3 | Third argument to be passed to function. (OPTIONAL, REFERENCE) |
mixed | $Arg4 | Fourth argument to be passed to function. (OPTIONAL, REFERENCE) |
mixed | $Arg5 | FifthFirst argument to be passed to function. (OPTIONAL, REFERENCE) |
mixed | $Arg6 | Sixth argument to be passed to function. (OPTIONAL, REFERENCE) |
mixed | $Arg7 | Seventh argument to be passed to function. (OPTIONAL, REFERENCE) |
mixed | $Arg8 | Eighth argument to be passed to function. (OPTIONAL, REFERENCE) |
mixed | $Arg9 | Ninth argument to be passed to function. (OPTIONAL, REFERENCE) |
Definition at line 1344 of file ApplicationFramework.php.
ApplicationFramework::AddPrefixForAlternateDomain | ( | $Domain, | |
$Prefix | |||
) |
Add an alternate domain for the site which should map to a path tree under the main site URL.
In addition to CleanURL support via htaccess, this functionality also requires that a RootUrlOverride be configured specifying the primary URL of the site.
string | $Domain | Domain that should be served from a prefix. |
string | $Prefix | Prefix (a URL path component) from whence the domain should be served. |
Definition at line 3344 of file ApplicationFramework.php.
ApplicationFramework::AddUnbufferedCallback | ( | $Callback, | |
$Parameters = array() |
|||
) |
Add a callback that will be executed after buffered content has been output and that won't have its output buffered.
callback | $Callback | Callback to add. |
array | $Parameters | Callback parameters in an array. (OPTIONAL) |
Definition at line 364 of file ApplicationFramework.php.
Referenced by DownloadFile().
|
static |
Get current base path (usually the part after the host name).
Definition at line 3526 of file ApplicationFramework.php.
|
static |
Get current base URL (the part before index.php) (e.g.
http://foobar.com/path/). The base URL is determined using the ultimate executing URL, after any clean URL remapping has been applied, so any extra "directory" segments that are really just part of a clean URL will not be included.
Definition at line 3484 of file ApplicationFramework.php.
Referenced by LoadPage().
ApplicationFramework::CleanUrlIsMapped | ( | $Path | ) |
Report whether clean URL has already been mapped.
string | $Path | Relative URL path to test against. |
Definition at line 3202 of file ApplicationFramework.php.
ApplicationFramework::ClearObjectLocationCache | ( | ) |
Clear object (class) file location cache.
Definition at line 406 of file ApplicationFramework.php.
ApplicationFramework::ClearPageCache | ( | ) |
Clear all pages from page cache.
Definition at line 1833 of file ApplicationFramework.php.
ApplicationFramework::ClearPageCacheForTag | ( | $Tag | ) |
Clear all cached pages associated with specified tag.
string | $Tag | Tag to clear pages for. |
Definition at line 1818 of file ApplicationFramework.php.
ApplicationFramework::ClearTemplateLocationCache | ( | ) |
Clear template location cache.
Definition at line 386 of file ApplicationFramework.php.
|
static |
Get/set name of current default user interface.
string | $UIName | Name of new default user interface. (OPTIONAL) |
Definition at line 1169 of file ApplicationFramework.php.
ApplicationFramework::DeleteTask | ( | $TaskId | ) |
Remove task from task queues.
int | $TaskId | Task ID. |
Definition at line 2842 of file ApplicationFramework.php.
ApplicationFramework::DoNotCacheCurrentPage | ( | ) |
Prevent the current page from being cached.
Definition at line 1776 of file ApplicationFramework.php.
ApplicationFramework::DoNotMinimizeFile | ( | $File | ) |
Specify file(s) to not attempt to minimize.
File names can include paths, in which case only files that exactly match that path will be excluded, or can be just the base file name, in which case any file with that name will be excluded. This does not prevent minimized versions of files from being used if found in the interface directories, just local (cached) minimized versions being generated and/or used.
mixed | $File | File name or array of file names. |
Definition at line 1131 of file ApplicationFramework.php.
ApplicationFramework::DoNotUrlFingerprint | ( | $Pattern | ) |
Specify file or file name pattern to exclude from URL fingerprinting.
The argument is treated as a file name unless the first and last characters are the same.
string | $Pattern | File name or file name pattern. |
Definition at line 1610 of file ApplicationFramework.php.
ApplicationFramework::DownloadFile | ( | $FilePath, | |
$FileName = NULL , |
|||
$MimeType = NULL |
|||
) |
Send specified file for download by user.
This method takes care of setting up the headers and suppressing further output, and is normally called from within the page file.
string | $FilePath | Full path to file. |
string | $FileName | Name of file. If not supplied, the name will be taken from the file path. (OPTIONAL) |
string | $MimeType | MIME type of file. If not supplied, an attempt will be made to determine the MIME type. (OPTIONAL) |
Definition at line 3678 of file ApplicationFramework.php.
References AddUnbufferedCallback(), and SuppressHTMLOutput().
ApplicationFramework::EventWillNextRunAt | ( | $EventName, | |
$Callback | |||
) |
Get date/time a periodic event will next run.
This is when the event should next go into the event queue, so it is the earliest time the event might run. Actual execution time will depend on whether there are other events already in the queue.
string | $EventName | Periodic event name (e.g. "EVENT_DAILY"). |
callback | $Callback | Event callback. |
Definition at line 2527 of file ApplicationFramework.php.
ApplicationFramework::FindCommonTemplate | ( | $BaseName | ) |
Preserved for backward compatibility for use with code written prior to October 2012.
string | $BaseName | Base name of template. |
Definition at line 3862 of file ApplicationFramework.php.
|
static |
Get current full URL, before any clean URL remapping and with any query string (e.g.
http://foobar.com/path/index.php?A=123&B=456).
Definition at line 3498 of file ApplicationFramework.php.
ApplicationFramework::GenerateCompactCss | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether generating compact CSS (when compiling SCSS) is enabled.
(Initially defaults to enabled on installation.) If SCSS compilation is not enabled, this setting has no effect.
bool | $NewValue | TRUE to enable, or FALSE to disable. (OPTIONAL) |
Definition at line 443 of file ApplicationFramework.php.
ApplicationFramework::GetCleanUrl | ( | ) |
Get the clean URL for the current page if one is available.
Otherwise, the unclean URL will be returned.
Definition at line 3318 of file ApplicationFramework.php.
References GetCleanUrlForPath(), and GetUncleanUrl().
ApplicationFramework::GetCleanUrlForPath | ( | $Path | ) |
Get the clean URL mapped for a path.
This only works for clean URLs where a replacement template for insertion into output (the $Template parameter to AddCleanUrl()) was specified.
string | $Path | Unclean path, e.g., index.php?P=FullRecord&ID=123. |
Definition at line 3223 of file ApplicationFramework.php.
Referenced by GetCleanUrl().
ApplicationFramework::GetCurrentBackgroundPriority | ( | ) |
Determine current priority if running in background.
Definition at line 3021 of file ApplicationFramework.php.
Referenced by GetNextHigherBackgroundPriority(), and GetNextLowerBackgroundPriority().
ApplicationFramework::GetElapsedExecutionTime | ( | ) |
Get time elapsed since constructor was called.
Definition at line 1729 of file ApplicationFramework.php.
Referenced by GetSecondsBeforeTimeout(), LoadPage(), MaxExecutionTime(), and OnCrash().
|
static |
Determine type of specified file based on the file name.
string | $FileName | Name of file. |
Definition at line 1632 of file ApplicationFramework.php.
Referenced by GUIFile(), IncludeUIFile(), and LoadPage().
|
static |
Get current amount of free memory.
The value returned is a "best guess" based on reported memory usage.
Definition at line 3601 of file ApplicationFramework.php.
Referenced by OnCrash().
ApplicationFramework::GetKnownPeriodicEvents | ( | ) |
Get list of known periodic events.
This returns a list with information about periodic events that have been hooked this invocation, and when they are next expected to run. The array returned has the following values:
Definition at line 2562 of file ApplicationFramework.php.
ApplicationFramework::GetLock | ( | $LockName, | |
$Wait = TRUE |
|||
) |
Get an exclusive ("write") lock on the specified name.
If the maximum PHP execution time is being modified in proximity to obtaining a lock (e.g. because a task will take longer than typical), that should be done before calling GetLock().
string | $LockName | Name of lock. |
bool | $Wait | If TRUE, method will not return until a lock has been obtained. (optional, defaults to TRUE) |
Definition at line 3766 of file ApplicationFramework.php.
References MaxExecutionTime(), and StdLib\SQL_DATE_FORMAT.
ApplicationFramework::GetLogEntries | ( | $Limit = 0 | ) |
Get log entries, in reverse chronological order.
int | $Limit | Maximum number of entries to return. (OPTIONAL, defaults to returning all entries) |
Definition at line 2099 of file ApplicationFramework.php.
References LogFile().
ApplicationFramework::GetNextHigherBackgroundPriority | ( | $Priority = NULL | ) |
Get next higher possible background task priority.
If already at the highest priority, the same value is returned.
int | $Priority | Background priority (PRIORITY_ value). (OPTIONAL, defaults to current priority if running in background, or NULL if running in foreground) |
Definition at line 3035 of file ApplicationFramework.php.
References GetCurrentBackgroundPriority().
ApplicationFramework::GetNextLowerBackgroundPriority | ( | $Priority = NULL | ) |
Get next lower possible background task priority.
If already at the lowest priority, the same value is returned.
int | $Priority | Background priority (PRIORITY_ value). (OPTIONAL, defaults to current priority if running in background, or NULL if running in foreground) |
Definition at line 3057 of file ApplicationFramework.php.
References GetCurrentBackgroundPriority().
ApplicationFramework::GetOrphanedTaskCount | ( | ) |
Retrieve current number of orphaned tasks.
Definition at line 2807 of file ApplicationFramework.php.
References MaxExecutionTime().
ApplicationFramework::GetOrphanedTaskList | ( | $Count = 100 , |
|
$Offset = 0 |
|||
) |
Retrieve list of tasks currently in queue.
int | $Count | Number to retrieve. (OPTIONAL, defaults to 100) |
int | $Offset | Offset into queue to start retrieval. (OPTIONAL) |
Definition at line 2795 of file ApplicationFramework.php.
References MaxExecutionTime().
ApplicationFramework::GetPageCacheInfo | ( | ) |
Get page cache information.
Definition at line 1847 of file ApplicationFramework.php.
ApplicationFramework::GetPageLocation | ( | ) |
Get the URL path to the page without the base path, if present.
Case is ignored when looking for a base path to strip off.
Definition at line 1028 of file ApplicationFramework.php.
References HtaccessSupport().
Referenced by GetPageUrl(), and LoadPage().
ApplicationFramework::GetPageName | ( | ) |
Get name of page being loaded.
The page name will not include an extension. This call is only meaningful once LoadPage() has been called.
Definition at line 1018 of file ApplicationFramework.php.
Referenced by GetUncleanUrl().
ApplicationFramework::GetPageUrl | ( | ) |
Get the full URL to the page.
Definition at line 1061 of file ApplicationFramework.php.
References GetPageLocation().
|
static |
Get PHP memory limit in bytes.
This is necessary because the PHP configuration setting can be in "shorthand" (e.g. "16M").
Definition at line 3611 of file ApplicationFramework.php.
Referenced by LoadPage().
ApplicationFramework::GetQueuedTaskCount | ( | $Callback = NULL , |
|
$Parameters = NULL , |
|||
$Priority = NULL , |
|||
$Description = NULL |
|||
) |
Get number of queued tasks that match supplied values.
Tasks will not be counted if the values do not match exactly, so callbacks with methods for different objects (even of the same class) will not match.
callback | $Callback | Function or method to call to perform task. (OPTIONAL) |
array | $Parameters | Array containing parameters to pass to function or method. Pass in empty array to match tasks with no parameters. (OPTIONAL) |
int | $Priority | Priority to assign to task. (OPTIONAL) |
string | $Description | Text description of task. (OPTIONAL) |
Definition at line 2746 of file ApplicationFramework.php.
Referenced by GetTaskQueueSize().
ApplicationFramework::GetQueuedTaskList | ( | $Count = 100 , |
|
$Offset = 0 |
|||
) |
Retrieve list of tasks currently in queue.
int | $Count | Number to retrieve. (OPTIONAL, defaults to 100) |
int | $Offset | Offset into queue to start retrieval. (OPTIONAL) |
Definition at line 2727 of file ApplicationFramework.php.
ApplicationFramework::GetRunningTaskList | ( | $Count = 100 , |
|
$Offset = 0 |
|||
) |
Retrieve list of tasks currently in queue.
int | $Count | Number to retrieve. (OPTIONAL, defaults to 100) |
int | $Offset | Offset into queue to start retrieval. (OPTIONAL) |
Definition at line 2780 of file ApplicationFramework.php.
References MaxExecutionTime().
|
static |
Retrieve SCRIPT_URL server value, pulling it from elsewhere if that variable isn't set.
Definition at line 3543 of file ApplicationFramework.php.
ApplicationFramework::GetSecondsBeforeTimeout | ( | ) |
Get remaining available (PHP) execution time.
Definition at line 1738 of file ApplicationFramework.php.
References GetElapsedExecutionTime(), and MaxExecutionTime().
ApplicationFramework::GetTask | ( | $TaskId | ) |
Retrieve task info from queue (either running or queued tasks).
int | $TaskId | Task ID. |
Definition at line 2855 of file ApplicationFramework.php.
|
static |
Get printable synopsis for task callback.
Any string values in the callback parameter list will be escaped with htmlspecialchars().
array | $TaskInfo | Array of task info as returned by GetTask(). |
Definition at line 2925 of file ApplicationFramework.php.
ApplicationFramework::GetTaskQueueSize | ( | $Priority = NULL | ) |
Retrieve current number of tasks in queue.
int | $Priority | Priority of tasks. (OPTIONAL, defaults to all priorities) |
Definition at line 2715 of file ApplicationFramework.php.
References GetQueuedTaskCount().
ApplicationFramework::GetUncleanUrl | ( | ) |
Get the unclean URL for the current page.
Definition at line 3327 of file ApplicationFramework.php.
References GetPageName().
Referenced by GetCleanUrl().
ApplicationFramework::GetUncleanUrlForPath | ( | $Path | ) |
Get the unclean URL for mapped for a path.
string | $Path | Clean path, e.g., r123/resource-title |
Definition at line 3268 of file ApplicationFramework.php.
ApplicationFramework::GetUserInterfacePaths | ( | $FilterExp = NULL | ) |
Get list of available user interfaces and the relative paths to the base directory for each interface.
string | $FilterExp | If this regular expression (preg_match() format) is specified, only interfaces whose directory path matches the expression will be returned. (OPTIONAL) |
Definition at line 1254 of file ApplicationFramework.php.
Referenced by GetUserInterfaces().
ApplicationFramework::GetUserInterfaces | ( | $FilterExp = NULL | ) |
Get list of available user interfaces and their labels.
Labels are taken from the file "NAME" in the base directory for the interface, if available. IF a NAME file isn't available, the canonical name is used for the label.
string | $FilterExp | If this regular expression (preg_match() format) is specified, only interfaces whose directory path matches the expression will be returned. (OPTIONAL) |
Definition at line 1203 of file ApplicationFramework.php.
References GetUserInterfacePaths().
ApplicationFramework::GUIFile | ( | $FileName | ) |
Search UI directories for specified image or CSS file and return name of correct file.
string | $FileName | Base file name. |
Definition at line 1377 of file ApplicationFramework.php.
References GetFileType(), JavascriptMinimizationEnabled(), ScssSupportEnabled(), UrlFingerprintingEnabled(), and UseMinimizedJavascript().
Referenced by IncludeUIFile(), LoadPage(), and PUIFile().
ApplicationFramework::HighMemoryUsageThreshold | ( | $NewValue = DB_NOVALUE , |
|
$Persistent = FALSE |
|||
) |
Get/set what percentage of max memory (set via the memory_limit PHP configuration directive) a page load can use before it should be considered to be using high memory and may be logged.
(Defaults to 90%.)
int | $NewValue | Threshold percentage. (OPTIONAL) |
bool | $Persistent | If TRUE the new value will be saved (i.e. persistent across page loads), otherwise the value will apply to just the current page load. (OPTIONAL, defaults to FALSE) |
Definition at line 1934 of file ApplicationFramework.php.
Referenced by LoadPage().
ApplicationFramework::HookEvent | ( | $EventsOrEventName, | |
$Callback = NULL , |
|||
$Order = self::ORDER_MIDDLE |
|||
) |
Hook one or more functions to be called when the specified event is signaled.
The callback parameter is of the PHP type "callback", which allows object methods to be passed.
array | string | $EventsOrEventName | Name of the event to hook. To hook multiple events, this may also be an array, with the event names as the index and the callbacks as the values. |
callback | $Callback | Function to be called when event is signaled. (OPTIONAL if EventsOrEventName is an array of events) |
int | $Order | Preference for when function should be called, primarily for CHAIN and FIRST events. (OPTIONAL, defaults to ORDER_MIDDLE) |
Definition at line 2321 of file ApplicationFramework.php.
References StdLib\SortCompare().
|
static |
Determine if .htaccess files are enabled.
This method depends on the environment variable HTACCESS_SUPPORT being set in .htaccess.
Definition at line 3374 of file ApplicationFramework.php.
Referenced by GetPageLocation().
ApplicationFramework::HtmlCharset | ( | $NewSetting = NULL | ) |
Get/set HTTP character encoding value.
This is set for the HTTP header and may be queried and set in the HTML header by the active user interface. The default charset is UTF-8. A list of valid character set values can be found at http://www.iana.org/assignments/character-sets
string | $NewSetting | New character encoding value string (e.g. "ISO-8859-1"). |
Definition at line 1116 of file ApplicationFramework.php.
Referenced by LoadPage().
ApplicationFramework::IncludeUIFile | ( | $FileNames, | |
$AdditionalAttributes = NULL |
|||
) |
Search UI directories for specified JavaScript or CSS file and print HTML tag to load file, using name of correct file with leading path.
If the file is not found, nothing is printed. This is intended to be called from within interface HTML files to ensure that the correct file is loaded, regardless of which interface the file is in. An override version of the file (with "-Override" at the end of the name, before the suffix) is also searched for and will be included if found.
mixed | $FileNames | File name or array of file names, without leading path. |
string | $AdditionalAttributes | Any additional attributes that should be included in HTML tag. (OPTIONAL) |
Definition at line 1555 of file ApplicationFramework.php.
References GetFileType(), and GUIFile().
ApplicationFramework::IsHookedEvent | ( | $EventName | ) |
Check if an event is registered and is hooked to.
string | $EventName | Name of event. |
Definition at line 2296 of file ApplicationFramework.php.
References IsRegisteredEvent().
ApplicationFramework::IsRegisteredEvent | ( | $EventName | ) |
Check if event has been registered (is available to be signaled).
string | $EventName | Name of event (string). |
Definition at line 2284 of file ApplicationFramework.php.
Referenced by IsHookedEvent().
ApplicationFramework::IsRunningInBackground | ( | ) |
Determine whether currently running inside a background task.
Definition at line 3011 of file ApplicationFramework.php.
ApplicationFramework::IsStaticOnlyEvent | ( | $EventName | ) |
Report whether specified event only allows static callbacks.
string | $EventName | Name of event to check. |
Definition at line 2512 of file ApplicationFramework.php.
ApplicationFramework::JavascriptMinimizationEnabled | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether the application framework will attempt to generate minimized JavaScript.
(Initially defaults to enabled on installation.) This setting has no effect if UseMinimizedJavascript() is set to FALSE.
bool | $NewValue | TRUE to enable, or FALSE to disable. (OPTIONAL) |
Definition at line 469 of file ApplicationFramework.php.
Referenced by GUIFile().
|
static |
Determine if rewrite support for JavaScript minification is available.
This method depends on the environment variable JSMIN_REWRITE_SUPPORT being set in .htaccess.
Definition at line 3410 of file ApplicationFramework.php.
ApplicationFramework::JumpToPageIsSet | ( | ) |
Report whether a page to autoload has been set.
Definition at line 1102 of file ApplicationFramework.php.
ApplicationFramework::LoadFunction | ( | $Callback | ) |
Attempt to load code for function or method if not currently available.
Function code to be loaded should be located in a file named "F-XXX.php", where "XXX" is the function name. The file may reside in "local/include", any of the interface "include" directories, or any of the object directories.
callback | $Callback | Function or method info. |
Definition at line 1679 of file ApplicationFramework.php.
References LogError().
ApplicationFramework::LoadPage | ( | $PageName | ) |
Load page PHP and HTML/TPL files.
string | $PageName | Name of page to be loaded (e.g. "BrowseResources"). |
Definition at line 506 of file ApplicationFramework.php.
References BaseUrl(), GetElapsedExecutionTime(), GetFileType(), GetPageLocation(), GetPhpMemoryLimit(), GUIFile(), HighMemoryUsageThreshold(), HtmlCharset(), LogHighMemoryUsage(), LogMessage(), LogSlowPageLoads(), PageCacheEnabled(), PHP, SignalEvent(), SlowPageLoadThreshold(), and UseBaseTag().
ApplicationFramework::LogError | ( | $Level, | |
$Msg | |||
) |
Write error message to log.
The difference between this and LogMessage is the way that an inability to write to the log is handled. If this method is unable to log the error and the error level was LOGLVL_ERROR or LOGLVL_FATAL, an exception is thrown.
int | $Level | Current message logging must be at or above specified level for error message to be written. (See LoggingLevel() for definitions of the error logging levels.) |
string | $Msg | Error message text. |
Definition at line 1954 of file ApplicationFramework.php.
References LogMessage().
Referenced by LoadFunction(), OnCrash(), and SignalEvent().
ApplicationFramework::LogFile | ( | $NewValue = NULL | ) |
Get/set log file name.
The log file location defaults to "local/logs/site.log", but can be changed via this method.
string | $NewValue | New log file name. (OPTIONAL) |
Definition at line 2084 of file ApplicationFramework.php.
Referenced by GetLogEntries().
ApplicationFramework::LoggingLevel | ( | $NewValue = DB_NOVALUE | ) |
Get/set logging level.
Status and error messages are only written if their associated level is at or below this value. The six levels of log messages are, in increasing level of severity: 6: TRACE - Very detailed logging, usually only used when attempting to diagnose a problem in one specific section of code. 5: DEBUG - Information that is diagnostically helpful when debugging. 4: INFO - Generally-useful information, that may come in handy but to which little attention is normally paid. (This should not be used for events that routinely occur with every page load.) 3: WARNING - An event that may potentially cause problems, but is automatically recovered from. 2: ERROR - Any error which is fatal to the operation currently being performed, but does not result in overall application shutdown or persistent data corruption. 1: FATAL - Any error which results in overall application shutdown or persistent data corruption.
int | $NewValue | New error logging level. (OPTIONAL) |
Definition at line 2066 of file ApplicationFramework.php.
References DB_NOVALUE.
ApplicationFramework::LogHighMemoryUsage | ( | $NewValue = DB_NOVALUE , |
|
$Persistent = FALSE |
|||
) |
Get/set whether logging of high memory usage is enabled.
When enabled, pages that use more than the percentage of max memory specified via HighMemoryUsageThreshold() (default 90%) are logged via LogMessage() with a level of LOGLVL_INFO. (This will not, of course, catch pages that crash because PHP's memory limit is reached.)
bool | $NewValue | TRUE to enable logging or FALSE to disable. (OPTIONAL) |
bool | $Persistent | If TRUE the new value will be saved (i.e. persistent across page loads), otherwise the value will apply to just the current page load. (OPTIONAL, defaults to FALSE) |
Definition at line 1916 of file ApplicationFramework.php.
Referenced by LoadPage().
ApplicationFramework::LogMessage | ( | $Level, | |
$Msg | |||
) |
Write status message to log.
The difference between this and LogError is the way that an inability to write to the log is handled.
int | $Level | Current message logging must be at or above specified level for message to be written. (See LoggingLevel() for definitions of the error logging levels.) |
string | $Msg | Message text. |
Definition at line 1996 of file ApplicationFramework.php.
Referenced by LoadPage(), and LogError().
ApplicationFramework::LogSlowPageLoads | ( | $NewValue = DB_NOVALUE , |
|
$Persistent = FALSE |
|||
) |
Get/set whether logging of long page load times is enabled.
When enabled, pages that take more than the time specified via SlowPageLoadThreshold() (default 10 seconds) are logged via LogMessage() with a level of LOGLVL_INFO. (This will not, of course, catch pages that take so long to load that the PHP execution timeout is reached.)
bool | $NewValue | TRUE to enable logging or FALSE to disable. (OPTIONAL) |
bool | $Persistent | If TRUE the new value will be saved (i.e. persistent across page loads), otherwise the value will apply to just the current page load. (OPTIONAL, defaults to FALSE) |
Definition at line 1879 of file ApplicationFramework.php.
Referenced by LoadPage().
ApplicationFramework::MaxExecutionTime | ( | $NewValue = DB_NOVALUE , |
|
$Persistent = FALSE |
|||
) |
Get/set maximum PHP execution time.
Setting a new value is not possible if PHP is running in safe mode. Note that this method returns the actual maximum execution time as currently understood by PHP, which could be different from the saved ApplicationFramework setting.
int | $NewValue | New setting for max execution time in seconds. (OPTIONAL, but minimum value is 5 if specified) |
bool | $Persistent | If TRUE the new value will be saved (i.e. persistent across page loads), otherwise the value will apply to just the current page load. (OPTIONAL, defaults to FALSE) |
Definition at line 3648 of file ApplicationFramework.php.
References DB_NOVALUE, and GetElapsedExecutionTime().
Referenced by GetLock(), GetOrphanedTaskCount(), GetOrphanedTaskList(), GetRunningTaskList(), and GetSecondsBeforeTimeout().
ApplicationFramework::MaxTasks | ( | $NewValue = DB_NOVALUE | ) |
Get/set maximum number of tasks to have running simultaneously.
int | $NewValue | New setting for max number of tasks. (OPTIONAL) |
Definition at line 2913 of file ApplicationFramework.php.
ApplicationFramework::ObjectLocationCacheExpirationInterval | ( | $NewInterval = DB_NOVALUE | ) |
Get/set object file location cache expiration period in minutes.
An expiration period of 0 disables caching.
int | $NewInterval | New expiration period in minutes. (OPTIONAL) |
Definition at line 398 of file ApplicationFramework.php.
ApplicationFramework::OnCrash | ( | ) |
Called automatically at program termination to ensure output is written out.
(Not intended to be called directly, could not be made private to class because of automatic execution method.)
Definition at line 5111 of file ApplicationFramework.php.
References $Items, GetElapsedExecutionTime(), GetFreeMemory(), and LogError().
ApplicationFramework::PageCacheEnabled | ( | $NewValue = DB_NOVALUE | ) |
Enable/disable page caching.
Page caching is disabled by default.
bool | $NewValue | TRUE to enable caching, or FALSE to disable. (OPTIONAL) |
Definition at line 1756 of file ApplicationFramework.php.
Referenced by LoadPage().
ApplicationFramework::PageCacheExpirationPeriod | ( | $NewValue = DB_NOVALUE | ) |
Get/set page cache expiration period in seconds.
The default is ten minutes (600 seconds).
int | $NewValue | Expiration period in seconds. (OPTIONAL) |
Definition at line 1767 of file ApplicationFramework.php.
|
static |
Get/set whether to prefer $_SERVER["HTTP_HOST"] (if available) over $_SERVER["SERVER_NAME"] when determining the current URL.
The default is FALSE.
bool | $NewValue | TRUE to prefer HTTP_HOST, or FALSE to prefer SERVER_NAME. |
Definition at line 3513 of file ApplicationFramework.php.
ApplicationFramework::PUIFile | ( | $FileName | ) |
Search UI directories for specified interface (image, CSS, JavaScript etc) file and print name of correct file with leading path.
If the file is not found, nothing is printed. This is intended to be called from within interface HTML files to ensure that the correct file is loaded, regardless of which interface the file is in.
string | $FileName | Base file name (without leading path). |
Definition at line 1535 of file ApplicationFramework.php.
References GUIFile().
ApplicationFramework::QueueTask | ( | $Callback, | |
$Parameters = NULL , |
|||
$Priority = self::PRIORITY_LOW , |
|||
$Description = "" |
|||
) |
Add task to queue.
The Callback parameters is the PHP "callback" type. If $Callback refers to a function (rather than an object method) that function must be available in a global scope on all pages or must be loadable by ApplicationFramework::LoadFunction().
callback | $Callback | Function or method to call to perform task. |
array | $Parameters | Array containing parameters to pass to function or method. (OPTIONAL, pass NULL for no parameters) |
int | $Priority | Priority to assign to task. (OPTIONAL, defaults to PRIORITY_LOW) |
string | $Description | Text description of task. (OPTIONAL) |
Definition at line 2626 of file ApplicationFramework.php.
Referenced by QueueUniqueTask().
ApplicationFramework::QueueUniqueTask | ( | $Callback, | |
$Parameters = NULL , |
|||
$Priority = self::PRIORITY_LOW , |
|||
$Description = "" |
|||
) |
Add task to queue if not already in queue or currently running.
If task is already in queue with a lower priority than specified, the task's priority will be increased to the new value. The Callback parameter is the PHP "callback" type. If $Callback refers to a function (rather than an object method) that function must be available in a global scope on all pages or must be loadable by ApplicationFramework::LoadFunction().
callback | $Callback | Function or method to call to perform task. |
array | $Parameters | Array containing parameters to pass to function or method. (OPTIONAL, pass NULL for no parameters) |
int | $Priority | Priority to assign to task. (OPTIONAL, defaults to PRIORITY_LOW) |
string | $Description | Text description of task. (OPTIONAL) |
Definition at line 2655 of file ApplicationFramework.php.
References QueueTask(), and TaskIsInQueue().
ApplicationFramework::RecordContextInCaseOfCrash | ( | $BacktraceOptions = 0 , |
|
$BacktraceLimit = 0 |
|||
) |
Record the current execution context in case of crash.
The current context (backtrace) will be saved with the crash info in case a task crashes. This is primarily intended as a debugging tool, to help determine the circumstances under which a background task is crashing. The $BacktraceLimit parameter is only supported in PHP 5.4 and later. (You can still supply it for earlier PHP versions, but it will be ignored.)
int | $BacktraceOptions | Option flags to pass to debug_backtrace() when retrieving context. (OPTIONAL, defaults to 0, which records function/method arguments but not objects) |
int | $BacktraceLimit | Maximum number of stack frames to record. (OPTIONAL, defaults to recording all stack frames) |
Definition at line 487 of file ApplicationFramework.php.
ApplicationFramework::RegisterEvent | ( | $EventsOrEventName, | |
$EventType = NULL |
|||
) |
Register one or more events that may be signaled.
array | string | $EventsOrEventName | Name of event (string). To register multiple events, this may also be an array, with the event names as the index and the event types as the values. |
int | $EventType | Type of event (constant). (OPTIONAL if EventsOrEventName is an array of events) |
Definition at line 2263 of file ApplicationFramework.php.
ApplicationFramework::ReleaseLock | ( | $LockName | ) |
Release lock with specified name.
string | $LockName | Name of lock. |
Definition at line 3839 of file ApplicationFramework.php.
ApplicationFramework::ReQueueOrphanedTask | ( | $TaskId, | |
$NewPriority = NULL |
|||
) |
Move orphaned task back into queue.
int | $TaskId | Task ID. |
int | $NewPriority | New priority for task being requeued. (OPTIONAL) |
Definition at line 2820 of file ApplicationFramework.php.
ApplicationFramework::RequireUIFile | ( | $FileName | ) |
Add file to list of required UI files.
This is used to make sure a particular JavaScript or CSS file is loaded. Only files loaded with ApplicationFramework::GUIFile() or ApplicationFramework::PUIFile() are considered when deciding if a file has already been loaded.
string | $FileName | Base name (without path) of required file. |
Definition at line 1622 of file ApplicationFramework.php.
|
static |
Get portion of current URL through host name, with no trailing slash (e.g.
Definition at line 3423 of file ApplicationFramework.php.
|
static |
Get/set root URL override.
(The "root URL" is the portion of the URL through the host name.) Any trailing slash will be removed. Pass in NULL to clear any existing override. This setting primarily affects the values returned by the URL retrieval methods and the attempted insertion of clean URLs in outgoing HTML.
string | $NewValue | New root URL override. (OPTIONAL) |
Definition at line 3466 of file ApplicationFramework.php.
|
static |
Determine if SCSS rewrite support is available.
This method depends on the environment variable SCSS_REWRITE_SUPPORT being set in .htaccess.
Definition at line 3398 of file ApplicationFramework.php.
ApplicationFramework::ScssSupportEnabled | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether SCSS compilation support is enabled.
(Initially defaults to enabled on installation.)
bool | $NewValue | TRUE to enable, or FALSE to disable. (OPTIONAL) |
Definition at line 430 of file ApplicationFramework.php.
Referenced by GUIFile().
|
static |
Get/set session timeout in seconds.
int | $NewValue | New session timeout value. (OPTIONAL) |
Definition at line 3360 of file ApplicationFramework.php.
ApplicationFramework::SetBrowserDetectionFunc | ( | $DetectionFunc | ) |
Specify function to use to detect the web browser type.
Function should return an array of browser names.
callback | $DetectionFunc | Browser detection function callback. |
Definition at line 353 of file ApplicationFramework.php.
ApplicationFramework::SetJumpToPage | ( | $Page, | |
$Delay = 0 , |
|||
$IsLiteral = FALSE |
|||
) |
Set URL of page to autoload after PHP page file is executed.
The HTML/TPL file will never be loaded if this is set. Pass in NULL to clear any autoloading.
string | $Page | URL of page to jump to (autoload). If the URL does not appear to point to a PHP or HTML file then "index.php?P=" will be prepended to it. |
int | $Delay | If non-zero, the page HTML will be generated and displayed, and the jump (refresh) will not occur until the specified delay in seconds has elapsed. (OPTIONAL, defaults to 0) |
bool | $IsLiteral | If TRUE, do not attempt to prepend "index.php?P=" to page. (OPTIONAL, defaults to FALSE) |
Definition at line 1077 of file ApplicationFramework.php.
ApplicationFramework::SignalEvent | ( | $EventName, | |
$Parameters = NULL |
|||
) |
Signal that an event has occured.
string | $EventName | Name of event being signaled. |
array | $Parameters | Associative array of parameters for event, with CamelCase names as indexes. The order of the array MUST correspond to the order of the parameters expected by the signal handlers. (OPTIONAL) |
Definition at line 2429 of file ApplicationFramework.php.
References LogError().
Referenced by LoadPage().
ApplicationFramework::SlowPageLoadThreshold | ( | $NewValue = DB_NOVALUE , |
|
$Persistent = FALSE |
|||
) |
Get/set how long a page load can take before it should be considered "slow" and may be logged.
(Defaults to 10 seconds.)
int | $NewValue | Threshold in seconds. (OPTIONAL) |
bool | $Persistent | If TRUE the new value will be saved (i.e. persistent across page loads), otherwise the value will apply to just the current page load. (OPTIONAL, defaults to FALSE) |
Definition at line 1896 of file ApplicationFramework.php.
Referenced by LoadPage().
ApplicationFramework::SuppressHTMLOutput | ( | $NewSetting = TRUE | ) |
Suppress loading of HTML files.
This is useful when the only output from a page is intended to come from the PHP page file.
bool | $NewSetting | TRUE to suppress HTML output, FALSE to not suppress HTML output. (OPTIONAL, defaults to TRUE) |
Definition at line 1159 of file ApplicationFramework.php.
Referenced by DownloadFile().
ApplicationFramework::TaskExecutionEnabled | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether automatic task execution is enabled.
(This does not prevent tasks from being manually executed.)
bool | $NewValue | TRUE to enable or FALSE to disable. (OPTIONAL) |
Definition at line 2903 of file ApplicationFramework.php.
ApplicationFramework::TaskIsInQueue | ( | $Callback, | |
$Parameters = NULL |
|||
) |
Check if task is already in queue or currently running.
When no $Parameters value is specified the task is checked against any other entries with the same $Callback.
callback | $Callback | Function or method to call to perform task. |
array | $Parameters | Array containing parameters to pass to function or method. (OPTIONAL) |
Definition at line 2692 of file ApplicationFramework.php.
Referenced by QueueUniqueTask().
ApplicationFramework::TemplateLocationCacheExpirationInterval | ( | $NewInterval = DB_NOVALUE | ) |
Get/set UI template location cache expiration period in minutes.
An expiration period of 0 disables caching.
int | $NewInterval | New expiration period in minutes. (OPTIONAL) |
Definition at line 378 of file ApplicationFramework.php.
ApplicationFramework::UnhookEvent | ( | $EventsOrEventName, | |
$Callback = NULL , |
|||
$Order = self::ORDER_MIDDLE |
|||
) |
Unhook one or more functions that were previously hooked to be called when the specified event is signaled.
The callback parameter is of the PHP type "callback", which allows object methods to be passed.
array | string | $EventsOrEventName | Name of the event to unhook. To unhook multiple events, this may also be an array, with the event names as the index and the callbacks as the values. |
callback | $Callback | Function to be called when event is signaled. (OPTIONAL if EventsOrEventName is an array of events) |
int | $Order | Preference for when function should be called, primarily for CHAIN and FIRST events. (OPTIONAL, defaults to ORDER_MIDDLE) |
Definition at line 2386 of file ApplicationFramework.php.
ApplicationFramework::UrlFingerprintingEnabled | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether URL fingerprinting is enabled.
(Initially defaults to enabled on installation.)
bool | $NewValue | TRUE to enable, or FALSE to disable. (OPTIONAL) |
Definition at line 418 of file ApplicationFramework.php.
Referenced by GUIFile().
|
static |
Determine if rewrite support for URL fingerprinting is available.
This method depends on the environment variable URL_FINGERPRINTING_SUPPORT being set in .htaccess.
Definition at line 3386 of file ApplicationFramework.php.
ApplicationFramework::UseBaseTag | ( | $NewValue = NULL | ) |
Get/set whether or not to use the "base" tag to ensure relative URL paths are correct.
(Without the "base" tag, an attempt will be made to dynamically rewrite relative URLs where needed.) Using the "base" tag may be problematic because it also affects relative anchor references and empty target references, which some third-party JavaScript libraries may rely upon.
bool | $NewValue | TRUE to enable use of tag, or FALSE to disable. (OPTIONAL) |
Definition at line 1147 of file ApplicationFramework.php.
Referenced by LoadPage().
ApplicationFramework::UseMinimizedJavascript | ( | $NewValue = DB_NOVALUE | ) |
Get/set whether minimized JavaScript will be searched for and used if found.
(Initially defaults to enabled on installation.) Minimized files end with ".min.js".
bool | $NewValue | TRUE to enable, or FALSE to disable. (OPTIONAL) |
Definition at line 456 of file ApplicationFramework.php.
Referenced by GUIFile().
|
static |
Determine if the URL was rewritten, i.e., the script is being accessed through a URL that isn't directly accessing the file the script is in.
This is not equivalent to determining whether a clean URL is set up for the URL.
string | $ScriptName | The file name of the running script. |
Definition at line 3572 of file ApplicationFramework.php.
const ApplicationFramework::EVENTTYPE_CHAIN = 2 |
Result chaining event type.
For this type the parameter array to each event handler is the return value from the previous handler, and the final return value is sent back to the event signaller.
Definition at line 2232 of file ApplicationFramework.php.
const ApplicationFramework::EVENTTYPE_DEFAULT = 1 |
Default event type.
Any handler return values are ignored.
Definition at line 2226 of file ApplicationFramework.php.
const ApplicationFramework::EVENTTYPE_FIRST = 3 |
First response event type.
For this type event handlers are called until one returns a non-NULL result, at which point no further handlers are called and that last result is passed back to the event signaller.
Definition at line 2238 of file ApplicationFramework.php.
const ApplicationFramework::EVENTTYPE_NAMED = 4 |
Named result event type.
Return values from each handler are placed into an array with the handler (function or class::method) name as the index, and that array is returned to the event signaller. The handler name for class methods is the class name plus "::" plus the method name. are called and that last result is passed back to the event signaller.
Definition at line 2246 of file ApplicationFramework.php.
const ApplicationFramework::FT_CSS = 1 |
CSS file type.
Definition at line 1665 of file ApplicationFramework.php.
const ApplicationFramework::FT_IMAGE = 2 |
Image (GIF/JPG/PNG) file type.
Definition at line 1667 of file ApplicationFramework.php.
const ApplicationFramework::FT_JAVASCRIPT = 3 |
JavaScript file type.
Definition at line 1669 of file ApplicationFramework.php.
const ApplicationFramework::FT_OTHER = 0 |
File type other than CSS, image, or JavaScript.
Definition at line 1663 of file ApplicationFramework.php.
const ApplicationFramework::LOGFILE_MAX_LINE_LENGTH = 2048 |
Maximum length for a line in the log file.
Definition at line 2214 of file ApplicationFramework.php.
const ApplicationFramework::LOGLVL_DEBUG = 5 |
DEBUG error logging level.
Information that is diagnostically helpful when debugging.
Definition at line 2187 of file ApplicationFramework.php.
const ApplicationFramework::LOGLVL_ERROR = 2 |
ERROR error logging level.
Any error which is fatal to the operation currently being performed, but does not result in overall application shutdown or persistent data corruption.
Definition at line 2204 of file ApplicationFramework.php.
const ApplicationFramework::LOGLVL_FATAL = 1 |
FATAL error logging level.
Any error which results in overall application shutdown or persistent data corruption.
Definition at line 2209 of file ApplicationFramework.php.
const ApplicationFramework::LOGLVL_INFO = 4 |
INFO error logging level.
Generally-useful information, that may come in handy but to which little attention is normally paid. (This should not be used for events that routinely occur with every page load.)
Definition at line 2193 of file ApplicationFramework.php.
const ApplicationFramework::LOGLVL_TRACE = 6 |
TRACE error logging level.
Very detailed logging, usually only used when attempting to diagnose a problem in one specific section of code.
Definition at line 2182 of file ApplicationFramework.php.
const ApplicationFramework::LOGLVL_WARNING = 3 |
WARNING error logging level.
An event that may potentially cause problems, but is automatically recovered from.
Definition at line 2198 of file ApplicationFramework.php.
const ApplicationFramework::MIN_GC_PROBABILITY = 0.01 |
Definition at line 3936 of file ApplicationFramework.php.
const ApplicationFramework::NOVALUE = ".-+-.NO VALUE PASSED IN FOR ARGUMENT.-+-." |
Definition at line 5392 of file ApplicationFramework.php.
const ApplicationFramework::ORDER_FIRST = 1 |
Run hooked function first (i.e.
before ORDER_MIDDLE events).
Definition at line 2249 of file ApplicationFramework.php.
const ApplicationFramework::ORDER_LAST = 3 |
Run hooked function last (i.e.
after ORDER_MIDDLE events).
Definition at line 2253 of file ApplicationFramework.php.
Referenced by PluginManager\__construct().
const ApplicationFramework::ORDER_MIDDLE = 2 |
Run hooked function after ORDER_FIRST and before ORDER_LAST events.
Definition at line 2251 of file ApplicationFramework.php.
const ApplicationFramework::OUTPUT_MODIFICATION_THRESHOLD = 0.10 |
Threshold below which page output modifications are considered to have failed.
Definition at line 5319 of file ApplicationFramework.php.
const ApplicationFramework::PAGECACHETAGIDOFFSET = 100000 |
Definition at line 3933 of file ApplicationFramework.php.
const ApplicationFramework::PRIORITY_BACKGROUND = 4 |
Lowest priority.
Definition at line 2612 of file ApplicationFramework.php.
Referenced by SPTSearchEngine\ConvertToDisplayParameters(), ClassificationFactory\RecalculateAllResourceCounts(), and SPTRecommender\SetUpdatePriority().
const ApplicationFramework::PRIORITY_HIGH = 1 |
Highest priority.
Definition at line 2606 of file ApplicationFramework.php.
const ApplicationFramework::PRIORITY_LOW = 3 |
Lower priority.
Definition at line 2610 of file ApplicationFramework.php.
Referenced by SPTRecommender\RunUpdateForItem().
const ApplicationFramework::PRIORITY_MEDIUM = 2 |
Medium (default) priority.
Definition at line 2608 of file ApplicationFramework.php.