Ubiquity  2.0.3
php rapid development framework
ModelViewer Class Reference

Public Member Functions

 __construct (HasModelViewerInterface $controller)
 
 getForm ($identifier, $instance)
 Returns the form for adding or modifying an object. More...
 
 setFormFieldsComponent (DataForm $form, $fieldTypes)
 Sets the components for each field. More...
 
 getModelDataElement ($instance, $model, $modal)
 
 getModelDataTable ($instances, $model, $page=1)
 Returns the dataTable responsible for displaying instances of the model. More...
 
 recordsPerPage ($model, $totalCount=0)
 
 addAllButtons (DataTable $dataTable, $attributes)
 
 confirmButtons (HtmlButton $confirmBtn, HtmlButton $cancelBtn)
 
 isModal ($objects, $model)
 Condition to determine if the edit or add form is modal for $model objects. More...
 
 getCaptions ($captions, $className)
 Returns the captions for list fields in showTable action. More...
 
 getFormCaptions ($captions, $className, $instance)
 Returns the captions for form fields. More...
 
 getElementCaptions ($captions, $className, $instance)
 Returns the captions for DataElement fields. More...
 
 getFkHeaderElementDetails ($member, $className, $object)
 Returns the header for a single foreign object (element is an instance, issue from ManyToOne), (from DataTable) More...
 
 getFkHeaderListDetails ($member, $className, $list)
 Returns the header for a list of foreign objects (issue from oneToMany or ManyToMany), (from DataTable) More...
 
 getFkElementDetails ($member, $className, $object)
 Returns a component for displaying a single foreign object (manyToOne relation), (from DataTable) More...
 
 getFkListDetails ($member, $className, $list)
 Returns a list component for displaying a collection of foreign objects (*ToMany relations), (from DataTable) More...
 
 getFkMemberElementDetails ($memberFK, $objectFK, $fkClass, $fkTable)
 Returns a component for displaying a foreign object (from DataTable) More...
 
 displayFkElementListDetails ($element, $member, $className, $object)
 To modify for displaying an element in a list component of foreign objects (from DataTable) More...
 
 getFkMemberElement ($memberFK, $objectFK, $fkClass, $fkTable)
 Returns a component for displaying a foreign object (from DataElement) More...
 
 getFkList ($member, $list)
 Returns a list component for displaying a collection of foreign objects (*ToMany relations), (from DataElement) More...
 
 displayFkElementList ($element, $member, $className, $object)
 To modify for displaying an element in a list component of foreign objects, (from DataElement) More...
 
 getFkElement ($member, $className, $object)
 Returns a component for displaying a single foreign object (manyToOne relation), (from DataElement) More...
 
 showDetailsOnDataTableClick ()
 To override to make sure that the detail of a clicked object is displayed or not. More...
 

Protected Member Functions

 getDataTableInstance ($instances, $model, $page=1)
 
 getDataTableRowButtons ()
 Returns an array of buttons ["display","edit","delete"] to display for each row in dataTable. More...
 
 relationMembersInForm ($form, $instance, $className)
 
 manyToOneFormField (DataForm $form, $member, $className, $instance)
 
 oneToManyFormField (DataForm $form, $member, $instance, $annot)
 
 manyToManyFormField (DataForm $form, $member, $instance, $annot)
 

Protected Attributes

 $controller
 

Private Attributes

 $jquery
 

Detailed Description

Definition at line 23 of file ModelViewer.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( HasModelViewerInterface  $controller)

Definition at line 35 of file ModelViewer.php.

Member Function Documentation

◆ addAllButtons()

addAllButtons ( DataTable  $dataTable,
  $attributes 
)

Definition at line 186 of file ModelViewer.php.

◆ confirmButtons()

confirmButtons ( HtmlButton  $confirmBtn,
HtmlButton  $cancelBtn 
)

Definition at line 200 of file ModelViewer.php.

◆ displayFkElementList()

displayFkElementList (   $element,
  $member,
  $className,
  $object 
)

To modify for displaying an element in a list component of foreign objects, (from DataElement)

Parameters
HtmlDoubleElement$element
string$member
string$className
object$object

Definition at line 390 of file ModelViewer.php.

◆ displayFkElementListDetails()

displayFkElementListDetails (   $element,
  $member,
  $className,
  $object 
)

To modify for displaying an element in a list component of foreign objects (from DataTable)

Parameters
HtmlDoubleElement$element
string$member
string$className
object$object

Definition at line 336 of file ModelViewer.php.

◆ getCaptions()

getCaptions (   $captions,
  $className 
)

Returns the captions for list fields in showTable action.

Parameters
array$captions
string$className

Definition at line 222 of file ModelViewer.php.

◆ getDataTableInstance()

getDataTableInstance (   $instances,
  $model,
  $page = 1 
)
protected

Definition at line 163 of file ModelViewer.php.

◆ getDataTableRowButtons()

getDataTableRowButtons ( )
protected

Returns an array of buttons ["display","edit","delete"] to display for each row in dataTable.

Returns
string[]

Definition at line 182 of file ModelViewer.php.

◆ getElementCaptions()

getElementCaptions (   $captions,
  $className,
  $instance 
)

Returns the captions for DataElement fields.

Parameters
array$captions
string$className

Definition at line 242 of file ModelViewer.php.

