Class: PhpExt_Data_XmlReader

Source Location: /PhpExt/Data/XmlReader.php

Class PhpExt_Data_XmlReader

Class Overview

Data reader class to create an Array of Ext.data.Record objects from an XML document based on mappings in a provided Ext.data.Record constructor.

Note that in order for the browser to parse a returned XML document, the Content-Type header in the HTTP response must be set to "text/xml".

Example code:

$myReader = new PhpExt_Data_XmlReader()
$myReader->setTotalRecords("results") // The element which contains the total dataset size (optional)
$myReader->setRecord("row"); // The repeated element which contains row information
$myReader->setId("id"); // The element within the row that provides an ID for the record (optional)
$myReader->addField(new PhpExt_Data_FieldConfigObject("name","name")); // "mapping" property not needed if it's the same as "name"
$myReader->addField(new PhpExt_Data_FieldConfigObject("occupation")); // This field will use "occupation" as the mapping.

This would consume an XML file like this:

<?xml ?>
<dataset>
<results>2</results>
<row>
<id>1</id>
<name>Bill</name>
<occupation>Gardener</occupation>
</row>
<row>
<id>2</id>
<name>Ben</name>
<occupation>Horticulturalist</occupation>
</row>
</dataset>

Located in /PhpExt/Data/XmlReader.php [line 55]

PhpExt_Object
   |
   --PhpExt_Data_DataReader
      |
      --PhpExt_Data_XmlReader

Methods

[ Top ]

Descendants

Child Class	Description
PhpExtUx_Form_XmlErrorReader

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PhpExt_Data_DataReader

PhpExt_Data_DataReader::$_fields

PhpExt_Data_DataReader::$_recordType

Inherited From PhpExt_Object

PhpExt_Object::$_extClassName

PhpExt_Object::$_extConfigProperties

PhpExt_Object::$_validExtConfigProperties

PhpExt_Object::$_varName

Inherited From PhpExt_Data_DataReader

PhpExt_Data_DataReader::__construct()

PhpExt_Data_DataReader::addField()

PhpExt_Data_DataReader::getField()

PhpExt_Data_DataReader::getFields()

Fields Collection

PhpExt_Data_DataReader::getJavascript()

PhpExt_Data_DataReader::getRecordType()

The Record type class for the reader. It will override the specified fields if available.

PhpExt_Data_DataReader::setRecordType()

The Record type class for the reader. It will override the specified fields if available.

Inherited From PhpExt_Object

PhpExt_Object::__construct()

PhpExt_Object::addValidConfigProperties()

PhpExt_Object::createMethodSignature()

PhpExt_Object::getConfigParams()

PhpExt_Object::getExtConfigProperty()

PhpExt_Object::getJavascript()

PhpExt_Object::getMethodInvokeStm()

PhpExt_Object::isExtObject()

PhpExt_Object::paramToString()

PhpExt_Object::setExtClassInfo()

PhpExt_Object::setExtConfigProperty()

PhpExt_Object::__get()

PhpExt_Object::__set()

[ Top ]

Method Summary

PhpExt_Data_XmlReader	__construct()
string	getId()	The DomQuery path relative from the record element to the element that contains a record identifier value.
string	getRecord()	The DomQuery path to the repeated element which contains record information.
string	getSuccess()	The DomQuery path to the success attribute used by forms.
string	getTotalRecords()	The DomQuery path from which to retrieve the total number of records in the dataset. This is only needed if the whole dataset is not passed in one go, but is being paged from the remote server.
PhpExt_Data_XmlReader	setId()	The DomQuery path relative from the record element to the element that contains a record identifier value.
PhpExt_Data_XmlReader	setRecord()	The DomQuery path to the repeated element which contains record information.
PhpExt_Data_XmlReader	setSuccess()	The DomQuery path to the success attribute used by forms.
PhpExt_Data_XmlReader	setTotalRecords()	The DomQuery path from which to retrieve the total number of records in the dataset. This is only needed if the whole dataset is not passed in one go, but is being paged from the remote server.

[ Top ]

Properties

Methods

Constructor __construct [line 130]

PhpExt_Data_XmlReader __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Data_DataReader::__construct()

Redefined in descendants as:

PhpExtUx_Form_XmlErrorReader::__construct()

[ Top ]

getId [line 71]

string getId(
)

The DomQuery path relative from the record element to the element that contains a record identifier value.

API Tags:

Access:

public

[ Top ]

getRecord [line 89]

string getRecord(
)

The DomQuery path to the repeated element which contains record information.

API Tags:

Access:

public

[ Top ]

getSuccess [line 107]

string getSuccess(
)

The DomQuery path to the success attribute used by forms.

API Tags:

Access:

public

[ Top ]

getTotalRecords [line 125]

string getTotalRecords(
)

The DomQuery path from which to retrieve the total number of records in the dataset. This is only needed if the whole dataset is not passed in one go, but is being paged from the remote server.

API Tags:

Access:

public

[ Top ]

setId [line 63]

PhpExt_Data_XmlReader setId(
string
$value 
)

The DomQuery path relative from the record element to the element that contains a record identifier value.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setRecord [line 81]

PhpExt_Data_XmlReader setRecord(
string
$value 
)

The DomQuery path to the repeated element which contains record information.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setSuccess [line 99]

PhpExt_Data_XmlReader setSuccess(
string
$value 
)

The DomQuery path to the success attribute used by forms.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setTotalRecords [line 117]

PhpExt_Data_XmlReader setTotalRecords(
string
$value 
)

The DomQuery path from which to retrieve the total number of records in the dataset. This is only needed if the whole dataset is not passed in one go, but is being paged from the remote server.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 08 Aug 2008 16:02:44 -0500 by phpDocumentor 1.4.0