ScwCookie::setCookie() - Code Metrics - Inspection of "Reduce conditions in setCookie method" - southcoastweb/gdpr-cookie - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — 2.2 ( b1819d...0900d1 )

by Myles
created 2018-03-16 11:54 UTC
ScwCookie::setCookie() B

↳ Parent: ScwCookie
Complexity

Conditions	5
Paths	5
Size

Total Lines	31
Code Lines	19
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	5
eloc	19
nc	5
nop	6
dl	0
loc	31
rs	8.439
c	0
b	0
f	0
<?php

namespace ScwCookie;

class ScwCookie
{
    public $config        = [];
    private $decisionMade = false;
    private $choices      = [];
    
    public function __construct()
    {
        $this->config = parse_ini_file("config.ini", true);

        $this->decisionMade = self::getCookie('scwCookieHidden') == 'true';
        $this->choices      = $this->getChoices();
    }

    public function getChoices()
    {
        if (self::getCookie('scwCookie') !== false) {
            $cookie = self::getCookie('scwCookie');
            $cookie = self::decrypt($cookie);
            return $cookie;
        }

        $return = [];
        foreach ($this->enabledCookies() as $name => $label) {
            $return[$name] = $this->config['unsetDefault'];
        }
        return $return;
    }

    public static function encrypt($value)
    {
        $return = json_encode($value);
        return $return;
    }

    public static function decrypt($value)
    {
        $value = str_replace('\"', '"', $value);
        $return = json_decode($value, true);
        return $return;
    }

    public function isAllowed($name)
    {
        $choices = $this->getChoices();
        return isset($choices[$name]) && $choices[$name] == 'allowed';
    }

    public function getCode($name)
    {
        return isset($this->config[$name]) && isset($this->config[$name]['code'])
            ? $this->config[$name]['code']
            : false;
    }

    public function output()
    {
        echo $this->getOutput();
    }

    public function getOutput()
    {
        $return = [];

        // Get decision window output
        $return[] = $this->getOutputHTML('decision');

        // Get Google Analytics embed code
        if ($this->config['Google_Analytics']['enabled'] && $this->isAllowed('Google_Analytics')) {
            $return[] = $this->getOutputHTML('googleAnalytics');
        }
        
        // Get Smartsupp embed code
        if ($this->config['Smartsupp']['enabled'] && $this->isAllowed('Smartsupp')) {
            $return[] = $this->getOutputHTML('smartsupp');
        }
        
        // Get Hotjar embed code
        if ($this->config['Hotjar']['enabled'] && $this->isAllowed('Hotjar')) {
            $return[] = $this->getOutputHTML('hotjar');
        }
        
        // Get Tawk.to embed code
        if ($this->config['Tawk.to']['enabled'] && $this->isAllowed('Tawk.to')) {
            $return[] = $this->getOutputHTML('tawkto');
        }

        return implode("\n", $return);
    }

    public function getOutputHTML($filename)
    {
        if (!file_exists(__DIR__.'/output/cookies/'.$filename.'.php')) {
            return false;
        }
        
        ob_start();
        include __DIR__.'/output/cookies/'.$filename.'.php';
        return trim(ob_get_clean());
    }

    public function enabledCookies()
    {
        $return = [];
        foreach ($this->config as $name => $value) {
            if (!is_array($value) || !isset($value['enabled']) || !$value['enabled']) {
                continue;
            }
            $return[$name] = $value['label'];
        }
        return $return;
    }

    public static function setCookie($name, $value, $lifetime = 30, $lifetimePeriod = 'days', $domain = '/', $secure = false)
    {
        // Validate parameters
        self::validateSetCookieParams($name, $value, $lifetime, $lifetimePeriod, $domain, $secure);
              validateSetCookieParams($name, $value, $lifetime, $lifetimePeriod, $domain, $secure);

        // Calculate expiry time
        switch ($lifetimePeriod) {
            case 'minutes':
                $expiry = time() + (60 * $lifetime);     // 60 = 1 minute
                break;

            case 'hours':
                $expiry = time() + (3600 * $lifetime);   // 3600 = 1 hour
                break;

            case 'days':
                $expiry = time() + (86400 * $lifetime);  // 86400 = 1 day
                break;

            case 'weeks':
                $expiry = time() + (604800 * $lifetime); // 604800 = 1 week
                break;
            
            default:
                header('HTTP/1.0 403 Forbidden');
                throw new \Exception("Lifetime not recognised");
                break;
        }

        // Set cookie
        return setcookie($name, $value, $expiry, $domain, $secure);
    }

    public function validateSetCookieParams($name, $value, $lifetime, $lifetimePeriod, $domain, $secure)
    {
        // Set allowed time periods
        $lifetimePeriods = array('minutes', 'hours', 'days', 'weeks');

        // Check values passed
        $validParams = is_string($name);
        $validParams = is_string($value) ? $validParams : false;
        $validParams = is_int($lifetime) ? $validParams : false;
        $validParams = in_array($lifetimePeriod, $lifetimePeriods) ? $validParams : false;
        $validParams = is_string($domain) ? $validParams : false;
        $validParams = is_bool($secure) ? $validParams : false;

        if (!$validParams) {
            // Failed parameter check
            header('HTTP/1.0 403 Forbidden');
            throw new \Exception("Incorrect parameter passed to Cookie::set");
        }

        return true;
    }

    public static function getCookie($name)
    {
        // If cookie exists - return it, otherwise return false
        return isset($_COOKIE[$name]) ? $_COOKIE[$name] : false;
    }

    public static function destroyCookie($name)
    {
        // Set cookie expiration to 1 hour ago
        return setcookie($name, '', time() - 3600);
    }
}

southcoastweb / gdpr-cookie

Push — 2.2 ( b1819d...0900d1 )

ScwCookie::setCookie() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
