Mailcode_Date_FormatInfo::getCharactersGrouped() - Code Metrics - Inspection of "Added date formatting docs." - Mistralys/mailcode - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 174259...689687 )

by Sebastian

created 2020-05-06 11:43 UTC

Mailcode_Date_FormatInfo::getCharactersGrouped() A

↳ Parent: Mailcode_Date_FormatInfo

Complexity

Conditions	4
Paths	6

Size

Total Lines	32
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	4
eloc	13
c	1
b	0
f	0
nc	6
nop	0
dl	0
loc	32
rs	9.8333

<?php
/**
 * File containing the {@see Mailcode_Date_FormatInfo} class.
 *
 * @package Mailcode
 * @subpackage Commands
 * @see Mailcode_Date_FormatInfo
 */

declare(strict_types=1);

namespace Mailcode;

use AppUtils\ConvertHelper;
use AppUtils\OperationResult;

/**
 * Main hub for information all around the date format strings
 * that can be used in the ShowDate command.
 *
 * @package Mailcode
 * @subpackage Commands
 * @author Sebastian Mordziol <[email protected]>
 */
class Mailcode_Date_FormatInfo
{
    const VALIDATION_INVALID_FORMAT_CHARACTER = 55801;
    const VALIDATION_EMPTY_FORMAT_STRING = 55802;
    
    const CHARTYPE_DATE = 'date';
    const CHARTYPE_TIME = 'time';
    const CHARTYPE_PUNCTUATION = 'punctuation';
    
   /**
    * @var string
    */
    private $defaultFormat = "Y/m/d";
    
   /**
    * @var Mailcode_Date_FormatInfo_Character[]
    */
    private $formatChars = array();
    
   /**
    * @var string[]
    */
    private $allowedChars = array();
    
   /**
    * @var Mailcode_Date_FormatInfo|NULL
    */
    private static $instance;
    
    private function __construct()
    {
        $this->initCharacters();
    }
    
    public static function getInstance() : Mailcode_Date_FormatInfo
    {
        if(!isset(self::$instance))
        {
            self::$instance = new Mailcode_Date_FormatInfo();
        }
        
        return self::$instance;
    }

   /**
    * Initialized the list of allowed date formatting
    * characters. This is done only once per request
    * by storing them statically for performance reasons.
    */
    private function initCharacters() : void
    {
        $chars = array(
            array(self::CHARTYPE_DATE, 'd', t('Day of the month, 2 digits with leading zeros')),
            array(self::CHARTYPE_DATE, 'm', t('Month number, with leading zeros')),
            array(self::CHARTYPE_DATE, 'Y', t('Year, 4 digits')),
            array(self::CHARTYPE_DATE, 'y', t('Year, 2 digits')),
            
            array(self::CHARTYPE_TIME, 'H', t('Hour, 24-hour format with leading zeros')),
            array(self::CHARTYPE_TIME, 'i', t('Minutes with leading zeros')),
            array(self::CHARTYPE_TIME, 's', t('Seconds with leading zeros')),
            
            array(self::CHARTYPE_PUNCTUATION, '.', t('Dot')),
            array(self::CHARTYPE_PUNCTUATION, '/', t('Slash')),
            array(self::CHARTYPE_PUNCTUATION, '-', t('Hyphen')),
            array(self::CHARTYPE_PUNCTUATION, ':', t('Colon')),
            array(self::CHARTYPE_PUNCTUATION, ' ', t('Space'))
        );
        
        foreach($chars as $def)
        {
            $char = new Mailcode_Date_FormatInfo_Character(
                $def[0],
                $def[1],
                $def[2]
            );
            
            $this->formatChars[] = $char;
            $this->allowedChars[] = $char->getChar();
        }
    }
    
    public function getDefaultFormat() : string
    {
        return $this->defaultFormat;
    }
    
    public function setDefaultFormat(string $formatString) : void
    {
        $this->defaultFormat = $formatString;
    }
    
