StickyForms.php

Go to the documentation of this file.

<?php

namespace Elgg\Forms;

class StickyForms {

    public function __construct(protected \ElggSession $session) {
    }
    
    public function makeStickyForm(string $form_name, array $ignored_field_names = []): void {
        $this->clearStickyForm($form_name);

        $default_ignored_field_names = [
            '__elgg_ts', // never store CSRF tokens
            '__elgg_token', // never store CSRF tokens
            '_elgg_sticky_form_name', // from sticky form support
            '_elgg_sticky_ignored_fields', // from sticky form support
            '_route', // added by router
        ];
        $ignored_field_names = array_merge($default_ignored_field_names, $ignored_field_names);
        
        $data = $this->session->get('sticky_forms', []);
        $req = _elgg_services()->request;
    
        // will go through XSS filtering in elgg_get_sticky_value()
        $vars = array_merge($req->query->all(), $req->request->all());
        foreach ($ignored_field_names as $key) {
            unset($vars[$key]);
        }
        
        $data[$form_name] = $vars;
    
        $this->session->set('sticky_forms', $data);
    }
    
    public function clearStickyForm(string $form_name): void {
        $data = $this->session->get('sticky_forms', []);
        unset($data[$form_name]);
        
        $this->session->set('sticky_forms', $data);
    }
    
    public function isStickyForm(string $form_name): bool {
        $data = $this->session->get('sticky_forms', []);
        return isset($data[$form_name]);
    }
    
    public function getStickyValue(string $form_name, string $variable = '', $default = null, bool $filter_result = true) {
        $data = $this->session->get('sticky_forms', []);
        if (isset($data[$form_name][$variable])) {
            $value = $data[$form_name][$variable];
            if ($filter_result) {
                // XSS filter result
                $value = elgg_sanitize_input($value);
            }
            
            return $value;
        }
        
        return $default;
    }
    
    public function getStickyValues(string $form_name, bool $filter_result = true): array {
        $data = $this->session->get('sticky_forms', []);
        if (!isset($data[$form_name])) {
            return [];
        }
    
        $values = $data[$form_name];
        if ($filter_result) {
            foreach ($values as $key => $value) {
                // XSS filter result
                $values[$key] = elgg_sanitize_input($value);
            }
        }
        
        return $values;
    }
}