windwalker/controller

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

Windwalker Controller package

2.1.9 2016-02-12 15:36 UTC

README

The Windwalker Controller package is a simple interface to control some business logic, id didn't dependency to any other packages. You may integrate it to any systems.

Installation via Composer

Add this to the require block in your composer.json.

{
    "require": {
        "windwalker/controller": "~2.0"
    }
}

Create Your Controller

use Windwalker\Controller\Controller;

class IndexController extends AbstractController
{
    public function execute()
    {
        return 'Index';
    }
}

$controller = new IndexController;

$output = $contorller->execute();

Windwakler Controller is a "Single Action Controller", follows single responsibility principle, every controller just maintain one task(action). It is inspired from Joomla New MVC. You can create IndexController, CreateController, UpdateController and DeleteController for CRUD.

Using Input and Application

By default, controller maintains an input and an application object. We can set it when construct:

use Windwalker\Controller\Controller;

class IndexController extends AbstractController
{
    public function execute()
    {
        // Get params from http request
        $method = $this->input->get('_method');

        $this->app->redirect('...');

        return true;
    }
}

$input = new Input;
$app = new WebApplication;

$controller = new IndexController($input, $app);

$output = $contorller->execute();

It didn't dependency to Windwalker self, you can push other framework's input and application into it:

$input = new Request;
$app = new HttpKernel;

$controller = new IndexController($input, $app);

$output = $contorller->execute();

HMVC

Using HMVC in Windwalker controller is very easy:

class IndexController extends AbstractController
{
    public function execute()
    {
        $this->input->set('id', 123);

        $foo = new FooController($this->input, $this->app);

        echo $foo->execute();

        return true;
    }
}

Multi Action Controller

If you are familiar to common multiple action pattern, use AbstractMultiActionController:

use Windwalker\Controller\AbstractMultiActionController;

class ArticleController extends AbstractMultiActionController
{
    public function indexAction()
    {}

    public function saveAction($id = null, $data = array())
    {}

    public function deleteAction($id = null)
    {}
}

$controller = new ArticleController;

// Will call saveAction()
$controller->setActionName('save')
    ->setArguments(array(5, $data))
    ->execute();

If no action set, will call doExecute() instead, but you still need to override doExecute() first.