Element::formater() - Code Metrics - nfephp-org/sped-ecf - Measure and Improve Code Quality continuously with Scrutinizer

Element::formater() A
last analyzed 2020-09-29 11:43 UTC

↳ Parent: Element

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	20
rs	9.2888
c	0
b	0
f	0
cc	5
nc	5
nop	3

<?php

namespace NFePHP\ECF\Common;

use \stdClass;
use NFePHP\Common\Strings;
use Exception;
use function Safe\json_decode;
use function Safe\json_encode;
use function Safe\preg_match;

abstract class Element
{

    public $std;
    public $values;
    protected $parameters;
    private $reg;

    /**
     * Constructor
     * @param string $reg
     */
    public function __construct($reg)
    {
        $this->reg = $reg;
        $this->values = new stdClass();
    }

    public function postValidation()
    {
        return true;
    }

    /**
     * Valida e ajusta os dados de entrada para os padões estabelecidos
     * @param \stdClass $std
     */
    protected function standarize(\stdClass $std)
    {
        if (empty($this->parameters)) {
            throw new Exception('Parametros não estabelecidos na classe');
        }
        $errors = [];
        //passa todos as variáveis do stdClass para minusculo
        $arr = array_change_key_case(get_object_vars($std), CASE_LOWER);
        $std = json_decode(json_encode($arr));
        //paga as chaves dos parametros e passa para minusculo
        $stdParam = json_decode(json_encode($this->parameters));
        $this->parameters = array_change_key_case(get_object_vars($stdParam), CASE_LOWER);
        $paramKeys = array_keys($this->parameters);
        //passa os paramatros com as chaves modificadas para um stdClass
        if (!$json = json_encode($this->parameters)) {
            throw new \RuntimeException("Falta definir os parametros ou existe erro no array");
        }
        $stdParam = json_decode($json);
        if ($stdParam === null) {
            throw new \RuntimeException("Houve uma falha na converção para stdClass");
        }
        //verifica se foram passados os dados obrigatórios
        foreach ($std as $key => $value) {
            if (!isset($stdParam->$key)) {
                //ignore non defined params
                continue;
            }
            if ($stdParam->$key->required && $std->$key === null) {
                $errors[] = "$key é requerido.";
            }
        }
        $newstd = new \stdClass();
        foreach ($paramKeys as $key) {
            if (!key_exists($key, $arr)) {
                $newstd->$key = null;
            } else {
                if ($std->$key === null) {
                    $newstd->$key = null;
                    continue;
                }
                //se o valor para o parametro foi passado, então validar
                $resp = $this->isFieldInError(
                    $std->$key,
                    $stdParam->$key,
                    strtoupper($key),
                    $this->reg,
                    $stdParam->$key->required
                );
                if ($resp) {
                    $errors[] = $resp;
                }
                //e formatar o dado passado
                $formated = $this->formater(
                    $std->$key,
                    $stdParam->$key->format,
                    strtoupper($key)
                );
                $newstd->$key = $formated;
            }
        }
        //se algum erro for detectado disparar um Exception
        if (!empty($errors)) {
            throw new \InvalidArgumentException(implode("\n", $errors));
        }
        return $newstd;
    }

    /**
     * Verifica os campos com relação ao tipo e seu regex
     * @param string|integer|float|null $input
     * @param stdClass $param
     * @param string $fieldname
     * @return string|boolean
     */
    protected function isFieldInError($input, $param, $fieldname, $element, $required)
    {
        $type = $param->type;
        $regex = $param->regex;
        if (empty($regex)) {
            return false;
        }
        if (($input === null || $input === '') && !$required) {
            return false;
        }
        switch ($type) {
            case 'integer':
                if (!is_numeric($input)) {
                    return "[$this->reg] $element campo: $fieldname deve ser um valor numérico inteiro.";
                }
                break;
            case 'numeric':
                if (!is_numeric($input)) {
                    return "[$this->reg] $element campo: $fieldname deve ser um numero.";
                }
                break;
            case 'string':
                if (!is_string($input)) {
                    return "[$this->reg] $element campo: $fieldname deve ser uma string.";
                }
                break;
        }
        $input = (string) $input;
        if ($regex === 'email') {
            if (!filter_var($input, FILTER_VALIDATE_EMAIL)) {
                return "[$this->reg] $element campo: $fieldname Esse email [$input] está incorreto.";
            }
            return false;
        }
        if (!preg_match("/$regex/", $input)) {
            return "[$this->reg] $element campo: $fieldname valor incorreto [$input]. (validação: $regex)";
        }
        return false;
    }

    /**
     * Formata os campos float
     * @param string|integer|float|null $value
     * @param string $format
     * @param string $fieldname
     * @return int|string|float|null
     * @throws \InvalidArgumentException
     */
    protected function formater($value, $format = null, $fieldname = '')
    {
        if ($value === null) {
            return $value;
        }
        if (!is_numeric($value)) {
            //se não é numerico então permitir apenas ASCII
            return Strings::toASCII($value);
        }
        if (empty($format)) {
            return $value;
        }
        //gravar os valores numericos para possivel posterior validação complexa
        $name = strtolower($fieldname);
        if ($value === '') {
            $value = 0;
        }
        $this->values->$name = (float) $value;
        return $this->numberFormat(floatval($value), $format, $fieldname);
    }