   /**
    * Validates the date format string, by ensuring that
    * all the characters it is composed of are known.
    *
    * @param string $formatString
    * @return OperationResult
    * 
    * @see Mailcode_Commands_Command_ShowDate::VALIDATION_EMPTY_FORMAT_STRING
    * @see Mailcode_Commands_Command_ShowDate::VALIDATION_INVALID_FORMAT_CHARACTER
    */
    public function validateFormat(string $formatString) : OperationResult
    {
        $result = new OperationResult($this);
        
        $trimmed = trim($formatString);
        
        if(empty($trimmed))
        {
            $result->makeError(
                t('Empty date format.'),
                self::VALIDATION_EMPTY_FORMAT_STRING
            );
            
            return $result;
        }
        
        $chars = ConvertHelper::string2array($formatString);
        $total = count($chars);
        
        for($i=0; $i < $total; $i++)
        {
            $char = $chars[$i];
            
            if(!in_array($char, $this->allowedChars))
            {
                $result->makeError(
                    t('Invalid character in date format:').' '.
                    t('%1$s at position %2$s.', '<code>'.$char.'</code>', $i+1),
                    self::VALIDATION_INVALID_FORMAT_CHARACTER
                );
                
                return $result;
            }
        }
        
        return $result;
    }
    
   /**
    * Retrieves all characters that are allowed to
    * be used in a date format string, with information
    * on each.
    *
    * @return Mailcode_Date_FormatInfo_Character[]
    */
    public function getCharactersList() : array
    {
        return $this->formatChars;
    }
    
   /**
    * Retrieves the characters list, grouped by type label.
    * 
    * @return array<string, array>
    */
    public function getCharactersGrouped() : array
    {
        $grouped = array();
        
        foreach($this->formatChars as $char)
        {
            $type = $char->getTypeLabel();
            
            if(!isset($grouped[$type]))
            {
                $grouped[$type] = array();
            }
            
            $grouped[$type][] = $char;
        }

        $groups = array_keys($grouped);
        
        foreach($groups as $group)
        {
            usort($grouped[$group], function(Mailcode_Date_FormatInfo_Character $a, Mailcode_Date_FormatInfo_Character $b)
            {
                return strnatcasecmp($a->getChar(), $b->getChar());
            });
        }
        
        uksort($grouped, function(string $a, string $b) 
        {
            return strnatcasecmp($a, $b);
        });
        
        return $grouped;
    }
}


