AbstractProcessor - Code Metrics - umbrellaTech/ya-retorno-boleto - Measure and Improve Code Quality continuously with Scrutinizer

AbstractProcessor A
last analyzed 2016-02-26 20:30 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	112
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes	11
Bugs	1	Features	1

Metric	Value
wmc	13
c	11
b	1
f	1
lcom	0
cbo	0
dl	0
loc	112
rs	10

10 Methods

Rating	Name	Size	Complexity
A	__construct()	6	2
A	needToCreateLote()	4	1
A	setNeedToCreateLote()	5	1
A	setNomeArquivo()	4	1
A	getNomeArquivo()	4	1
	processarLinha()	1	?
	processCnab()	2	?
A	formataNumero()	15	3
A	createDate()	8	2
A	createDateTime()	8	2

<?php

namespace Umbrella\Ya\RetornoBoleto;

use DateTime;
use Stringy\Stringy;
use Umbrella\Ya\RetornoBoleto\Cnab\ComposableInterface;

/**
 * Classe base para leitura de arquivos de retorno de cobranças dos bancos brasileiros.<br/>
 * @author Ítalo Lelis de Vietro <[email protected]>
 */
abstract class AbstractProcessor
{
    /**
     * @property string $nomeArquivo Nome do arquivo de texto a ser lido
     */
    protected $nomeArquivo = "";
    protected $needToCreateLote = false;

    /**
     * Construtor da classe.
     * @param string $nomeArquivo Nome do arquivo de retorno do banco.
     */
    public function __construct($nomeArquivo = null)
    {
        if (isset($nomeArquivo)) {
            $this->setNomeArquivo($nomeArquivo);
        }
    }

    public function needToCreateLote()
    {
        return $this->needToCreateLote;
    }

    public function setNeedToCreateLote($needToCreateLote)
    {
        $this->needToCreateLote = $needToCreateLote;
        return $this;
    }

    /**
     * Setter para o atributo
     * @param string $nomeArquivo
     */
    public function setNomeArquivo($nomeArquivo)
    {
        $this->nomeArquivo = $nomeArquivo;
    }

    /**
     * Getter para o atributo
     */
    public function getNomeArquivo()
    {
        return $this->nomeArquivo;
    }

    /**
     * Processa uma linha do arquivo de retorno. O método é abstrato e deve ser implementado nas sub-classes.
     * @param int $numLn Número da linha a ser processada
     * @param string $linha String contendo a linha a ser processada
     * @return ComposableInterface Retorna um vetor associativo contendo os valores da linha processada.
     */
    public abstract function processarLinha($numLn, Stringy $linha);


    public abstract function processCnab(RetornoInterface $retorno, ComposableInterface $composable,

                                         LoteInterface $lote = null);


    /**
     * Formata uma string, contendo um valor real (float) sem o separador de decimais,
     * para a sua correta representação real.
     * @param string $valor String contendo o valor na representação
     * usada nos arquivos de retorno do banco, sem o separador de decimais.
     * @param int $numCasasDecimais Total de casas decimais do número
     * representado em $valor.
     * @return float Retorna o número representado em $valor, no seu formato float,
     * contendo o separador de decimais.
     */
    public function formataNumero($valor, $numCasasDecimais = 2)
    {
        if (empty($valor)) {
            return 0;
        }
        $casas = $numCasasDecimais;
        if ($casas > 0) {
            $valor = substr($valor, 0, strlen($valor) - $casas) . "." . substr($valor, strlen($valor) - $casas, $casas);
            $valor = (float)$valor;
        } else {
            $valor = (int)$valor;
        }

        return $valor;
    }

