Child classes:
- VShell
- Virtual Web Platform - Shell Interface
Inherited Variables
Class: VWidget
- VWidget::$baseurl
- VWidget::$height
- VWidget::$visible
- VWidget::$width
- VWidget::$_basePath
- VWidget::$_blockAccess
- VWidget::$_charset
- VWidget::$_defaultModel
- VWidget::$_defaultWidgetID
- VWidget::$_doTask
- VWidget::$_escape
- VWidget::$_format
- VWidget::$_id
- VWidget::$_layout
- VWidget::$_layoutExt
- VWidget::$_listener
- VWidget::$_methods
- VWidget::$_mode
- VWidget::$_models
- VWidget::$_output
- VWidget::$_params
- VWidget::$_parent_name
- VWidget::$_path
- VWidget::$_redirect
- VWidget::$_redirectMessage
- VWidget::$_redirectMessageType
- VWidget::$_require_secure_line
- VWidget::$_R_Id
- VWidget::$_task
- VWidget::$_taskMap
- VWidget::$_template
- VWidget::$_widgets
Inherited Constants
Inherited Methods
Class: VWidget
- VWidget::__construct()
- Class constructor
- VWidget::addHelperPath()
- Adds to the stack of helper script paths in LIFO order.
- VWidget::addModelPath()
- Adds to the stack of model paths in LIFO order.
- VWidget::addPath()
- Adds to the search path for templates and resources.
- VWidget::addTemplatePath()
- Adds to the stack of view script paths in LIFO order.
- VWidget::addWidgetPath()
- Add one or more view paths to the widget search stack, in LIFO order.
- VWidget::assign()
- Assigns variables to the widget
- VWidget::assignRef()
- Assign variable to the widget by reference
- VWidget::authorizeTask()
- Authorization check
- VWidget::blockAccess()
- Block access to widget
- VWidget::build()
- Build widget
- VWidget::display()
- Display the widget
- VWidget::escape()
- Escapes a value for output in a layout.
- VWidget::getClassPrefix()
- Method to get the base class name
- VWidget::getDefaultWidgetID()
- Get ID of default widget
- VWidget::getDisplay()
- Get display output for MWL based architecture
- VWidget::getFormat()
- Get Widget Output Format
- VWidget::getID()
- Method to get the widget name
- VWidget::getLayout()
- Get the layout.
- VWidget::getModel()
- Method to get a model object, loading it if required.
- VWidget::getParams()
- Get Parameters
- VWidget::getParentName()
- Method to get the widget parent name
- VWidget::getRequestListener()
- Get Request Listener
- VWidget::getResourceID()
- Get Resource ID
- VWidget::getService()
- Method to get a reference to the current widget and load it if necessary.
- VWidget::getTask()
- Get the last or current task performed by this widget
- VWidget::getTasks()
- Gets the available tasks
- VWidget::getWidget()
- Method to get a reference to the current widget and load it if necessary.
- VWidget::isVisible()
- Check widget visibility
- VWidget::loadHelper()
- Load a helper file
- VWidget::loadTemplate()
- Load a template file
- VWidget::noPHP()
- Replace PHP Tags
- VWidget::redirect()
- Redirects the browser or returns false if no redirect is set.
- VWidget::registerDefaultTask()
- Register the default task to perform if the requested task is not found.
- VWidget::registerTask()
- Register a task to a method
- VWidget::requireSecureLine()
- Require a secure line
- VWidget::runService()
- Run service request
- VWidget::runTask()
- Run selected task
- VWidget::setDefaultWidgetID()
- Set default widget ID
- VWidget::setEscape()
- Sets the _escape() callback.
- VWidget::setFormat()
- Set Widget Output Format
- VWidget::setLayout()
- Sets the layout name to use
- VWidget::setLayoutExt()
- Allows a different extension for the layout files to be used
- VWidget::setModel()
- Method to add a model to the widget.
- VWidget::setPath()
- Sets an entire array of search paths for templates or resources.
- VWidget::setRedirect()
- Set a URL for browser redirection.
- VWidget::setRequestListener()
- Set listener
- VWidget::setResourceID()
- Set Resource ID
- VWidget::setVisible()
- Set widget visibility
- VWidget::_createFileName()
- Create the filename for a resource.
- VWidget::_createModel()
- Method to load and return a model object.
- VWidget::_createWidget()
- Method to load and return a widget object. This method that uses a default set path to load the widget class file.
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::__toString()
- Return object as a string
Class Details
Virtual Web Platform - Application Type
This is the base class for Web Applications
The class name for the entry point of an application must use the naming convention [appname]Application and must extend the VApplication class.
The entry point for the application is the method main($argv,$env) where $argv are the virtual command line arguments, and $env is set of two dimensional environment variables $env[method][variable]. The entry point may be public or protected but should not be static or private.
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
static $_nosave_application_paths = array()
[line 99]
Tags:
- var - Loaded application paths
- access - protected
Type: array
Overrides:
[ Top ]
Class Methods
static getCurrent
static VApplication &getCurrent(
)
[line 133]
Get Current Application
Tags:
- return - Current Application
- access - public
Parameters:
[ Top ]
static getCurrentApplicationID
static string getCurrentApplicationID(
)
[line 202]
Get Current Application ID
Tags:
- return - Application ID
- access - public
Parameters:
[ Top ]
static getCurrentApplicationPath
static string getCurrentApplicationPath(
)
[line 223]
Get Current Application Path
Tags:
- return - Current application path
- access - public
Parameters:
[ Top ]
__construct
VApplication __construct(
[array
$config = array()])
[line 235]
Class Constructor
Tags:
- access - public
Overrides VWidget::__construct() (Class constructor)
Parameters:
- array $config - Configuration settings
[ Top ]
getBasePath
string getBasePath(
)
[line 145]
Get Application Path
Tags:
- return - Application path
- access - public
Parameters:
[ Top ]
getID
string getID(
)
[line 157]
Get Application Id
Tags:
- return - Application Id
- access - public
Overrides VWidget::getID() (Method to get the widget name)
Parameters:
[ Top ]
_execute
mixed _execute(
&$argv,
&$envp, array
$argv, array
$envp)
[line 173]
Execute Application - Internal
Tags:
- return - Application Return Value
- access - protected
Parameters:
- array $argv - Arguments
- array $envp - Environment
- &$argv -
- &$envp -
[ Top ]