PHP Class Admin

Inheritance: extends CI_Controller
Afficher le fichier Open project: openeyes/openeyes Class Usage Examples

Méthodes publiques

Свойство Type Description
$displayOrder integer

Protected Properties

Свойство Type Description
$controller BaseAdminController
$customCancelURL string
$customSaveURL string
$editFields array
$editTemplate string
$filterFields array
$isSubList boolean
$listFields array
$listTemplate string
$model BaseActiveRecord
$modelDisplayName string
$modelId integer
$modelName string
$pagination CPagination
$search ModelSearch
$subListParent array Contains key value of parent object relation for a sublist.
$unsortableColumns array

Méthodes publiques

Méthode Description
__construct ( BaseActiveRecord $model, BaseAdminController $controller )
attributeValue ( $row, $attribute ) : string
deleteModel ( ) Deletes the models for which an array of IDs has been posted.
editModel ( ) Edits the model, runs validation and renders the edit form.
generateAdminForRelationList ( $relation, array $listFields )
generateReturnUrl ( $requestUri ) : string
getController ( ) : BaseAdminController
getCustomCancelURL ( ) : string
getCustomSaveURL ( ) : string
getEditFields ( ) : array
getEditTemplate ( ) : string
getFilterFields ( ) : array
getListFields ( ) : array
getListTemplate ( ) : string
getModel ( ) : BaseActiveRecord
getModelDisplayName ( ) : string
getModelId ( ) : integer
getModelName ( ) : string
getPagination ( ) : mixed
getSearch ( ) : ModelSearch
getSubListParent ( ) : array
getUnsortableColumns ( ) : array
isSortableColumn ( $attribute ) : boolean Returns wether a given column is sortable or not.
isSubList ( ) : boolean
listModel ( $buttons = true ) Lists all the rows returned from the search in a table.
searchAll ( ) Sets up search on all listed elements.
setController ( BaseAdminController $controller )
setCustomCancelURL ( $cancelURL )
setCustomSaveURL ( $saveURL )
setEditFields ( array $editFields )
setEditTemplate ( string $editTemplate )
setFilterFields ( $filters )
setIsSubList ( boolean $isSubList )
setListFields ( array $listFields )
setListTemplate ( string $listTemplate )
setModel ( BaseActiveRecord $model )
setModelDisplayName ( $displayName )
setModelId ( integer $modelId )
setModelName ( string $modelName )
setPagination ( mixed $pagination )
setSearch ( ModelSearch $search )
setSubListParent ( array $subListParent )
setUnsortableColumns ( array $unsortableColumns )
sortModel ( ) Saves the display_order.
sortQuery ( $attribute, $order, $queryString ) : string Takes the current URL, sets two values in it and returns it.

Méthodes protégées

Méthode Description
audit ( $type, $data = null )
getRelationDefnition ( $relation ) : mixed
relationClassFromRelation ( $relation ) : BaseActiveRecord
relationFieldFromRelation ( $relation )
render ( $template, array $data = [] )

Method Details

__construct() public méthode

public __construct ( BaseActiveRecord $model, BaseAdminController $controller )
$model BaseActiveRecord
$controller BaseAdminController

attributeValue() public méthode

public attributeValue ( $row, $attribute ) : string
$row
$attribute
Résultat string

audit() protected méthode

protected audit ( $type, $data = null )
$type

deleteModel() public méthode

Deletes the models for which an array of IDs has been posted.
public deleteModel ( )

editModel() public méthode

Edits the model, runs validation and renders the edit form.
public editModel ( )

generateAdminForRelationList() public méthode

public generateAdminForRelationList ( $relation, array $listFields )
$listFields array

generateReturnUrl() public méthode

public generateReturnUrl ( $requestUri ) : string
Résultat string

getController() public méthode

public getController ( ) : BaseAdminController
Résultat BaseAdminController

getCustomCancelURL() public méthode

public getCustomCancelURL ( ) : string
Résultat string

getCustomSaveURL() public méthode

public getCustomSaveURL ( ) : string
Résultat string

getEditFields() public méthode

public getEditFields ( ) : array
Résultat array

getEditTemplate() public méthode

public getEditTemplate ( ) : string
Résultat string

getFilterFields() public méthode

public getFilterFields ( ) : array
Résultat array

getListFields() public méthode

public getListFields ( ) : array
Résultat array

getListTemplate() public méthode

public getListTemplate ( ) : string
Résultat string

getModel() public méthode

public getModel ( ) : BaseActiveRecord
Résultat BaseActiveRecord

getModelDisplayName() public méthode

