phpMv -UI toolkit 2.4.12
jQuery, jQuery UI, Twitter Bootstrap and Semantic-UI library for php & php MVC Frameworks
Loading...
Searching...
No Matches
InstanceViewer Class Reference
+ Inheritance diagram for InstanceViewer:

Public Member Functions

 __construct ($identifier, $instance=NULL, $captions=NULL)
 
 moveFieldTo ($from, $to)
 
 swapFields ($index1, $index2)
 
 removeField ($index)
 
 getValues ()
 
 getIdentifier ($index=NULL)
 
 getValue ($index)
 
 insertField ($index, $field, $key=null)
 
 sortColumnContent ($index, $array)
 
 insertInField ($index, $field, $key=null)
 
 addField ($field, $key=null)
 
 addFields ($fields)
 
 count ()
 
 visiblePropertiesCount ()
 
 getProperty ($index)
 
 getFieldName ($index)
 
 setInstance ($instance)
 
 setVisibleProperties ($visibleProperties)
 
 setValueFunction ($index, $callback)
 
 setIdentifierFunction ($callback)
 
 getProperties ()
 
 getCaption ($index)
 
 getCaptions ()
 
 setCaption ($index, $caption)
 
 setCaptions ($captions)
 
 afterCompile ($index, $callback)
 Associates a $callback function after the compilation of the field at $index position The $callback function can take the following arguments : $field=>the compiled field, $instance : the active instance of the object, $index: the field position.
 
 setCaptionCallback ($captionCallback)
 Defines a callback function to call for modifying captions function parameters are.
 
 setDefaultValueFunction ($defaultValueFunction)
 Defines the default function which displays fields value.
 
 getVisibleProperties ()
 
 getSimpleProperties ()
 
 getDefaultValueFunction ()
 
 getGroupByFields ()
 
 setGroupByFields ($groupByFields)
 
 addGroupBy ($groupByField)
 
 getGroupByFieldsCount ()
 

Static Public Member Functions

static setIndex ($index)
 

Static Public Attributes

static $index = 0
 

Protected Member Functions

 _beforeAddProperty ($index, &$field)
 
 _getDefaultValue ($name, $value, $index)
 
 _getPropertyValue (\ReflectionProperty $property)
 
 _getValue ($property, $index)
 
 _postGetValue ($index, $propertyName, $value)
 
 showableProperty (\ReflectionProperty $rProperty)
 
 getDefaultProperties ()
 

Protected Attributes

 $widgetIdentifier
 
 $instance
 
 $reflect
 
 $properties
 
 $visibleProperties
 
 $values
 
 $afterCompile
 
 $captions
 
 $captionCallback
 
 $defaultValueFunction
 
 $groupByFields
 

Private Member Functions

 setInstanceProperty ($property)
 

Detailed Description

Definition at line 8 of file InstanceViewer.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $identifier,
  $instance = NULL,
  $captions = NULL 
)

Reimplemented in DeInstanceViewer, and FormInstanceViewer.

Definition at line 34 of file InstanceViewer.php.

Member Function Documentation

◆ _beforeAddProperty()

_beforeAddProperty (   $index,
$field 
)
protected

Reimplemented in FormInstanceViewer.

Definition at line 106 of file InstanceViewer.php.

◆ _getDefaultValue()

_getDefaultValue (   $name,
  $value,
  $index 
)
protected

Definition at line 108 of file InstanceViewer.php.

◆ _getPropertyValue()

_getPropertyValue ( \ReflectionProperty  $property)
protected

Definition at line 113 of file InstanceViewer.php.

◆ _getValue()

_getValue (   $property,
  $index 
)
protected

Definition at line 118 of file InstanceViewer.php.

◆ _postGetValue()

_postGetValue (   $index,
  $propertyName,
  $value 
)
protected

Definition at line 146 of file InstanceViewer.php.

◆ addField()

addField (   $field,
  $key = null 
)

Definition at line 208 of file InstanceViewer.php.

◆ addFields()

addFields (   $fields)

Definition at line 219 of file InstanceViewer.php.

◆ addGroupBy()

addGroupBy (   $groupByField)

Definition at line 457 of file InstanceViewer.php.

◆ afterCompile()

afterCompile (   $index,
  $callback 
)

Associates a $callback function after the compilation of the field at $index position The $callback function can take the following arguments : $field=>the compiled field, $instance : the active instance of the object, $index: the field position.

Parameters
int$indexpostion of the compiled field
callable$callbackfunction called after the field compilation
Returns
InstanceViewer

Definition at line 394 of file InstanceViewer.php.

◆ count()

count ( )

Definition at line 224 of file InstanceViewer.php.

◆ getCaption()

getCaption (   $index)

Definition at line 331 of file InstanceViewer.php.

◆ getCaptions()

getCaptions ( )

Definition at line 343 of file InstanceViewer.php.

◆ getDefaultProperties()

getDefaultProperties ( )
protected

Definition at line 296 of file InstanceViewer.php.

◆ getDefaultValueFunction()

getDefaultValueFunction ( )
Returns
callable

Definition at line 437 of file InstanceViewer.php.

◆ getFieldName()

getFieldName (   $index)

