Seboettg\CiteProc\Rendering\Date\DatePart

Complexity

Total Complexity

40

Size/Duplication

Total Lines	202
Duplicated Lines	0 %

Test Coverage

Coverage

86.05%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getRangeDelimiter()	0	3	1
A	getName()	0	3	1
A	__construct()	0	21	6
A	render()	0	5	2
A	monthFromLocale()	0	8	2
A	getForm()	0	3	1
A	renderYear()	0	12	4
A	renderWithoutAffixes()	0	18	6
B	renderMonth()	0	24	8
B	renderDay()	0	21	9

<?php
/**
 * citeproc-php

Doc comment short description must start with a capital letter

 *
 * @link        http://github.com/seboettg/citeproc-php for the source repository

The tag in position 1 should be the @copyright tag

Tag value indented incorrectly; expected 6 spaces but found 8

 * @copyright   Copyright (c) 2016 Sebastian Böttger.

@copyright tag must contain a year and the name of the copyright holder

Tag value indented incorrectly; expected 1 spaces but found 3

 * @license     https://opensource.org/licenses/MIT

@license tag must contain a URL and a license name

Tag value indented incorrectly; expected 3 spaces but found 5

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

namespace Seboettg\CiteProc\Rendering\Date;
use Seboettg\CiteProc\CiteProc;
use Seboettg\CiteProc\Rendering\Layout;
use Seboettg\CiteProc\Rendering\Number;
use Seboettg\CiteProc\Styles\AffixesTrait;
use Seboettg\CiteProc\Styles\DelimiterTrait;
use Seboettg\CiteProc\Styles\FormattingTrait;
use Seboettg\CiteProc\Styles\RangeDelimiterTrait;
use Seboettg\CiteProc\Styles\TextCaseTrait;


/**
 * Class DatePart
 * @package Seboettg\CiteProc\Rendering\Date

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

 *
 * @author Sebastian Böttger <seboettg@gmail.com>
 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class DatePart
{

    const DEFAULT_RANGE_DELIMITER = "–";

    use FormattingTrait,

The trait Seboettg\CiteProc\Styles\AffixesTrait requires the property $single which is not provided by Seboettg\CiteProc\Rendering\Date\DatePart.

        AffixesTrait,
        TextCaseTrait,
        RangeDelimiterTrait;

    /**

Missing short description in doc comment

     * @var string
     */
    private $name;

Private member variable "name" must be prefixed with an underscore

    /**

Missing short description in doc comment

     * @var string
     */
    private $form;

Private member variable "form" must be prefixed with an underscore

    /**

Missing short description in doc comment

     * @var string
     */
    private $rangeDelimiter;

Private member variable "rangeDelimiter" must be prefixed with an underscore

    /**

Missing short description in doc comment

     * @var Date
     */
    private $parent;

Private member variable "parent" must be prefixed with an underscore

    public function __construct(\SimpleXMLElement $node)

