jasny /
twig-extensions
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like DateExtension often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use DateExtension, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 11 | class DateExtension extends AbstractExtension |
||
| 12 | { |
||
| 13 | /** |
||
| 14 | * Class constructor |
||
| 15 | */ |
||
| 16 | 48 | public function __construct() |
|
| 17 | { |
||
| 18 | 48 | if (!extension_loaded('intl')) { |
|
| 19 | throw new \Exception("The Date Twig extension requires the 'intl' PHP extension."); // @codeCoverageIgnore |
||
| 20 | } |
||
| 21 | 48 | } |
|
| 22 | |||
| 23 | |||
| 24 | /** |
||
| 25 | * Return extension name |
||
| 26 | * |
||
| 27 | * @return string |
||
| 28 | */ |
||
| 29 | public function getName() |
||
| 30 | { |
||
| 31 | return 'jasny/date'; |
||
| 32 | } |
||
| 33 | |||
| 34 | /** |
||
| 35 | * Callback for Twig to get all the filters. |
||
| 36 | * |
||
| 37 | * @return \Twig\TwigFilter[] |
||
| 38 | */ |
||
| 39 | 34 | public function getFilters() |
|
| 49 | |||
| 50 | /** |
||
| 51 | * Turn a value into a DateTime object |
||
| 52 | * |
||
| 53 | * @param string|int|\DateTime $date |
||
| 54 | * @return \DateTime |
||
| 55 | */ |
||
| 56 | 30 | protected function valueToDateTime($date) |
|
| 57 | { |
||
| 58 | 30 | if (!$date instanceof \DateTime) { |
|
| 59 | 30 | $date = is_int($date) ? \DateTime::createFromFormat('U', $date) : new \DateTime((string)$date); |
|
| 60 | } |
||
| 61 | |||
| 62 | 30 | return $date; |
|
| 63 | } |
||
| 64 | |||
| 65 | /** |
||
| 66 | * Get configured intl date formatter. |
||
| 67 | * |
||
| 68 | * @param string|null $dateFormat |
||
| 69 | * @param string|null $timeFormat |
||
| 70 | * @param string $calendar |
||
| 71 | * @return \IntlDateFormatter |
||
| 72 | */ |
||
| 73 | 28 | protected function getDateFormatter($dateFormat, $timeFormat, $calendar) |
|
| 74 | { |
||
| 75 | 28 | $datetype = isset($dateFormat) ? $this->getFormat($dateFormat) : null; |
|
| 76 | 28 | $timetype = isset($timeFormat) ? $this->getFormat($timeFormat) : null; |
|
| 77 | |||
| 78 | 28 | $calendarConst = $calendar === 'traditional' ? \IntlDateFormatter::TRADITIONAL : \IntlDateFormatter::GREGORIAN; |
|
| 79 | |||
| 80 | 28 | $pattern = $this->getDateTimePattern( |
|
| 81 | 28 | isset($datetype) ? $datetype : $dateFormat, |
|
| 82 | 28 | isset($timetype) ? $timetype : $timeFormat, |
|
| 83 | 28 | $calendarConst |
|
| 84 | ); |
||
| 85 | |||
| 86 | 28 | return new \IntlDateFormatter(\Locale::getDefault(), $datetype, $timetype, null, $calendarConst, $pattern); |
|
| 87 | } |
||
| 88 | |||
| 89 | /** |
||
| 90 | * Format the date/time value as a string based on the current locale |
||
| 91 | * |
||
| 92 | * @param string|false $format 'short', 'medium', 'long', 'full', 'none' or false |
||
| 93 | * @return int|null |
||
| 94 | */ |
||
| 95 | 28 | protected function getFormat($format) |
|
| 96 | { |
||
| 97 | 28 | if ($format === false) { |
|
| 98 | 22 | $format = 'none'; |
|
| 99 | } |
||
| 100 | |||
| 101 | $types = [ |
||
| 102 | 28 | 'none' => \IntlDateFormatter::NONE, |
|
| 103 | 'short' => \IntlDateFormatter::SHORT, |
||
| 104 | 'medium' => \IntlDateFormatter::MEDIUM, |
||
| 105 | 'long' => \IntlDateFormatter::LONG, |
||
| 106 | 'full' => \IntlDateFormatter::FULL |
||
| 107 | ]; |
||
| 108 | |||
| 109 | 28 | return isset($types[$format]) ? $types[$format] : null; |
|
| 110 | } |
||
| 111 | |||
| 112 | /** |
||
| 113 | * Get the date/time pattern. |
||
| 114 | * |
||
| 115 | * @param int|string $datetype |
||
| 116 | * @param int|string $timetype |
||
| 117 | * @param int $calendar |
||
| 118 | * @return string |
||
| 119 | */ |
||
| 120 | 28 | protected function getDateTimePattern($datetype, $timetype, $calendar = \IntlDateFormatter::GREGORIAN) |
|
| 121 | { |
||
| 122 | 28 | if (is_int($datetype) && is_int($timetype)) { |
|
| 123 | 16 | return null; |
|
| 124 | } |
||
| 125 | |||
| 126 | 12 | return $this->getDatePattern( |
|
| 127 | 12 | isset($datetype) ? $datetype : \IntlDateFormatter::SHORT, |
|
| 128 | 12 | isset($timetype) ? $timetype : \IntlDateFormatter::SHORT, |
|
| 129 | 12 | $calendar |
|
| 130 | ); |
||
| 131 | } |
||
| 132 | |||
| 133 | /** |
||
| 134 | * Get the formatter to create a date and/or time pattern |
||
| 135 | * |
||
| 136 | * @param int|string $datetype |
||
| 137 | * @param int|string $timetype |
||
| 138 | * @param int $calendar |
||
| 139 | * @return \IntlDateFormatter |
||
| 140 | */ |
||
| 141 | 6 | protected function getDatePatternFormatter($datetype, $timetype, $calendar = \IntlDateFormatter::GREGORIAN) |
|
| 142 | { |
||
| 143 | 6 | return \IntlDateFormatter::create( |
|
| 144 | 6 | \Locale::getDefault(), |
|
| 145 | 6 | is_int($datetype) ? $datetype : \IntlDateFormatter::NONE, |
|
| 146 | 6 | is_int($timetype) ? $timetype : \IntlDateFormatter::NONE, |
|
| 147 | 6 | \IntlTimeZone::getGMT(), |
|
| 148 | 6 | $calendar |
|
| 149 | ); |
||
| 150 | } |
||
| 151 | |||
| 152 | /** |
||
| 153 | * Get the date and/or time pattern |
||
| 154 | * Default date pattern is short date pattern with 4 digit year. |
||
| 155 | * |
||
| 156 | * @param int|string $datetype |
||
| 157 | * @param int|string $timetype |
||
| 158 | * @param int $calendar |
||
| 159 | * @return string |
||
| 160 | */ |
||
| 161 | 12 | protected function getDatePattern($datetype, $timetype, $calendar = \IntlDateFormatter::GREGORIAN) |
|
| 175 | |||
| 176 | /** |
||
| 177 | * Format the date and/or time value as a string based on the current locale |
||
| 178 | * |
||
| 179 | * @param \DateTime|int|string $value |
||
| 180 | * @param string $dateFormat null, 'short', 'medium', 'long', 'full' or pattern |
||
| 181 | * @param string $timeFormat null, 'short', 'medium', 'long', 'full' or pattern |
||
| 182 | * @param string $calendar 'gregorian' or 'traditional' |
||
| 183 | * @return string |
||
| 184 | */ |
||
| 185 | 31 | protected function formatLocal($value, $dateFormat, $timeFormat, $calendar = 'gregorian') |
|
| 196 | |||
| 197 | /** |
||
| 198 | * Format the date value as a string based on the current locale |
||
| 199 | * |
||
| 200 | * @param DateTime|int|string $date |
||
| 201 | * @param string $format null, 'short', 'medium', 'long', 'full' or pattern |
||
| 202 | * @param string $calendar 'gregorian' or 'traditional' |
||
| 203 | * @return string |
||
| 204 | */ |
||
| 205 | 11 | public function localDate($date, $format = null, $calendar = 'gregorian') |
|
| 209 | |||
| 210 | /** |
||
| 211 | * Format the time value as a string based on the current locale |
||
| 212 | * |
||
| 213 | * @param DateTime|int|string $date |
||
| 214 | * @param string $format 'short', 'medium', 'long', 'full' or pattern |
||
| 215 | * @param string $calendar 'gregorian' or 'traditional' |
||
| 216 | * @return string |
||
| 217 | */ |
||
| 218 | 11 | public function localTime($date, $format = 'short', $calendar = 'gregorian') |
|
| 222 | |||
| 223 | /** |
||
| 224 | * Format the date/time value as a string based on the current locale |
||
| 225 | * |
||
| 226 | * @param DateTime|int|string $date |
||
| 227 | * @param string $format date format, pattern or ['date'=>format, 'time'=>format) |
||
| 228 | * @param string $calendar 'gregorian' or 'traditional' |
||
| 229 | * @return string |
||
| 230 | */ |
||
| 231 | 9 | public function localDateTime($date, $format = null, $calendar = 'gregorian') |
|
| 243 | |||
| 244 | |||
| 245 | /** |
||
| 246 | * Split duration into seconds, minutes, hours, days, weeks and years. |
||
| 247 | * |
||
| 248 | * @param int $seconds |
||
| 249 | * @return array |
||
| 250 | */ |
||
| 251 | 13 | protected function splitDuration($seconds, $max) |
|
| 285 | |||
| 286 | /** |
||
| 287 | * Calculate duration from seconds. |
||
| 288 | * One year is seen as exactly 52 weeks. |
||
| 289 | * |
||
| 290 | * Use null to skip a unit. |
||
| 291 | * |
||
| 292 | * @param int $value Time in seconds |
||
| 293 | * @param array $units Time units (seconds, minutes, hours, days, weeks, years) |
||
| 294 | * @param string $separator |
||
| 295 | * @return string |
||
| 296 | */ |
||
| 297 | 14 | public function duration($value, $units = ['s', 'm', 'h', 'd', 'w', 'y'], $separator = ' ') |
|
| 333 | |||
| 334 | /** |
||
| 335 | * Get the age (in years) based on a date. |
||
| 336 | * |
||
| 337 | * @param DateTime|string $value |
||
| 338 | * @return int |
||
| 339 | */ |
||
| 340 | 3 | public function age($value) |
|
| 350 | } |
||
| 351 |
Loading history...
It seems like the type of the argument is not accepted by the function/method which you are calling.
In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.
We suggest to add an explicit type cast like in the following example: