ConvertHelper_EOL::detect() - Code Metrics - Inspection of "Passing parameters through to phpunit." - Mistralys/application-utils - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a3e4b0...6ea7df )

by Sebastian

created 2021-04-12 06:08 UTC

ConvertHelper_EOL::detect() B

↳ Parent: ConvertHelper_EOL

Complexity

Conditions	6
Paths	13

Size

Total Lines	56
Code Lines	35

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	35
dl	0
loc	56
rs	8.7377
c	0
b	0
f	0
cc	6
nc	13
nop	1

How to fix Long Method

<?php
/**
 * File containing the {@see AppUtils\ConvertHelper_EOL} class.
 * 
 * @package Application Utils
 * @subpackage ConvertHelper
 * @see AppUtils\ConvertHelper_EOL
 */

declare(strict_types=1);

namespace AppUtils;

/**
 * Container class for an end of line (EOL) character.
 * Used as result when detecting EOL characters in a
 * string or file.
 *
 * @package Application Utils
 * @subpackage ConvertHelper
 * @author Sebastian Mordziol <[email protected]>
 * 
 * @see ConvertHelper::detectEOLCharacter()
 */
class ConvertHelper_EOL
{
    const TYPE_CRLF = 'CR+LF';
    const TYPE_LFCR = 'LF+CR';
    const TYPE_LF = 'LF';
    const TYPE_CR = 'CR';
    
   /**
    * @var string
    */
    protected $char;
    
   /**
    * @var string
    */
    protected $type;
    
   /**
    * @var string
    */
    protected $description;

    protected static $eolChars = null;

    public function __construct(string $char, string $type, string $description)
    {
        $this->char = $char;
        $this->type = $type;
        $this->description = $description;
    }
    
   /**
    * The actual EOL character.
    * @return string
    */
    public function getCharacter() : string
    {
        return $this->char;
    }
    
   /**
    * A more detailed, human readable description of the character.
    * @return string
    */
    public function getDescription() : string
    {
        return $this->description;
    }
    
   /**
    * The EOL character type, e.g. "CR+LF", "CR"...
    * @return string
    * 
    * @see ConvertHelper_EOL::TYPE_CR
    * @see ConvertHelper_EOL::TYPE_CRLF
    * @see ConvertHelper_EOL::TYPE_LF
    * @see ConvertHelper_EOL::TYPE_LFCR
    */
    public function getType() : string
    {
        return $this->type;
    }

    public function isCRLF() : bool
    {
        return $this->isType(self::TYPE_CRLF);
    }
    
    public function isCR() : bool
    {
        return $this->isType(self::TYPE_CR);
    }
    
    public function isLF() : bool
    {
        return $this->isType(self::TYPE_LF);
    }
    
    public function isLFCR() : bool
    {
        return $this->isType(self::TYPE_LFCR);
    }
    
    public function isType(string $type) : bool
    {
        return $this->type === $type;
    }

    /**
     * Detects the most used end-of-line character in the subject string.
     *
     * @param string $subjectString The string to check.
     * @return NULL|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected.
     */
    public static function detect(string $subjectString) : ?ConvertHelper_EOL
    {
        if(empty($subjectString)) {
            return null;
        }

        if(!isset(self::$eolChars))
        {
            $cr = chr((int)hexdec('0d'));
            $lf = chr((int)hexdec('0a'));

            self::$eolChars = array(
                array(
                    'char' => $cr.$lf,
                    'type' => ConvertHelper_EOL::TYPE_CRLF,
                    'description' => t('Carriage return followed by a line feed'),
                ),
                array(
                    'char' => $lf.$cr,
                    'type' => ConvertHelper_EOL::TYPE_LFCR,
                    'description' => t('Line feed followed by a carriage return'),
                ),
                array(
                    'char' => $lf,
                    'type' => ConvertHelper_EOL::TYPE_LF,
                    'description' => t('Line feed'),
                ),
                array(
                    'char' => $cr,
                    'type' => ConvertHelper_EOL::TYPE_CR,
                    'description' => t('Carriage Return'),
                ),
            );
        }

        $max = 0;
        $results = array();
        foreach(self::$eolChars as $def)
        {
            $amount = substr_count($subjectString, $def['char']);

            if($amount > $max)
            {
                $max = $amount;
                $results[] = $def;
            }
        }

        if(empty($results)) {
            return null;
        }

        return new ConvertHelper_EOL(
            $results[0]['char'],
            $results[0]['type'],
            $results[0]['description']
        );
    }
}