Missing doc comment for function __construct()

    {
        foreach ($node->attributes() as $attribute) {
            if ("name" === $attribute->getName()) {
                $this->name = (string) $attribute;
            }
            if ("form" === $attribute->getName()) {
                $this->form = (string) $attribute;
            }
            if ("range-delimiter" === $attribute->getName()) {
                $this->rangeDelimiter = (string) $attribute;
            }
        }

        if (empty($this->rangeDelimiter)) {
            $this->rangeDelimiter = self::DEFAULT_RANGE_DELIMITER;
        }

        $this->initFormattingAttributes($node);
        $this->initAffixesAttributes($node);
        $this->initTextCaseAttributes($node);
    }


    /**

Missing short description in doc comment

     * @param DateTime $date

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param Date $parent

Missing parameter comment

Expected 5 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function render(DateTime $date, Date $parent)
    {
        $this->parent = $parent; //set parent
        $text = $this->renderWithoutAffixes($date);
        return !empty($text) ? $this->addAffixes($text) : "";
    }

    /**

Missing short description in doc comment

Parameter $date should have a doc-comment as per coding-style.

Parameter $parent should have a doc-comment as per coding-style.

     * @param $date

Missing parameter name

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function renderWithoutAffixes(DateTime $date, Date $parent = null)
    {
        if (!is_null($parent)) {
            $this->parent = $parent;
        }
        $text = "";
        switch ($this->name) {
            case 'year':

Line indented incorrectly; expected 8 spaces, found 12

                $text = $this->renderYear($date);
                break;
            case 'month':

Line indented incorrectly; expected 8 spaces, found 12

                $text = $this->renderMonth($date);
                break;
            case 'day':

Line indented incorrectly; expected 8 spaces, found 12

                $text = $this->renderDay($date);
        }

        return !empty($text) ? $this->format($this->applyTextCase($text)) : "";
    }

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @param DateTime $date

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return string|int

Tag cannot be grouped with parameter tags in a doc comment

     */
    protected function renderYear(DateTime $date)
    {
        $text = $date->getYear();
        if ($text > 0 && $text < 1000) {
            $text = $text . CiteProc::getContext()->getLocale()->filter("terms", "ad")->single;
            return $text;
        } elseif ($text < 0) {
            $text = $text * -1;
            $text = $text . CiteProc::getContext()->getLocale()->filter("terms", "bc")->single;
            return $text;
        }
        return $text;
    }

    /**

Missing short description in doc comment

     * @param DateTime $date

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag cannot be grouped with parameter tags in a doc comment

     */
    protected function renderMonth(DateTime $date)
    {
        if ($date->getMonth() < 1 || $date->getMonth() > 12) {
            return "";
        }

        $text = $date->getMonth();

        $form = !empty($this->form) ? $this->form : "long";
        switch ($form) {
            case 'numeric':

Line indented incorrectly; expected 8 spaces, found 12

                break;
            case 'numeric-leading-zeros':

Line indented incorrectly; expected 8 spaces, found 12

                $text = sprintf("%02d", $text);
                break;
            case 'short':

Line indented incorrectly; expected 8 spaces, found 12

                $text = $this->monthFromLocale($text, $form);
                break;
            case 'long':

Line indented incorrectly; expected 8 spaces, found 12

            default:

Line indented incorrectly; expected 8 spaces, found 12

                $text = $this->monthFromLocale($text, $form);
                break;
        }
        return $text;
    }

    /**

Missing short description in doc comment

     * @param DateTime $date

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return int|string

Tag cannot be grouped with parameter tags in a doc comment

     */
    protected function renderDay(DateTime $date)
    {
        if ($date->getDay() < 1 || $date->getDay() > 31) {
            return "";
        }

        $text = $date->getDay();
        $form = !empty($this->form) ? $this->form : $this->parent->getForm();
        switch ($form) {
            case 'numeric':

Line indented incorrectly; expected 8 spaces, found 12

                break;
            case 'numeric-leading-zeros':

Line indented incorrectly; expected 8 spaces, found 12

                $text = sprintf("%02d", $text);
                break;
            case 'ordinal':

Line indented incorrectly; expected 8 spaces, found 12

                $limitDayOrdinals = CiteProc::getContext()->getLocale()->filter("options", "limit-day-ordinals-to-day-1");
                if (!$limitDayOrdinals || Layout::getNumberOfCitedItems() <= 1) {

Line indented incorrectly; expected 12 spaces, found 16

$limitDayOrdinals is of type stdClass, thus it always evaluated to true.

                    $text = Number::ordinal($text);
                }

Line indented incorrectly; expected 12 spaces, found 16

        }
        return $text;
    }

    /**

Missing short description in doc comment

Parameter $text should have a doc-comment as per coding-style.

Parameter $form should have a doc-comment as per coding-style.

     * @param $text

Missing parameter name

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param $form

Missing parameter name

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return mixed

Tag cannot be grouped with parameter tags in a doc comment

     */
    protected function monthFromLocale($text, $form)
    {
        if (empty($form)) {
            $form = "long";
        }
        $month = 'month-' . sprintf('%02d', $text);
        $text = CiteProc::getContext()->getLocale()->filter('terms', $month, $form)->single;
        return $text;
    }

}