Child classes:
- ImageDocument
- Virtual Web Platform - PNG Response Document
- XMLDocument
- Virtual Web Platform - XML Document support
- JSDocument
- Virtual Web Platform - JS Document support (Javascript)
- CSVDocument
- Virtual Web Platform - CSV Response Document
- HTMLDocument
- Virtual Web Platform - HTML Document support
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::__toString()
- Return object as a string
Class Details
Virtual Web Platform - Document support
This class provides the default API for Documents. This is the base class for all document types.
Registry keys can be used to add support
for new document types.
Client Key: DOCUMENT\Types\[doctype]
The registry key should have a value named 'location'
which is the file which will be loaded
when the document type is requested.
Required Headers:
VWP::RequireLibrary('vwp.documents.document');
Usage:
VDocument::RequireDocumentType(string $doctype);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
$debug_notices = array()
[line 125]
Tags:
- var - Debug notices
- access - public
Type: array
Overrides:
[ Top ]
$errors = array()
[line 104]
Tags:
- var - Errors
- access - public
Type: array
Overrides:
[ Top ]
$notices = array()
[line 111]
Tags:
- var - Notices
- access - public
Type: array
Overrides:
[ Top ]
$screens = array()
[line 157]
Screen buffer
Tags:
- var - Screens
- access - public
Type: array
Overrides:
[ Top ]
$scripts = array()
[line 134]
Scripts
Tags:
- var - Registered Scripts
- access - public
Type: array
Overrides:
[ Top ]
$warnings = array()
[line 118]
Tags:
- var - Warnings
- access - public
Type: array
Overrides:
[ Top ]
$_aliases = array()
[line 83]
Tags:
- var - Alias buffer
- access - public
Type: array
Overrides:
[ Top ]
$_attribs = array()
[line 97]
Tags:
- var - Attributes buffer
- access - public
Type: array
Overrides:
[ Top ]
$_escape = 'htmlentities'
[line 76]
Default escape function
Tags:
- access - public
Type: string
Overrides:
[ Top ]
$_meta = array()
[line 67]
Meta Data
Tags:
- var - Meta data
- access - public
Type: array
Overrides:
[ Top ]
$_require_secure_line = false
[line 141]
Tags:
- var - Require Secure Connection
- access - protected
Type: boolean
Overrides:
[ Top ]
$_widgets = array()
[line 90]
Tags:
- var - Widgets buffer
- access - public
Type: array
Overrides:
[ Top ]
Class Methods
static registerDocumentType
static void registerDocumentType(
$doctype, string
$location, string
$type)
[line 293]
Register Document Type
Tags:
- access - public
Parameters:
- string $type -
- string $location - Filename
- $doctype -
[ Top ]
static RequireDocumentType
static true|object True RequireDocumentType(
string
$doctype)
[line 344]
Require a document type
Tags:
- return - on success or error on failure
- access - public
Parameters:
- string $doctype - Document type
[ Top ]
__construct
VDocument __construct(
)
[line 466]
Class constructor
Tags:
- access - public
Overridden in child classes as:
- ImageDocument::__construct()
- Class constructor
- XMLDocument::__construct()
- Class constructor
- SOAPDocument::__construct()
- Class constructor
- JSDocument::__construct()
- Class constructor
- CSVDocument::__construct()
- Class constructor
- HTMLDocument::__construct()
- Class constructor
Overrides VObject::__construct() (Class Constructor)
Parameters:
[ Top ]
appendBuffer
void appendBuffer(
string
$screenId, string
$data)
[line 280]
Append screen buffer
Tags:
- access - public
Parameters:
- string $screenId - Screen ID
- string $data - Data
[ Top ]
createScreenBuffer
void createScreenBuffer(
array
$cfg)
[line 255]
Create a screen buffer
Tags:
- access - public
Parameters:
- array $cfg - Configuration settings
[ Top ]
divertUnsecureLine
void divertUnsecureLine(
)
[line 243]
Switch to a secure line
Tags:
- access - public
Overridden in child classes as:
- JSDocument::divertUnsecureLine()
- Switch to HTTPS
- HTMLDocument::divertUnsecureLine()
- Switch to HTTPS
Parameters:
[ Top ]
getBuffer
string &getBuffer(
string|false
$screenId)
[line 434]
Get data from buffer
Tags:
- return - Data
- access - public
Parameters:
- string|false $screenId - Screen ID
[ Top ]
getDocumentType
void getDocumentType(
)
[line 197]
Get Document Type
Overridden in child classes as:
- ImageDocument::getDocumentType()
- Get Document Type
Parameters:
[ Top ]
isSecureLine
boolean isSecureLine(
)
[line 232]
Test if current connection is secure
Tags:
- return - True if is a secure line
- access - public
Overridden in child classes as:
- JSDocument::isSecureLine()
- Test if this is a secure connection
- HTMLDocument::isSecureLine()
- Test if this is a secure connection
Parameters:
[ Top ]
registerDefaults
void registerDefaults(
)
[line 452]
Register default settings
Overridden in child classes as:
- ImageDocument::registerDefaults()
- Register Default Variables
- XMLDocument::registerDefaults()
- Register Default Variables
- JSDocument::registerDefaults()
- Register Default Variables
- CSVDocument::registerDefaults()
- Register Default Variables
- HTMLDocument::registerDefaults()
- Register Default Variables
Parameters:
[ Top ]
registerScript
void registerScript(
string
$uri, [string
$type = "text/javascript"])
[line 176]
Register Script
Tags:
- access - public
Parameters:
- string $uri - Script URI
- string $type - Script type
[ Top ]
render
void render(
)
[line 443]
Display document
Overridden in child classes as:
- ImageDocument::render()
- Display document
- XMLDocument::render()
- Display document
- SOAPDocument::render()
- Display document
- JSDocument::render()
- Display document
- CSVDocument::render()
- Display document
- HTMLDocument::render()
- Display document
Parameters:
[ Top ]
requireSecureLine
boolean requireSecureLine(
[boolean
$require = null])
[line 217]
Require secure line
Note: Use null for require field to return value without changing the current value
Tags:
- return - Current value of secure line requirement
Parameters:
- boolean $require - Require secure line
[ Top ]
setMetaData
void setMetaData(
$name,
$value)
[line 163]
Set Meta Data
Parameters:
- $name -
- $value -
[ Top ]
unregisterScript
void unregisterScript(
string
$uri)
[line 188]
Unregister Script
Tags:
- access - public
Parameters:
- string $uri - Script URI
[ Top ]