1			<?php
2			/**
3			* File containing the {@see AppUtils\ConvertHelper_EOL} class.
4			*
5			* @package Application Utils
6			* @subpackage ConvertHelper
7			* @see AppUtils\ConvertHelper_EOL
8			*/
9
10			declare(strict_types=1);
11
12			namespace AppUtils;
13
14			/**
15			* Container class for an end of line (EOL) character.
16			* Used as result when detecting EOL characters in a
17			* string or file.
18			*
19			* @package Application Utils
20			* @subpackage ConvertHelper
21			* @author Sebastian Mordziol <[email protected]>
22			*
23			* @see ConvertHelper::detectEOLCharacter()
24			*/
25			class ConvertHelper_EOL
26			{
27			const TYPE_CRLF = 'CR+LF';
28			const TYPE_LFCR = 'LF+CR';
29			const TYPE_LF = 'LF';
30			const TYPE_CR = 'CR';
31
32			/**
33			* @var string
34			*/
35			protected $char;
36
37			/**
38			* @var string
39			*/
40			protected $type;
41
42			/**
43			* @var string
44			*/
45			protected $description;
46
47			protected static $eolChars = null;
48
49			public function __construct(string $char, string $type, string $description)
50			{
51			$this->char = $char;
52			$this->type = $type;
53			$this->description = $description;
54			}
55
56			/**
57			* The actual EOL character.
58			* @return string
59			*/
60			public function getCharacter() : string
61			{
62			return $this->char;
63			}
64
65			/**
66			* A more detailed, human readable description of the character.
67			* @return string
68			*/
69			public function getDescription() : string
70			{
71			return $this->description;
72			}
73
74			/**
75			* The EOL character type, e.g. "CR+LF", "CR"...
76			* @return string
77			*
78			* @see ConvertHelper_EOL::TYPE_CR
79			* @see ConvertHelper_EOL::TYPE_CRLF
80			* @see ConvertHelper_EOL::TYPE_LF
81			* @see ConvertHelper_EOL::TYPE_LFCR
82			*/
83			public function getType() : string
84			{
85			return $this->type;
86			}
87
88			public function isCRLF() : bool
89			{
90			return $this->isType(self::TYPE_CRLF);
91			}
92
93			public function isCR() : bool
94			{
95			return $this->isType(self::TYPE_CR);
96			}
97
98			public function isLF() : bool
99			{
100			return $this->isType(self::TYPE_LF);
101			}
102
103			public function isLFCR() : bool
104			{
105			return $this->isType(self::TYPE_LFCR);
106			}
107
108			public function isType(string $type) : bool
109			{
110			return $this->type === $type;
111			}
112
113			/**
114			* Detects the most used end-of-line character in the subject string.
115			*
116			* @param string $subjectString The string to check.
117			* @return NULL\|ConvertHelper_EOL The detected EOL instance, or NULL if none has been detected.
118			*/
119			public static function detect(string $subjectString) : ?ConvertHelper_EOL
120			{
121			if(empty($subjectString)) {
122			return null;
123			}
124
125			if(!isset(self::$eolChars))
126			{
127			$cr = chr((int)hexdec('0d'));
128			$lf = chr((int)hexdec('0a'));
129
130			self::$eolChars = array(
131			array(
132			'char' => $cr.$lf,
133			'type' => ConvertHelper_EOL::TYPE_CRLF,
134			'description' => t('Carriage return followed by a line feed'),
135			),
136			array(
137			'char' => $lf.$cr,
138			'type' => ConvertHelper_EOL::TYPE_LFCR,
139			'description' => t('Line feed followed by a carriage return'),
140			),
141			array(
142			'char' => $lf,
143			'type' => ConvertHelper_EOL::TYPE_LF,
144			'description' => t('Line feed'),
145			),
146			array(
147			'char' => $cr,
148			'type' => ConvertHelper_EOL::TYPE_CR,
149			'description' => t('Carriage Return'),
150			),
151			);
152			}
153
154			$max = 0;
155			$results = array();
156			foreach(self::$eolChars as $def)
157			{
158			$amount = substr_count($subjectString, $def['char']);
159
160			if($amount > $max)
161			{
162			$max = $amount;
163			$results[] = $def;
164			}
165			}
166
167			if(empty($results)) {
168			return null;
169			}
170
171			return new ConvertHelper_EOL(
172			$results[0]['char'],
173			$results[0]['type'],
174			$results[0]['description']
175			);
176			}
177			}
178

Mistralys / application-utils

Push — master ( a3e4b0...6ea7df )

ConvertHelper_EOL::detect() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like