Routes

This page lists all default routes added by Uccello.

Definition

A route is a way to access to resources. It is represented by a unique URL.

Modules can be classified into two categories:

• Modules that allow records management.

• Modules that add functionality without necessarily being linked to specific records.

Thanks to the programming concept used by Uccello, when you create a new module, several routes are automatically available.

Depending on the type of module we have created, the following routes are available by default:

For modules not linked to records, only theuccello.index route is available.

Default routes

Name	URL	Description
uccello.index	/{domain}/{module}	By default the displayed page is empty. But you can customize it to display different information.
uccello.list	/{domain}/{module}/list	List of your module's records.
uccello.detail	/{domain}/{module}/detail?id=[0-9]+	Record detail page.
uccello.edit	/{domain}/{module}/edit or /{domain}/{module}/edit?id=[0-9]+	Page to create a new record. Record edit page.
uccello.delete	/{domain}/{module}/delete?id=[0-9]+	URL to delete a record.
uccello.restore	/{domain}/{module}/restore?id=[0-9]+	URL to restore a record from the trash.
uccello.tree	/{domain}/{module}/tree	List of your module's records represented in a tree. This view is only accessible if your Model extends \Gzero\EloquentTree\Model\Tree.

If multi domains option is not activated, /{domain}/{module} is replaced by /{module} in all URL.

The helper function ucroute() helps you to call an Uccello's route, for example:

ucroute('uccello.list', $domain, $module);
// Example: /uccello/person/list

or with params:

ucroute('uccello.edit', $domain, $module, [ 'id' => 1 ]);
// Example: /uccello/person/edit?id=1

If multi domains option is not activated, the domain will not be present in the generated route.