BretRZaun\StatusPage\Check\PhpIniCheck

Complexity

Total Complexity

21

Size/Duplication

Total Lines	147
Duplicated Lines	9.52 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	stringToMegabyte()	0	14	4
B	check()	0	20	6
A	checkBoolean()	0	6	1
A	checkMemory()	0	9	2
A	checkNumber()	14	19	5
A	checkRegex()	0	6	1
A	checkString()	0	6	1

<?php
namespace BretRZaun\StatusPage\Check;

use BretRZaun\StatusPage\Result;

class PhpIniCheck extends AbstractCheck
{

    const TypeBoolean = 'boolean';
    const TypeMemory  = 'memory';
    const TypeNumber  = 'number';
    const TypeRegex   = 'regex';
    const TypeString  = 'string';

    protected $varName;
    protected $varType;
    protected $varValue;
    protected $maxValue;
    protected $iniValue;

    /**
     * PhpIniCheck constructor.
     *
     * @param string $label
     * @param string $varName <b>Name</b> of ini value - used for ini_get(...)
     * @param string $varType <b>Type</b> of ini value - see class constant
     * @param mixed $varValue <b>Value</b> which is expected
     * @param null $maxValue <b>maximum</b> value is optional used for numbers
     *
     * @return PhpIniCheck

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct(string $label, string $varName, string $varType, $varValue, $maxValue=null)
    {
        parent::__construct($label);
        $this->varName = $varName;
        $this->varType = $varType;
        $this->varValue = $varValue;
        $this->maxValue = $maxValue;
        $this->iniValue = ini_get($varName);
    }

    /**
     * @param string $size
     * @return int|bool(false)

The doc-type int|bool(false) could not be parsed: Expected "|" or "end of type", but got "(" at position 8. (view supported doc-types)

     */
    protected function stringToMegabyte(string $size)
    {
        $value = preg_replace('~[^0-9]*~','', $size);
        switch (substr(strtolower($size), -1)) {
            case 'm':
                return (int)$value;
            case 'k':
                return round((int)$value / 1024);
            case 'g':
                return ((int)$value * 1024);
            default:
                return false;
        }
    }


    /**
     * @return Result
     */
    public function check(): Result
    {
        switch ($this->varType) {
            case self::TypeBoolean:
                return $this->checkBoolean();
            case self::TypeMemory:
                return $this->checkMemory();
            case self::TypeNumber:
                return $this->checkNumber();
            case self::TypeRegex:
                return $this->checkRegex();
            case self::TypeString:
                return $this->checkString();
            default:
                $result = new Result($this->label);
                $result->setSuccess(false);
                $result->setError("Invalid Type: " . $this->varType);
                return $result;
        }
    }

    /**
     * @return Result
     */
    protected function checkBoolean() {
        $result = new Result($this->label);
        $result->setSuccess( boolval($this->iniValue) === boolval($this->varValue) );
        $result->setError("php.ini value of '".$this->varName."' is set to '".strval(boolval($this->iniValue))."' instead of expected '".strval(boolval($this->varValue))."'");
        return $result;
    }

    /**
     * @return Result
     */
    protected function checkMemory() {
        $result = new Result($this->label);
        if ($this->iniValue != -1) {
            $value = $this->stringToMegabyte($this->iniValue);
            $result->setSuccess( $value >= $this->varValue );
            $result->setError("php.ini value of '".$this->varName."' is set to '".strval($this->iniValue)."', minimum expected is '".strval($this->varValue)."'");
        }
        return $result;
    }

    /**
     * @return Result
     */
    protected function checkNumber() {
        $result = new Result($this->label);
        if (!is_null($this->varValue)) {

This code seems to be duplicated across your project.

            if ($this->iniValue < $this->varValue) {
                $result->setSuccess(false);
                $result->setError("php.ini value of '".$this->varName."' is set to '".strval($this->iniValue)."', minimum expected is '".strval($this->varValue)."'");
                return $result;
            }
        }
        if (!is_null($this->maxValue)) {

This code seems to be duplicated across your project.

            if ($this->iniValue > $this->maxValue) {
                $result->setSuccess(false);
                $result->setError("php.ini value of '".$this->varName."' is set to '".strval($this->iniValue)."', maximum expected is '".strval($this->maxValue)."'");
                return $result;
            }
        }
        $result->setError("php.ini value of '".$this->varName."' is set to '".strval($this->iniValue));
        return $result;
    }

    /**
     * @return Result
     */
    protected function checkRegex() {
        $result = new Result($this->label);
        $result->setSuccess(preg_match('~'.$this->varValue.'~', $this->iniValue));
        $result->setError("php.ini value of '".$this->varName."' is set to '".strval($this->iniValue)."', expected is '".strval($this->varValue)."'");
        return $result;
    }

    /**
     * @return Result
     */
    protected function checkString() {
        $result = new Result($this->label);
        $result->setSuccess( strval($this->iniValue) == strval($this->varValue) );
        $result->setError("php.ini value of '".$this->varName."' is set to '".strval($this->iniValue)."', expected is '".strval($this->varValue)."'");
        return $result;
    }

}