phpPeanuts  2.2.0
phpPeanuts framework
 All Data Structures Namespaces Files Functions Variables
Public Member Functions | Data Fields
PntDerivedPropertyDescriptor Class Reference

Inherits PntPropertyDescriptor.

Inherited by PntMultiValuePropertyDescriptor.

Public Member Functions

 isDerived ()
 
 getTwin ()
 
 getPersistent ()
 
 getDbSortPaths ()
 
 getIdPropertyDescriptor ()
 
 isValueInOptionsOf ($obj, $filter=false)
 
 deriveValueFor ($obj, $filter=true)
 
 propagateValue_for ($value, $obj)
 
 getCompulsory ()
 
 getShortlistPath ()
 
 setShortlistPath ($value)
 
- Public Member Functions inherited from PntPropertyDescriptor
 __construct ($name, $type, $readOnly, $minValue, $maxValue, $minLength, $maxLength, $classDir)
 
 getName ()
 
 setName ($aString)
 
 isLegalType ($aString)
 
 getType ()
 
 setType ($aString)
 
 getReadOnly ()
 
 setReadOnly ($aValue)
 
 getMinValue ()
 
 setMinValue ($aValue)
 
 getMaxValue ()
 
 setMaxValue ($aValue)
 
 getMinLength ()
 
 setMinLength ($aValue)
 
 getMaxLength ()
 
 setMaxLength ($aValue)
 
 getPersistent ()
 
 getDbSortPaths ()
 
 setDbSortPaths ($paths)
 
 getClassDir ()
 
 setClassDir ($value)
 
 getOwner ()
 
 setOwner ($anPntClassDescriptor)
 
 getValueValidator ()
 
 getVisible ()
 
 setVisible ($value)
 
 getHoldsId ()
 
 getCompulsory ()
 
 isDerived ()
 
 isFieldProperty ()
 
 isTypePrimitive ()
 
 isMultiValue ()
 
 getIdPropertyDescriptor ()
 
 __toString ()
 
 getValueFor ($obj, $filter=true)
 
 setValue_for ($value, $obj)
 
 getOptionsFor ($obj, $filter=true)
 
 hasOptionsGetter ($obj)
 
 getOptionsFilter ($obj, $filter)
 
 deriveValueFor ($obj)
 
 propagateValue_for ($value, $obj)
 
 isValueInOptionsOf ($obj, $filter=false)
 
 isValue_in ($value, $someObjects)
 
 _getValueFor ($obj)
 
 _setValue_for ($value, $obj)
 
 _getOptionsFor ($obj)
 
 _deriveValueFor ($obj)
 
 _propagateValue_for ($value, $obj)
 
 _getValueValidator ()
 
- Public Member Functions inherited from PntDescriptor
 getName ()
 
 setName ($aString)
 
 getLabel ()
 
 setLabel ($aString)
 
 __toString ()
 
 toString ()
 

Data Fields

 $shortlistPath
 
- Data Fields inherited from PntPropertyDescriptor
 $name
 
 $type
 
 $minValue
 
 $maxValue
 
 $minLength = 0
 
 $maxLength
 
 $readOnly
 
 $ownerName
 
 $classDir
 
 $isTypePrimitive
 
 $visible
 
- Data Fields inherited from PntDescriptor
 $name
 
 $label
 

Additional Inherited Members

- Static Public Member Functions inherited from PntPropertyDescriptor
static primitiveTypes ()
 

Member Function Documentation

deriveValueFor (   $obj,
  $filter = true 
)

Return the property value for the object Called if no getter method exists. Delegate to the types classDescriptor if unsucessfull, retrieve option with key = idProperty.value

Exceptions
PntReflectionErrorfor primitive types, if no idProperty, if no options. Return null if option not found
Parameters
@objPntObject The object whose property value to answer
PntSqlFilter$filterignoored
getCompulsory ( )
Returns
boolean Wheather null values, empty Strings, values <= 0 or objects with empty labels are forbidden
getDbSortPaths ( )

Get the paths that can be used to make the database sort by this property

Returns
Array of string Navigational paths, not null
getIdPropertyDescriptor ( )

Returns the propertyDescriptor of the corresponding id-Property this is the property named as this, extended with 'Id'

Returns
PntPropertyDescriptor
getPersistent ( )

Defines the persistency of the property. For derived properties it answers wheather the receiver's values are persistent. for derived properties that are persistent the value(s) will automatically be retrieved from persistent storage otherwise the value may be derived from the propertyOptions

Returns
mixed PNT_NOT (=false), PNT_READ_WRITE (=true)
getShortlistPath ( )
Returns
string The path to the multi value property holding the shortList a value for this property may be selected from. : ShortlistDialogWidget must be installed : no options getter method or Dialog must be adapted to only select values from options
getTwin ( )

If a property implements a role in a relationship, the property that implements the role on the other side is its twin.

Returns
PntPropertyDescriptor The twin property in the relationship
isDerived ( )
isValueInOptionsOf (   $obj,
  $filter = false 
)
propagateValue_for (   $value,
  $obj 
)

Set the property value for the object Called if no setter method exists and the property is not readOnly. Delegate to the types classDescriptor

Exceptions
PntReflectionErrorfor primitive types or if no id property
Parameters
@valuevarianr The value to set
@objPntObject The object whose property value to set
setShortlistPath (   $value)
Parameters
string$valueThe path to the multi value property holding the shortList a value for this property may be selected from

Field Documentation

$shortlistPath

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