AbstractTimeGraphWidget::groupingType() - Code Metrics - Inspection of "Graph widgets" - locomotivemtl/charcoal-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( eff997...1abf17 )

by Mathieu

created 2016-03-15 17:11 UTC

AbstractTimeGraphWidget::groupingType() A

↳ Parent: AbstractTimeGraphWidget

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php
namespace Charcoal\Admin\Widget\Graph;

// Dependencies from `PHP`
use \DateInterval;
use \DateTime;
use \DateTimeInterface;
use \InvalidArgumentException;
use \PDO;

// Dependencies from `charcoal-core`
use \Charcoal\Model\ModelFactory;

// From `charcoal-admin`
use \Charcoal\Admin\Widget\Graph\AbstractGraphWidget;
use \Charcoal\Amin\Widget\Graph\GraphWidgetInterface;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

/**
 * Base Graph widget
 */
abstract class AbstractTimeGraphWidget extends AbstractGraphWidget implements TimeGraphWidgetInterface
{
    /**
     * @var array $dbRows
     */
    private $dbRows;

    /**
     * @var string $groupingType
     */
    private $groupingType;

    /**
     * @var strubg $dateFirnat
     */
    private $dateFormat;

    /**
     * @var string $sqlDateFormat
     */
    private $sqlDateFormat;

    /**
     * @var DateTimeInterface $startDate
     */
    private $startDate;

    /**
     * @var DateTimeInterface $endDate
     */
    private $endDate;

    /**
     * @var DateInterval $dateInterval
     */
    private $dateInterval;

    /**
     * @param string $type The group type.
     * @throws InvalidArgumentException If the group type is not a valid type.
     */
    public function setGroupingType($type)
    {
        if ($type == 'hour') {
            $this->groupingType = 'hour';
            return $this->setGroupingTypeByHour();
        } elseif ($type == 'day') {
            $this->groupingType = 'day';
            return $this->setGroupingTypeByDay();
        } elseif ($type == 'month') {
            $this->groupingType = 'month';
            return $this->setGroupingTypeByMonth();
        } else {
            throw new InvalidArgumentException(
                'Invalid group type: can be "hour", "day" or "month".'
            );
        }
    }

    /**
     * @return string
     */
    public function groupingType()
    {
        return $this->groupingType;
    }

