Class: PhpExt_Data_FieldConfigObject

Source Location: /PhpExt/Data/FieldConfigObject.php

Class PhpExt_Data_FieldConfigObject

Class Overview

Located in /PhpExt/Data/FieldConfigObject.php [line 24]

PhpExt_Object
   |
   --PhpExt_Config_ConfigObject
      |
      --PhpExt_Data_FieldConfigObject

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From PhpExt_Config_ConfigObject

PhpExt_Config_ConfigObject::$_options

Inherited From PhpExt_Object

PhpExt_Object::$_extClassName

PhpExt_Object::$_extConfigProperties

PhpExt_Object::$_validExtConfigProperties

PhpExt_Object::$_varName

Inherited From PhpExt_Config_ConfigObject

PhpExt_Config_ConfigObject::__construct()

PhpExt_Config_ConfigObject::getJavascript()

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 ]

Constant Summary

SORT_DIR_ASC
SORT_DIR_DESC
TYPE_AUTO
TYPE_BOOLEAN
TYPE_DATE
TYPE_FLOAT
TYPE_INT
TYPE_STRING

[ Top ]

Method Summary

PhpExt_Data_FieldConfigObject	__construct()
JavascriptStm	getConvert()	(Optional) A function which converts the value provided by the Reader into an object that will be stored in the Record. It is passed the following parameters: v : Mixed The data value as read by the Reader.
string	getDateFormat()	(Optional) A format String for the Date.parseDate function.
string	getMapping()	(Optional) A path specification for use by the Ext.data.Reader implementation that is creating the Record to access the data value from the data object. If an Ext.data.JsonReader is being used, then this is a string containing the javascript expression to reference the data relative to the record item's root. If an Ext.data.XmlReader is being used, this is an Ext.DomQuery path to the data item relative to the record element. If the mapping expression is the same as the field name, this may be omitted.
string	getName()	The name by which the field is referenced within the Record. This is referenced by, for example the dataIndex property in column definition objects passed to Ext.grid.ColumnModel
string	getSortDir()	(Optional) Initial direction to sort. PhpExt_Data_FieldObjectConfig::SORT_DIR_ASC or PhpExt_Data_FieldObjectConfig::SORT_DIR_DESC
string	getSortType()	(Optional) A member of Ext.data.SortTypes.
string	getType()	(Optional) The data type for conversion to displayable value. Possible values are
PhpExt_Data_FieldConfigObject	setConvert()	(Optional) A function which converts the value provided by the Reader into an object that will be stored in the Record. It is passed the following parameters: v : Mixed The data value as read by the Reader.
PhpExt_Data_FieldConfigObject	setDateFormat()	(Optional) A format String for the Date.parseDate function.
PhpExt_Data_FieldConfigObject	setMapping()	(Optional) A path specification for use by the Ext.data.Reader implementation that is creating the Record to access the data value from the data object. If an Ext.data.JsonReader is being used, then this is a string containing the javascript expression to reference the data relative to the record item's root. If an Ext.data.XmlReader is being used, this is an Ext.DomQuery path to the data item relative to the record element. If the mapping expression is the same as the field name, this may be omitted.
PhpExt_Data_FieldConfigObject	setName()	The name by which the field is referenced within the Record. This is referenced by, for example the dataIndex property in column definition objects passed to Ext.grid.ColumnModel
PhpExt_Data_FieldObjectConfig	setSortDir()	(Optional) Initial direction to sort. PhpExt_Data_FieldObjectConfig::SORT_DIR_ASC or PhpExt_Data_FieldObjectConfig::SORT_DIR_DESC
PhpExt_Data_FieldConfigObject	setSortType()	(Optional) A member of Ext.data.SortTypes.
PhpExt_Data_FieldConfigObject	setType()	(Optional) The data type for conversion to displayable value. Possible values are

[ Top ]

Properties

Methods

Constructor __construct [line 193]

PhpExt_Data_FieldConfigObject __construct(

$name, [
$mapping = null], [
$type = null], [
$dateFormat = null], [
$sortType = null], [
$sortDir = null], [
$convert = null] 
)

Parameters:

	$name:
	$mapping:
	$type:
	$dateFormat:
	$sortType:
	$sortDir:
	$convert:

API Tags:

Access:

public

Redefinition of:

PhpExt_Config_ConfigObject::__construct()

[ Top ]

getConvert [line 169]

JavascriptStm getConvert(
)

(Optional) A function which converts the value provided by the Reader into an object that will be stored in the Record. It is passed the following parameters:

v : Mixed The data value as read by the Reader.

