CRUDControllerUtilitiesTrait Class Reference

Inheritance diagram for CRUDControllerUtilitiesTrait:

Public Member Functions
	loadView (string $viewName, $pData=null, bool $asString=false)
	index ()
	_getBaseRoute ()
	_setStyle ($elm)
	_getAdminData ()
	_getFiles ()

Protected Member Functions
	showSimpleMessage_ (CRUDMessage $message, $staticName=null)
	showConfMessage_ (CRUDMessage $message, $url, $responseElement, $data, $attributes=null)
	getInstances (&$totalCount, $page=1, $id=null)
	search ($model, $search)
	updateMemberDataElement ($member, $instance)
	_edit ($instance, $modal="no")
	_showModel ($id=null)
	_deleteMultiple ($data, $action, $target, $condition, $params=[])
	Helper to delete multiple objects.
	refreshInstance ($instance, $isNew)
	getAdminData ()
	To override for defining a new adminData.
	getModelViewer ()
	To override for defining a new ModelViewer.
	_getModelViewer ()
	getFiles ()
	To override for changing view files.
	getEvents ()
	To override for changing events.
	getInstanceToString ($instance)

Protected Attributes
	$modelViewer
	$adminDatas
	$events
	$crudFiles

Private Member Functions
	getModelInstance ($ids, $transform=true, $included=true)
	_renderDataTableForRefresh ($instances, $model, $totalCount)
	_getEvents ()
	getSingleton (&$value, $method)
	crudLoadView ($viewName, $vars=[])

Detailed Description

Definition at line 21 of file CRUDControllerUtilitiesTrait.php.

Member Function Documentation

_deleteMultiple()

_deleteMultiple (   $data,   $action,   $target,   $condition,   $params = []  )

protected

Helper to delete multiple objects.

Parameters

mixed	$data
string	$action
string	$target	the css selector for refreshing
callable | string	$condition	the callback for generating the SQL where (for deletion) with the parameter data, or a simple string
array	$params	The statement parameters for a prepared query

Definition at line 143 of file CRUDControllerUtilitiesTrait.php.

_edit()

_edit (   $instance,   $modal = "no"  )

protected

Definition at line 103 of file CRUDControllerUtilitiesTrait.php.

_getAdminData()

_getAdminData

(

)

Definition at line 185 of file CRUDControllerUtilitiesTrait.php.

_getBaseRoute()

_getBaseRoute ( )

abstract

Reimplemented in MultiResourceCRUDController.

_getEvents()

_getEvents ( )

private

Definition at line 228 of file CRUDControllerUtilitiesTrait.php.

_getFiles()

_getFiles

(

)

Returns

CRUDFiles

Definition at line 215 of file CRUDControllerUtilitiesTrait.php.

_getModelViewer()

_getModelViewer ( )

protected

Definition at line 198 of file CRUDControllerUtilitiesTrait.php.

_renderDataTableForRefresh()

_renderDataTableForRefresh (   $instances,   $model,   $totalCount  )

private

Definition at line 96 of file CRUDControllerUtilitiesTrait.php.

_setStyle()

_setStyle (   $elm )

abstract

Reimplemented in CRUDController.

_showModel()

_showModel (   $id = null )

protected

Definition at line 128 of file CRUDControllerUtilitiesTrait.php.

crudLoadView()

crudLoadView (   $viewName,   $vars = []  )

private

Definition at line 239 of file CRUDControllerUtilitiesTrait.php.

getAdminData()

getAdminData ( )

protected

To override for defining a new adminData.

Returns

CRUDDatas

Definition at line 181 of file CRUDControllerUtilitiesTrait.php.

getEvents()

getEvents ( )

protected

To override for changing events.

Returns

CRUDEvents

Definition at line 224 of file CRUDControllerUtilitiesTrait.php.

getFiles()

getFiles ( )

protected

To override for changing view files.

Returns

CRUDFiles

Definition at line 207 of file CRUDControllerUtilitiesTrait.php.

getInstances()

getInstances ( &  $totalCount,   $page = 1,   $id = null  )

protected

Definition at line 40 of file CRUDControllerUtilitiesTrait.php.

getInstanceToString()

getInstanceToString (   $instance )

protected

Parameters

object

$instance

Returns

string

Definition at line 264 of file CRUDControllerUtilitiesTrait.php.

getModelInstance()

getModelInstance (   $ids,   $transform = true,   $included = true  )

private

Parameters

mixed	$ids
boolean	$transform
boolean	$included

Returns

object

Definition at line 71 of file CRUDControllerUtilitiesTrait.php.

getModelViewer()

getModelViewer ( )

protected

To override for defining a new ModelViewer.

Returns

ModelViewer

Definition at line 194 of file CRUDControllerUtilitiesTrait.php.

getSingleton()

getSingleton ( &  $value,   $method  )

private

Definition at line 232 of file CRUDControllerUtilitiesTrait.php.

index()

index ( )

abstract

Reimplemented in CRUDController.

loadView()

loadView ( string  $viewName,   $pData = null, bool  $asString = false  )

abstract

refreshInstance()

refreshInstance (   $instance,   $isNew  )

protected

Definition at line 167 of file CRUDControllerUtilitiesTrait.php.

search()

search (   $model,   $search  )

protected

Definition at line 58 of file CRUDControllerUtilitiesTrait.php.

showConfMessage_()

showConfMessage_ ( CRUDMessage  $message,   $url,   $responseElement,   $data,   $attributes = null  )

abstractprotected

showSimpleMessage_()

showSimpleMessage_ ( CRUDMessage  $message,   $staticName = null  )

abstractprotected

updateMemberDataElement()

updateMemberDataElement (   $member,   $instance  )

protected

Definition at line 90 of file CRUDControllerUtilitiesTrait.php.

Field Documentation

$adminDatas

$adminDatas

protected

Definition at line 36 of file CRUDControllerUtilitiesTrait.php.

$crudFiles

$crudFiles

protected

Definition at line 38 of file CRUDControllerUtilitiesTrait.php.

$events

$events

protected

Definition at line 37 of file CRUDControllerUtilitiesTrait.php.

$modelViewer

$modelViewer

protected

Definition at line 35 of file CRUDControllerUtilitiesTrait.php.

---

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

• C:/Users/myadd/Documents/GitHub/ubiquity-doc-api/vendor/phpmv/ubiquity/src/Ubiquity/controllers/crud/CRUDControllerUtilitiesTrait.php