Sesshin\SessionFlash

Complexity

Total Complexity

19

Size/Duplication

Total Lines	203
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	add()	0	6	1
A	set()	0	6	1
A	get()	0	4	1
A	has()	0	10	2
A	getCurrentData()	0	6	2
A	reflash()	0	5	1
A	keep()	0	5	2
A	mergeNewFlashes()	0	5	1
A	removeFromOldFlashData()	0	9	2
A	ageFlashData()	0	10	2
A	clear()	0	4	1
A	singleton()	0	8	2

<?php
    /**
     * Created by PhpStorm.
     * User: yabafinet
     * Date: 10/01/18
     * Time: 09:24 AM
     */

    namespace Sesshin;


    class SessionFlash
    {
        /**
         * Singleton of this class
         *
         * @var $this
         */
        public static $singleton;

        /**
         * Object manager of sessions.
         *
         * @var Session
         */
        private $session;

        /**
         * Unique ID in each transaction request.
         *
         * @var int
         */
        private $msg_id;

The property $msg_id is not used and could be removed.

        /**
         * key name to save the flash dat
         *
         * @var string
         */
        protected $key_name = '_flash';

        /**
         * SessionFlash constructor.
         *
         * @param Session $session
         */
        public function __construct(Session $session)
        {
            $this->session = $session;
        }

        /**
         * Add a value in the flash session.
         *
         * @param $value
         * @param string $type
         */
        public function add($value, $type = 'n')
        {
            $this->session->put($type, $value);
            $this->session->push($this->key_name.'.new', $type);
            $this->removeFromOldFlashData([$type]);
        }


        /**
         * Add a value in the flash session.
         *
         * @param $key
         * @param $value
         */
        public function set($key, $value)
        {
            $this->session->put($key, $value);
            $this->session->push($this->key_name.'.new', $key);
            $this->removeFromOldFlashData([$key]);
        }

        /**
         * Get a value in the flash session.
         *
         * @param $key
         * @return mixed
         */
        public function get($key)
        {
            return $this->session->getValue($key);
        }

        /**
         * Determine if exist key in flash data.
         *
         * @param $key
         * @return bool
         */
        public function has($key)
        {
            $current_data = $this->session->getValue($key);

            if (isset($current_data)) {
                return true;
            } else {
                return false;
            }
        }

        /**
         * Get all the data or data of a type.
         *
         * @return mixed
         */
        public function getCurrentData()
        {
            $current_data = $this->session->getValue($this->key_name);

            return isset($current_data) ? $current_data : $current_data = array();
        }

        /**
         * Reflash all of the session flash data.
         *
         * @return void
         */
        public function reflash()
        {
            $this->mergeNewFlashes($this->session->getValue($this->key_name.'.old'));
            $this->session->setValue($this->key_name.'.old', []);
        }


        /**
         * Reflash a subset of the current flash data.
         *
         * @param  array|mixed  $keys
         * @return void
         */
        public function keep($keys = null)
        {
            $this->mergeNewFlashes($keys = is_array($keys) ? $keys : func_get_args());
            $this->removeFromOldFlashData($keys);
        }


        /**
         * Merge new flash keys into the new flash array.
         *
         * @param  array  $keys
         * @return void
         */
        protected function mergeNewFlashes(array $keys)
        {
            $values = array_unique(array_merge($this->session->getValue($this->key_name.'.new'), $keys));
            $this->session->setValue($this->key_name.'.new', $values);
        }

        /**
         * Remove the given keys from the old flash data.
         *
         * @param  array  $keys
         * @return void
         */
        protected function removeFromOldFlashData(array $keys)
        {
            $old_data = $this->session->getValue($this->key_name.'.old');

            if (! is_array($old_data)) {
                $old_data = array();
            }
            $this->session->setValue($this->key_name.'.old', array_diff($old_data, $keys));
        }

        /**
         * Age the flash data for the session.
         *
         * @return void
         */
        public function ageFlashData()
        {
            $old_data = $this->session->getValue($this->key_name.'.old');
            if (! is_array($old_data)) {
                $old_data = array();
            }
            $this->session->forget($old_data);
            $this->session->put($this->key_name.'.old', $this->session->getValue($this->key_name.'.new'));
            $this->session->put($this->key_name.'.new', []);
        }


        /**
         * Clear all data flash.
         *
         */
        public function clear()
        {
            $this->session->unsetValue($this->key_name);
        }


        /**
         * Calling this class in a singleton way.
         *
         * @param Session|null $session
         * @return SessionFlash
         */
        static function singleton(Session $session = null)

It is generally recommended to explicitly declare the visibility for methods.

        {
            if (self::$singleton == null) {
                self::$singleton = new SessionFlash($session);

It seems like $session defined by parameter $session on line 206 can be null; however, Sesshin\SessionFlash::__construct() does not accept null, maybe add an additional type check?

            }

            return self::$singleton;
        }
    }