| Property | Type | Description | |
|---|---|---|---|
| $displayOrder | integer |
| Property | 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 |
| Method | 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. |
| Method | Description | |
|---|---|---|
| audit ( $type, $data = null ) | ||
| getRelationDefnition ( $relation ) : mixed | ||
| relationClassFromRelation ( $relation ) : BaseActiveRecord | ||
| relationFieldFromRelation ( $relation ) | ||
| render ( $template, array $data = [] ) |
| public __construct ( BaseActiveRecord $model, BaseAdminController $controller ) | ||
| $model | BaseActiveRecord | |
| $controller | BaseAdminController | |
| public attributeValue ( $row, $attribute ) : string | ||
| $row | ||
| $attribute | ||
| return | string | |
| public deleteModel ( ) |
| public editModel ( ) |
| public generateAdminForRelationList ( $relation, array $listFields ) | ||
| $listFields | array | |
| public getController ( ) : BaseAdminController | ||
| return | BaseAdminController | |
| protected getRelationDefnition ( $relation ) : mixed | ||
| $relation | ||
| return | mixed | |
| public isSortableColumn ( $attribute ) : boolean | ||
| $attribute | ||
| return | boolean | |
| public listModel ( $buttons = true ) |
| protected relationClassFromRelation ( $relation ) : BaseActiveRecord | ||
| $relation | ||
| return | BaseActiveRecord | |
| public setController ( BaseAdminController $controller ) | ||
| $controller | BaseAdminController | |
| public setEditTemplate ( string $editTemplate ) | ||
| $editTemplate | string | |
| public setListTemplate ( string $listTemplate ) | ||
| $listTemplate | string | |
| public setSubListParent ( array $subListParent ) | ||
| $subListParent | array | |
| public setUnsortableColumns ( array $unsortableColumns ) | ||
| $unsortableColumns | array | |
| protected BaseAdminController $controller | ||
| return | BaseAdminController | |
| protected array $subListParent | ||
| return | array | |
