MVC Rest Controller

Zemit MVC Rest Controller aims to simplify the process in a straightforward way while keeping the security, flexibility as well as Phalcon's native features.

Default Actions

Good to know: The controller usually refer to the associated model name. You can map the controller to another model by overriding the method getModelClassName() to fit your needs.

By default, the default action (indexAction) will analyse the request and forward it to the respective action as shown below:

Request	Path	Action	Forwarded to
POST	/:controller/:id	indexAction($id)	saveAction($id)
PUT	/:controller/:id	indexAction($id)	saveAction($id)
PATCH	/:controller/:id	indexAction($id)	saveAction($id)
DELETE	/:controller/:id	indexAction($id)	deleteAction($id)
GET	/:controller/:id	indexAction($id)	getAction($id)
GET	/:controller/	indexAction($id)	getListAction()

Optional path: The id parameter in the path is always optional and can be provided as a GET, a POST data or in a raw JSON BODY. If no id is passed, the system will act as if you want to create a new entry.

More actions are available using their respective path. See the list below:

Request	Path	Action	Behavior
GET	/:controller/get/:id /:controller/get-single/:id	getAction($id)	Get a single
GET, POST	/:controller/get-all /:controller/get-list	getListAction()	Get a list
GET, POST	/:controller/export	exportAction()	Download a flat list JSON, CSV, or XLSX
GET, POST	/:controller/count	countAction()	Get count from query
GET, POST	/:controller/new	newAction()	Get default values
GET, POST, PUT, PATCH	/:controller/validate	validateAction($id)	Validate only
GET, POST, PUT, PATCH	/:controller/save	saveAction($id)	Validate and save
GET, POST, DELETE	/:controller/delete	deleteAction($id)	Delete
GET, POST	/:controller/restore	restoreAction($id)	Restore soft-delete
GET, POST	/:controller/reorder	reorderAction($id)	Change list positions

Default Responses

Creating your own Rest Controller

Simply create a controller and then extend from the Zemit\Mvc\Controller\Rest class. In this example below, UserController will automatically get the User model from the defined namespaces within Module.php.

// ./app/Modules/Api/Controllers/UserController.php
namespace App\Modules\Api\Controllers;

class UserController extends Zemit\Mvc\Controller\Rest
{
    // ...
}

Forcing a custom model

// ./app/Modules/Api/Controllers/UserController.php
namespace App\Modules\Api\Controllers;

class UserController extends Zemit\Mvc\Controller\Rest
{
    public function getModelClassName()
    {
        return App\Common\Models\User::class
    }
}