chamilo/chamilo-lms

View on GitHub
public/main/inc/lib/chamilo_session.class.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php
/* For licensing terms, see /license.txt */

use Chamilo\CoreBundle\Framework\Container;

/**
 * @todo replace all $_SESSION calls with this class.
 */
class ChamiloSession implements \ArrayAccess
{
    /**
     * @param string $name
     */
    public function __unset($name)
    {
        unset($_SESSION[$name]);
    }

    /**
     * @param string $name
     *
     * @return bool
     */
    public function __isset($name)
    {
        return self::has($name);
    }

    /**
     * It it exists returns the value stored at the specified offset.
     * If offset does not exists returns null. Do not trigger a warning.
     *
     * @param string $name
     *
     * @return mixed
     */
    public function __get($name)
    {
        return self::read($name);
    }

    /**
     * @param string $name
     * @param mixed  $value
     */
    public function __set($name, $value)
    {
        self::write($name, $value);
    }

    /**
     * @param string     $variable
     * @param mixed|null $default
     *
     * @return mixed|null
     */
    public static function read($variable, $default = null)
    {
        $session = Container::getSession();

        $result = null;
        if (isset($session) && $session && $variable) {
            $result = $session->get($variable);
        }

        // Check if the value exists in the $_SESSION array
        if (empty($result)) {
            if (isset($_SESSION[$variable])) {
                return $_SESSION[$variable];
            }

            return $default;
        } else {
            return $result;
        }
    }

    /**
     * @param string $variable
     * @param mixed  $value
     */
    public static function write($variable, $value)
    {
        $session = Container::getSession();
        // Writing the session in 2 instances because
        $_SESSION[$variable] = $value;
        $session->set($variable, $value);
    }

    /**
     * @param string $variable
     */
    public static function erase($variable)
    {
        $variable = (string) $variable;
        $session = Container::getSession();
        $session->remove($variable);

        if (isset($GLOBALS[$variable])) {
            unset($GLOBALS[$variable]);
        }
        if (isset($_SESSION[$variable])) {
            unset($_SESSION[$variable]);
        }
    }

    /**
     * Returns true if session has variable set up, false otherwise.
     *
     * @param string $variable
     *
     * @return bool
     */
    public static function has($variable): bool
    {
        return isset($_SESSION[$variable]);
    }

    /**
     * Clear.
     */
    public static function clear(): void
    {
        $session = Container::getSession();
        $session->clear();
    }

    /**
     * Destroy.
     */
    public static function destroy(): void
    {
        $session = Container::getSession();
        $session->invalidate();
    }

    /*
     * ArrayAccess
     */
    public function offsetExists($offset): bool
    {
        return isset($_SESSION[$offset]);
    }

    /**
     * If it exists returns the value stored at the specified offset.
     * If offset does not exist returns null. Do not trigger a warning.
     *
     * @param string $offset
     *
     * @return mixed
     */
    public function offsetGet($offset): mixed
    {
        return self::read($offset);
    }

    public function offsetSet($offset, $value): void
    {
        self::write($offset, $value);
    }

    public function offsetUnset($offset): void
    {
        unset($_SESSION[$offset]);
    }
}