Seboettg\CiteProc\Rendering\Date\DateRange\DateRangeRenderer

Complexity

Total Complexity

15

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Test Coverage

Coverage

95.92%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
B	getRenderer()	0	27	8
A	renderOneRangePart()	0	7	2
A	factory()	0	4	1
A	__construct()	0	3	1
A	renderDateParts()	0	18	3

<?php
/*

You must use "/**" style comments for a file comment

 * citeproc-php: DateRangeParser.php
 * User: Sebastian Böttger <sebastian.boettger@thomascook.de>
 * created at 03.11.19, 20:00
 */

namespace Seboettg\CiteProc\Rendering\Date\DateRange;

use Seboettg\CiteProc\Rendering\Date\DatePart;
use Seboettg\CiteProc\Rendering\Date\DateTime;
use Seboettg\CiteProc\Rendering\Date\Date;
use Seboettg\Collection\ArrayList;

/**
 * Class DatePartRenderer
 * @package Seboettg\CiteProc\Rendering\Date\DateRange

There must be exactly one blank line before the tags in a doc comment

 */

Missing @category tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

abstract class DateRangeRenderer {

Opening brace of a class must be on the line after the definition

    /**

Missing short description in doc comment

     * @var Date
     */
    protected $parentDateObject;

    /**

Missing short description in doc comment

     * @param Date $dateObject

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param int $toRender

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return DateRangeRenderer

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public static function factory(Date $dateObject, $toRender)
    {
        $className = self::getRenderer($toRender);
        return new $className($dateObject);
    }

    /**
     * DatePartRenderer constructor.
     * @param Date $parentDateObject

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

     */
    public function __construct(Date $parentDateObject)
    {
        $this->parentDateObject = $parentDateObject;
    }

    private static function getRenderer($toRender)

Private method name "DateRangeRenderer::getRenderer" must be prefixed with an underscore

Missing doc comment for function getRenderer()

    {
        $className = "";
        switch ($toRender) {
            case Date::DATE_RANGE_STATE_DAY:

Line indented incorrectly; expected 8 spaces, found 12

                $className = "DayRenderer";
                break;
            case Date::DATE_RANGE_STATE_MONTH:

Line indented incorrectly; expected 8 spaces, found 12

                $className = "MonthRenderer";
                break;
            case Date::DATE_RANGE_STATE_YEAR:

Line indented incorrectly; expected 8 spaces, found 12

                $className = "YearRenderer";
                break;
            case Date::DATE_RANGE_STATE_MONTHDAY:

Line indented incorrectly; expected 8 spaces, found 12

                $className = "MonthDayRenderer";
                break;
            case Date::DATE_RANGE_STATE_YEARDAY:

Line indented incorrectly; expected 8 spaces, found 12

                $className = "YearDayRenderer";
                break;
            case Date::DATE_RANGE_STATE_YEARMONTH:

Line indented incorrectly; expected 8 spaces, found 12

                $className = "YearMonthRenderer";
                break;
            case Date::DATE_RANGE_STATE_YEARMONTHDAY:

Line indented incorrectly; expected 8 spaces, found 12

                $className = "YearMonthDayRenderer";
                break;
        }
        return __NAMESPACE__ . "\\" . $className;
    }

    /**

Missing short description in doc comment

     * @param ArrayList<DatePart> $dateParts

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param DateTime $from

Missing parameter comment

Expected 12 spaces after parameter type; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param DateTime $to

Missing parameter comment

Expected 12 spaces after parameter type; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param $delimiter

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public abstract function parseDateRange(ArrayList $dateParts, DateTime $from, DateTime $to, $delimiter);

    /**

Missing short description in doc comment

     * @param DatePart $datePart

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param DateTime $from

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param DateTime $to

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param $delimiter

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function renderOneRangePart(DatePart $datePart, DateTime $from, DateTime $to, $delimiter)
    {
        $prefix = $datePart->renderPrefix();
        $from = $datePart->renderWithoutAffixes($from, $this->parentDateObject);
        $to = $datePart->renderWithoutAffixes($to, $this->parentDateObject);
        $suffix = !empty($to) ? $datePart->renderSuffix() : "";
        return $prefix . $from . $delimiter . $to . $suffix;
    }

    protected function renderDateParts($dateParts, $from, $to, $delimiter)

Missing doc comment for function renderDateParts()

    {
        $ret = "";
        foreach ($dateParts as $datePart) {
            if (is_array($datePart)) {

                $renderedFrom  = $datePart[0]->render($from, $this->parentDateObject);
                $renderedFrom .= $datePart[1]->renderPrefix();
                $renderedFrom .= $datePart[1]->renderWithoutAffixes($from, $this->parentDateObject);
                $renderedTo  = $datePart[0]->renderWithoutAffixes($to, $this->parentDateObject);
                $renderedTo .= $datePart[0]->renderSuffix();
                $renderedTo .= $datePart[1]->render($to, $this->parentDateObject);
                $ret .= $renderedFrom . $delimiter . $renderedTo;
            } else {
                $ret .= $datePart->render($from, $this->parentDateObject);
            }
        }
        return $ret;
    }
}