Class: PhpExt_Data_DataReader

Source Location: /PhpExt/Data/DataReader.php

Class PhpExt_Data_DataReader

Class Overview

Abstract base class for reading structured data from a data source and converting it into an object containing PhpExt_Data_Record objects and metadata for use by an PhpExt_Data_Store. This class is intended to be extended and should not be created directly. For existing implementations.

Located in /PhpExt/Data/DataReader.php [line 33]

PhpExt_Object
   |
   --PhpExt_Data_DataReader

Author(s):

API Tags:

See:	PhpExt_Data_XmlReader.
See:	PhpExt_Data_JsonReader
See:	PhpExt_Data_ArrayReader
Abstract:
Usedby:	PhpExt_Data_Store::setReader()
Usedby:	PhpExt_Form_FormPanel::setReader()
Usedby:	PhpExt_Form_FormPanel::setErrorReader()

Properties

Methods

[ Top ]

Descendants

Child Class	Description
PhpExt_Data_ArrayReader	Data reader class to create an Array of Ext.data.Record objects from an Array. Each element of that Array represents a row of data fields. The fields are pulled into a Record object using as a subscript, the mapping property of the field definition if it exists, or the field's ordinal position in the definition.
PhpExt_Data_JsonReader	Data reader class to create an Array of Ext.data.Record objects from a JSON response based on mappings in a provided Ext.data.Record constructor.
PhpExt_Data_XmlReader	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.

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PhpExt_Object

PhpExt_Object::$_extClassName

PhpExt_Object::$_extConfigProperties

PhpExt_Object::$_validExtConfigProperties

PhpExt_Object::$_varName

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 ]

Property Summary

PhpExt_Data_FieldConfigObjectCollection	$_fields
mixed	$_recordType

[ Top ]

Method Summary

PhpExt_Data_DataReader	__construct()
PhpExt_Data_FieldConfigObject	addField()
PhpExt_Data_FieldConfigObject	getField()
PhpExt_Data_FieldConfigObjectCollection	getFields()	Fields Collection
void	getJavascript()
string	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.

[ Top ]

Properties

PhpExt_Data_FieldConfigObjectCollection $_fields = null [line 38]

API Tags:

Access:

public

[ Top ]

mixed $_recordType = null [line 50]

API Tags:

Access:

protected

[ Top ]

Methods

Constructor __construct [line 69]

PhpExt_Data_DataReader __construct(
)

API Tags:

Access:

public

Redefinition of:

PhpExt_Object::__construct()

Redefined in descendants as:

[ Top ]

addField [line 80]

PhpExt_Data_FieldConfigObject addField(
PhpExt_Data_FieldConfigObject
$field 
)

Parameters:

PhpExt_Data_FieldConfigObject

$field:

API Tags:

Access:

public

[ Top ]

getField [line 88]

PhpExt_Data_FieldConfigObject getField(

$name 
)

Parameters:

$name:

API Tags:

Access:

public

[ Top ]

getFields [line 45]

PhpExt_Data_FieldConfigObjectCollection getFields(
)

Fields Collection

API Tags:

Access:

public

[ Top ]

getJavascript [line 92]

void getJavascript(
[
$lazy = false], [
$varName = null] 
)

Parameters:

	$lazy:
	$varName:

API Tags:

Access:

public

Redefinition of:

PhpExt_Object::getJavascript()

[ Top ]

getRecordType [line 64]

string getRecordType(
)

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

API Tags:

Access:

public

[ Top ]

setRecordType [line 56]

PhpExt_Data_DataReader setRecordType(
string
$value 
)

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

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:52:30 -0500 by phpDocumentor 1.4.0