Class QApplicationBase

This abstract class should never be instantiated. It contains static methods, variables and constants to be used throughout the application.

The static method "Initialize" should be called at the begin of the script by prepend.inc.

QBaseClass

QApplicationBase

Abstract
Located at includes/framework/QApplicationBase.class.php

Methods summary
`final public`	# `__construct( )` This faux constructor method throws a caller exception. The Application object should never be instantiated, and this constructor override simply guarantees it. This faux constructor method throws a caller exception. The Application object should never be instantiated, and this constructor override simply guarantees it. Throws `QCallerException`
`public static`	# `Initialize( )` This should be the first call to initialize all the static variables The application object also has static methods that are miscellaneous web development utilities, etc. This should be the first call to initialize all the static variables The application object also has static methods that are miscellaneous web development utilities, etc. Throws Exception
`public static integer`	# `IsBrowser( integer $intBrowserType )` Checks for the type of browser in use by the client. Checks for the type of browser in use by the client. Parameters `$intBrowserType` Returns integer
`public static`	# `InitializeDatabaseConnections( )` This call will initialize the database connection(s) as defined by the constants DB_CONNECTION_X, where "X" is the index number of a particular database connection. This call will initialize the database connection(s) as defined by the constants DB_CONNECTION_X, where "X" is the index number of a particular database connection. Throws Exception
`public static`	# `SessionOverride( )`
`public static boolean`	# `Autoload( $strClassName )` This is called by the PHP5 Autoloader. This static method can be overridden. This is called by the PHP5 Autoloader. This static method can be overridden. Parameters `$strClassName` Returns boolean whether or not a class was found / included
`public static`	# `SetErrorHandler( string $strName, integer $intLevel = null )` Temprorarily overrides the default error handling mechanism. Remember to call RestoreErrorHandler to restore the error handler back to the default. Temprorarily overrides the default error handling mechanism. Remember to call RestoreErrorHandler to restore the error handler back to the default. Parameters `$strName` the name of the new error handler function, or NULL if none `$intLevel` if a error handler function is defined, then the new error reporting level (if any) Throws `QCallerException`
`public static`	# `RestoreErrorHandler( )` Restores the temporarily overridden default error handling mechanism back to the default. Restores the temporarily overridden default error handling mechanism back to the default.
`public static boolean`	# `MakeDirectory( string $strPath, null\|integer $intMode = null )` Create a directory on file system Create a directory on file system Parameters `$strPath` Path of the directory to be created `$intMode` Octal representation of permissions ('0755' style) Returns boolean
`public static`	# `Redirect( string $strLocation, boolean $blnAbortCurrentScript = true )` This will redirect the user to a new web location. This can be a relative or absolute web path, or it can be an entire URL. This will redirect the user to a new web location. This can be a relative or absolute web path, or it can be an entire URL. TODO: break this into two routines, since the resulting UI behavior is really different. Redirect and LoadPage?? Parameters `$strLocation` target patch `$blnAbortCurrentScript` Whether to abort the current script, or finish it out so data gets saved.
`public static`	# `CloseWindow( boolean $blnAbortCurrentScript = false )` This will close the window. This will close the window. Parameters `$blnAbortCurrentScript` Whether to abort the current script, or finish it out so data gets saved.
`public static`	# `SetCookie( string $strName, sring $strValue, QDateTime $dttTimeout, string $strPath = '/', null\|string $strDomain = null, boolean $blnSecure = false )` Set a cookie. Allows setting of cookies in responses to ajax requests. Set a cookie. Allows setting of cookies in responses to ajax requests. Parameters `$strName` `$strValue` `$dttTimeout` `$strPath` `$strDomain` `$blnSecure`
`public static`	# `DeleteCookie( $strName )` Delete's the given cookie IF its set. In other words, you cannot set a cookie and then delete a cookie right away before the cookie gets sent to the browser. Delete's the given cookie IF its set. In other words, you cannot set a cookie and then delete a cookie right away before the cookie gets sent to the browser. Parameters `$strName`
`public static string`	# `QueryString( string $strItem )` Gets the value of the QueryString item $strItem. Will return NULL if it doesn't exist. Gets the value of the QueryString item $strItem. Will return NULL if it doesn't exist. Parameters `$strItem` the parameter name Returns string value of the parameter
`public static string`	# `GenerateQueryString( array $arr = null )` Generates a valid URL Query String based on values in the provided array. If no array is provided, it uses the global $_GET Generates a valid URL Query String based on values in the provided array. If no array is provided, it uses the global $_GET Parameters `$arr` Returns string
`protected static null\|string`	# `GenerateQueryStringHelper( string $strKey, string\|integer\|array $mixValue )` Generates part of query string (helps in generating the complete query string) Generates part of query string (helps in generating the complete query string) Parameters `$strKey` Key for the query string `$mixValue` Value we have to put as the value of the key Returns null\|string
`public static`	# `CheckRemoteAdmin( )` By default, this is used by the codegen and form drafts to do a quick check on the ALLOW_REMOTE_ADMIN constant (as defined in configuration.inc.php). If enabled, then anyone can access the page. If disabled, only "localhost" can access the page. If you want to run a script that should be accessible regardless of ALLOW_REMOTE_ADMIN, simply remove the CheckRemoteAdmin() method call from that script. By default, this is used by the codegen and form drafts to do a quick check on the ALLOW_REMOTE_ADMIN constant (as defined in configuration.inc.php). If enabled, then anyone can access the page. If disabled, only "localhost" can access the page. If you want to run a script that should be accessible regardless of ALLOW_REMOTE_ADMIN, simply remove the CheckRemoteAdmin() method call from that script. Throws `QRemoteAdminDeniedException`
`public static boolean`	# `IsRemoteAdminSession( )` Checks whether the current request was made by an ADMIN This does not refer to your Database admin or an Admin user defined in your application but an IP address (or IP address range) defined in configuration.inc.php. Checks whether the current request was made by an ADMIN This does not refer to your Database admin or an Admin user defined in your application but an IP address (or IP address range) defined in configuration.inc.php. The function can be used to restrict access to sensitive pages to a list of IPs (or IP ranges), such as the LAN to which the server hosting the QCubed application is connected. Returns boolean
`public static boolean`	# `IsIPInRange( string $ip, string $range )` Checks whether the given IP falls into the given IP range Checks whether the given IP falls into the given IP range Parameters `$ip` the IP number to check `$range` the IP number range. The range could be in 'IP/mask' or 'IP - IP' format. mask could be a simple integer or a dotted netmask. Returns boolean
`public static string\|null`	# `PathInfo( integer $intIndex )` Gets the value of the PathInfo item at index $intIndex. Will return NULL if it doesn't exist. Gets the value of the PathInfo item at index $intIndex. Will return NULL if it doesn't exist. The way PathInfo index is determined is, for example, given a URL '/folder/page.php/id/15/blue', QApplication::PathInfo(0) will return 'id' QApplication::PathInfo(1) will return '15' QApplication::PathInfo(2) will return 'blue' Parameters `$intIndex` index Returns string\|null
`public static`	# `DisplayAlert( string $strMessage )` Causes the browser to display a JavaScript alert() box with supplied message Causes the browser to display a JavaScript alert() box with supplied message Parameters `$strMessage` Message to be displayed
`public static`	# `ExecuteJavaScript( string $strJavaScript, string $strPriority = QJsPriority::Standard )` This class can be used to call a Javascript function in the client browser from the server side. Can be used inside event handlers to do something after verification on server side. This class can be used to call a Javascript function in the client browser from the server side. Can be used inside event handlers to do something after verification on server side. TODO: Since this is implemented with an "eval" on the client side in ajax, we should phase this out in favor of specific commands sent to the client. Deprecated Will be eventually removed. If you need to do something in javascript, add it to QAjaxResponse. Parameters `$strJavaScript` the javascript to execute `$strPriority` Throws `QCallerException`
`public static`	# `ExecuteControlCommand( string $strControlId, string $strFunctionName )` Execute a function on a particular control. Many javascript widgets are structured this way, and this gives us a general purpose way of sending commands to widgets without an 'eval' on the client side. Execute a function on a particular control. Many javascript widgets are structured this way, and this gives us a general purpose way of sending commands to widgets without an 'eval' on the client side. Commands will be executed in the order received, along with ExecuteJavaScript commands and ExecuteObjectCommands. If you want to force a command to execute first, give it high priority, or last, give it low priority. Parameters `$strControlId` Id of control to direct the command to. `$strFunctionName` Function name to call. For jQueryUI, this would be the widget name
`public static`	# `ExecuteSelectorFunction( array\|string $mixSelector, string $strFunctionName )` Call a function on a jQuery selector. The selector can be a single string, or an array where the first item is a selector specifying the items within the context of the second selector. Call a function on a jQuery selector. The selector can be a single string, or an array where the first item is a selector specifying the items within the context of the second selector. Parameters `$mixSelector` `$strFunctionName` Throws `QCallerException`
`public static`	# `ExecuteJsFunction( string $strFunctionName )` Call the given function with the given arguments. If just a function name, then the window object is searched. The function can be inside an object accessible from the global namespace by separating with periods. Call the given function with the given arguments. If just a function name, then the window object is searched. The function can be inside an object accessible from the global namespace by separating with periods. Parameters `$strFunctionName` Can be namespaced, as in "qcubed.func".
`public static`	# `AddStyleSheets( array $strStyleSheetArray )` One time add of style sheets, to be used by QForm only for last minute style sheet injection. One time add of style sheets, to be used by QForm only for last minute style sheet injection. Parameters `$strStyleSheetArray`
`public static`	# `AddJavaScriptFiles( string[] $strJavaScriptFileArray )` Add an array of javascript files for one-time inclusion. Called by QForm. Do not call. Add an array of javascript files for one-time inclusion. Called by QForm. Do not call. Parameters `$strJavaScriptFileArray`
`public static string`	# `OutputPage( string $strBuffer )` Outputs the current page with the buffer data Outputs the current page with the buffer data Parameters `$strBuffer` Buffer data Returns string
`public static`	# `StartOutputBuffering( )`
`public static`	# `EndOutputBuffering( $strBuffer )`
`public static string`	# `RenderFiles( )` Render scripts for injecting files into the html output. This is for server only, not ajax. This list will appear ahead of the javascript commands rendered below. Render scripts for injecting files into the html output. This is for server only, not ajax. This list will appear ahead of the javascript commands rendered below. Returns string
`public static string`	# `RenderJavascript( $blnBeforeControls = false )` Function renders all the Javascript commands as output to the client browser. This is a mirror of what occurs in the success function in the qcubed.js ajax code. Function renders all the Javascript commands as output to the client browser. This is a mirror of what occurs in the success function in the qcubed.js ajax code. Parameters `$blnBeforeControls` to only render the javascripts that need to come before the controls are defined. This is used to break the commands issued into two groups. Returns string
`public static array`	# `GetJavascriptCommandArray( )` Return the javascript command array, for use by form ajax response. Will erase the command array, so the form better use it. Return the javascript command array, for use by form ajax response. Will erase the command array, so the form better use it. Returns array
`public static string`	# `Translate( string $strToken )` If LanguageCode is specified and QI18n::Initialize() has been called, then this will perform a translation of the given token for the specified Language Code and optional Country code. If LanguageCode is specified and QI18n::Initialize() has been called, then this will perform a translation of the given token for the specified Language Code and optional Country code. Otherwise, this will simply return the token as is. This method is also used by the global print-translated "_t" function. Parameters `$strToken` Returns string the Translated token (if applicable)
`public static string`	# `HtmlEntities( string $strText )` Global/Central HtmlEntities command to perform the PHP equivalent of htmlentities. Feel free to override to specify encoding/quoting specific preferences (e.g. ENT_QUOTES/ENT_NOQUOTES, etc.) Global/Central HtmlEntities command to perform the PHP equivalent of htmlentities. Feel free to override to specify encoding/quoting specific preferences (e.g. ENT_QUOTES/ENT_NOQUOTES, etc.) Be careful of one thing though. This now uses ENT_HTML5, to correspond with the default page DOCTYPE. This has the added benefit of encoding newlines in data sent to controls. In particular, a multi-line textbox needs to have newlines encoded to prevent problems when the output is formatted using _indent(). This method is also used by the global print "_p" function. Parameters `$strText` text string to perform html escaping Returns string the html escaped string
`public static`	# `SendAjaxResponse( array $strResponseArray )` Print an ajax response to the browser. Print an ajax response to the browser. Parameters `$strResponseArray` An array keyed with QAjaxResponse items. These items will be read by the qcubed.js ajax success function and operated on. The goals is to eventually have all possible response types represented in the QAjaxResponse so that we can remove the "eval" in qcubed.js.
`public static string`	# `GetJsFileUri( string $strFile )` Utility function to get the JS file URI, given a string input Utility function to get the JS file URI, given a string input Parameters `$strFile` File name to be tested Returns string the final JS file URI
`public static string`	# `GetCssFileUri( string $strFile )` Utility function to get the CSS file URI, given a string input Utility function to get the CSS file URI, given a string input Parameters `$strFile` File name to be tested Returns string the final CSS URI
`public static`	# `VarDump( )` For development purposes, this static method outputs all the Application static variables For development purposes, this static method outputs all the Application static variables

