USession.php

Go to the documentation of this file.

<?php
 
namespace Ubiquity\utils\http;
 
use Ubiquity\utils\base\UString;
use Ubiquity\utils\http\session\SessionObject;
use Ubiquity\controllers\Startup;
 
class USession {
    protected static $sessionInstance;
 
    public static function getArray(string $arrayKey): array {
        if (self::$sessionInstance->exists ( $arrayKey )) {
            $array = self::$sessionInstance->get ( $arrayKey );
            if (! \is_array ( $array ))
                $array = [ ];
        } else
            $array = [ ];
        return $array;
    }
 
    public static function addOrRemoveValueFromArray(string $arrayKey, $value, $add = null): ?bool {
        $array = self::getArray ( $arrayKey );
        $_SESSION [$arrayKey] = $array;
        $search = \array_search ( $value, $array );
        if ($search === false && $add) {
            $array [] = $value;
            self::$sessionInstance->set ( $arrayKey, $array );
            return true;
        } else if ($add !== true) {
            unset ( $array [$search] );
            self::$sessionInstance->set ( $arrayKey, $array );
            return false;
        }
        return null;
    }
 
    public static function removeValueFromArray(string $arrayKey, $value): ?bool {
        return self::addOrRemoveValueFromArray ( $arrayKey, $value, false );
    }
 
    public static function addValueToArray(string $arrayKey, $value): ?bool {
        return self::addOrRemoveValueFromArray ( $arrayKey, $value, true );
    }
 
    public static function setBoolean(string $key, $value) {
        return self::$sessionInstance->set ( $key, UString::isBooleanTrue ( $value ) );
    }
 
    public static function getBoolean(string $key): bool {
        $v = self::$sessionInstance->get ( $key, false );
        return UString::isBooleanTrue ( $v );
    }
 
    public static function session(string $key, $default = NULL) {
        return self::$sessionInstance->get ( $key, $default );
    }
 
    public static function get(string $key, $default = NULL) {
        return self::$sessionInstance->get ( $key, $default );
    }
 
    public static function set(string $key, $value) {
        return self::$sessionInstance->set ( $key, $value );
    }
 
    public static function setTmp(string $key, $value, $duration) {
        if (self::$sessionInstance->exists ( $key )) {
            $object = self::$sessionInstance->get ( $key );
            if ($object instanceof SessionObject) {
                return $object->setValue ( $value );
            }
        }
        $object = new SessionObject ( $value, $duration );
        return self::$sessionInstance->set ( $key, $object );
    }
 
    public static function getTmp(string $key, $default = null) {
        if (self::$sessionInstance->exists ( $key )) {
            $object = self::$sessionInstance->get ( $key );
            if ($object instanceof SessionObject) {
                $value = $object->getValue ();
                if (isset ( $value )) {
                    return $object->getValue();
                }
                else {
                    self::delete ( $key );
                }
            }
        }
        return $default;
    }
 
    public static function getTimeout(string $key) {
        if (self::$sessionInstance->exists ( $key )) {
            $object = self::$sessionInstance->get ( $key );
            if ($object instanceof SessionObject) {
                $value = $object->getTimeout ();
                if ($value < 0) {
                    return 0;
                } else {
                    return $value;
                }
            }
        }
        return;
    }
 
    public static function delete(string $key): void {
        self::$sessionInstance->delete ( $key );
    }
 
    public static function inc(string $key, int $inc = 1) {
        return self::set ( $key, self::get ( $key, 0 ) + $inc );
    }
 
    public static function dec(string $key, int $dec = 1) {
        return self::set ( $key, self::get ( $key, 0 ) - $dec );
    }
 
    public static function concat(string $key, string $str, string $default = NULL): string {
        return self::set ( $key, self::get ( $key, $default ) . $str );
    }
 
    public static function apply(string $key, $callback, $default = NULL) {
        $value = self::get ( $key, $default );
        if (\is_string ( $callback ) && \function_exists ( $callback )) {
            $value = \call_user_func ( $callback, $value );
        } elseif ($callback instanceof \Closure) {
            $value = $callback ( $value );
        } else {
            return $value;
        }
        return self::set ( $key, $value );
    }
 
    public static function Walk($callback, $userData = null): array {
        $all = self::$sessionInstance->getAll ();
        foreach ( $all as $k => $v ) {
            self::$sessionInstance->set ( $k, $callback ( $k, $v, $userData ) );
        }
        return self::$sessionInstance->getAll ();
    }
 
    public static function replace(array $keyAndValues): array {
        foreach ( $keyAndValues as $k => $v ) {
            self::$sessionInstance->set ( $k, $v );
        }
        return self::$sessionInstance->getAll ();
    }
 
    public static function getAll(): array {
        return self::$sessionInstance->getAll ();
    }
 
    public static function start($name = null): void {
        if (! isset ( self::$sessionInstance )) {
            self::$sessionInstance = Startup::getSessionInstance ();
        }
        self::$sessionInstance->start ( $name );
    }
 
    public static function isStarted(): bool {
        return self::$sessionInstance->isStarted ();
    }
 
    public static function exists(string $key): bool {
        return self::$sessionInstance->exists ( $key );
    }
 
    public static function init(string $key, $value) {
        if (! self::$sessionInstance->exists ( $key )) {
            self::$sessionInstance->set ( $key, $value );
        }
        return self::$sessionInstance->get ( $key );
    }
 
    public static function terminate(): void {
        self::$sessionInstance->terminate ();
    }
 
    public static function getCsrfProtectionClass() {
        if (isset ( self::$sessionInstance )) {
            return \get_class ( self::$sessionInstance->getVerifyCsrf () );
        }
    }
 
    public static function getInstanceClass() {
        if (isset ( self::$sessionInstance )) {
            return \get_class ( self::$sessionInstance );
        }
    }
 
    public static function visitorCount() {
        return self::$sessionInstance->visitorCount ();
    }
    
    public static function regenerateId(bool $deleteOldSession=false):bool {
        return self::$sessionInstance->regenerateId($deleteOldSession);
    }
}