DateExtension::formatLocal() - Code Metrics - Inspection of "Clean up, PSR-2 and tests for TextExtension" - jasny/twig-extensions - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 205cf7...842449 )

by Arnold

created 2017-02-07 13:13 UTC

DateExtension::formatLocal() B

↳ Parent: DateExtension

Complexity

Conditions	6
Paths	7

Size

Total Lines	26
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	26
rs	8.439
cc	6
eloc	16
nc	7
nop	4

<?php

namespace Jasny\Twig;

/**
 * Format a date based on the current locale in Twig
 */
class DateExtension extends \Twig_Extension
{
    /**
     * Class constructor
     */
    public function __construct()
    {
        if (!extension_loaded('intl')) {
            throw new \Exception("The Date Twig extension requires the 'intl' PHP extension."); // @codeCoverageIgnore
        }
    }

    
    /**
     * Return extension name
     * 
     * @return string
     */
    public function getName()
    {
        return 'jasny/date';
    }

    /**
     * Callback for Twig to get all the filters.
     * 
     * @return \Twig_Filter[]
     */
    public function getFilters()
    {
        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());
}
            'localdate' => new \Twig_SimpleFilter('localdate', [$this, 'localDate']),
            'localtime' => new \Twig_SimpleFilter('localtime', [$this, 'localTime']),
            'localdatetime' => new \Twig_SimpleFilter('localdatetime', [$this, 'localDateTime']),
            'duration' => new \Twig_SimpleFilter('duration', [$this, 'duration']),
            'age' => new \Twig_SimpleFilter('age', [$this, 'age']),
        ];
    }

    
    /**
     * Format the date/time value as a string based on the current locale
     * 
     * @param string $format    null, 'short', 'medium', 'long', 'full' or pattern
     * @param int    $calendar
     * @return array [format, pattern)
     */
    protected function getFormat($format, $calendar = \IntlDateFormatter::GREGORIAN)
    {
        if ($format === false) {
            return [\IntlDateFormatter::NONE, null];
        }
        
        $pattern = null;
        
        switch ($format) {
            case null:     $pattern = $this->getDefaultDatePattern($calendar); 
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
                           $format = \IntlDateFormatter::SHORT; break;
switch ($expr) {
     case "A":
         doSomething();
         break; //wrong
     case "B":
         doSomething();
         break; //right
     case "C:":
         doSomething();
         return true; //right
 }
            case 'short':  $format = \IntlDateFormatter::SHORT;  break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 'medium': $format = \IntlDateFormatter::MEDIUM; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 'long':   $format = \IntlDateFormatter::LONG;   break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 'full':   $format = \IntlDateFormatter::FULL;   break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            default:       $pattern = $format;
switch ($expr) {
    default:
        doSomething(); //right
        break;
}


switch ($expr) {
    default:

        doSomething(); //wrong
        break;
}
                           $format = \IntlDateFormatter::SHORT; break;
switch ($expr) {
     case "A":
         doSomething();
         break; //wrong
     case "B":
         doSomething();
         break; //right
     case "C:":
         doSomething();
         return true; //right
 }
        }
        
        return [$format, $pattern];
    }
    
    /**
     * Default date pattern is short date pattern with 4 digit year
     * 
     * @param int $calendar
     * @return string
     */
    protected function getDefaultDatePattern($calendar=\IntlDateFormatter::GREGORIAN)
    {
        $pattern = \IntlDateFormatter::create(
            \Locale::getDefault(),
            \IntlDateFormatter::SHORT,
            \IntlDateFormatter::NONE,
            \IntlTimeZone::getGMT(),
            $calendar
        )->getPattern();
        
        return preg_replace('/\byy?\b/', 'yyyy', $pattern);
    }

    /**
     * Format the date and/or time value as a string based on the current locale
     * 
     * @param DateTime|int|string $date
     * @param string              $dateFormat  null, 'short', 'medium', 'long', 'full' or pattern
     * @param string              $timeFormat  null, 'short', 'medium', 'long', 'full' or pattern
     * @param string              $calendar    'gregorian' or 'traditional'
     * @return string
     */
    protected function formatLocal($date, $dateFormat, $timeFormat, $calendar = 'gregorian')
    {
        if (!isset($date)) {
            return null;
        }
        
        if (!$date instanceof \DateTime) {
            $date = is_int($date) ? \DateTime::createFromFormat('U', $date) : new \DateTime((string)$date);
        }
        
        $calendarConst = $calendar === 'traditional' ? \IntlDateFormatter::TRADITIONAL : \IntlDateFormatter::GREGORIAN;
        
        list($datetype, $pattern1) = $this->getFormat($dateFormat, $calendarConst);
        list($timetype, $pattern2) = $this->getFormat($timeFormat, $calendarConst);
        
        $df = new \IntlDateFormatter(
            \Locale::getDefault(),
            $datetype,
            $timetype,
            null,
            $calendarConst,
            $pattern1 ?: $pattern2
        );
        
        return $df->format($date->getTimestamp());
    }

    /**
     * Format the date value as a string based on the current locale
     * 
     * @param DateTime|int|string $date
     * @param string              $format    null, 'short', 'medium', 'long', 'full' or pattern
     * @param string              $calendar  'gregorian' or 'traditional'
     * @return string
     */
    public function localDate($date, $format = null, $calendar = 'gregorian')
    {
        return $this->formatLocal($date, $format, false, $calendar);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }
    
    /**
     * Format the time value as a string based on the current locale
     * 
     * @param DateTime|int|string $date
     * @param string              $format    'short', 'medium', 'long', 'full' or pattern
     * @param string              $calendar  'gregorian' or 'traditional'
     * @return string
     */
    public function localTime($date, $format='short', $calendar='gregorian')
    {
        return $this->formatLocal($date, false, $format, $calendar);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Format the date/time value as a string based on the current locale
     * 
     * @param DateTime|int|string $date
     * @param string              $format    date format, pattern or ['date'=>format, 'time'=>format)
     * @param string              $calendar  'gregorian' or 'traditional'
     * @return string
     */
    public function localDateTime($date, $format=null, $calendar='gregorian')
    {
        if (is_array($format) || !isset($format)) {
            $formatDate = null;
            $formatTime = 'short';
            
            extract((array)$format, EXTR_PREFIX_ALL, 'format');

        } else {
            $formatDate = $format;
            $formatTime = 'short';
        }
        
        return $this->formatLocal($date, $formatDate, $formatTime, $calendar);
    }
    

    /**
     * Split duration into seconds, minutes, hours, days, weeks and years.
     * 
     * @param int $seconds
     * @return array
     */
    protected function splitDuration($seconds, $max)
    {
        if ($max < 1 || $seconds < 60) {
            return [$seconds];
        }
        
        $minutes = floor($seconds / 60);
        $seconds = $seconds % 60;
        if ($max < 2 || $minutes < 60) {
            return [$seconds, $minutes];
        }
        
        $hours = floor($minutes / 60);
        $minutes = $minutes % 60;
        if ($max < 3 || $hours < 24) {

            return [$seconds, $minutes, $hours];
        }
        
        $days = floor($hours / 24);
        $hours = $hours % 24;
        if ($max < 4 || $days < 7) {

            return [$seconds, $minutes, $hours, $days]; 
        }
        
        $weeks = floor($days / 7);
        $days = $days % 7;
        if ($max < 5 || $weeks < 52) {

            return [$seconds, $minutes, $hours, $days, $weeks];
        }
        
        $years = floor($weeks / 52);
        $weeks = $weeks % 52;
        return [$seconds, $minutes, $hours, $days, $weeks, $years];
    }
    
    /**
     * Calculate duration from seconds.
     * 1 year is seen as exactly 52 weeks.
     * 
     * Use null to skip a unit.
     * 
     * @param int    $seconds    Time in seconds
     * @param array  $units      Time units (seconds, minutes, hours, days, weeks, years)
     * @param string $separator
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return string
     */
    public function duration($seconds, $units = ['s', 'm', 'h', 'd', 'w', 'y'], $seperator = ' ')
    {
        list($seconds, $minutes, $hours, $days, $weeks, $years) =
            $this->splitDuration($seconds, count($units)-1) + array_fill(0, 6, null);
        
        $duration = '';
        if (isset($years) && isset($units[5])) {

            $duration .= $seperator . $years . $units[5];
        }
        
        if (isset($weeks) && isset($units[4])) {

            $duration .= $seperator . $weeks . $units[4];
        }
        
        if (isset($days) && isset($units[3])) {

            $duration .= $seperator . $days . $units[3];
        }
        
        if (isset($hours) && isset($units[2])) {

            $duration .= $seperator . $hours . $units[2];
        }
        
        if (isset($minutes) && isset($units[1])) {

            $duration .= $seperator . $minutes . $units[1];
        }
        
        if (isset($seconds) && isset($units[0])) {

            $duration .= $seperator . $seconds . $units[0];
        }
        
        return trim($duration, $seperator);
    }

    /**
     * Get the age (in years) based on a date.
     * 
     * @param DateTime|string $date
     * @return int
     */
    public function age($date)
    {
        if (!$date instanceof \DateTime) {
            $date = new \DateTime($date);
        }
        
        return $date->diff(new \DateTime())->format('%y');
    }
}


