phpPeanuts  2.2.0
phpPeanuts framework
 All Data Structures Namespaces Files Functions Variables
Public Member Functions | Static Public Member Functions
PntObjectNavigation Class Reference

Inherits PntNavigation.

Public Member Functions

 setNextPath ($path)
 
 newJoinFilter ()
 
 step ($item)
 
 getOptions ($item)
 
 getOptionsStep ($item)
 
 getSettedProp ()
 
 getToSettedOn ()
 
 popAfterSettedOn ()
 
 setValue ($item, $value)
 
 getItemToSetOn ($item)
 
 getResultType ()
 
 getFirstProp ()
 
 isSingleValue ()
 
 getFirstPropertyLabel ()
 
 getPathLabel ()
 
 getIdPath ()
 
 getResultClassDir ()
 
 isSettedReadOnly ()
 
 isSettedCompulsory ()
 
 getLastProp ()
 
 getDbSortPaths ()
 
 getWayBack ($nextBack=null)
 
 collectAll ($argument, $extra1=null, $extra2=null, $extra3=null)
 
 collectAllDistinct ($argument, $extra1=null, $extra2=null, $extra3=null)
 
 _getOptions ($item)
 
 _getOptionsStep ($item)
 
- Public Member Functions inherited from PntNavigation
 getItemType ()
 
 setItemType ($value)
 
 getKey ()
 
 setKey ($value)
 
 getNext ()
 
 setNext ($value)
 
 getStepResultType ()
 
 setStepResultType ($value)
 
 setPath ($path)
 
 setNextPath ($path)
 
 getPath ($length=null)
 
 getFirstPropertyLabel ()
 
 getPathLabel ()
 
 getLabel ()
 
 __clone ()
 
 pop ()
 
 evaluate ($item, $extra1=null, $extra2=null, $extra3=null)
 
 collect ($argument)
 
 step ($item)
 
 _setPath ($path)
 
 _step ($item)
 
 _collect (&$argument)
 
- Public Member Functions inherited from PntEvaluation
 getKey ()
 
 setKey ($value)
 
 getLabel ()
 
 getClass ()
 
 evaluate ($item, $extra1=null, $extra2=null, $extra3=null)
 
 getResultType ()
 
 getLastProp ()
 
 __toString ()
 
 toString ()
 
 _evaluate ($item)
 

Static Public Member Functions

static getPropIncludeType ($key, $itemType)
 
- Static Public Member Functions inherited from PntNavigation
static getInstance ($path, $itemType=null)
 
static nav1Sort (&$array, $nav, $ascending=true)
 
static byNav1SortKey (&$array, $nav)
 
static collect_path ($array, $path, $itemType=null)
 
static distinct ($items)
 
static _getInstance ($path, $itemType=null)
 
static _byNav1SortKey (&$array, $nav)
 
static _nav1Sort (&$array, $nav, $ascending=true)
 
- Static Public Member Functions inherited from PntEvaluation
static getInstance ($key)
 
static _getInstance ($key)
 

Additional Inherited Members

- Data Fields inherited from PntNavigation
 $itemType
 
 $key
 
 $next
 
 $getterName
 

Member Function Documentation

_getOptions (   $item)
_getOptionsStep (   $item)
collectAll (   $argument,
  $extra1 = null,
  $extra2 = null,
  $extra3 = null 
)

Multi value navigation from the argument over a mixed path. array $argument holding instances of $this->itemType

Returns
array With the results of navigating from each element collecting all the results in a single array
Exceptions
PntErrorif an error occurs
collectAllDistinct (   $argument,
  $extra1 = null,
  $extra2 = null,
  $extra3 = null 
)
getDbSortPaths ( )

The paths that can be used to make the database sort by this If not all but the last property is persistent, an empty array is returned. Otherwise this' path except for the last step is concatenated with the last properties' dbSortPaths.

Returns
Array of string Navigational paths
getFirstProp ( )
getFirstPropertyLabel ( )
getIdPath ( )

Returns the path to the id property

Returns
String
getItemToSetOn (   $item)
Returns
the one but last single value step result
getLastProp ( )
getOptions (   $item)
Exceptions
PntError
getOptionsStep (   $item)

Gets the options for the setted property

Parameters
PntObject$item
Returns
PntObjectNavigation
Exceptions
PntError
getPathLabel ( )
static getPropIncludeType (   $key,
  $itemType 
)
static
Exceptions
PntReflectionError
getResultClassDir ( )
getResultType ( )
getSettedProp ( )

Return the PropertyDescriptor of the setted property This is the last property. Remark: if the setted properties type is not a primitive type, The user interface will actually set the idProperty of the setted property

getToSettedOn ( )
Returns
PntNavigation to the value whose property will be set. this is the one but last property, or null if only one step.
getWayBack (   $nextBack = null)
Returns
PntNavigation for the way back Requires the properties of all steps to have twins Does not include filters that may be necessary because of polymorphisms
isSettedCompulsory ( )
isSettedReadOnly ( )
isSingleValue ( )
Returns
wheather the entire path is single value
newJoinFilter ( )
popAfterSettedOn ( )
setNextPath (   $path)
Exceptions
PntReflectionError
setValue (   $item,
  $value 
)
step (   $item)

Single value navigation from the argument using the key. if the argument is null, return null else, use propertyDescriptor to get next value. PntObject item from which to navigate

Returns
mixed result of the navigation step
Exceptions
PntReflectionError

The documentation for this class was generated from the following file: