activecollab/controller

Invokable controller that accepts containers, works with ETag and more

2.1.2 2024-01-23 14:27 UTC

Requires

• php: >=8.0
• ext-json: *
• activecollab/containeraccess: ^2.0
• activecollab/etag: ^1.0
• activecollab/templateengine: ^3.0
• activecollab/utils: ^2.0
• laminas/laminas-diactoros: ^2.8
• psr/http-factory: ^1.0
• psr/http-message: ^1.0
• psr/http-server-middleware: ^1.0
• psr/log: ~1.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.0
• monolog/monolog: ^1.0
• phpunit/phpunit: ^9.0
• pimple/pimple: ^3.0

Suggests

• slim/http: Allow using of chunked file download

MIT

• controller

README

Supported action responses:

1. \ActiveCollab\Controller\Response\FileDownloadResponse - streams a file download.
2. \ActiveCollab\Controller\Response\StatusResponse - returns a HTTP status, without response body.
3. \ActiveCollab\Controller\Response\ViewResponse - Renders a particular view.

When within a controller action, use these methods to get individual request parameters:

1. getParsedBodyParam()
2. getCookieParam()
3. getQueryParam()
4. getServerParam()

All of these methods accept three parameters:

1. $request (\Psr\Http\Message\ServerRequestInterface instance)
2. $param_name (string)
3. $default (mixed, NULL by default)

Configuration

Controllers can override protected configure() method to do additional setup after controller construction. This method is separated from constructor, so developer does not need to inherit and manage complicated controller constructor.

<?php

namespace App;

use ActiveCollab\Controller\Controller;

class TestController extends Controller
{
    public $is_configured = false;

    protected function configure(): void
    {
        $this->is_configured = true;
    }
}

Exception Handling

When action fails due to an exception, system will return 500 HTTP error, with a message that does not expose any of the system details.

This is done in such a way that new RuntimeException is constructed, with generic error message, and real exception is passed as $previous constructor argument of the new exception. If you have your system configured so exceptions are fully described when 500 errors are rendered (in debug mode for example), you'll be able to access original exception detials like that.

To change default exception message, call setLogExceptionMessage() controller method:

$controller->setLogExceptionMessage('Something weird happened: {exception}');

If $logger is added to the controller (during construction or later on), all exceptions that actions throw will be logged with error level.

To do

1. Add $payload to status shortcut methods.