jasny/controller

A general controller for PSR-7

Jasny Controller

, _(*1)

PSR-7 controller for Slim Framework and other micro-frameworks., _(*2)

The controller is responsible handling the HTTP request, manipulate the model and initiate the view., _(*3)

The code in the controller read as a high level description of each action. The controller should not contain implementation details. This belongs in the model, view or in services and libraries., _(*4)

Installation

Install using composer, _(*5)

composer require jasny\controller

Setup

Jasny\Controller can be used as a base class for each of your controllers. It lets you interact with the PSR-7 server request and response in a friendly matter., _(*6)

class MyController extends Jasny\Controller\Controller
{
    public function hello(string $name, #[QueryParam] string $others = ''): void
    {
        $this->output("Hello $name" . ($others ? " and $others" : ""), 'text');
    }
}

Visiting https://example.com/hello/Arnold&others=friends would output Hello Arnold and friends., _(*7)

Actions are defined as public methods of the controller., _(*8)

A controller is a callable object by implementing the [__invoke][] method. The invoke method takes a PSR-7 server request and response object and will return a modified response object. This all is abstracted away when you write your controller., _(*9)

A router typically handles the request and chooses the correct controller object to call. The router is also responsible for extracting parameters from the url path and possibly choosing a method to call within the controller., _(*10)

Slim framework

Slim is a PHP micro-framework that works with PSR-7. To use this library with slim, use the provided middleware., _(*11)

use Jasny\Controller\Middleware\Slim as ControllerMiddleware;
use Slim\Factory\AppFactory;

$app = AppFactory::create();

$app->add(new ControllerMiddleware());
$app->addRoutingMiddleware();

$app->get('/hello/{name}', ['MyController', 'hello']);

Optionally, the middleware can convert error responses from the controller to Slim HTTP Errors by passing true to the middleware constructor., _(*12)

use Jasny\Controller\Middleware\Slim as ControllerMiddleware;
use Slim\Factory\AppFactory;

$app = AppFactory::create();

$app->add(new ControllerMiddleware(true));
$app->addRoutingMiddleware();
$app->addErrorMiddleware(true, true, true);

Relay + SwitchRoute

SwitchRoute, a super-fast router based on generating code. The router needs a PSR-15 request handler to work with PRS-7 server requests, like Relay., _(*13)

By default, the route action is converted to the method that will be called by the PSR-15 handler. For this library, __invoke should be called instead. The invoke method will take care of calling the right method within the controller., _(*14)

$stud = fn($str) => strtr(ucwords($str, '-'), ['-' => '']);

$invoker = new Invoker(fn (?string $controller, ?string $action) => [
    $controller !== null ? $stud($controller) . 'Controller' : $stud($action) . 'Action',
    '__invoke'
]);

See SwitchRoute for more information, _(*15)

Output

When using PSR-7, you shouldn't use echo, because it makes it harder to write tests. Instead, use the output method of the controller, which writes to the response body stream object., _(*16)

$this->output('Hello world');

A second argument may be passed, which sets the Content-Type header. You can pass a mime type like 'text/html'. Alternatively you can use a common file extension like 'txt'. The controller uses the ralouphie/mimey library to get the mime type., _(*17)

class MyController extends Jasny\Controller\Controller
{
    /**
     * Output a random number between 0 and 100 as HTML
     */
    public function random()
    {
        $number = rand(0, 100);
        $this->output("<h1>$number</h1>", 'html');
    }
}

JSON

The json method can be used to serialize and output data as JSON., _(*18)

class MyController extends Jasny\Controller\Controller
{
    /**
     * Output 5 random numbers between 0 and 100 as JSON
     */
    public function random()
    {
        $numbers = array_map(fn() => rand(0, 100), range(1, 5));
        $this->json($numbers);
    }
}

Response status

To set the response status you can use the status() method. This method can take the response status as integer or as string specifying both the status code and phrase., _(*19)

class MyController extends Jasny\Controller\Controller
{
    public function process(string $size)
    {
        if (!in_array($size, ['XS', 'S', 'M', 'L', 'XL'])) {
            return $this
                ->status("400 Bad Request")
                ->output("Invalid size: $size");
        }

        // Create something ...

        return $this
            ->status(201)
            ->header("Location: http://www.example.com/foo/something")
            ->json($something);
    }
}

Alternatively and preferably you can use helper method to set a specific response status. Some method can optionally take arguments that make sense for that status., _(*20)

class MyController extends Jasny\Controller\Controller
{
    public function process(string $size)
    {
        if (!in_array($size, ['XS', 'S', 'M', 'L', 'XL'])) {
            return $this->badRequest()->output("Invalid size: $size");
        }

        // Create something ...

        return $this
            ->created("http://www.example.com/foo/something")
            ->json($something);
    }
}

The following methods for setting the output status are available, _(*21)

• Some methods take a $message argument. This will set the output.
• If a method takes a $code argument, you can specify the status code.
• The back() method will redirect to the referer, but only if the referer is from the same domain as the current url.

Sometimes it's useful to check the status code that has been set for the response. This can be done with the getStatusCode() method. In addition, there are methods to check the type of status., _(*22)

Response headers

You can set the response header using the setResponseHeader() method., _(*23)

class MyController extends Jasny\Controller\Controller
{
    public function process()
    {
        $this->header("Content-Language", "nl");
        // ...
    }
}

By default, response headers are overwritten. In some cases you want to have duplicate headers. In that case set the third argument to true, eg header($header, $value, true)., _(*24)

$this->header("Cache-Control", "no-cache"); // overwrite header
$this->header("Cache-Control", "no-store", true); // add header

Input

With PSR-7, you shouldn't use super globals $_GET, $_POST, $_COOKIE, and $_SERVER. Instead, these values are available through the server request object. This is done using PHP attributes., _(*25)

The controller will map each argument of a method to a parameter. By default, arguments are mapped to path parameters., _(*26)

Parameters

Path parameters

A router may extract parameters from the request URL. In the following example, the url path /hello/world, the path parameter name will have the value "world"., _(*27)

$app->get('/hello/{name}', ['MyController', 'hello']);

The name parameter will be passed as argument to the hello method., _(*28)

class MyController extends Jasny\Controller\Controller
{
    public function hello(string $name)
    {
        $this->output("Hello $name");
    }
}

Single request parameter

The controller will pass PSR-7 request parameters as arguments. This is specified by an attribute, _(*29)

• QueryParam
• BodyParam
• Cookie
• UploadedFile
• Header

If the argument name is used as parameter name, _(*30)

• for QueryParam, underscores are replaced with dashes. Eg: $foo_bar will translate to query param foo-bar.
• for Header, words are capitalized and underscores become dashes. Eg: $foo_bar translates to header Foo-Bar.

All request parameters

To get all request parameters of a specific type, the following attributes are available., _(*31)

• Query
• Body
• Cookies
• UploadedFiles
• Headers

For the Body attribute, the type of the argument should either be an array or a string. If an array is passed the argument will be the parsed body. In case of a string it will be the raw body., _(*32)

PSR-7 request attribute

Middleware can set attributes of the PSR-7 request. These request attributes are available as arguments by using the Attr attribute., _(*33)

Parameter name

For single parameters, the name of the argument will be used as parameter name. Alternatively, it's possible to specify a name when defining the attribute., _(*34)

use Jasny\Controller\Controller;
use Jasny\Controller\Parameter\PathParam;
use Jasny\Controller\Parameter\QueryParam;

class MyController extends Controller
{
    public function hello(#[PathParam] string $name, #[QueryParam('and')] string $other = '')
    {
        $this->output("Hello $name" . ($other ? " and $other" : ""));
    }
}

Note: #[PathParam] could be omitted, since it's the default behaviour., _(*35)

Parameter type

It's possible to specify a type as second argument when defining the attribute. By default, the type is determined on the type of the argument., _(*36)

use Jasny\Controller\Controller;
use Jasny\Controller\Parameter\BodyParam;

class MyController extends Controller
{
    public function send(#[BodyParam(type: 'email')] string $emailAddress)
    {
        // ...
    }
}

Parameter attributes use the filter_var function to sanitize input. The following filters are defined, _(*37)

For other types (like string), no filter is applied., _(*38)

use Jasny\Controller\Controller;
use Jasny\Controller\Parameter\PostParam;

class MyController extends Controller
{
    public function message(#[PostParam(type: 'email')] array $email)
    {
        // ...
    }
}

To add custom types, add filters to SingleParameter::$types, _(*39)

use Jasny\Controller\Parameter\SingleParameter;

SingleParameter::$types['slug'] = [FILTER_VALIDATE_REGEXP, '/^[a-z\-]+$/'];

Content negotiation

Content negotiation allows the controller to give different output based on Accept request headers. It can be used to select the content type (switch between JSON and XML), the content language, encoding, and charset., _(*40)

negotiateCharset() will modify the Content-Type header if it's already set. Otherwise, it will just return the selected charset., _(*41)

The negotiate method takes a list or priorities as argument. It sets the response header and returns the selected option., _(*42)

class MyController extends Jasny\Controller\Controller
{
    public function hello()
    {
        $language = $this->negotiateLanguage(['en', 'de', 'fr', 'nl;q=0.6']);

        switch ($language) {
            case 'en':
                return $this->output('Good morning');
            case 'de':
                return $this->output('Guten Morgen');
            case 'fr':
                return $this->output('Bonjour');
            case 'nl':
                return $this->output('Goedemorgen');
            default:
                return $this
                    ->notAcceptable()
                    ->output("This content isn't available in your language");
        }
    }
}

For more information, please check the documentation of the willdurand/negotiation library., _(*43)

Hooks

In addition to the action method, the controller will also call the before() and after() method., _(*44)

Before

The before() method is call prior to the action method. If it returns a response, the method action is never called., _(*45)

class MyController extends Jasny\Controller\Controller
{
    protected function before()
    {
        if ($this->auth->getUser()->getCredits() <= 0) {
            return $this->paymentRequired()->output("Sorry, you're out of credits");
        }
    }