    /**
     * Format number
     * @param float $value
     * @param string $format
     * @return string
     * @throws \InvalidArgumentException
     */
    private function numberFormat($value, $format, $fieldname)
    {
        $n = explode('v', $format);
        $mdec = strpos($n[1], '-');
        $p = explode('.', "{$value}");
        $ndec = !empty($p[1]) ? strlen($p[1]) : 0; //decimal digits
        $nint = strlen($p[0]); //integer digits
        $intdig = (int) $n[0];
        if ($nint > $intdig) {
            throw new \InvalidArgumentException("[$this->reg] O [$fieldname] é maior "
            . "que o permitido [$format].");
        }
        if ($mdec !== false) {
            //is multi decimal
            $mm = explode('-', $n[1]);
            $decmin = (int) $mm[0];
            $decmax = (int) $mm[1];
            //verificar a quantidade de decimais informada
            //se maior ou igual ao minimo e menor ou igual ao maximo
            if ($ndec >= $decmin && $ndec <= $decmax) {
                //deixa como está
                return number_format($value, $ndec, ',', '');
            }
            //se menor que o minimo, formata para o minimo
            if ($ndec < $decmin) {
                return number_format($value, $decmin, ',', '');
            }
            //se maior que o maximo, formata para o maximo
            if ($ndec > $decmax) {
                return number_format($value, $decmax, ',', '');
            }
        }
        $decplaces = (int) $n[1];
        return number_format($value, $decplaces, ',', '');
    }

    /**
     * Construtor do elemento
     * @return string
     */
    protected function build()
    {
        $register = '';
        foreach ($this->parameters as $key => $params) {
            $register .= $this->std->$key . '|';
        }
        return $register;
    }

    /**
     * Retorna o elemento formatado em uma string
     * @return string
     */
    public function __toString()
    {
        return '|' . $this->reg . '|' . $this->build();
    }
}