    /**
     * @param string $format The date format.
     * @throws InvalidArgumentException If the format argument is not a string.
     * @return UserTimeGraphWidget Chainable
     */
    public function setDateFormat($format)
    {
        if (!is_string($format)) {
            throw new InvalidArgumentException(
                'Date format must be a string'
            );
        }
        $this->dateFormat = $format;

        return $this;
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 string
     */
    public function dateFormat()
    {
        return $this->dateFormat;
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());
}
    }

    /**
     * @param string $format The date format.
     * @throws InvalidArgumentException If the format argument is not a string.
     * @return UserTimeGraphWidget Chainable
     */
    public function setSqlDateFormat($format)
    {
        if (!is_string($format)) {
            throw new InvalidArgumentException(
                'SQL date format must be a string'
            );
        }
        $this->sqlDateFormat = $format;
        return $this;
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 string
     */
    public function sqlDateFormat()
    {
        return $this->sqlDateFormat;
    }

    /**
     * @param string|DateTimeInterface $ts The start date.
     * @throws InvalidArgumentException If the date is not a valid datetime format.
     * @return UserTimeGraphWidget Chainable
     */
    public function setStartDate($ts)

    {
        if (is_string($ts)) {
            try {
                $ts = new DateTime($ts);
            } catch (Exception $e) {

                throw new InvalidArgumentException(
                    'Invalid start date: '.$e->getMessage()
                );
            }
        }
        if (!($ts instanceof DateTimeInterface)) {
            throw new InvalidArgumentException(
                'Invalid "Start Date" value. Must be a date/time string or a DateTime object.'
            );
        }
        $this->startDate = $ts;
        return $this;
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 DateTimeInterface
     */
    public function startDate()
    {
        return $this->startDate;
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());
}
    }

    /**
     * @param string|DateTimeInterface $ts The end date.
     * @throws InvalidArgumentException If the date is not a valid datetime format.
     * @return UserTimeGraphWidget Chainable
     */
    public function setEndDate($ts)

    {
        if (is_string($ts)) {
            try {
                $ts = new DateTime($ts);
            } catch (Exception $e) {

                throw new InvalidArgumentException(
                    'Invalid end date: '.$e->getMessage()
                );
            }
        }
        if (!($ts instanceof DateTimeInterface)) {
            throw new InvalidArgumentException(
                'Invalid "End Date" value. Must be a date/time string or a DateTime object.'
            );
        }
        $this->endDate = $ts;
        return $this;
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 DateTimeInterface
     */
    public function endDate()
    {
        return $this->endDate;
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());
}
    }

    /**
     * @param string|DateInterval $interval The date interval, between "categories".
     * @throws InvalidArgumentException If the argument is not a string or an interval object.
     * @return UserTimeGraphWidget Chainable
     */
    public function setDateInterval($interval)
    {
        if (is_string($interval)) {
            $this->dateInterval = DateInterval::createfromdatestring($interval);
        } elseif ($interval instanceof DateInterval) {
            $this->dateInterval = $interval;
        } else {
            throw new InvalidArgumentException(
                'Can not set date interval.'
            );
        }
        return $this;
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 DateInterval
     */
    public function dateInterval()
    {
        return $this->dateInterval;
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 UserTimeGraphWidget Chainable
      */
    protected function setGroupingTypeByHour()

    {
        $this->setDateFormat('Y-m-d H:i');
        $this->setSqlDateFormat('%Y-%m-%d %H:%i');
        $this->setStartDate('-24 hours');
        $this->setEndDate('now');
        $this->setDateInterval('+1 hour');

        return $this;
    }

    /**
     * @return UserTimeGraphWidget Chainable
     */
    protected function setGroupingTypeByDay()

    {
        $this->setDateFormat('Y-m-d');
        $this->setSqlDateFormat('%Y-%m-%d');
        $this->setStartDate('-30 days');
        $this->setEndDate('now');
        $this->setDateInterval('+1 day');

        return $this;
    }

    /**
     * @return UserTimeGraphWidget Chainable
     */
    protected function setGroupingTypeByMonth()

    {
        $this->setDateFormat('Y-m');
        $this->setSqlDateFormat('%Y-%m');
        $this->setStartDate('-12 months');
        $this->setEndDate('now');
        $this->setDateInterval('+1 month');

        return $this;
    }

    /**
     * @return array
     */
    protected function dbRows()
    {
        if ($this->dbRows === null) {
            $factory = new ModelFactory([

                'logger' => $this->logger
            ]);

            $model = $factory->create($this->objType(), [
                'logger' => $this->logger
            ]);

            $sql = [];
            $seriesOptions = $this->seriesOptions();
            foreach ($seriesOptions as $serieId => $serieOpts) {
                $sql[] = $serieOpts['function'].' as '.$serieId;
            }

            $q = sprintf(
                '
                SELECT
                    %1$s as x,
                    '.implode(
                    ', ',
                    $sql
                ).'
                FROM
                    %2$s
                WHERE
                    %1$s BETWEEN  :start_date AND :end_date
                GROUP BY
                    %1$s
                ORDER BY
                    %1$s ASC',
                $this->categoryFunction(),
                $model->source()->table()
            );
            $res = $model->source()->dbQuery($q, [
                'start_date'    => $this->startDate()->format($this->dateFormat()),
                'end_date'      => $this->endDate()->format($this->dateFormat())
            ]);
            $this->dbRows = $res->fetchAll((PDO::FETCH_GROUP|PDO::FETCH_UNIQUE|PDO::FETCH_ASSOC));
        }
        return $this->dbRows;
    }

    /**
     * Fill all rows with 0 value for all series, when it is unset.
     *
     * @param array $rows The row structure to fill.
     * @return array
     */
    protected function fillRows(array $rows)
    {
        $row = [];
        $seriesOptions = $this->seriesOptions();
        foreach ($seriesOptions as $serieId => $serieOpts) {
            $row[$serieId] = '0';
        }

        $starts = clone($this->startDate());
        $ends = $this->endDate();
        while ($starts < $ends) {
            $x = $starts->format($this->dateFormat());
            if (!isset($rows[$x])) {
                $rows[$x] = $row;
            }
            $starts->add($this->dateInterval());
        }
        ksort($rows);
        return $rows;
    }

    /**
     * @return string
     */
    abstract protected function objType();

    /**
     * @return array
     */
    abstract protected function seriesOptions();

        /**
         * @return string
         */
    abstract protected function categoryFunction();
}


1			<?php
2			namespace Charcoal\Admin\Widget\Graph;
3
4			// Dependencies from `PHP`
5			use \DateInterval;
6			use \DateTime;
7			use \DateTimeInterface;
8			use \InvalidArgumentException;
9			use \PDO;
10
11			// Dependencies from `charcoal-core`
12			use \Charcoal\Model\ModelFactory;
13
14			// From `charcoal-admin`
15			use \Charcoal\Admin\Widget\Graph\AbstractGraphWidget;
16			use \Charcoal\Amin\Widget\Graph\GraphWidgetInterface;
			0 ignored issues – show Bug introduced 2016-03-15 17:14 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Charcoal\Admin\Widget\Graph\GraphWidgetInterface`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
17
18			/**
19			* Base Graph widget
20			*/
21			abstract class AbstractTimeGraphWidget extends AbstractGraphWidget implements TimeGraphWidgetInterface
22			{
23			/**
24			* @var array $dbRows
25			*/
26			private $dbRows;
27
28			/**
29			* @var string $groupingType
30			*/
31			private $groupingType;
32
33			/**
34			* @var strubg $dateFirnat
35			*/
36			private $dateFormat;
37
38			/**
39			* @var string $sqlDateFormat

locomotivemtl / charcoal-admin

Push — master ( eff997...1abf17 )

AbstractTimeGraphWidget::groupingType() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like