1			<?php
2
3			namespace Jasny\Twig;
4
5			/**
6			* Format a date based on the current locale in Twig
7			*/
8			class DateExtension extends \Twig_Extension
9			{
10			/**
11			* Class constructor
12			*/
13			public function __construct()
14			{
15			if (!extension_loaded('intl')) {
16			throw new \Exception("The Date Twig extension requires the 'intl' PHP extension."); // @codeCoverageIgnore
17			}
18			}
19
20
21			/**
22			* Return extension name
23			*
24			* @return string
25			*/
26			public function getName()
27			{
28			return 'jasny/date';
29			}
30
31			/**
32			* Callback for Twig to get all the filters.
33			*
34			* @return \Twig_Filter[]
35			*/
36			public function getFilters()
37			{
38			return [
			0 ignored issues – show Bug Best Practice introduced 2017-02-07 13:15 UTC by Report Bug Copy Issue Report The return type of `return array('localdate'... array($this, 'age')));` (`array<string,Twig_SimpleFilter>`) is incompatible with the return type declared by the interface `Twig_ExtensionInterface::getFilters` of type `Twig_SimpleFilter[]`. 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...
39			'localdate' => new \Twig_SimpleFilter('localdate', [$this, 'localDate']),

jasny / twig-extensions

Push — master ( 205cf7...842449 )

DateExtension::formatLocal() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like