Class XmlNode

XML node.

Single XML node in an XML tree.

Object

XmlNode

Direct Subclasses

Package: cake\cake\libs
Since: CakePHP v .0.10.3.1400
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: The MIT License
Location: xml.php

Properties summary

$__parent public

XmlNode

Reference to parent node.
$attributes public

array

Attributes on this node
$children public

array

This node's children
$name public

string

Name of node
$namespace public

string

Node namespace
$namespaces public

array

Namespaces defined for this node and all child nodes
$value public

string

Value of node

Inherited Properties

_log

Method Summary

__construct() public

Constructor.
__tagOptions() public

Gets the tag-specific options for the given node name
__toString() public

Returns data from toString when this object is converted to a string.
_killParent() public

Debug method. Deletes the parent. Also deletes this node's children, if given the $recursive parameter.
addNamespace() public

Adds a namespace to the current node
append() public

Append given node as a child.
child() public

Returns child node with given ID.
children() public

Gets a list of childnodes with the given tag name.
cloneNode() public

Returns a copy of self.
compare() public

Compares $node to this XmlNode object
createElement() public

Creates an XmlElement object that can be appended to this document or a node in it
createNode() public

Creates an XmlNode object that can be appended to this document or a node in it
createTextNode() public

Creates an XmlTextNode object that can be appended to this document or a node in it
document() public

Returns the XML document to which this node belongs
first() public

Returns first child node, or null if empty.
hasChildren() public

Returns true if this structure has child nodes.
last() public

Returns last child node, or null if empty.
name() public

Returns the fully-qualified XML node name, with namespace
nextSibling() public

Gets a reference to the next child node in the list of this node's parent.
normalize() public

Gets the XML element properties from an object.
parent() public

Returns parent node.
previousSibling() public

Gets a reference to the previous child node in the list of this node's parent.
removeNamespace() public

Adds a namespace to the current node
setParent() public

Sets the parent node of this XmlNode.
toArray() public

Return array representation of current object.
toString() public

Returns this XML structure as a string.

Method Detail

__construct() public ¶

__construct( string $name = null , array $value = null , mixed $namespace = null , array $children ,… )

Constructor.

Parameters

string $name optional null: Node name
array $value optional null: $attributes Node attributes
mixed $namespace optional null: $value Node contents (text)
array $children ,…: Node children

Overrides

Object::__construct()

__tagOptions() public ¶

__tagOptions( string $name , string $option = null )

Gets the tag-specific options for the given node name

Parameters

string $name: XML tag name
string $option optional null: The specific option to query. Omit for all options

Returns

mixed
A specific option value if $option is specified, otherwise an array of all options

__toString() public ¶

__toString( )

Returns data from toString when this object is converted to a string.

Returns

string
String representation of this structure.

_killParent() public ¶

_killParent( boolean $recursive = true )

Debug method. Deletes the parent. Also deletes this node's children, if given the $recursive parameter.

Parameters

boolean $recursive optional true: Recursively delete elements.

addNamespace() public ¶

addNamespace( string $prefix , string $url )

Adds a namespace to the current node

Parameters

string $prefix: The namespace prefix
string $url: The namespace DTD URL

append() public ¶

append( object $child , array $options = array() )

Append given node as a child.

Parameters

object $child: XmlNode with appended child
array $options optional array(): XML generator options for objects and arrays

Returns

object
A reference to the appended child node

child() public ¶

child( string $id )

Returns child node with given ID.

Parameters

string $id: Name of child node

Returns

object
Child XmlNode

children() public ¶

children( string $name )

Gets a list of childnodes with the given tag name.

Parameters

string $name: Tag name of child nodes

Returns

array
An array of XmlNodes with the given tag name

cloneNode() public ¶

cloneNode( )

Returns a copy of self.

Returns

object
Cloned instance

compare() public ¶

compare( object $node )

Compares $node to this XmlNode object

Parameters

object $node: XmlNode or subclass instance

Returns

boolean
True if the nodes match, false otherwise

createElement() public ¶

createElement( string $name = null , string $value = null , array $attributes = array() , string $namespace = false )

Creates an XmlElement object that can be appended to this document or a node in it

Parameters

string $name optional null: Element name
string $value optional null: Element value
array $attributes optional array(): Element attributes
string $namespace optional false: Node namespace

Returns

object
XmlElement

createNode() public ¶

createNode( string $name = null , string $value = null , string $namespace = false )

Creates an XmlNode object that can be appended to this document or a node in it

Parameters

string $name optional null: Node name
string $value optional null: Node value
string $namespace optional false: Node namespace

Returns

object
XmlNode

createTextNode() public ¶

createTextNode( string $value = null )

Creates an XmlTextNode object that can be appended to this document or a node in it

Parameters

string $value optional null: Node value

Returns

object
XmlTextNode

document() public ¶

document( )

Returns the XML document to which this node belongs

Returns

object
Parent XML object

first() public ¶

first( )

Returns first child node, or null if empty.

Returns

object
First XmlNode

hasChildren() public ¶

hasChildren( )

Returns true if this structure has child nodes.

Returns

boolean

last() public ¶

last( )

Returns last child node, or null if empty.

Returns

object
Last XmlNode

name() public ¶

name( )

Returns the fully-qualified XML node name, with namespace

nextSibling() public ¶

nextSibling( )

Gets a reference to the next child node in the list of this node's parent.

Returns

object
A reference to the XmlNode object

normalize() public ¶

normalize( object $object , $keyName = null , $options = array() )

Gets the XML element properties from an object.

Parameters

object $object: Object to get properties from
$keyName optional null
$options optional array()

Returns

array
Properties from object

parent() public ¶

parent( )

Returns parent node.

Returns

object
Parent XmlNode

previousSibling() public ¶

previousSibling( )

Gets a reference to the previous child node in the list of this node's parent.

Returns

object
A reference to the XmlNode object

removeNamespace() public ¶

removeNamespace( string $prefix , string $url ,… )

Adds a namespace to the current node

Parameters

string $prefix: The namespace prefix
string $url ,…: The namespace DTD URL

setParent() public ¶

setParent( $parent )

Sets the parent node of this XmlNode.

toArray() public ¶

toArray( boolean $camelize = true )

Return array representation of current object.

Parameters

boolean $camelize optional true: true will camelize child nodes, false will not alter node names

Returns

array
Array representation

toString() public ¶

toString( $options = array() , $depth = 0 )

Returns this XML structure as a string.

Returns

string
String representation of the XML structure.

Overrides

Object::toString()

Methods inherited from Object

Object() public ¶

Object( )

A hack to support __construct() on PHP 4 Hint: descendant classes have no PHP4 class_name() constructors, so this constructor gets called first and calls the top-layer __construct() which (if present) should call parent::__construct()

Returns

Object

__openPersistent() public ¶

__openPersistent( string $name , string $type = null )

Open the persistent class file for reading Used by Object::_persist()

Parameters

string $name: Name of persisted class
string $type optional null: Type of persistance (e.g: registry)

_persist() public ¶

_persist( string $name , string $return , $object , $type = null )

Checks for a persistent class file, if found file is opened and true returned If file is not found a file is created and false returned If used in other locations of the model you should choose a unique name for the persistent file There are many uses for this method, see manual for examples

Parameters

string $name: name of the class to persist
string $return: $object the object to persist
$object
$type optional null

Returns

boolean
Success

_savePersistent() public ¶

_savePersistent( string $name , object $object )

You should choose a unique name for the persistent file

There are many uses for this method, see manual for examples

Parameters

string $name: name used for object to cache
object $object: the object to persist

Returns

boolean
true on save, throws error if file can not be created

_set() public ¶

_set( array $properties = array() )

Allows setting of multiple properties of the object in a single line of code.

Parameters

array $properties optional array(): An associative array containing properties and corresponding values.

_stop() public ¶

_stop( $status = 0 )

Stop execution of the current script

Parameters

$status optional 0: http://php.net/exit for values

cakeError() public ¶

cakeError( string $method , array $messages = array() )

Used to report user friendly errors. If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.

Parameters

string $method: Method to be called in the error class (AppError or ErrorHandler classes)
array $messages optional array(): Message that is to be displayed by the error class

Returns

error
message

dispatchMethod() public ¶

dispatchMethod( string $method , array $params = array() )

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array, and improves performance by using straight method calls in most cases.

Parameters

string $method: Name of the method to call
array $params optional array(): Parameter list to use when calling $method

Returns

mixed
Returns the result of the method call

log() public ¶

log( string $msg , integer $type = LOG_ERROR )

API for logging events.

Parameters

string $msg: Log message
integer $type optional LOG_ERROR: Error type constant. Defined in app/config/core.php.

Returns

boolean
Success of log write

requestAction() public ¶

requestAction( mixed $url , array $extra = array() )

Calls a controller's method from any location.

Parameters

mixed $url: String or array-based url.
array $extra optional array(): if array includes the key "return" it sets the AutoRender to true.

Returns

mixed

Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.

Properties detail

`$__parent` ¶

public XmlNode

Reference to parent node.

null

`$attributes` ¶

public array

Attributes on this node

array()

`$children` ¶

public array

This node's children

array()

`$name` ¶

public string

Name of node

null

`$namespace` ¶

public string

Node namespace

null

`$namespaces` ¶

public array

Namespaces defined for this node and all child nodes

array()

`$value` ¶

public string

Value of node

Classes

Functions

Class XmlNode

Direct Subclasses

Properties summary

Inherited Properties

Method Summary

__construct() public

__tagOptions() public

__toString() public

_killParent() public

addNamespace() public

append() public

child() public

children() public

cloneNode() public

compare() public

createElement() public

createNode() public

createTextNode() public

document() public

first() public

hasChildren() public

last() public

name() public

nextSibling() public

normalize() public

parent() public

previousSibling() public

removeNamespace() public

setParent() public

toArray() public

toString() public

Method Detail

__construct() public ¶

Parameters

Overrides

__tagOptions() public ¶

Parameters

Returns

__toString() public ¶

Returns

_killParent() public ¶

Parameters

addNamespace() public ¶

Parameters

append() public ¶

Parameters

Returns

child() public ¶

Parameters

Returns

children() public ¶

Parameters

Returns

cloneNode() public ¶

Returns

compare() public ¶

Parameters

Returns

createElement() public ¶

Parameters

Returns

createNode() public ¶

Parameters

Returns

createTextNode() public ¶

Parameters

Returns

document() public ¶

Returns

first() public ¶

Returns

hasChildren() public ¶

Returns

last() public ¶

Returns

name() public ¶

nextSibling() public ¶

Returns