PHP Класс Admin

Наследование: extends CI_Controller
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$displayOrder integer

Защищенные свойства (Protected)

Свойство Тип Описание
$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

Открытые методы

Метод Описание
__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.

Защищенные методы

Метод Описание
audit ( $type, $data = null )
getRelationDefnition ( $relation ) : mixed
relationClassFromRelation ( $relation ) : BaseActiveRecord
relationFieldFromRelation ( $relation )
render ( $template, array $data = [] )

Описание методов

__construct() публичный Метод

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

attributeValue() публичный Метод

public attributeValue ( $row, $attribute ) : string
$row
$attribute
Результат string

audit() защищенный Метод

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

deleteModel() публичный Метод

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

editModel() публичный Метод

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

generateAdminForRelationList() публичный Метод

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

generateReturnUrl() публичный Метод

public generateReturnUrl ( $requestUri ) : string
Результат string

getController() публичный Метод

public getController ( ) : BaseAdminController
Результат BaseAdminController

getCustomCancelURL() публичный Метод

public getCustomCancelURL ( ) : string
Результат string

getCustomSaveURL() публичный Метод

public getCustomSaveURL ( ) : string
Результат string

getEditFields() публичный Метод

public getEditFields ( ) : array
Результат array

getEditTemplate() публичный Метод

public getEditTemplate ( ) : string
Результат string

getFilterFields() публичный Метод

public getFilterFields ( ) : array
Результат array

getListFields() публичный Метод

public getListFields ( ) : array
Результат array

getListTemplate() публичный Метод

public getListTemplate ( ) : string
Результат string

getModel() публичный Метод

public getModel ( ) : BaseActiveRecord
Результат BaseActiveRecord

getModelDisplayName() публичный Метод

public getModelDisplayName ( ) : string
Результат string

getModelId() публичный Метод

public getModelId ( ) : integer
Результат integer

getModelName() публичный Метод

public getModelName ( ) : string
Результат string

getPagination() публичный Метод

public getPagination ( ) : mixed
Результат mixed

getRelationDefnition() защищенный Метод

protected getRelationDefnition ( $relation ) : mixed
$relation
Результат mixed

getSearch() публичный Метод

public getSearch ( ) : ModelSearch
Результат ModelSearch

getSubListParent() публичный Метод

public getSubListParent ( ) : array
Результат array

getUnsortableColumns() публичный Метод

public getUnsortableColumns ( ) : array
Результат array

isSortableColumn() публичный Метод

Returns wether a given column is sortable or not.
public isSortableColumn ( $attribute ) : boolean
$attribute
Результат boolean

isSubList() публичный Метод

public isSubList ( ) : boolean
Результат boolean

listModel() публичный Метод

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

relationClassFromRelation() защищенный Метод

protected relationClassFromRelation ( $relation ) : BaseActiveRecord
$relation
Результат BaseActiveRecord

relationFieldFromRelation() защищенный Метод

protected relationFieldFromRelation ( $relation )

render() защищенный Метод

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

searchAll() публичный Метод

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

setController() публичный Метод

public setController ( BaseAdminController $controller )
$controller BaseAdminController

setCustomCancelURL() публичный Метод

public setCustomCancelURL ( $cancelURL )
$cancelURL

setCustomSaveURL() публичный Метод

public setCustomSaveURL ( $saveURL )
$saveURL

setEditFields() публичный Метод

public setEditFields ( array $editFields )
$editFields array

setEditTemplate() публичный Метод

public setEditTemplate ( string $editTemplate )
$editTemplate string

setFilterFields() публичный Метод

public setFilterFields ( $filters )
$filters

setIsSubList() публичный Метод

public setIsSubList ( boolean $isSubList )
$isSubList boolean

setListFields() публичный Метод

public setListFields ( array $listFields )
$listFields array

setListTemplate() публичный Метод

public setListTemplate ( string $listTemplate )
$listTemplate string

setModel() публичный Метод

public setModel ( BaseActiveRecord $model )
$model BaseActiveRecord

setModelDisplayName() публичный Метод

public setModelDisplayName ( $displayName )

setModelId() публичный Метод

public setModelId ( integer $modelId )
$modelId integer

setModelName() публичный Метод

public setModelName ( string $modelName )
$modelName string

setPagination() публичный Метод

public setPagination ( mixed $pagination )
$pagination mixed

setSearch() публичный Метод

public setSearch ( ModelSearch $search )
$search ModelSearch

setSubListParent() публичный Метод

public setSubListParent ( array $subListParent )
$subListParent array

setUnsortableColumns() публичный Метод

public setUnsortableColumns ( array $unsortableColumns )
$unsortableColumns array

sortModel() публичный Метод

Saves the display_order.
public sortModel ( )

sortQuery() публичный Метод

Takes the current URL, sets two values in it and returns it.
public sortQuery ( $attribute, $order, $queryString ) : string
$attribute
$order
$queryString
Результат string

Описание свойств

$controller защищенное свойство

protected BaseAdminController $controller
Результат BaseAdminController

$customCancelURL защищенное свойство

protected string $customCancelURL
Результат string

$customSaveURL защищенное свойство

protected string $customSaveURL
Результат string

$displayOrder публичное свойство

public int $displayOrder
Результат integer

$editFields защищенное свойство

protected array $editFields
Результат array

$editTemplate защищенное свойство

protected string $editTemplate
Результат string

$filterFields защищенное свойство

protected array $filterFields
Результат array

$isSubList защищенное свойство

protected bool $isSubList
Результат boolean

$listFields защищенное свойство

protected array $listFields
Результат array

$listTemplate защищенное свойство

protected string $listTemplate
Результат string

$model защищенное свойство

protected BaseActiveRecord $model
Результат BaseActiveRecord

$modelDisplayName защищенное свойство

protected string $modelDisplayName
Результат string

$modelId защищенное свойство

protected int $modelId
Результат integer

$modelName защищенное свойство

protected string $modelName
Результат string

$pagination защищенное свойство

protected CPagination $pagination
Результат CPagination

$subListParent защищенное свойство

Contains key value of parent object relation for a sublist.
protected array $subListParent
Результат array

$unsortableColumns защищенное свойство

protected array $unsortableColumns
Результат array