- The CRUD controllers allow you to perform basic operations on a Model class:
- Create
- Read
- Update
- Delete
- ...
Note
Since version 2.4.6, Two types of CrudController exist: - ResourceCrudController associated with a model - MultiResourceCRUDController, displaying an index and allowing to navigate between models.
In the admin interface (web-tools), activate the Controllers part, and choose create Resource Crud controller:
- Then fill in the form:
- Enter the controller name
- Select the associated model
- Then click on the validate button
The generated controller:
<?php
namespace controllers;
/**
* CRUD Controller UsersController
**/
class UsersController extends \Ubiquity\controllers\crud\CRUDController{
public function __construct(){
parent::__construct();
$this->model= models\User::class;
}
public function _getBaseRoute():string {
return 'UsersController';
}
}Test the created controller by clicking on the get button in front of the index action:
Clicking on a row of the dataTable (instance) displays the objects associated to the instance (details action):
Using the search area:
It is possible to create an instance by clicking on the add button
The default form for adding an instance of User:
The edit button on each row allows you to edit an instance
The default form for adding an instance of User:
The delete button on each row allows you to edit an instance
Display of the confirmation message before deletion:
Create again a ResourceCrudController from the admin interface:
It is now possible to customize the module using overriding.
| Method | Signification | Default return |
|---|---|---|
| routes | ||
| index() | Default page : list all objects | |
| edit($modal="no", $ids="") | Edits an instance | |
| newModel($modal="no") | Creates a new instance | |
| display($modal="no",$ids="") | Displays an instance | |
| delete($ids) | Deletes an instance | |
| update() | Displays the result of an instance updating | |
| showDetail($ids) | Displays associated members with foreign keys | |
| refresh() | Refreshes the area corresponding to the DataTable (#lv) | |
| refreshTable($id=null) | //TO COMMENT |
| Method | Signification | Default return |
|---|---|---|
| index route | ||
| getModelDataTable($instances, $model,$totalCount,$page=1) | Creates the dataTable and Adds its behavior | DataTable |
| getDataTableInstance($instances,$model,$totalCount,$page=1) | Creates the dataTable | DataTable |
| recordsPerPage($model,$totalCount=0) | Returns the count of rows to display (if null there's no pagination) | null or 6 |
| getGroupByFields() | Returns an array of members on which to perform a grouping | [] |
| getDataTableRowButtons() | Returns an array of buttons to display for each row ["edit","delete","display"] | ["edit","delete"] |
| onDataTableRowButton(HtmlButton $bt, ?string $name) | To override for modifying the dataTable row buttons | |
| getCaptions($captions, $className) | Returns the captions of the column headers | all member names |
| detail route | ||
| showDetailsOnDataTableClick() | To override to make sure that the detail of a clicked object is displayed or not | true |
| onDisplayFkElementListDetails($element,$member,$className,$object) | To modify for displaying each element in a list component of foreign objects | |
| getFkHeaderElementDetails($member, $className, $object) | Returns the header for a single foreign object (issue from ManyToOne) | HtmlHeader |
| getFkElementDetails($member, $className, $object) | Returns a component for displaying a single foreign object (manyToOne relation) | HtmlLabel |
| getFkHeaderListDetails($member, $className, $list) | Returns the header for a list of foreign objects (oneToMany or ManyToMany) | HtmlHeader |
| getFkListDetails($member, $className, $list) | Returns a list component for displaying a collection of foreign objects (many) | HtmlList |
| edit and newModel routes | ||
| getForm($identifier, $instance) | Returns the form for adding or modifying an object | HtmlForm |
| formHasMessage() | Determines if the form has a message title | true |
| getFormModalTitle($instance) | Returns the form modal title | instance class |
| onFormModalButtons($btOkay, $btCancel) | Hook for updating modal buttons | |
| getFormTitle($form,$instance) | Returns an associative array defining form message title with keys "icon","message","subMessage" | HtmlForm |
| setFormFieldsComponent(DataForm $form,$fieldTypes) | Sets the components for each field | |
| onGenerateFormField($field) | For doing something when $field is generated in form | |
| isModal($objects, $model) | Condition to determine if the edit or add form is modal for $model objects | count($objects)>5 |
| getFormCaptions($captions, $className, $instance) | Returns the captions for form fields | all member names |
| display route | ||
| getModelDataElement($instance,$model,$modal) | Returns a DataElement object for displaying the instance | DataElement |
| getElementCaptions($captions, $className, $instance) | Returns the captions for DataElement fields | all member names |
| delete route | ||
| onConfirmButtons(HtmlButton $confirmBtn,HtmlButton $cancelBtn) | To override for modifying delete confirmation buttons |
| Method | Signification | Default return |
|---|---|---|
| index route | ||
| _getInstancesFilter($model) | Adds a condition for filtering the instances displayed in dataTable | 1=1 |
| getFieldNames($model) | Returns the fields to display in the index action for $model | all member names |
| getSearchFieldNames($model) | Returns the fields to use in search queries | all member names |
| edit and newModel routes | ||
| getFormFieldNames($model,$instance) | Returns the fields to update in the edit and newModel actions for $model | all member names |
| getManyToOneDatas($fkClass,$instance,$member) | Returns a list (filtered) of $fkClass objects to display in an html list | all $fkClass instances |
| getOneToManyDatas($fkClass,$instance,$member) | Returns a list (filtered) of $fkClass objects to display in an html list | all $fkClass instances |
| getManyToManyDatas($fkClass,$instance,$member) | Returns a list (filtered) of $fkClass objects to display in an html list | all $fkClass instances |
| display route | ||
| getElementFieldNames($model) | Returns the fields to display in the display action for $model | all member names |
| Method | Signification | Default return |
|---|---|---|
| index route | ||
| onConfDeleteMessage(CRUDMessage $message,$instance) | Returns the confirmation message displayed before deleting an instance | CRUDMessage |
| onSuccessDeleteMessage(CRUDMessage $message,$instance) | RReturns the message displayed after a deletion | CRUDMessage |
| onErrorDeleteMessage(CRUDMessage $message,$instance) | Returns the message displayed when an error occurred when deleting | CRUDMessage |
| edit and newModel routes | ||
| onSuccessUpdateMessage(CRUDMessage $message) | Returns the message displayed when an instance is added or inserted | CRUDMessage |
| onErrorUpdateMessage(CRUDMessage $message) | Returns the message displayed when an error occurred when updating or inserting | CRUDMessage |
| onNewInstance(object $instance) | Triggered after the creation of a new instance | |
| onBeforeUpdate(object $instance, bool $isNew) | Triggered before the instance update | |
| all routes | ||
| onNotFoundMessage(CRUDMessage $message,$ids) | Returns the message displayed when an instance does not exists | |
| onDisplayElements($dataTable,$objects,$refresh) | Triggered after displaying objects in dataTable |
| Method | Signification | Default return |
|---|---|---|
| template files | ||
| getViewBaseTemplate() | Returns the base template for all | Crud actions if getBaseTemplate return a base template filename | @framework/crud/baseTemplate.html |
| getViewIndex() | Returns the template for the **in | dex** route | @framework/crud/index.html |
| getViewForm() | Returns the template for the **ed | it** and newInstance routes | @framework/crud/form.html |
| getViewDisplay() | Returns the template for the **di | splay** route | @framework/crud/display.html |
| Urls | ||
| getRouteRefresh() | Returns the route for refreshing | the index route | /refresh |
| getRouteDetails() | Returns the route for the detail | route, when the user click on a dataTable row | /showDetail |
| getRouteDelete() | Returns the route for deleting an | instance | /delete |
| getRouteEdit() | Returns the route for editing an | instance | /edit |
| getRouteDisplay() | Returns the route for displaying | an instance | /display |
| getRouteRefreshTable() | Returns the route for refreshing | the dataTable | /refreshTable |
| getDetailClickURL($model) | Returns the route associated with | a foreign key instance in list | "" |
Displayed in frm block
Displayed in frm block
Note
The MultiResourceCRUDController displays an index allowing to navigate between the CRUDs of the models.
In the admin interface (web-tools), activate the Controllers part, and choose create Index Crud controller:
- Then fill in the form:
- Enter the controller name
- The route path (which must contain the variable part {resource})
- Then click on the validate button
The generated controller:
<?php
namespace controllers;
use Ubiquity\attributes\items\router\Route;
#[Route(path: "/{resource}/crud",inherited: true,automated: true)]
class CrudIndex extends \Ubiquity\controllers\crud\MultiResourceCRUDController{
#[Route(name: "crud.index",priority: -1)]
public function index() {
parent::index();
}
#[Route(path: "#//home/crud",name: "crud.home",priority: 100)]
public function home(){
parent::home();
}
protected function getIndexType():array {
return ['four link cards','card'];
}
public function _getBaseRoute():string {
return "/".$this->resource."/crud";
}
}Test the created controller at /home/crud url:
Create again a MultiResourceCrudController from the admin interface:
It is now possible to customize the module using overriding like the ResourceCRUDControllers.
| Method | Signification | Default return |
|---|---|---|
| routes | ||
| home () | Home page : list all models | |
All routes from CRUDController |
||
| Events | ||
| onRenderView(array &$data) | On before home page rendering | |
| Configuration | ||
| hasNavigation() | Returns True for displaying the navigation dropdown menu | True |
| getIndexModels() | Returns the list of available models to display | models from default db |
| getIndexModelsDetails() | Returns an associative array (title, icon url) for each model | [] |
| getIndexDefaultIcon(string $resource) | Returns the icon for a model | A random animal |
| getIndexDefaultTitle(string $resource) | Returns the title for a model | The resource name |
| getIndexDefaultDesc(string $modelClass) | Returns the description for a model | The complete classname |
| getIndexDefaultUrl(string $resource) | Returns the url associated to a model | The route path |
| getIndexDefaultMeta(string $modelClass) | Returns the meta for a model | |
| getIndexType() | Defines the index component css classes | cards |
| getModelName() | Returns the complete model name for $this->resource | From default model NS |
| Method | Signification | Default return |
|---|---|---|
| template files | ||
| getViewHome() | Returns the base template for the | home view | @framework/crud/home.html |
| getViewItemHome() | Returns the template for an item | in home route | @framework/crud/itemHome.html |
| getViewNav() | Returns the template for displayi | ng models in a dropdown | @framework/crud/nav.html |
Note
All other methods of the CRUDController, CRUDFiles, CRUDEvents and CRUDDatas classes can be overridden as for the ResourceCRUDController.