1			<?php
2			/**
3			* File containing the {@see Mailcode_Date_FormatInfo} class.
4			*
5			* @package Mailcode
6			* @subpackage Commands
7			* @see Mailcode_Date_FormatInfo
8			*/
9
10			declare(strict_types=1);
11
12			namespace Mailcode;
13
14			use AppUtils\ConvertHelper;
15			use AppUtils\OperationResult;
16
17			/**
18			* Main hub for information all around the date format strings
19			* that can be used in the ShowDate command.
20			*
21			* @package Mailcode
22			* @subpackage Commands
23			* @author Sebastian Mordziol <[email protected]>
24			*/
25			class Mailcode_Date_FormatInfo
26			{
27			const VALIDATION_INVALID_FORMAT_CHARACTER = 55801;
28			const VALIDATION_EMPTY_FORMAT_STRING = 55802;
29
30			const CHARTYPE_DATE = 'date';
31			const CHARTYPE_TIME = 'time';
32			const CHARTYPE_PUNCTUATION = 'punctuation';
33
34			/**
35			* @var string
36			*/
37			private $defaultFormat = "Y/m/d";
38
39			/**
40			* @var Mailcode_Date_FormatInfo_Character[]
41			*/
42			private $formatChars = array();
43
44			/**
45			* @var string[]
46			*/
47			private $allowedChars = array();
48
49			/**
50			* @var Mailcode_Date_FormatInfo\|NULL
51			*/
52			private static $instance;
53
54			private function __construct()
55			{
56			$this->initCharacters();
57			}
58
59			public static function getInstance() : Mailcode_Date_FormatInfo
60			{
61			if(!isset(self::$instance))
62			{
63			self::$instance = new Mailcode_Date_FormatInfo();
64			}
65
66			return self::$instance;
67			}
68
69			/**
70			* Initialized the list of allowed date formatting
71			* characters. This is done only once per request
72			* by storing them statically for performance reasons.
73			*/
74			private function initCharacters() : void
75			{
76			$chars = array(
77			array(self::CHARTYPE_DATE, 'd', t('Day of the month, 2 digits with leading zeros')),
78			array(self::CHARTYPE_DATE, 'm', t('Month number, with leading zeros')),
79			array(self::CHARTYPE_DATE, 'Y', t('Year, 4 digits')),
80			array(self::CHARTYPE_DATE, 'y', t('Year, 2 digits')),
81
82			array(self::CHARTYPE_TIME, 'H', t('Hour, 24-hour format with leading zeros')),
83			array(self::CHARTYPE_TIME, 'i', t('Minutes with leading zeros')),
84			array(self::CHARTYPE_TIME, 's', t('Seconds with leading zeros')),
85
86			array(self::CHARTYPE_PUNCTUATION, '.', t('Dot')),
87			array(self::CHARTYPE_PUNCTUATION, '/', t('Slash')),
88			array(self::CHARTYPE_PUNCTUATION, '-', t('Hyphen')),
89			array(self::CHARTYPE_PUNCTUATION, ':', t('Colon')),
90			array(self::CHARTYPE_PUNCTUATION, ' ', t('Space'))
91			);
92
93			foreach($chars as $def)
94			{
95			$char = new Mailcode_Date_FormatInfo_Character(
96			$def[0],
97			$def[1],
98			$def[2]
99			);
100
101			$this->formatChars[] = $char;
102			$this->allowedChars[] = $char->getChar();
103			}
104			}
105
106			public function getDefaultFormat() : string
107			{
108			return $this->defaultFormat;
109			}
110
111			public function setDefaultFormat(string $formatString) : void
112			{
113			$this->defaultFormat = $formatString;
114			}
115
116			/**
117			* Validates the date format string, by ensuring that
118			* all the characters it is composed of are known.
119			*
120			* @param string $formatString
121			* @return OperationResult
122			*
123			* @see Mailcode_Commands_Command_ShowDate::VALIDATION_EMPTY_FORMAT_STRING
124			* @see Mailcode_Commands_Command_ShowDate::VALIDATION_INVALID_FORMAT_CHARACTER
125			*/
126			public function validateFormat(string $formatString) : OperationResult
127			{
128			$result = new OperationResult($this);
129
130			$trimmed = trim($formatString);
131
132			if(empty($trimmed))
133			{
134			$result->makeError(
135			t('Empty date format.'),
136			self::VALIDATION_EMPTY_FORMAT_STRING
137			);
138
139			return $result;
140			}
141
142			$chars = ConvertHelper::string2array($formatString);
143			$total = count($chars);
144
145			for($i=0; $i < $total; $i++)
146			{
147			$char = $chars[$i];
148
149			if(!in_array($char, $this->allowedChars))
150			{
151			$result->makeError(
152			t('Invalid character in date format:').' '.
153			t('%1$s at position %2$s.', '<code>'.$char.'</code>', $i+1),
154			self::VALIDATION_INVALID_FORMAT_CHARACTER
155			);
156
157			return $result;
158			}
159			}
160
161			return $result;
162			}
163
164			/**
165			* Retrieves all characters that are allowed to
166			* be used in a date format string, with information
167			* on each.
168			*
169			* @return Mailcode_Date_FormatInfo_Character[]
170			*/
171			public function getCharactersList() : array
172			{
173			return $this->formatChars;
174			}
175
176			/**
177			* Retrieves the characters list, grouped by type label.
178			*
179			* @return array<string, array>
180			*/
181			public function getCharactersGrouped() : array
182			{
183			$grouped = array();
184
185			foreach($this->formatChars as $char)
186			{
187			$type = $char->getTypeLabel();
188
189			if(!isset($grouped[$type]))
190			{
191			$grouped[$type] = array();
192			}
193
194			$grouped[$type][] = $char;
195			}
196
197			$groups = array_keys($grouped);
198
199			foreach($groups as $group)
200			{
201			usort($grouped[$group], function(Mailcode_Date_FormatInfo_Character $a, Mailcode_Date_FormatInfo_Character $b)
202			{
203			return strnatcasecmp($a->getChar(), $b->getChar());
204			});
205			}
206
207			uksort($grouped, function(string $a, string $b)
208			{
209			return strnatcasecmp($a, $b);
210			});
211
212			return $grouped;
213			}
214			}
215

Mistralys / mailcode

Push — master ( 174259...689687 )

Mailcode_Date_FormatInfo::getCharactersGrouped() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like