    /**
     * Formata uma string, contendo uma data sem o separador, no formato DDMMAA.
     * @param string $date String contendo a data no formato DDMMAA.
     * @return DateTime
     */
    public function createDate($date, $format = "dmy")
    {
        if (empty($date)) {
            return "";
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        return DateTime::createFromFormat($format, $date);
    }

    /**
     * Formata uma string, contendo uma data sem o separador, no formato DDMMAA HHIISS.
     * @param string $dateTimeString String contendo a data no formato DDMMAA.
     * @return DateTime
     */
    public function createDateTime($dateTimeString, $format = "mdy His")
    {
        if (empty($dateTimeString)) {
            return "";
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }

        return DateTime::createFromFormat($format, $dateTimeString);
    }
}


1			<?php
2
3			namespace Umbrella\Ya\RetornoBoleto;
4
5			use DateTime;
6			use Stringy\Stringy;
7			use Umbrella\Ya\RetornoBoleto\Cnab\ComposableInterface;
8
9			/**
10			* Classe base para leitura de arquivos de retorno de cobranças dos bancos brasileiros.<br/>
11			* @author Ítalo Lelis de Vietro <[email protected]>
12			*/
13			abstract class AbstractProcessor
14			{
15			/**
16			* @property string $nomeArquivo Nome do arquivo de texto a ser lido
17			*/
18			protected $nomeArquivo = "";
19			protected $needToCreateLote = false;
20
21			/**
22			* Construtor da classe.
23			* @param string $nomeArquivo Nome do arquivo de retorno do banco.
24			*/
25			public function __construct($nomeArquivo = null)
26			{
27			if (isset($nomeArquivo)) {
28			$this->setNomeArquivo($nomeArquivo);
29			}
30			}
31
32			public function needToCreateLote()
33			{
34			return $this->needToCreateLote;
35			}
36
37			public function setNeedToCreateLote($needToCreateLote)
38			{
39			$this->needToCreateLote = $needToCreateLote;
40			return $this;
41			}
42
43			/**
44			* Setter para o atributo
45			* @param string $nomeArquivo
46			*/
47			public function setNomeArquivo($nomeArquivo)
48			{
49			$this->nomeArquivo = $nomeArquivo;
50			}
51
52			/**
53			* Getter para o atributo
54			*/
55			public function getNomeArquivo()
56			{
57			return $this->nomeArquivo;
58			}
59
60			/**
61			* Processa uma linha do arquivo de retorno. O método é abstrato e deve ser implementado nas sub-classes.
62			* @param int $numLn Número da linha a ser processada
63			* @param string $linha String contendo a linha a ser processada
64			* @return ComposableInterface Retorna um vetor associativo contendo os valores da linha processada.
65			*/
66			public abstract function processarLinha($numLn, Stringy $linha);
			0 ignored issues – show Coding Style introduced 2016-02-26 20:30 UTC by Report Bug Copy Issue Report The abstract declaration must precede the visibility declaration Loading history...
67
68			public abstract function processCnab(RetornoInterface $retorno, ComposableInterface $composable,
			0 ignored issues – show Coding Style introduced 2016-02-26 20:30 UTC by Report Bug Copy Issue Report The abstract declaration must precede the visibility declaration Loading history... Coding Style introduced 2016-02-26 20:30 UTC by Report Bug Copy Issue Report The first parameter of a multi-line function declaration must be on the line after the opening bracket Loading history... Coding Style introduced 2016-02-26 20:30 UTC by Report Bug Copy Issue Report Multi-line function declarations must define one parameter per line Loading history...
69			LoteInterface $lote = null);
			0 ignored issues – show Coding Style introduced 2016-02-26 20:30 UTC by Report Bug Copy Issue Report Multi-line function declaration not indented correctly; expected 8 spaces but found 41 Loading history... Coding Style introduced 2016-02-26 20:30 UTC by Report Bug Copy Issue Report The closing parenthesis of a multi-line function declaration must be on a new line Loading history...
70
71			/**
72			* Formata uma string, contendo um valor real (float) sem o separador de decimais,
73			* para a sua correta representação real.
74			* @param string $valor String contendo o valor na representação
75			* usada nos arquivos de retorno do banco, sem o separador de decimais.
76			* @param int $numCasasDecimais Total de casas decimais do número
77			* representado em $valor.
78			* @return float Retorna o número representado em $valor, no seu formato float,
79			* contendo o separador de decimais.
80			*/
81			public function formataNumero($valor, $numCasasDecimais = 2)
82			{
83			if (empty($valor)) {
84			return 0;
85			}
86			$casas = $numCasasDecimais;
87			if ($casas > 0) {
88			$valor = substr($valor, 0, strlen($valor) - $casas) . "." . substr($valor, strlen($valor) - $casas, $casas);
89			$valor = (float)$valor;
90			} else {
91			$valor = (int)$valor;
92			}
93
94			return $valor;
95			}
96
97			/**
98			* Formata uma string, contendo uma data sem o separador, no formato DDMMAA.
99			* @param string $date String contendo a data no formato DDMMAA.
100			* @return DateTime
101			*/
102			public function createDate($date, $format = "dmy")
103			{
104			if (empty($date)) {
105			return "";
			0 ignored issues – show Bug Best Practice introduced 2016-02-26 20:30 UTC by Report Bug Copy Issue Report The return type of `return '';` (`string`) is incompatible with the return type documented by `Umbrella\Ya\RetornoBolet...ctProcessor::createDate` of type `DateTime`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
106			}
107
108			return DateTime::createFromFormat($format, $date);
109			}
110
111			/**
112			* Formata uma string, contendo uma data sem o separador, no formato DDMMAA HHIISS.
113			* @param string $dateTimeString String contendo a data no formato DDMMAA.
114			* @return DateTime
115			*/
116			public function createDateTime($dateTimeString, $format = "mdy His")
117			{
118			if (empty($dateTimeString)) {
119			return "";
			0 ignored issues – show Bug Best Practice introduced 2016-02-26 20:30 UTC by Report Bug Copy Issue Report The return type of `return '';` (`string`) is incompatible with the return type documented by `Umbrella\Ya\RetornoBolet...ocessor::createDateTime` of type `DateTime`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
120			}
121
122			return DateTime::createFromFormat($format, $dateTimeString);
123			}
124			}
125

umbrellaTech / ya-retorno-boleto

AbstractProcessor A last analyzed 2016-02-26 20:30 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

10 Methods

Duplication Side-by-Side

Filter issues like

AbstractProcessor A
last analyzed 2016-02-26 20:30 UTC