WebServCo\Framework\Libraries\Session

Complexity

Total Complexity

14

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	checkSession()	0	5	2
A	clear()	0	3	1
A	set()	0	10	1
A	start()	0	48	3
A	get()	0	8	1
A	has()	0	3	1
A	remove()	0	9	1
A	setStoragePath()	0	19	4

<?php
namespace WebServCo\Framework\Libraries;

use WebServCo\Framework\Settings as S;
use WebServCo\Framework\Exceptions\ApplicationException;

final class Session extends \WebServCo\Framework\AbstractLibrary
{
    protected function checkSession()
    {
        if (session_status() === \PHP_SESSION_NONE) {
            throw new ApplicationException(
                'Session is not started.'
            );
        }
    }
    
    protected function setStoragePath($storagePath)
    {
        if (empty($storagePath)) {
            return false;
        }
        
        $result = ini_set('session.save_path', $storagePath);

The assignment to $result is dead and can be removed.

        $actualStoragePath = session_save_path($storagePath);
        
        if ($actualStoragePath != $storagePath) {
            if ($this->setting('strict_custom_path', true)) {
                throw new ApplicationException(
                    'Unable to set custom session storage path. ' .
                    sprintf('Current path: %s', $actualStoragePath)
                );
            }
            return false;
        }
        return true;
    }
    
    public function start($storagePath = null)
    {
        if (session_status() === \PHP_SESSION_ACTIVE) {
            throw new ApplicationException(
                'Unable to start session: already started.'
            );
        }
        
        /**
         * Set cache limiter.
         */
        session_cache_limiter('public, must-revalidate');
        
        /**
         * Set cache expire (minutes).
         */
        session_cache_expire($this->setting('expire', '36000') / 60);
        
        /**
         * Set garbage collector timeout (seconds).
         */
        ini_set('session.gc_maxlifetime', $this->setting('expire', '36000'));
        
        /**
        * Set custom session storage path.
        */
        $this->setStoragePath($storagePath);
    
        /**
         * Make sure garbage collector visits us.
         */
        ini_set('session.gc_probability', 1);

        session_set_cookie_params(
            $this->setting(sprintf('cookie%slifetime', S::DIVIDER), 60 * 60 * 24 * 14),
            $this->setting(sprintf('cookie%spath', S::DIVIDER), '/'),
            $this->setting(sprintf('cookie%sdomain', S::DIVIDER), ''),
            $this->setting(sprintf('cookie%ssecure', S::DIVIDER), false),
            $this->setting(sprintf('cookie%shttponly', S::DIVIDER), true)
        );
        
        session_name('webservco');
        
        if (!session_start()) {
            throw new ApplicationException('Unable to start session');
        }
        
        return true;
    }
    
    public function set($setting, $value)
    {
        $this->checkSession();
        
        $_SESSION = \WebServCo\Framework\ArrayStorage::set(
            $_SESSION,
            $setting,
            $value
        );
        return true;
    }
    
    public function get($setting, $defaultValue = false)
    {
        $this->checkSession();
        
        return \WebServCo\Framework\ArrayStorage::get(
            $_SESSION,
            $setting,
            $defaultValue
        );
    }
    
    public function has($setting)
    {
        return (bool) $this->get($setting);
    }
    
    public function remove($setting)
    {
        $this->checkSession();
        
        $_SESSION = \WebServCo\Framework\ArrayStorage::remove(
            $_SESSION,
            $setting
        );
        return true;
    }
    
    public function clear($setting)
    {
        return $this->set($setting, null);
    }
}