DrMVC\Session\Session

Complexity

Total Complexity

22

Size/Duplication

Total Lines	185
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getPrefix()	0	4	1
A	setPrefix()	0	5	1
A	isStarted()	0	4	1
A	init()	0	7	2
A	set()	0	12	4
A	pull()	0	12	2
A	get()	0	5	1
A	id()	0	4	1
A	regenerate()	0	5	1
A	display()	0	4	1
A	cleanUp()	0	15	4
A	destroy()	0	14	2

<?php

namespace DrMVC\Session;

/**
 * Class Session
 * @package DrMVC\Session
 */
class Session implements SessionInterface
{
    /**
     * Session prefix name
     * @var string
     */
    private $_prefix;

    /**
     * Session constructor.
     *
     * @param   string|null $prefix
     */
    public function __construct(string $prefix = null)
    {
        $this->setPrefix($prefix);
    }

    /**
     * @return  string|null
     */
    public function getPrefix()
    {
        return $this->_prefix;
    }

    /**
     * @param   string|null $prefix
     * @return  SessionInterface
     */
    public function setPrefix(string $prefix = null): SessionInterface
    {
        $this->_prefix = $prefix;
        return $this;
    }

    /**
     * @return bool
     */
    public function isStarted(): bool
    {
        return (session_status() === PHP_SESSION_ACTIVE);
    }

    /**
     * if session has not started, start sessions
     *
     * @return  string
     */
    public function init(): string
    {
        if (!$this->isStarted()) {
            session_start();
        }
        return $this->id();
    }

    /**
     * Add value to a session.
     *
     * @param   array|string $name name the data to save
     * @param   string|bool $value the data to save
     * @return  SessionInterface
     */
    public function set($name, $value = false): SessionInterface
    {
        if (\is_array($name) && false === $value) {
            foreach ($name as $key => $val) {
                $_SESSION[$this->getPrefix() . $key] = $val;
            }
        } else {
            $_SESSION[$this->getPrefix() . $name] = $value;
        }

        return $this;
    }

    /**
     * Extract item from session then delete from the session,
     * finally return the item.
     *
     * @param   string $name item to extract
     * @return  mixed
     */
    public function pull(string $name): string
    {
        $key = $this->getPrefix() . $name;

        if (isset($_SESSION[$key])) {
            $value = $_SESSION[$key];
            unset($_SESSION[$key]);
            return $value;
        }

        return false;
    }

    /**
     * Get item from session
     *
     * @param   string $name item to look for in session
     * @return  mixed
     */
    public function get(string $name)
    {
        $key = $this->getPrefix() . $name;
        return $_SESSION[$key] ?? false;
    }

    /**
     * Return session id
     *
     * @return  string with the session id.
     */
    public function id(): string
    {
        return session_id();
    }

    /**
     * Regenerate session_id and return new id
     *
     * @return  string
     */
    public function regenerate(): string
    {
        session_regenerate_id(true);
        return $this->id();
    }

    /**
     * Return the session array.
     *
     * @return  array of session indexes
     */
    public function display(): array
    {
        return $_SESSION;
    }

    /**
     * Clean all keys stored in session array
     *
     * @param   string|null $prefix
     * @return  SessionInterface
     */
    private function cleanUp(string $prefix = null): SessionInterface
    {
        if (null === $prefix) {
            session_unset();
            session_destroy();
        } else {
            foreach ($_SESSION as $key => $value) {
                if (strpos($key, $prefix) === 0) {
                    unset($_SESSION[$key]);
                }
            }
        }

        return $this;
    }

    /**
     * Remove some single key, remove keys by prefix or destroy session
     *
     * @param   string $name session name to destroy
     * @param   boolean $byPrefix if set to true clear all sessions for current prefix of session
     * @return  SessionInterface
     */
    public function destroy($name = '', $byPrefix = false): SessionInterface
    {
        $prefix = $this->getPrefix();

        if ('' === $name) {
            // Clean up if key name is not provided
            $this->cleanUp($prefix);
        } else {
            // Or just remove single key
            unset($_SESSION[$prefix . $name]);
        }

        return $this;
    }

}