Methods inherited from QBaseClass
`OverrideAttributes(), __call(), __get(), __set()`

Properties summary
`public static QAbstractCacheProvider`	`$objCacheProvider` The cache provider object used for caching ORM objects It is initialized below in Initialize(), based on the CACHE_PROVIDER and CACHE_PROVIDER_OPTIONS variables defined in configuration.inc.php The cache provider object used for caching ORM objects It is initialized below in Initialize(), based on the CACHE_PROVIDER and CACHE_PROVIDER_OPTIONS variables defined in configuration.inc.php	# `null`
`public static boolean`	`$blnLocalCache` Set to true to turn on short-term caching. This is an in-memory cache that caches database objects only for as long as a single http request lasts. Depending on your application, this may speed up your database accesses. It DOES increase the amount of memory used in a request. Set to true to turn on short-term caching. This is an in-memory cache that caches database objects only for as long as a single http request lasts. Depending on your application, this may speed up your database accesses. It DOES increase the amount of memory used in a request.	# `false`
`protected static integer`	`$BrowserType` Internal bitmask signifying which BrowserType the user is using Use the QApplication::IsBrowser() method to do browser checking Internal bitmask signifying which BrowserType the user is using Use the QApplication::IsBrowser() method to do browser checking	# `QBrowserType::Unsupported`
`public static float`	`$BrowserVersion` Major version number of browser Major version number of browser	# `null`
`public static string`	`$CacheControl` Definition of CacheControl for the HTTP header. In general, it is recommended to keep this as "private". But this can/should be overriden for file/scripts that have special caching requirements (e.g. dynamically created images like QImageLabel). Definition of CacheControl for the HTTP header. In general, it is recommended to keep this as "private". But this can/should be overriden for file/scripts that have special caching requirements (e.g. dynamically created images like QImageLabel).	# `'private'`
`public static #P#C\QCrossScripting.Purify\|?`	`$DefaultCrossScriptingMode` Defines the default mode for controls that need protection against cross-site scripting. Can be overridden at the individual control level, or for all controls by overriding it in QApplication. Set to QCrossScripting::Legacy for backward compatibility reasons for legacy applications; For new applications the recommended setting is QCrossScripting::Purify. Defines the default mode for controls that need protection against cross-site scripting. Can be overridden at the individual control level, or for all controls by overriding it in QApplication. Set to QCrossScripting::Legacy for backward compatibility reasons for legacy applications; For new applications the recommended setting is QCrossScripting::Purify.	# `QCrossScripting::Legacy`
`public static string`	`$DocumentRoot` Path of the "web root" or "document root" of the web server Like "/home/www/htdocs" on Linux/Unix or "c:\inetpub\wwwroot" on Windows Path of the "web root" or "document root" of the web server Like "/home/www/htdocs" on Linux/Unix or "c:\inetpub\wwwroot" on Windows	#
`public static boolean`	`$ProcessOutput` Whether or not we are currently trying to Process the Output of the page. Used by the OutputPage PHP output_buffering handler. As of PHP 5.2, this gets called whenever ob_get_contents() is called. Because some classes like QFormBase utilizes ob_get_contents() to perform template evaluation without wanting to actually perform OutputPage, this flag can be set/modified by QFormBase::EvaluateTemplate accordingly to prevent OutputPage from executing. Whether or not we are currently trying to Process the Output of the page. Used by the OutputPage PHP output_buffering handler. As of PHP 5.2, this gets called whenever ob_get_contents() is called. Because some classes like QFormBase utilizes ob_get_contents() to perform template evaluation without wanting to actually perform OutputPage, this flag can be set/modified by QFormBase::EvaluateTemplate accordingly to prevent OutputPage from executing. Also set this to false if you are outputting custom headers, especially if you send your own "Content-Type" header.	# `true`
`public static string`	`$ScriptFilename` Full path of the actual PHP script being run Like "/home/www/htdocs/folder/script.php" on Linux/Unix or "c:\inetpub\wwwroot" on Windows Full path of the actual PHP script being run Like "/home/www/htdocs/folder/script.php" on Linux/Unix or "c:\inetpub\wwwroot" on Windows	#
`public static string`	`$ScriptName` Web-relative path of the actual PHP script being run So for "http://www.domain.com/folder/script.php", QApplication::$ScriptName would be "/folder/script.php" Web-relative path of the actual PHP script being run So for "http://www.domain.com/folder/script.php", QApplication::$ScriptName would be "/folder/script.php"	#
`public static string`	`$PathInfo` Extended Path Information after the script URL (if applicable) So for "http://www.domain.com/folder/script.php/15/225" QApplication::$PathInfo would be "/15/255" Extended Path Information after the script URL (if applicable) So for "http://www.domain.com/folder/script.php/15/225" QApplication::$PathInfo would be "/15/255"	#
`public static string`	`$QueryString` Query String after the script URL (if applicable) So for "http://www.domain.com/folder/script.php?item=15&value=22" QApplication::$QueryString would be "item=15&value=22" Query String after the script URL (if applicable) So for "http://www.domain.com/folder/script.php?item=15&value=22" QApplication::$QueryString would be "item=15&value=22"	#
`public static string`	`$RequestUri` The full Request URI that was requested So for "http://www.domain.com/folder/script.php/15/25/?item=15&value=22" QApplication::$RequestUri would be "/folder/script.php/15/25/?item=15&value=22" The full Request URI that was requested So for "http://www.domain.com/folder/script.php/15/25/?item=15&value=22" QApplication::$RequestUri would be "/folder/script.php/15/25/?item=15&value=22"	#
`public static string`	`$ServerAddress` The IP address of the server running the script/PHP application This is either the LOCAL_ADDR or the SERVER_ADDR server constant, depending on the server type, OS and configuration. The IP address of the server running the script/PHP application This is either the LOCAL_ADDR or the SERVER_ADDR server constant, depending on the server type, OS and configuration.	#
`public static string`	`$EncodingType` The encoding type for the application (e.g. UTF-8, ISO-8859-1, etc.) The encoding type for the application (e.g. UTF-8, ISO-8859-1, etc.)	# `"UTF-8"`
`public static string`	`$ContentType` The content type to output. The content type to output.	# `"text/html"`
`public static QDatabaseBase[]`	`$Database` An array of Database objects, as initialized by QApplication::InitializeDatabaseConnections() An array of Database objects, as initialized by QApplication::InitializeDatabaseConnections()	#
`public static boolean`	`$CliMode` A flag to indicate whether or not this script is run as a CLI (Command Line Interface) A flag to indicate whether or not this script is run as a CLI (Command Line Interface)	#
`public static array`	`$ClassFile` Class File Array - used by QApplication::AutoLoad to more quickly load core class objects without making a file_exists call. Class File Array - used by QApplication::AutoLoad to more quickly load core class objects without making a file_exists call.	#
`public static array`	`$PreloadedClassFile` Preloaded Class File Array - used by QApplication::Initialize to load any core class objects during Initailize() Preloaded Class File Array - used by QApplication::Initialize to load any core class objects during Initailize()	#
`public static string`	`$RequestMode` The QRequestMode enumerated value for the current request mode The QRequestMode enumerated value for the current request mode	#
`public static string`	`$CountryCode` 2-letter country code to set for internationalization and localization (e.g. us, uk, jp) 2-letter country code to set for internationalization and localization (e.g. us, uk, jp)	#
`public static string`	`$LanguageCode` 2-letter language code to set for internationalization and localization (e.g. en, jp, etc.) 2-letter language code to set for internationalization and localization (e.g. en, jp, etc.)	#
`public static QTranslationBase`	`$LanguageObject` The instance of the active QI18n object (which contains translation strings), if any. The instance of the active QI18n object (which contains translation strings), if any.	#
`public static boolean`	`$Minimize` True to force drawing to be minimized. True to force drawing to be minimized.	# `false`
`public static null\|array;`	`$JavascriptExclusiveCommand` If this particular item is set, we ensure that this command, and only this command will get invoked on the next response. The rest of the commands will wait until the next response. If this particular item is set, we ensure that this command, and only this command will get invoked on the next response. The rest of the commands will wait until the next response.	# `null`
`protected static array`	`$JavascriptCommandArray` A structured array of commands to be sent to either the ajax response, or page output. Replaces the AlertMessageArray, JavaScriptArray, JavaScriptArrayHighPriority, and JavaScriptArrayLowPriority. A structured array of commands to be sent to either the ajax response, or page output. Replaces the AlertMessageArray, JavaScriptArray, JavaScriptArrayHighPriority, and JavaScriptArrayLowPriority.	# `array()`
`protected static array`	`$JavascriptFileArray` JS files to be added to the list of files in front of the javascript commands. Should include jquery, etc. JS files to be added to the list of files in front of the javascript commands. Should include jquery, etc.	# `array()`
`public static boolean`	`$ErrorFlag` Used to determine if an error has occurred Used to determine if an error has occurred	# `false`

Packages

Classes

Interfaces

Traits

Exceptions

Functions

Class QApplicationBase

Throws

Throws

Parameters

Returns

Throws

Parameters

Returns

Parameters

Throws

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Returns

Parameters

Returns

Parameters

Returns

Parameters

Deprecated

Parameters

Throws

Parameters

Parameters

Throws

Parameters

Parameters

Parameters

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns