Class XmlElement
The XML Element
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: xml.php
Inherited Properties
Method Summary
-
__construct() public
Construct an Xml element -
addAttribute() public
Add attributes to this element -
attributes() public
Get all the attributes for this element -
removeAttribute() public
Remove attributes to this element
Method Detail
__construct() public ¶
__construct( string $name = null , string $value = null , array $attributes = array() , string $namespace = false )
Construct an Xml element
Parameters
- string $name optional null
- name of the node
- string $value optional null
- value of the node
- array $attributes optional array()
- string $namespace optional false
Returns
A copy of $data in XML format
Overrides
addAttribute() public ¶
addAttribute( string $name , string $val = null )
Add attributes to this element
Parameters
- string $name
- name of the node
- string $val optional null
- $value value of the node
Returns
removeAttribute() public ¶
removeAttribute( string $attr )
Remove attributes to this element
Parameters
- string $attr
- $name name of the node
Returns
Methods inherited from XmlNode
__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
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 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
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
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
An array of XmlNodes with the given tag name
compare() public ¶
compare( object $node )
Compares $node to this XmlNode object
Parameters
- object $node
- XmlNode or subclass instance
Returns
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
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
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
XmlTextNode
document() public ¶
document( )
Returns the XML document to which this node belongs
Returns
Parent XML object
hasChildren() public ¶
hasChildren( )
Returns true if this structure has child nodes.
Returns
nextSibling() public ¶
nextSibling( )
Gets a reference to the next child node in the list of this node's parent.
Returns
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
Properties from object
previousSibling() public ¶
previousSibling( )
Gets a reference to the previous child node in the list of this node's parent.
Returns
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
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 representation
toString() public ¶
toString( $options = array() , $depth = 0 )
Returns this XML structure as a string.
Returns
String representation of the XML structure.
Overrides
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
__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
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
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. Will only set properties that are part of a class declaration.
Parameters
- array $properties optional array()
- An associative array containing properties and corresponding values.
_stop() public ¶
_stop( $status = 0 )
Stop execution of the current script. Wraps exit() making testing easier.
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
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
Parameters
- string $method
- Name of the method to call
- array $params optional array()
- Parameter list to use when calling $method
Returns
Returns the result of the method call
log() public ¶
log( string $msg , integer $type = LOG_ERROR )
Convience method to write a message to CakeLog. See CakeLog::write() for more information on writing to logs.
Parameters
- string $msg
- Log message
- integer $type optional LOG_ERROR
- Error type constant. Defined in app/config/core.php.
Returns
Success of log write
requestAction() public ¶
requestAction( mixed $url , array $extra = array() )
Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.
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
Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.