PhpExt : Data [ class tree ] [ index ] [ all elements ]

Class: PhpExt_Data_SortInfoConfigObject

Source Location: /PhpExt/Data/SortInfoConfigObject.php

Class PhpExt_Data_SortInfoConfigObject

Class Overview

Sort Info Config Object for SortInfo property in PhpExt_Data_Store

Located in /PhpExt/Data/SortInfoConfigObject.php [line 26]

PhpExt_Object
   |
   --PhpExt_Config_ConfigObject
      |
      --PhpExt_Data_SortInfoConfigObject
Author(s):
API Tags:
See:  PhpExt_Data_Store
Usedby:  PhpExt_Data_Store::setSortInfo()

Methods

[ Top ]
Method Summary
PhpExt_Data_SortInfoConfigObject   __construct()  
string   getDirection()  
string   getField()   The field name to which this sorting applies.
PhpExt_Data_SortInfoConfigObject   setDirection()   Sort direction. it can be either PhpExt_Data_SortInfoConfigObject::ASC or PhpExt_Data_SortInfoConfigObject::DESC
PhpExt_Data_SortInfoConfigObject   setField()   The field name to which this sorting applies.

[ Top ]
Methods
Constructor __construct  [line 69]

  PhpExt_Data_SortInfoConfigObject __construct( $fieldName, [ $direction = PhpExt_Data_SortInfoConfigObject::SORT_DIR_ASC]  )

Parameters:
   $fieldName: 
   $direction: 

API Tags:
Access:  public


Redefinition of:
PhpExt_Config_ConfigObject::__construct()

[ Top ]
getDirection  [line 65]

  string getDirection( )


API Tags:
Access:  public


[ Top ]
getField  [line 45]

  string getField( )

The field name to which this sorting applies.


API Tags:
Access:  public


[ Top ]
setDirection  [line 57]

  PhpExt_Data_SortInfoConfigObject setDirection( string $value  )

Sort direction. it can be either PhpExt_Data_SortInfoConfigObject::ASC or PhpExt_Data_SortInfoConfigObject::DESC

Parameters:
string   $value: 

API Tags:
See:  PhpExt_Data_SortInfoConfigObject::SORT_DIR_ASC
See:  PhpExt_Data_SortInfoConfigObject::SORT_DIR_DESC
Access:  public


[ Top ]
setField  [line 37]

  PhpExt_Data_SortInfoConfigObject setField( string $value  )

The field name to which this sorting applies.

Parameters:
string   $value: 

API Tags:
Access:  public


[ Top ]
Constants
SORT_DIR_ASC = 'ASC' [line 28]

[ Top ]
SORT_DIR_DESC = 'DESC' [line 29]

[ Top ]

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