Definition at line 236 of file InstanceViewer.php.

◆ getGroupByFields()

getGroupByFields ( )
Returns
mixed

Definition at line 445 of file InstanceViewer.php.

◆ getGroupByFieldsCount()

getGroupByFieldsCount ( )

Definition at line 461 of file InstanceViewer.php.

◆ getIdentifier()

getIdentifier (   $index = NULL)

Definition at line 88 of file InstanceViewer.php.

◆ getProperties()

getProperties ( )

Definition at line 327 of file InstanceViewer.php.

◆ getProperty()

getProperty (   $index)

Definition at line 232 of file InstanceViewer.php.

◆ getSimpleProperties()

getSimpleProperties ( )

Definition at line 427 of file InstanceViewer.php.

◆ getValue()

getValue (   $index)

Reimplemented in DeInstanceViewer.

Definition at line 101 of file InstanceViewer.php.

◆ getValues()

getValues ( )

Definition at line 68 of file InstanceViewer.php.

◆ getVisibleProperties()

getVisibleProperties ( )

Definition at line 423 of file InstanceViewer.php.

◆ insertField()

insertField (   $index,
  $field,
  $key = null 
)

Definition at line 160 of file InstanceViewer.php.

◆ insertInField()

insertInField (   $index,
  $field,
  $key = null 
)

Definition at line 180 of file InstanceViewer.php.

◆ moveFieldTo()

moveFieldTo (   $from,
  $to 
)

Definition at line 47 of file InstanceViewer.php.

◆ removeField()

removeField (   $index)

Reimplemented in FormInstanceViewer.

Definition at line 61 of file InstanceViewer.php.

◆ setCaption()

setCaption (   $index,
  $caption 
)

Definition at line 372 of file InstanceViewer.php.

◆ setCaptionCallback()

setCaptionCallback (   $captionCallback)

Defines a callback function to call for modifying captions function parameters are.

$captions: the captions to modify and $instance: the active model instance

Parameters
callable$captionCallback
Returns
\Ajax\semantic\widgets\base\InstanceViewer

Definition at line 406 of file InstanceViewer.php.

◆ setCaptions()

setCaptions (   $captions)

Definition at line 379 of file InstanceViewer.php.

◆ setDefaultValueFunction()

setDefaultValueFunction (   $defaultValueFunction)

Defines the default function which displays fields value.

Parameters
callable$defaultValueFunctionfunction parameters are : $name : the field name, $value : the field value ,$index : the field index, $instance : the active instance of model
Returns
\Ajax\semantic\widgets\base\InstanceViewer

Definition at line 418 of file InstanceViewer.php.

◆ setGroupByFields()

setGroupByFields (   $groupByFields)
Parameters
mixed$groupByFields

Definition at line 453 of file InstanceViewer.php.

◆ setIdentifierFunction()

setIdentifierFunction (   $callback)

Definition at line 318 of file InstanceViewer.php.

◆ setIndex()

static setIndex (   $index)
static

Definition at line 323 of file InstanceViewer.php.

◆ setInstance()

setInstance (   $instance)

Definition at line 252 of file InstanceViewer.php.

◆ setInstanceProperty()

setInstanceProperty (   $property)
private

Definition at line 273 of file InstanceViewer.php.

◆ setValueFunction()

setValueFunction (   $index,
  $callback 
)

Definition at line 313 of file InstanceViewer.php.

◆ setVisibleProperties()

setVisibleProperties (   $visibleProperties)

Definition at line 308 of file InstanceViewer.php.

◆ showableProperty()

showableProperty ( \ReflectionProperty  $rProperty)
protected

Definition at line 248 of file InstanceViewer.php.

◆ sortColumnContent()

sortColumnContent (   $index,
  $array 
)

Definition at line 171 of file InstanceViewer.php.

◆ swapFields()

swapFields (   $index1,
  $index2 
)

Definition at line 54 of file InstanceViewer.php.

◆ visiblePropertiesCount()

visiblePropertiesCount ( )

Definition at line 228 of file InstanceViewer.php.

Field Documentation

◆ $afterCompile

$afterCompile
protected

Definition at line 22 of file InstanceViewer.php.

◆ $captionCallback

$captionCallback
protected

Definition at line 26 of file InstanceViewer.php.

◆ $captions

$captions
protected

Definition at line 24 of file InstanceViewer.php.

◆ $defaultValueFunction

Definition at line 28 of file InstanceViewer.php.

◆ $groupByFields

$groupByFields
protected

Definition at line 30 of file InstanceViewer.php.

◆ $index

$index = 0
static

Definition at line 32 of file InstanceViewer.php.

◆ $instance

$instance
protected

Definition at line 12 of file InstanceViewer.php.

◆ $properties

$properties
protected

Definition at line 16 of file InstanceViewer.php.

◆ $reflect

$reflect
protected

Definition at line 14 of file InstanceViewer.php.

◆ $values

$values
protected

Definition at line 20 of file InstanceViewer.php.

◆ $visibleProperties

$visibleProperties
protected

Definition at line 18 of file InstanceViewer.php.

◆ $widgetIdentifier

$widgetIdentifier
protected

Definition at line 10 of file InstanceViewer.php.


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