API Tags:

Access:

public

[ Top ]

getDateFormat [line 189]

string getDateFormat(
)

(Optional) A format String for the Date.parseDate function.

API Tags:

Access:

public

[ Top ]

getMapping [line 69]

string getMapping(
)

(Optional) A path specification for use by the Ext.data.Reader implementation that is creating the Record to access the data value from the data object. If an Ext.data.JsonReader is being used, then this is a string containing the javascript expression to reference the data relative to the record item's root. If an Ext.data.XmlReader is being used, this is an Ext.DomQuery path to the data item relative to the record element. If the mapping expression is the same as the field name, this may be omitted.

API Tags:

Access:

public

[ Top ]

getName [line 51]

string getName(
)

The name by which the field is referenced within the Record. This is referenced by, for example the dataIndex property in column definition objects passed to Ext.grid.ColumnModel

API Tags:

Access:

public

[ Top ]

getSortDir [line 145]

string getSortDir(
)

(Optional) Initial direction to sort. PhpExt_Data_FieldObjectConfig::SORT_DIR_ASC or PhpExt_Data_FieldObjectConfig::SORT_DIR_DESC

API Tags:

See:	PhpExt_Data_FieldObjectConfig::SORT_DIR_ASC
See:	PhpExt_Data_FieldObjectConfig::SORT_DIR_DESC
Access:	public

[ Top ]

getSortType [line 119]

string getSortType(
)

(Optional) A member of Ext.data.SortTypes.

API Tags:

Access:

public

[ Top ]

getType [line 101]

string getType(
)

(Optional) The data type for conversion to displayable value. Possible values are

PhpExt_Data_FieldConfigObject::TYPE_AUTO (Default, implies no conversion)
PhpExt_Data_FieldConfigObject::TYPE_STRING
PhpExt_Data_FieldConfigObject::TYPE_INT
PhpExt_Data_FieldConfigObject::TYPE_FLOAT
PhpExt_Data_FieldConfigObject::TYPE_BOOLEAN
PhpExt_Data_FieldConfigObject::TYPE_DATE

API Tags:

Access:

public

[ Top ]

setConvert [line 158]

PhpExt_Data_FieldConfigObject setConvert(
$value
$value 
)

(Optional) A function which converts the value provided by the Reader into an object that will be stored in the Record. It is passed the following parameters:

v : Mixed The data value as read by the Reader.

Parameters:

$value

$value:

JavascriptStm

API Tags:

Access:

public

[ Top ]

setDateFormat [line 180]

PhpExt_Data_FieldConfigObject setDateFormat(
string
$value 
)

(Optional) A format String for the Date.parseDate function.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setMapping [line 61]

PhpExt_Data_FieldConfigObject setMapping(
string
$value 
)

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setName [line 43]

PhpExt_Data_FieldConfigObject setName(
string
$value 
)

The name by which the field is referenced within the Record. This is referenced by, for example the dataIndex property in column definition objects passed to Ext.grid.ColumnModel

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setSortDir [line 133]

PhpExt_Data_FieldObjectConfig setSortDir(
string
$value 
)

(Optional) Initial direction to sort. PhpExt_Data_FieldObjectConfig::SORT_DIR_ASC or PhpExt_Data_FieldObjectConfig::SORT_DIR_DESC

Parameters:

string

$value:

API Tags:

See:	PhpExt_Data_FieldObjectConfig::SORT_DIR_ASC
See:	PhpExt_Data_FieldObjectConfig::SORT_DIR_DESC
Access:	public

[ Top ]

setSortType [line 111]

PhpExt_Data_FieldConfigObject setSortType(
string
$value 
)

(Optional) A member of Ext.data.SortTypes.

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

setType [line 86]

PhpExt_Data_FieldConfigObject setType(
string
$value 
)

(Optional) The data type for conversion to displayable value. Possible values are

Parameters:

string

$value:

API Tags:

Access:

public

[ Top ]

Constants

SORT_DIR_ASC = 'ASC' [line 33]

[ Top ]

SORT_DIR_DESC = 'DESC' [line 34]

[ Top ]

TYPE_AUTO = 'auto' [line 26]

[ Top ]

TYPE_BOOLEAN = 'bool' [line 30]

[ Top ]

TYPE_DATE = 'date' [line 31]

[ Top ]

TYPE_FLOAT = 'float' [line 29]

[ Top ]

TYPE_INT = 'int' [line 28]

[ Top ]

TYPE_STRING = 'string' [line 27]

[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:53:32 -0500 by phpDocumentor 1.4.0