◆ getFkElement()

getFkElement (   $member,
  $className,
  $object 
)

Returns a component for displaying a single foreign object (manyToOne relation), (from DataElement)

Parameters
string$member
string$className
object$object
Returns
BaseHtml

Definition at line 400 of file ModelViewer.php.

◆ getFkElementDetails()

getFkElementDetails (   $member,
  $className,
  $object 
)

Returns a component for displaying a single foreign object (manyToOne relation), (from DataTable)

Parameters
string$member
string$className
object$object
Returns
BaseHtml

Definition at line 275 of file ModelViewer.php.

◆ getFkHeaderElementDetails()

getFkHeaderElementDetails (   $member,
  $className,
  $object 
)

Returns the header for a single foreign object (element is an instance, issue from ManyToOne), (from DataTable)

Parameters
string$member
string$className
object$object
Returns
HtmlHeader

Definition at line 253 of file ModelViewer.php.

◆ getFkHeaderListDetails()

getFkHeaderListDetails (   $member,
  $className,
  $list 
)

Returns the header for a list of foreign objects (issue from oneToMany or ManyToMany), (from DataTable)

Parameters
string$member
string$className
array$list
Returns
HtmlHeader

Definition at line 264 of file ModelViewer.php.

◆ getFkList()

getFkList (   $member,
  $list 
)

Returns a list component for displaying a collection of foreign objects (*ToMany relations), (from DataElement)

Parameters
string$member
string$className
array | \Traversable$list
Returns
HtmlCollection

Definition at line 377 of file ModelViewer.php.

◆ getFkListDetails()

getFkListDetails (   $member,
  $className,
  $list 
)

Returns a list component for displaying a collection of foreign objects (*ToMany relations), (from DataTable)

Parameters
string$member
string$className
array | \Traversable$list
Returns
HtmlCollection

Definition at line 286 of file ModelViewer.php.

◆ getFkMemberElement()

getFkMemberElement (   $memberFK,
  $objectFK,
  $fkClass,
  $fkTable 
)

Returns a component for displaying a foreign object (from DataElement)

Parameters
string$memberFK
mixed$objectFK
string$fkClass
string$fkTable
Returns
string|NULL

Definition at line 347 of file ModelViewer.php.

◆ getFkMemberElementDetails()

getFkMemberElementDetails (   $memberFK,
  $objectFK,
  $fkClass,
  $fkTable 
)

Returns a component for displaying a foreign object (from DataTable)

Parameters
string$memberFK
mixed$objectFK
string$fkClass
string$fkTable
Returns
string|NULL

Definition at line 301 of file ModelViewer.php.

◆ getForm()

getForm (   $identifier,
  $instance 
)

Returns the form for adding or modifying an object.

Parameters
string$identifier
object$instancethe object to add or modify
Returns
DataForm

Definition at line 47 of file ModelViewer.php.

◆ getFormCaptions()

getFormCaptions (   $captions,
  $className,
  $instance 
)

Returns the captions for form fields.

Parameters
array$captions
string$className

Definition at line 232 of file ModelViewer.php.

◆ getModelDataElement()

getModelDataElement (   $instance,
  $model,
  $modal 
)

Definition at line 92 of file ModelViewer.php.

◆ getModelDataTable()

getModelDataTable (   $instances,
  $model,
  $page = 1 
)

Returns the dataTable responsible for displaying instances of the model.

Parameters
array$instancesobjects to display
string$modelmodel class name (long name)
Returns
DataTable

Definition at line 123 of file ModelViewer.php.

◆ isModal()

isModal (   $objects,
  $model 
)

Condition to determine if the edit or add form is modal for $model objects.

Parameters
array$objects
string$model
Returns
boolean

Definition at line 212 of file ModelViewer.php.

◆ manyToManyFormField()

manyToManyFormField ( DataForm  $form,
  $member,
  $instance,
  $annot 
)
protected

Definition at line 463 of file ModelViewer.php.

◆ manyToOneFormField()

manyToOneFormField ( DataForm  $form,
  $member,
  $className,
  $instance 
)
protected

Definition at line 425 of file ModelViewer.php.

◆ oneToManyFormField()

oneToManyFormField ( DataForm  $form,
  $member,
  $instance,
  $annot 
)
protected

Definition at line 448 of file ModelViewer.php.

◆ recordsPerPage()

recordsPerPage (   $model,
  $totalCount = 0 
)

Definition at line 157 of file ModelViewer.php.

◆ relationMembersInForm()

relationMembersInForm (   $form,
  $instance,
  $className 
)
protected

Definition at line 412 of file ModelViewer.php.

◆ setFormFieldsComponent()

setFormFieldsComponent ( DataForm  $form,
  $fieldTypes 
)

Sets the components for each field.

Parameters
DataForm$form
array$fieldTypesassociative array of field names (keys) and types (values)

Definition at line 72 of file ModelViewer.php.

◆ showDetailsOnDataTableClick()

showDetailsOnDataTableClick ( )

To override to make sure that the detail of a clicked object is displayed or not.

Returns
boolean Return true if you want to see details

Definition at line 408 of file ModelViewer.php.

Field Documentation

◆ $controller

$controller
protected

Definition at line 33 of file ModelViewer.php.

◆ $jquery

$jquery
private

Definition at line 28 of file ModelViewer.php.


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