StickyForms.php

Go to the documentation of this file.

<?php
namespace Elgg\Forms;

class StickyForms {
    
    public function makeStickyForm($form_name) {

        $banned_keys = [];
        // TODO make $banned_keys an argument
        if (in_array($form_name, ['register', 'useradd', 'usersettings'])) {
            $banned_keys = ['password', 'password2'];
        }

        elgg_clear_sticky_form($form_name);
    
        $session = _elgg_services()->session;
        $data = $session->get('sticky_forms', array());
        $req = _elgg_services()->request;
    
        // will go through XSS filtering in elgg_get_sticky_value()
        $vars = array_merge($req->query->all(), $req->request->all());
        foreach ($banned_keys as $key) {
            unset($vars[$key]);
        }
        $data[$form_name] = $vars;
    
        $session->set('sticky_forms', $data);
    }
    
    function clearStickyForm($form_name) {
        $session = _elgg_services()->session;
        $data = $session->get('sticky_forms', array());
        unset($data[$form_name]);
        $session->set('sticky_forms', $data);
    }
    
    function isStickyForm($form_name) {
        $session = _elgg_services()->session;
        $data = $session->get('sticky_forms', array());
        return isset($data[$form_name]);
    }
    
    function getStickyValue($form_name, $variable = '', $default = null, $filter_result = true) {
        $session = _elgg_services()->session;
        $data = $session->get('sticky_forms', array());
        if (isset($data[$form_name][$variable])) {
            $value = $data[$form_name][$variable];
            if ($filter_result) {
                // XSS filter result
                $value = filter_tags($value);
            }
            return $value;
        }
        return $default;
    }
    
    function getStickyValues($form_name, $filter_result = true) {
        $session = _elgg_services()->session;
        $data = $session->get('sticky_forms', array());
        if (!isset($data[$form_name])) {
            return array();
        }
    
        $values = $data[$form_name];
        if ($filter_result) {
            foreach ($values as $key => $value) {
                // XSS filter result
                $values[$key] = filter_tags($value);
            }
        }
        return $values;
    }
    
    function clearStickyValue($form_name, $variable) {
        $session = _elgg_services()->session;
        $data = $session->get('sticky_forms', array());
        unset($data[$form_name][$variable]);
        $session->set('sticky_forms', $data);
    }
    
}