ActionMiddleware.php

Go to the documentation of this file.

<?php

namespace Elgg\Router\Middleware;

use Elgg\Exceptions\Http\ValidationException;
use Elgg\Http\OkResponse;

class ActionMiddleware {

    protected $request;
    
    protected $form_name;
    
    public function __invoke(\Elgg\Request $request): void {
        $this->request = $request;
        
        $route = $request->getRoute();
        list(, $action) = explode(':', $route, 2);

        // save sticky form values
        $this->prepareStickyForm();
        
        $result = $request->elgg()->events->triggerResults('action:validate', $action, ['request' => $request], true);
        if ($result === false) {
            throw new ValidationException(elgg_echo('ValidationException'));
        }

        // set the maximum execution time for actions
        $action_timeout = $request->elgg()->config->action_time_limit;
        if (isset($action_timeout)) {
            set_time_limit($action_timeout);
        }
    }
    
    protected function prepareStickyForm(): void {
        $this->form_name = $this->request->getParam('_elgg_sticky_form_name');
        
        if (empty($this->form_name)) {
            return;
        }
        
        // add user and system ignored fields
        $ignored_fields = (string) $this->request->getParam('_elgg_sticky_ignored_fields');
        $ignored_fields = elgg_string_to_array($ignored_fields);
        
        _elgg_services()->stickyForms->makeStickyForm($this->form_name, $ignored_fields);
        
        // register sticky value cleanup
        $this->request->elgg()->events->registerHandler('response', 'all', [$this, 'cleanupStickyValues']);
    }
    
    public function cleanupStickyValues(\Elgg\Event $event): void {
        $response = $event->getValue();
        if (!$response instanceof OkResponse) {
            return;
        }
        
        _elgg_services()->stickyForms->clearStickyForm($this->form_name);
    }
}