Class: XMLDocument

Source Location: /libraries/vwp/documents/xml.php

Class Overview [line 67]

VType
   |
   --VObject
      |
      --VDocument
         |
         --XMLDocument

Virtual Web Platform - XML Document support

Author(s):

Version:

Copyright:

  • (c) Ralph Ritoch - All Rights Reserved

Variables

Constants

Methods


Child classes:

WSDLDocument
Virtual Web Platform - WSDL Document support
XSLDocument
Virtual Web Platform - XSL Document support
SOAPDocument
Virtual Web Platform - SOAP Document support

Inherited Methods

Class: VDocument

VDocument::__construct()
Class constructor
VDocument::appendBuffer()
Append screen buffer
VDocument::createScreenBuffer()
Create a screen buffer
VDocument::divertUnsecureLine()
Switch to a secure line
VDocument::getBuffer()
Get data from buffer
VDocument::getDocumentType()
Get Document Type
VDocument::isSecureLine()
Test if current connection is secure
VDocument::registerDefaults()
Register default settings
VDocument::registerDocumentType()
Register Document Type
VDocument::registerScript()
Register Script
VDocument::render()
Display document
VDocument::RequireDocumentType()
Require a document type
VDocument::requireSecureLine()
Require secure line
VDocument::setMetaData()
Set Meta Data
VDocument::unregisterScript()
Unregister Script

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 - XML Document support

This class provides the default API for XML Documents. This is the base class for all document types.

Tags:

[ Top ]


Class Variables

$document_title

[line 107]

Tags:

  • var - Document title
  • access - public

Type: string

Overrides:

[ Top ]

$page_title

[line 100]

Tags:

  • var - Page title
  • access - public

Type: string

Overrides:

[ Top ]

$site_name

[line 114]

Tags:

  • var - Site Name
  • access - public

Type: string

Overrides:

[ Top ]

$target =  null

[line 157]

Target

Tags:

  • access - public

Type: string

Overrides:

[ Top ]

$theme_path

[line 121]

Tags:

  • var - Theme path
  • access - public

Type: string

Overrides:

[ Top ]

$_charset =  "utf-8"

[line 139]

Character Set

Tags:

  • var - Charset
  • access - public

Type: $_charset

Overrides:

[ Top ]

$_escape = array('XMLDocument','xmlentities')

[line 77]

Default escape function

Tags:

  • access - public

Type: string

Overrides: Array

[ Top ]

$_headers = array()

[line 86]

HTTP Headers

Tags:

  • var - HTTP response headers
  • access - protected

Type: array

Overrides:

[ Top ]

$_mime_type =  "text/xml"

[line 130]

Mime Type

Tags:

  • var - Mime type
  • access - public

Type: $_mime_type

Overrides:

[ Top ]

$_templateDriver

[line 93]

Tags:

  • var - Template driver
  • access - protected

Type: object

Overrides:

[ Top ]

$_xml_doc =  null

[line 148]

XML Document

Tags:

  • var - XML Document
  • access - public

Type: DOMDocument

Overrides:

[ Top ]


Class Methods

static bagChildPrefixes

static void bagChildPrefixes( object $node, [array $bag = array()])

[line 217]

Bag Child Node Prefixes

Tags:

  • access - public

Parameters:

  • object $node - Node
  • array $bag - Bag

[ Top ]

static changeNamespacePrefix

static void changeNamespacePrefix( object $node, string $origPrefix, string $newPrefix, string $ns)

[line 292]

Change namespace prefix

Tags:

  • access - public

Parameters:

  • object $node -
  • string $origPrefix - Original prefix
  • string $newPrefix - New prefix
  • string $ns - Namespace

[ Top ]

static collectChildNodeNamespaces

static void collectChildNodeNamespaces( object $node)

[line 269]

Add XMLNS attributes to selected node

Tags:

  • access - public

Parameters:

  • object $node - Node

[ Top ]

static getElementAfter

static object getElementAfter( object $node)

[line 622]

Get Element After

Tags:

  • return - Node
  • access - public

Parameters:

  • object $node - Node

[ Top ]

static parseAttributes

static array parseAttributes( string $str)

[line 377]

Parse XML attributes

Tags:

  • return - Attributes
  • access - public

Parameters:

  • string $str - Source string

[ Top ]

static xmlentities

static string xmlentities( string $txt)

[line 642]

Encode string to XML data

Tags:

  • return - Encoded text
  • access - public

Parameters:

  • string $txt - Source text

[ Top ]

__construct

XMLDocument __construct( )

[line 861]

Class constructor

Tags:

  • access - public

Overridden in child classes as:

SOAPDocument::__construct()
Class constructor

Overrides VDocument::__construct() (Class constructor)

Parameters:

[ Top ]

getTarget

string getTarget( )

[line 166]

Get Target

Tags:

  • return - target
  • access - public

Parameters:

[ Top ]

getThemeTemplateFile

string getThemeTemplateFile( string $themePath)

[line 697]

Get theme Template

Tags:

  • return - Path to template
  • access - public

Overridden in child classes as:

WSDLDocument::getThemeTemplateFile()
Get theme Template
XSLDocument::getThemeTemplateFile()
Get theme Template

Parameters:

  • string $themePath - Theme Path

[ Top ]

header

void header( string $string, [boolean $replace = true])

[line 660]

Set HTTP response header

Tags:

  • access - public

Parameters:

  • string $string - Header
  • boolean $replace - Replace headers

[ Top ]

loadXML

boolean|object True loadXML( string $data)

[line 196]

Load XML from source

Tags:

  • return - on success, error or warning otherwise
  • access - public

Parameters:

  • string $data - XML Data

[ Top ]

loadXMLFile

boolean|obect loadXMLFile( string $filename)

[line 178]

Load XML From File

Tags:

  • return - True on success, error or warning otherwise
  • access - public

Parameters:

  • string $filename - Filename

[ Top ]

registerDefaults

void registerDefaults( )

[line 708]

Register Default Variables

Tags:

  • access - public

Overrides VDocument::registerDefaults() (Register default settings)

Parameters:

[ Top ]

render

void render( )

[line 736]

Display document

Tags:

  • access - public

Overridden in child classes as:

SOAPDocument::render()
Display document

Overrides VDocument::render() (Display document)

Parameters:

[ Top ]

sendHeaders

void sendHeaders( )

[line 675]

Send HTTP headers

Tags:

  • access - public

Parameters:

[ Top ]

_templateDriverCall

void _templateDriverCall( array $match)

[line 466]

Process template driver call

Tags:

  • access - public

Parameters:

  • array $match - Match data

[ Top ]


Class Constants


Documentation generated on Mon, 17 Jan 2011 01:57:45 -0600 by phpDocumentor 1.4.3