ScwCookie::output() - Code Metrics - Inspection of "Add missing semi colon!" - southcoastweb/gdpr-cookie - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — 2.2 ( 0c4a89...fca7ff )

by Myles
created 2018-04-13 09:26 UTC
ScwCookie::output() A

↳ Parent: ScwCookie
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
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 isEnabled($name)
    {
        $check = $this->config[$name];
        return is_array($check) && isset($check['enabled']) && $check['enabled'];
    }

    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 embed codes
        $embedCodes = [
            'Google_Analytics' => 'googleAnalytics',
            'Smartsupp'        => 'smartsupp',
            'Hotjar'           => 'hotjar',
            'Tawk.to'          => 'tawkto',
        ];
        foreach ($embedCodes as $configKey => $embedFile) {
            if ($this->config[$configKey]['enabled'] && $this->isAllowed($configKey)) {
                $return[] = $this->getOutputHTML($embedFile);
            }
        }

        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 (!$this->isEnabled($name)) {
                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);

        // Calculate expiry
        $expiry = strtotime('+'.$lifetime.' '.$lifetimePeriod);

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

    public static function validateSetCookieParams($name, $value, $lifetime, $lifetimePeriod, $domain, $secure)
    {
        // Set allowed time periods
        $lifetimePeriods = array('minutes', 'hours', 'days', 'weeks');
        
        // Types of parameters to check
        $paramTypes = [
            // Type => Array of variables
            'string' => [$name, $value, $domain],
            'int'    => [$lifetime],
            'bool'   => [$secure],
        ];

        // Validate basic parameters
        $validParams = self::basicValidationChecks($paramTypes);

        // More complex validations
        $validParams = in_array($lifetimePeriod, $lifetimePeriods) ? $validParams : false;

        // Ensure parameters are still valid
        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 basicValidationChecks($parameters)
    public static function basicValidationChecks(/** @scrutinizer ignore-unused */ $parameters)
    {
        foreach ($paramTypes as $type => $variables) {

            $functionName = 'is_'.$type;
            foreach ($variables as $variable) {
                if (!$functionName($variable)) {
                    return false;
                }
            }
        }
        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 ( 0c4a89...fca7ff )

ScwCookie::output() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