public getModelDisplayName ( ) : string
Résultat string

getModelId() public méthode

public getModelId ( ) : integer
Résultat integer

getModelName() public méthode

public getModelName ( ) : string
Résultat string

getPagination() public méthode

public getPagination ( ) : mixed
Résultat mixed

getRelationDefnition() protected méthode

protected getRelationDefnition ( $relation ) : mixed
$relation
Résultat mixed

getSearch() public méthode

public getSearch ( ) : ModelSearch
Résultat ModelSearch

getSubListParent() public méthode

public getSubListParent ( ) : array
Résultat array

getUnsortableColumns() public méthode

public getUnsortableColumns ( ) : array
Résultat array

isSortableColumn() public méthode

Returns wether a given column is sortable or not.
public isSortableColumn ( $attribute ) : boolean
$attribute
Résultat boolean

isSubList() public méthode

public isSubList ( ) : boolean
Résultat boolean

listModel() public méthode

Lists all the rows returned from the search in a table.
public listModel ( $buttons = true )

relationClassFromRelation() protected méthode

protected relationClassFromRelation ( $relation ) : BaseActiveRecord
$relation
Résultat BaseActiveRecord

relationFieldFromRelation() protected méthode

protected relationFieldFromRelation ( $relation )

render() protected méthode

protected render ( $template, array $data = [] )
$template
$data array

searchAll() public méthode

Sets up search on all listed elements.
public searchAll ( )

setController() public méthode

public setController ( BaseAdminController $controller )
$controller BaseAdminController

setCustomCancelURL() public méthode

public setCustomCancelURL ( $cancelURL )
$cancelURL

setCustomSaveURL() public méthode

public setCustomSaveURL ( $saveURL )
$saveURL

setEditFields() public méthode

public setEditFields ( array $editFields )
$editFields array

setEditTemplate() public méthode

public setEditTemplate ( string $editTemplate )
$editTemplate string

setFilterFields() public méthode

public setFilterFields ( $filters )
$filters

setIsSubList() public méthode

public setIsSubList ( boolean $isSubList )
$isSubList boolean

setListFields() public méthode

public setListFields ( array $listFields )
$listFields array

setListTemplate() public méthode

public setListTemplate ( string $listTemplate )
$listTemplate string

setModel() public méthode

public setModel ( BaseActiveRecord $model )
$model BaseActiveRecord

setModelDisplayName() public méthode

public setModelDisplayName ( $displayName )

setModelId() public méthode

public setModelId ( integer $modelId )
$modelId integer

setModelName() public méthode

public setModelName ( string $modelName )
$modelName string

setPagination() public méthode

public setPagination ( mixed $pagination )
$pagination mixed

setSearch() public méthode

public setSearch ( ModelSearch $search )
$search ModelSearch

setSubListParent() public méthode

public setSubListParent ( array $subListParent )
$subListParent array

setUnsortableColumns() public méthode

public setUnsortableColumns ( array $unsortableColumns )
$unsortableColumns array

sortModel() public méthode

Saves the display_order.
public sortModel ( )

sortQuery() public méthode

Takes the current URL, sets two values in it and returns it.
public sortQuery ( $attribute, $order, $queryString ) : string
$attribute
$order
$queryString
Résultat string

Property Details

$controller protected_oe property

protected BaseAdminController $controller
Résultat BaseAdminController

$customCancelURL protected_oe property

protected string $customCancelURL
Résultat string

$customSaveURL protected_oe property

protected string $customSaveURL
Résultat string

$displayOrder public_oe property

public int $displayOrder
Résultat integer

$editFields protected_oe property

protected array $editFields
Résultat array

$editTemplate protected_oe property

protected string $editTemplate
Résultat string

$filterFields protected_oe property

protected array $filterFields
Résultat array

$isSubList protected_oe property

protected bool $isSubList
Résultat boolean

$listFields protected_oe property

protected array $listFields
Résultat array

$listTemplate protected_oe property

protected string $listTemplate
Résultat string

$model protected_oe property

protected BaseActiveRecord $model
Résultat BaseActiveRecord

$modelDisplayName protected_oe property

protected string $modelDisplayName
Résultat string

$modelId protected_oe property

protected int $modelId
Résultat integer

$modelName protected_oe property

protected string $modelName
Résultat string

$pagination protected_oe property

protected CPagination $pagination
Résultat CPagination

$subListParent protected_oe property

Contains key value of parent object relation for a sublist.
protected array $subListParent
Résultat array

$unsortableColumns protected_oe property

protected array $unsortableColumns
Résultat array