Inherited Variables
Inherited Constants
Inherited Methods
Class: VObject
- VObject::__construct()
- Class Constructor
- VObject::bind()
- Bind values to this object
- VObject::delete()
- Delete Object
- VObject::get()
- Get value
- VObject::getAll()
- Get all object values
- VObject::getError()
- Get error message
- VObject::getErrors()
- Get errors
- VObject::getMethods()
- Get object methods
- VObject::getProperties()
- Get object properties
- VObject::save()
- Save Object
- VObject::set()
- Set a value
- VObject::setError()
- Set error value
- VObject::setProperties()
- Set property values
- VObject::setProperty()
- Set property value
- VObject::toString()
- Convert object to string
- VObject::__destruct()
- Class Destructor
- VObject::__get()
- VObject::__isset()
- VObject::__set()
- VObject::__toString()
- Return object as a string
- VObject::__unset()
Class Details
Virtual Web Platform - System Interface
This file provides the primary core system interface
Tags:
- author - Ralph Ritoch <rritoch@gmail.com>
- copyright - (c) Ralph Ritoch - All Rights Reserved
- link - VNetPublishing.Com
- license - VNETLPL Limited Public License
[ Top ]
Class Variables
$_document
[line 54]
Current Document
Tags:
- access - public
Type: obect
Overrides:
[ Top ]
$_kernel = null
[ Top ]
Class Methods
static addCleanupTask
static void addCleanupTask(
string|array
$taskFunc, [string|array
$abortFunc = null])
[line 298]
Add Cleanup Task
Tags:
- access - public
Parameters:
- string|array $taskFunc - Task function
- string|array $abortFunc - Abort Function
[ Top ]
static addNotice
static boolean addNotice(
string
$msg)
[line 463]
Add a new system notice
Tags:
- return - True on success
- access - public
Parameters:
- string $msg - System notice
[ Top ]
static add_application_path
static void add_application_path(
string
$path)
[line 520]
Add an application path
Tags:
- access - public
Parameters:
- string $path - Application path
[ Top ]
static add_library_path
static void add_library_path(
string
$path)
[line 505]
Add a library path
Tags:
- access - public
Parameters:
- string $path - Library path
[ Top ]
static debug
static void debug(
string
$debug_msg, [string
$errfile = null], [integer
$errline = null])
[line 490]
Add debug notice
Tags:
- access - public
Parameters:
- string $debug_msg - Debug message
- string $errfile - Source filename
- integer $errline - Source line number
[ Top ]
static dispatchError
static boolean dispatchError(
integer
$errno, string
$errstr, [string
$errfile = null], [integer
$errline = null])
[line 1141]
System error handler
Tags:
- return - True to supress default system error handling
- access - public
Parameters:
- integer $errno - Error number
- string $errstr - Error message
- string $errfile - Error filename
- integer $errline - Line error occurred
[ Top ]
static document
static VDocument &document(
)
[line 860]
Current document Vector
Tags:
- return - Current Document
- access - public
Parameters:
[ Top ]
static ethrow
static object Error ðrow(
&$error, object
$error)
[line 646]
Throw an error or warning
Tags:
- return - or warning
- access - public
Parameters:
- object $error - Error or warning
- &$error -
[ Top ]
static getConfig
static VConfig &getConfig(
)
[line 368]
Get configuration object
Tags:
- return - Configuration object
- access - public
Parameters:
[ Top ]
static getDebugNotices
static array getDebugNotices(
)
[line 476]
Get debug notices
Tags:
- return - system notices
- access - public
Parameters:
[ Top ]
static getDocument
static VDocument &getDocument(
)
[line 848]
Get current document
Tags:
- return - Current Document
- access - public
Parameters:
[ Top ]
static getErrorMessages
static array getErrorMessages(
)
[line 426]
Get system error messages
Tags:
- return - Error messages
- access - public
Parameters:
[ Top ]
static getInstance
static VWP &getInstance(
)
[line 957]
Get instance of VWP object
Tags:
- return - Instance of VWP object
- access - public
Parameters:
[ Top ]
static getLanguage
static object Language &getLanguage(
)
[line 614]
Get current language
Tags:
- access - public
Parameters:
[ Top ]
static getLastError
static object Last getLastError(
)
[line 402]
Get last error
Tags:
- return - Error
- access - public
Parameters:
[ Top ]
static getNotices
static array getNotices(
)
[line 450]
Get system notices
Tags:
- return - System notices
- access - public
Parameters:
[ Top ]
static getPaths
static array getPaths(
string
$type)
[line 537]
Get a path list
Tags:
- return - Path list
- access - public
Parameters:
- string $type - Path type
[ Top ]
static getRedirectURL
static string getRedirectURL(
)
[line 235]
Get Redirect URL
Tags:
- return - Redirect URL
- access - public
Parameters:
[ Top ]
static getShell
static VShell &getShell(
)
[line 927]
Get Current Shell
Tags:
- return - Current Shell Object
- access - public
Parameters:
[ Top ]
static getTheme
static string getTheme(
)
[line 552]
Get current theme
Tags:
- return - Theme Name
- access - public
Parameters:
[ Top ]
static getThemeType
static string getThemeType(
)
[line 569]
Get Theme Type
Tags:
- return - Theme Type
- access - public
Parameters:
[ Top ]
static getVarPath
static void getVarPath(
[string
$app = null])
[line 385]
Get Applications Var Path
Tags:
- access - public
Parameters:
- string $app - Application name
[ Top ]
static getWarnings
static array getWarnings(
)
[line 438]
Get system warnings
Tags:
- return - System warnings
- access - public
Parameters:
[ Top ]
static isError
static boolean isError(
mixed
$ob)
[line 704]
Test if value is an error
Tags:
- return - True if test subject is an error
- access - public
Parameters:
- mixed $ob - Test subject
[ Top ]
static isWarning
static boolean isWarning(
mixed
$ob)
[line 717]
Test if value is a warning
Tags:
- return - True if test subject is a warning or error
- access - public
Parameters:
- mixed $ob - Test subject
[ Top ]
static is_associative
static boolean is_associative(
mixed
$array)
[line 1118]
Test if is an associative array
Tags:
- return - True if data is an associative array
- access - public
Parameters:
- mixed $array -
[ Top ]
static libraryExists
static boolean libraryExists(
string
$lib)
[line 818]
Test if library exists
Note: Library names are in the form of libname.[subs].interfacename
Tags:
- return - True if library found
- access - public
Parameters:
- string $lib - Library name
[ Top ]
static noStop
static void noStop(
[boolean
$blockStop = true])
[line 310]
Continue processing after connection closes
Tags:
- access - public
Parameters:
- boolean $blockStop - Continue after connection closes
[ Top ]
static noWarn
static void noWarn(
[boolean
$status = true])
[line 414]
Set block next warning status
Tags:
- access - public
Parameters:
- boolean $status - True to block reporting system warning
[ Top ]
static o
static VWP &o(
)
[line 940]
Access Mainframe object
Tags:
- return - Mainframe object
- access - public
Parameters:
[ Top ]
static pause
static void pause(
)
[line 341]
Pause VWP Application
Tags:
- access - public
Parameters:
[ Top ]
static raiseError
static object Error raiseError(
string
$msg, [string
$system = null], [integer
$errno = null], [boolean
$throw = true])
[line 669]
Generate a system error
Tags:
- access - public
Parameters:
- string $msg - Error message
- string $system - Error system
- integer $errno - Error number
- boolean $throw - Throw error
[ Top ]
static raiseWarning
static object Error raiseWarning(
string
$msg, [string
$system = null], [integer
$errno = null], [boolean
$throw = true])
[line 688]
Generate a system warning
Tags:
- access - public
Parameters:
- string $msg - Error message
- string $system - Error system
- integer $errno - Error number
- boolean $throw - Throw error
[ Top ]
static redirect
static void redirect(
string
$url)
[line 221]
Set Redirect
Tags:
- access - public
Parameters:
- string $url - Redirect URL
[ Top ]
static RequireExtension
static boolean|object True RequireExtension(
string
$ext, [boolean
$throw = true])
[line 743]
Require a PHP Extension
Tags:
- return - on success, error or warning otherwise
- access - public
Parameters:
- string $ext - PHP Extension ID
- boolean $throw - Throw warning on railure
[ Top ]
static RequireLibrary
static true|object True RequireLibrary(
string
$lib)
[line 778]
Require a system library
Note: Library names are in the form of libname.[subs].interfacename
Tags:
- return - on success or error on failure
- access - public
Parameters:
- string $lib - Library name
[ Top ]
static resetTimeLimit
static void resetTimeLimit(
)
[line 272]
Reset time limit
Restores the time limit to the value set when the first VWP object was created.
Tags:
- access - public
Parameters:
[ Top ]
static resume
static void resume(
)
[line 355]
Resume VWP Application
Tags:
- access - public
Parameters:
[ Top ]
static setStrict
static void setStrict(
[boolean
$val = true])
[line 326]
Set Strict PHP Mode
Tags:
- access - public
Parameters:
- boolean $val - Strict Mode
[ Top ]
static setTheme
static string setTheme(
string
$type, [string
$theme = null])
[line 587]
Set current theme
Tags:
- return - Old theme name
- access - public
Parameters:
- string $type - Theme type
- string $theme - Theme name
[ Top ]
static setTimeLimit
static integer|object Previous setTimeLimit(
integer
$timeout)
[line 247]
Set time limit
Tags:
- return - value on success, error or warning on failure
- access - public
Parameters:
- integer $timeout - Seconds
[ Top ]
static vexit
static void vexit(
[string
$message = 'Halt!'])
[line 729]
System Abort
Tags:
- access - public
Parameters:
- string $message - Abort message
[ Top ]
__construct
VWP __construct(
)
[line 1266]
Class Constructor
Tags:
- access - public
Overrides VObject::__construct() (Class Constructor)
Parameters:
[ Top ]
__destruct
void __destruct(
)
[line 1318]
Class Destructor
Tags:
- access - public
Overrides VObject::__destruct() (Class Destructor)
Parameters:
[ Top ]
dbi
VDBI &dbi(
)
[line 890]
Database Vector
Usage: v()->dbi()->
Tags:
- return - Database Interface
- access - public
Parameters:
[ Top ]
dispatch
void dispatch(
)
[line 1031]
Dispatch user request
Note: This should be called by the script entry point, normally index.php
Tags:
- access - public
Parameters:
[ Top ]
dom
VDOMImplementationRegistry &dom(
)
[line 1237]
DOM Implementation Registry
Tags:
- return - DOM Implementation Registry
- access - public
Parameters:
[ Top ]
execute
mixed execute(
$command,
&$envp, string
$app, array
$envp)
[line 980]
Execute an application
This execute function places the output of the buffer into the current documents buffer and returns the value returned by the application.
Tags:
- return - Result
- access - public
Parameters:
- string $app - Application ID
- array $envp - System environment
- $command -
- &$envp -
[ Top ]
filesystem
VFilesystem &filesystem(
[object
$driver = null], [
$test = false])
[line 907]
Filesystem
Tags:
- return - Filesystem
- access - public
Parameters:
- object $driver -
- $test -
[ Top ]
session
void &session(
)
[line 1254]
Current Session
Tags:
- access - public
Parameters:
[ Top ]
shell
VShell &shell(
)
[line 874]
Shell Vector
Usage: v()->shell()->
Tags:
- return - Current Shell
- access - public
Parameters:
[ Top ]
version
string version(
)
[line 1295]
Get Version
Tags:
- return - Version
- access - public
Parameters:
[ Top ]
version_status
string version_status(
)
[line 1307]
Get Version Status
Tags:
- return - Version
- access - public
Parameters:
[ Top ]