    // ...
}

Instead of before() consider using guards., _(*46)

After

The after() method is called after the action, regardless of the action response type., _(*47)

class MyController extends Jasny\Controller\Controller
{
    // ...

    protected function after()
    {
        $this->header('X-Available-Credits', $this->auth->getUser()->getCredits());
    }
}

Guards

Guards are PHP Attributes that are invoked before the controller method is called. A guard is similar to middleware, though more limited. The purpose of using a guard is to check if the controller action may be executed. If the guard returns a response, that response is emitted and the method on the controller is never called., _(*48)

class MyController extends Jasny\Controller\Controller
{
    #[MustBeLoggedIn]
    public function send()
    {
        // ...
    }
}

A guard class should implement the process method. A guard class has the same methods as a controller class. The process method can have input parameters., _(*49)

use Jasny\Controller\Guard;
use Jasny\Controller\Parameter\Attr;

#[\Attribute]
class MustBeLoggedIn extends Guard
{
    public function process(#[Attr] User? $sessionUser)
    {
        if ($sessionUser === null) {
            return $this->forbidden()->output("Not logged in");
        }
    }
}

Order of execution

Guards may be defined on the controller class or the action method. The order of execution is, _(*50)

• Class guards
• before()
• Method guards
• Action
• after()

Dependency injection

Guards are attributes, which are instantiated using PHP reflection. Parameters can be specified when the guard is declared., _(*51)

#[MinimalCredits(value: 20)]
class MyController extends \Jasny\Controller\Controller
{
    // ...
}

This makes it difficult to make a service (like a DB connection) available to a guard using dependency injection., _(*52)

Some DI container libraries, like PHP-DI, are able to inject services to an already instantiated object. To utilize this, overwrite the Guardian class and register it to the container., _(*53)

use Jasny\Controller\Guardian;
use Jasny\Controller\Guard;
use DI\Container;

return [
    Guardian::class => function (Container $container) {
        return new class ($container) extends Guardian {
            public function __construct(private Container $container) {}

            public function instantiate(\ReflectionAttribute $attribute): Guard {
                $guard = $attribute->newInstance();
                $this->container->injectOn($guard);

                return $guard;
            }
        } 
    }
];

The guard class can use #[Inject] attributes or @Inject annotations., _(*54)

use Jasny\Controller\Guard;
use DI\Attribute\Inject;

class MyGuard extends Guard
{
    #[Inject]
    private DBConnection $db;

    // ...
}

Make sure the Guardian service is injected into the controller using dependency injection., _(*55)

use Jasny\Controller\Controller;
use Jasny\Controller\Guardian;

class MyController extends Controller
{
    public function __construct(
        protected Guardian $guardian
    ) {}
}