1			<?php
2
3			namespace NFePHP\ECF\Common;
4
5			use \stdClass;
6			use NFePHP\Common\Strings;
7			use Exception;
8			use function Safe\json_decode;
9			use function Safe\json_encode;
10			use function Safe\preg_match;
11
12			abstract class Element
13			{
14
15			public $std;
16			public $values;
17			protected $parameters;
18			private $reg;
19
20			/**
21			* Constructor
22			* @param string $reg
23			*/
24			public function __construct($reg)
25			{
26			$this->reg = $reg;
27			$this->values = new stdClass();
28			}
29
30			public function postValidation()
31			{
32			return true;
33			}
34
35			/**
36			* Valida e ajusta os dados de entrada para os padões estabelecidos
37			* @param \stdClass $std
38			*/
39			protected function standarize(\stdClass $std)
40			{
41			if (empty($this->parameters)) {
42			throw new Exception('Parametros não estabelecidos na classe');
43			}
44			$errors = [];
45			//passa todos as variáveis do stdClass para minusculo
46			$arr = array_change_key_case(get_object_vars($std), CASE_LOWER);
47			$std = json_decode(json_encode($arr));
48			//paga as chaves dos parametros e passa para minusculo
49			$stdParam = json_decode(json_encode($this->parameters));
50			$this->parameters = array_change_key_case(get_object_vars($stdParam), CASE_LOWER);
51			$paramKeys = array_keys($this->parameters);
52			//passa os paramatros com as chaves modificadas para um stdClass
53			if (!$json = json_encode($this->parameters)) {
54			throw new \RuntimeException("Falta definir os parametros ou existe erro no array");
55			}
56			$stdParam = json_decode($json);
57			if ($stdParam === null) {
58			throw new \RuntimeException("Houve uma falha na converção para stdClass");
59			}
60			//verifica se foram passados os dados obrigatórios
61			foreach ($std as $key => $value) {
62			if (!isset($stdParam->$key)) {
63			//ignore non defined params
64			continue;
65			}
66			if ($stdParam->$key->required && $std->$key === null) {
67			$errors[] = "$key é requerido.";
68			}
69			}
70			$newstd = new \stdClass();
71			foreach ($paramKeys as $key) {
72			if (!key_exists($key, $arr)) {
73			$newstd->$key = null;
74			} else {
75			if ($std->$key === null) {
76			$newstd->$key = null;
77			continue;
78			}
79			//se o valor para o parametro foi passado, então validar
80			$resp = $this->isFieldInError(
81			$std->$key,
82			$stdParam->$key,
83			strtoupper($key),
84			$this->reg,
85			$stdParam->$key->required
86			);
87			if ($resp) {
88			$errors[] = $resp;
89			}
90			//e formatar o dado passado
91			$formated = $this->formater(
92			$std->$key,
93			$stdParam->$key->format,
94			strtoupper($key)
95			);
96			$newstd->$key = $formated;
97			}
98			}
99			//se algum erro for detectado disparar um Exception
100			if (!empty($errors)) {
101			throw new \InvalidArgumentException(implode("\n", $errors));
102			}
103			return $newstd;
104			}
105
106			/**
107			* Verifica os campos com relação ao tipo e seu regex
108			* @param string\|integer\|float\|null $input
109			* @param stdClass $param
110			* @param string $fieldname
111			* @return string\|boolean
112			*/
113			protected function isFieldInError($input, $param, $fieldname, $element, $required)
114			{
115			$type = $param->type;
116			$regex = $param->regex;
117			if (empty($regex)) {
118			return false;
119			}
120			if (($input === null \|\| $input === '') && !$required) {
121			return false;
122			}
123			switch ($type) {
124			case 'integer':
125			if (!is_numeric($input)) {
126			return "[$this->reg] $element campo: $fieldname deve ser um valor numérico inteiro.";
127			}
128			break;
129			case 'numeric':
130			if (!is_numeric($input)) {
131			return "[$this->reg] $element campo: $fieldname deve ser um numero.";
132			}
133			break;
134			case 'string':
135			if (!is_string($input)) {
136			return "[$this->reg] $element campo: $fieldname deve ser uma string.";
137			}
138			break;
139			}
140			$input = (string) $input;
141			if ($regex === 'email') {
142			if (!filter_var($input, FILTER_VALIDATE_EMAIL)) {
143			return "[$this->reg] $element campo: $fieldname Esse email [$input] está incorreto.";
144			}
145			return false;
146			}
147			if (!preg_match("/$regex/", $input)) {
148			return "[$this->reg] $element campo: $fieldname valor incorreto [$input]. (validação: $regex)";
149			}
150			return false;
151			}
152
153			/**
154			* Formata os campos float
155			* @param string\|integer\|float\|null $value
156			* @param string $format
157			* @param string $fieldname
158			* @return int\|string\|float\|null
159			* @throws \InvalidArgumentException
160			*/
161			protected function formater($value, $format = null, $fieldname = '')
162			{
163			if ($value === null) {
164			return $value;
165			}
166			if (!is_numeric($value)) {
167			//se não é numerico então permitir apenas ASCII
168			return Strings::toASCII($value);
169			}
170			if (empty($format)) {
171			return $value;
172			}
173			//gravar os valores numericos para possivel posterior validação complexa
174			$name = strtolower($fieldname);
175			if ($value === '') {
176			$value = 0;
177			}
178			$this->values->$name = (float) $value;
179			return $this->numberFormat(floatval($value), $format, $fieldname);
180			}
181
182			/**
183			* Format number
184			* @param float $value
185			* @param string $format
186			* @return string
187			* @throws \InvalidArgumentException
188			*/
189			private function numberFormat($value, $format, $fieldname)
190			{
191			$n = explode('v', $format);
192			$mdec = strpos($n[1], '-');
193			$p = explode('.', "{$value}");
194			$ndec = !empty($p[1]) ? strlen($p[1]) : 0; //decimal digits
195			$nint = strlen($p[0]); //integer digits
196			$intdig = (int) $n[0];
197			if ($nint > $intdig) {
198			throw new \InvalidArgumentException("[$this->reg] O [$fieldname] é maior "
199			. "que o permitido [$format].");
200			}
201			if ($mdec !== false) {
202			//is multi decimal
203			$mm = explode('-', $n[1]);
204			$decmin = (int) $mm[0];
205			$decmax = (int) $mm[1];
206			//verificar a quantidade de decimais informada
207			//se maior ou igual ao minimo e menor ou igual ao maximo
208			if ($ndec >= $decmin && $ndec <= $decmax) {
209			//deixa como está
210			return number_format($value, $ndec, ',', '');
211			}
212			//se menor que o minimo, formata para o minimo
213			if ($ndec < $decmin) {
214			return number_format($value, $decmin, ',', '');
215			}
216			//se maior que o maximo, formata para o maximo
217			if ($ndec > $decmax) {
218			return number_format($value, $decmax, ',', '');
219			}
220			}
221			$decplaces = (int) $n[1];
222			return number_format($value, $decplaces, ',', '');
223			}
224
225			/**
226			* Construtor do elemento
227			* @return string
228			*/
229			protected function build()
230			{
231			$register = '';
232			foreach ($this->parameters as $key => $params) {
233			$register .= $this->std->$key . '\|';
234			}
235			return $register;
236			}
237
238			/**
239			* Retorna o elemento formatado em uma string
240			* @return string
241			*/
242			public function __toString()
243			{
244			return '\|' . $this->reg . '\|' . $this->build();
245			}
246			}
247

nfephp-org / sped-ecf

Element::formater() A last analyzed 2020-09-29 11:43 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Element::formater() A
last analyzed 2020-09-29 11:43 UTC