Seboettg\CiteProc\Rendering\Date\Date

Complexity

Total Complexity

68

Size/Duplication

Total Lines	355
Duplicated Lines	0 %

Test Coverage

Coverage

97.2%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	prepareDatePartsChildren()	0	24	6
A	getDatePartsFromLocales()	0	26	6
F	render()	0	89	27
A	getVariable()	0	3	1
A	prepareDatePartsInVariable()	0	8	5
B	createDateTime()	0	21	7
A	cleanDate()	0	7	2
A	renderDateRange()	0	4	1
A	getForm()	0	3	1
B	__construct()	0	29	7
A	hasDatePartsFromLocales()	0	4	1
A	renderNumeric()	0	3	1
A	iterateAndRenderDateParts()	0	12	3

<?php
/*

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

 * citeproc-php
 *
 * @link        http://github.com/seboettg/citeproc-php for the source repository
 * @copyright   Copyright (c) 2016 Sebastian Böttger.
 * @license     https://opensource.org/licenses/MIT
 */

namespace Seboettg\CiteProc\Rendering\Date;

use Exception;
use Seboettg\CiteProc\CiteProc;
use Seboettg\CiteProc\Exception\CiteProcException;
use Seboettg\CiteProc\Exception\InvalidStylesheetException;
use Seboettg\CiteProc\Rendering\Date\DateRange\DateRangeRenderer;
use Seboettg\CiteProc\Styles\AffixesTrait;
use Seboettg\CiteProc\Styles\DisplayTrait;
use Seboettg\CiteProc\Styles\FormattingTrait;
use Seboettg\CiteProc\Styles\TextCaseTrait;
use Seboettg\CiteProc\Util;
use Seboettg\Collection\ArrayList;
use SimpleXMLElement;


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

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 Date
{

    use AffixesTrait,

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

        DisplayTrait,
        FormattingTrait,
        TextCaseTrait;

    // bitmask: ymd
    const DATE_RANGE_STATE_NONE         = 0; // 000
    const DATE_RANGE_STATE_DAY          = 1; // 001
    const DATE_RANGE_STATE_MONTH        = 2; // 010
    const DATE_RANGE_STATE_MONTHDAY     = 3; // 011
    const DATE_RANGE_STATE_YEAR         = 4; // 100
    const DATE_RANGE_STATE_YEARDAY      = 5; // 101
    const DATE_RANGE_STATE_YEARMONTH    = 6; // 110
    const DATE_RANGE_STATE_YEARMONTHDAY = 7; // 111

    private static $localizedDateFormats = [

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

        'numeric',
        'text'
    ];

    /**

Missing short description in doc comment

     * @var ArrayList
     */
    private $dateParts;

Private member variable "dateParts" 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 $variable = "";

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

    /**

Missing short description in doc comment

     * @var string
     */
    private $datePartsAttribute = "";

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

    /**
     * Date constructor.
     * @param SimpleXMLElement $node

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

Missing parameter comment

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

     * @throws InvalidStylesheetException

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

     */
    public function __construct(SimpleXMLElement $node)
    {
        $this->dateParts = new ArrayList();

        /** @var SimpleXMLElement $attribute */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        foreach ($node->attributes() as $attribute) {
            switch ($attribute->getName()) {
                case 'form':

Line indented incorrectly; expected 12 spaces, found 16

                    $this->form = (string) $attribute;
                    break;
                case 'variable':

Line indented incorrectly; expected 12 spaces, found 16

                    $this->variable = (string) $attribute;
                    break;
                case 'date-parts':

Line indented incorrectly; expected 12 spaces, found 16

                    $this->datePartsAttribute = (string) $attribute;
            }
        }
        /** @var SimpleXMLElement $child */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        foreach ($node->children() as $child) {
            if ($child->getName() === "date-part") {
                $datePartName = (string) $child->attributes()["name"];
                $this->dateParts->set($this->form . "-" . $datePartName, Util\Factory::create($child));
            }
        }

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

    /**

Missing short description in doc comment

     * @param $data

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

     * @throws InvalidStylesheetException

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

     * @throws Exception

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

     */
    public function render($data)
    {
        $ret = "";
        $var = null;

The assignment to $var is dead and can be removed.

        if (isset($data->{$this->variable})) {
            $var = $data->{$this->variable};
        } else {
            return "";
        }

        try {
            $this->prepareDatePartsInVariable($data, $var);
        } catch (CiteProcException $e) {
            if (isset($data->{$this->variable}->{'raw'}) &&
                !preg_match("/(\p{L}+)\s?([\-\-&,])\s?(\p{L}+)/u", $data->{$this->variable}->{'raw'})) {

Each line in a multi-line IF statement must begin with a boolean operator

Closing parenthesis of a multi-line IF statement must be on a new line

                return $this->addAffixes($this->format($this->applyTextCase($data->{$this->variable}->{'raw'})));
            } else {
                if (isset($data->{$this->variable}->{'string-literal'})) {
                    return $this->addAffixes($this->format($this->applyTextCase($data->{$this->variable}->{'string-literal'})));
                }
            }
        }

        $form = $this->form;
        $dateParts = !empty($this->datePartsAttribute) ? explode("-", $this->datePartsAttribute) : [];
        $this->prepareDatePartsChildren($dateParts, $form);


        // No date-parts in date-part attribute defined, take into account that the defined date-part children will be used.
        if (empty($this->datePartsAttribute) && $this->dateParts->count() > 0) {
            /** @var DatePart $part */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            foreach ($this->dateParts as $part) {
                $dateParts[] = $part->getName();
            }
        }

        /* cs:date may have one or more cs:date-part child elements (see Date-part). The attributes set on
        these elements override those specified for the localized date formats (e.g. to get abbreviated months for all
        locales, the form attribute on the month-cs:date-part element can be set to “short”). These cs:date-part
        elements do not affect which, or in what order, date parts are rendered. Affixes, which are very
        locale-specific, are not allowed on these cs:date-part elements. */

        if ($this->dateParts->count() > 0) {
            if (!isset($var->{'date-parts'})) { // ignore empty date-parts
                return "";
            }

            if (count($data->{$this->variable}->{'date-parts'}) === 1) {
                $data_ = $this->createDateTime($data->{$this->variable}->{'date-parts'});
                $ret .= $this->iterateAndRenderDateParts($dateParts, $data_);
            } else if (count($var->{'date-parts'}) === 2) { //date range
                $data_ = $this->createDateTime($var->{'date-parts'});
                $from = $data_[0];
                $to = $data_[1];
                $interval = $to->diff($from);
                $delimiter = "";
                $toRender = 0;
                if ($interval->y > 0 && in_array('year', $dateParts)) {
                    $toRender |= self::DATE_RANGE_STATE_YEAR;
                    $delimiter = $this->dateParts->get($this->form . "-year")->getRangeDelimiter();
                }
                if ($interval->m > 0 && $from->getMonth() - $to->getMonth() !== 0 && in_array('month', $dateParts)) {
                    $toRender |= self::DATE_RANGE_STATE_MONTH;
                    $delimiter = $this->dateParts->get($this->form . "-month")->getRangeDelimiter();
                }
                if ($interval->d > 0 && $from->getDay() - $to->getDay() !== 0 && in_array('day', $dateParts)) {
                    $toRender |= self::DATE_RANGE_STATE_DAY;
                    $delimiter = $this->dateParts->get($this->form . "-day")->getRangeDelimiter();
                }
                if ($toRender === self::DATE_RANGE_STATE_NONE) {
                    $ret .= $this->iterateAndRenderDateParts($dateParts, $data_);
                } else {
                    $ret .= $this->renderDateRange($toRender, $from, $to, $delimiter);
                }
            }

            if (isset($var->raw) && preg_match("/(\p{L}+)\s?([\-\-&,])\s?(\p{L}+)/u", $var->raw, $matches)) {
                return $matches[1] . $matches[2] . $matches[3];
            }
        }
        // fallback:
        // When there are no dateParts children, but date-parts attribute in date
        // render numeric
        else if (!empty($this->datePartsAttribute)) {

Expected "} else if (...) \n"; found "\n // fallback:\n // When there are no dateParts children, but date-parts attribute in date\n // render numeric\n else if (...) {\n"

            $data = $this->createDateTime($var->{'date-parts'});
            $ret = $this->renderNumeric($data[0]);
        }

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

    /**

Missing short description in doc comment

     * @param array $dates

Missing parameter comment

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

     * @return array

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

     * @throws Exception

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

     */
    private function createDateTime($dates)

Private method name "Date::createDateTime" must be prefixed with an underscore

    {
        $data = [];
        foreach ($dates as $date) {
            $date = $this->cleanDate($date);
            if ($date[0] < 1000) {
                $dateTime = new DateTime(0, 0, 0);
                $dateTime->setDay(0)->setMonth(0)->setYear(0);
                $data[] = $dateTime;
            }
            $dateTime = new DateTime($date[0], array_key_exists(1, $date) ? $date[1] : 1, array_key_exists(2, $date) ? $date[2] : 1);
            if (!array_key_exists(1, $date)) {
                $dateTime->setMonth(0);
            }
            if (!array_key_exists(2, $date)) {
                $dateTime->setDay(0);
            }
            $data[] = $dateTime;
        }

        return $data;
    }

    /**

Missing short description in doc comment

     * @param int $toRender

Missing parameter comment

Expected 6 spaces after parameter type; 1 found

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

     */
    private function renderDateRange($toRender, DateTime $from, DateTime $to, $delimiter)

Private method name "Date::renderDateRange" must be prefixed with an underscore

    {
        $datePartRenderer = DateRangeRenderer::factory($this, $toRender);
        return $datePartRenderer->parseDateRange($this->dateParts, $from, $to, $delimiter);
    }

    /**

Missing short description in doc comment

     * @param string $format

Missing parameter comment

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

     * @return bool

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

     */
    private function hasDatePartsFromLocales($format)

Private method name "Date::hasDatePartsFromLocales" must be prefixed with an underscore

    {
        $dateXml = CiteProc::getContext()->getLocale()->getDateXml();
        return !empty($dateXml[$format]);
    }

    /**

Missing short description in doc comment

     * @param string $format

Missing parameter comment

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

     * @return array

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

     */
    private function getDatePartsFromLocales($format)

Private method name "Date::getDatePartsFromLocales" must be prefixed with an underscore

    {
        $ret = [];
        // date parts from locales
        $dateFromLocale_ = CiteProc::getContext()->getLocale()->getDateXml();
        $dateFromLocale = $dateFromLocale_[$format];

        // no custom date parts within the date element (this)?
        if (!empty($dateFromLocale)) {

            $dateForm = array_filter(is_array($dateFromLocale) ? $dateFromLocale : [$dateFromLocale], function($element) use ($format) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

                /** @var SimpleXMLElement $element */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                $dateForm = (string) $element->attributes()["form"];
                return $dateForm === $format;
            });

For multi-line function calls, the closing parenthesis should be on a new line.

            //has dateForm from locale children (date-part elements)?
            $localeDate = array_pop($dateForm);

            if ($localeDate instanceof SimpleXMLElement && $localeDate->count() > 0) {
                foreach ($localeDate as $child) {
                    $ret[] = $child;
                }
            }
        }
        return $ret;
    }

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @param $data

Missing parameter comment

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

     * @param $var

Missing parameter comment

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

     * @throws CiteProcException

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

     */

Missing @return tag in function comment

    private function prepareDatePartsInVariable($data, $var)

Private method name "Date::prepareDatePartsInVariable" must be prefixed with an underscore

    {
        if (!isset($data->{$this->variable}->{'date-parts'}) || empty($data->{$this->variable}->{'date-parts'})) {
            if (isset($data->{$this->variable}->raw) && !empty($data->{$this->variable}->raw)) {
                // try to parse date parts from "raw" attribute
                $var->{'date-parts'} = Util\DateHelper::parseDateParts($data->{$this->variable});
            } else {
                throw new CiteProcException("No valid date format");
            }
        }
    }

    /**

Missing short description in doc comment

     * @param $dateParts

Missing parameter comment

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

     * @param string $form

Missing parameter comment

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

     * @throws InvalidStylesheetException

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

     */

Missing @return tag in function comment

    private function prepareDatePartsChildren($dateParts, $form)

Private method name "Date::prepareDatePartsChildren" must be prefixed with an underscore

    {
        /* Localized date formats are selected with the optional form attribute, which must set to either “numeric”
        (for fully numeric formats, e.g. “12-15-2005”), or “text” (for formats with a non-numeric month, e.g.
        “December 15, 2005”). Localized date formats can be customized in two ways. First, the date-parts attribute may
        be used to show fewer date parts. The possible values are:
            - “year-month-day” - (default), renders the year, month and day
            - “year-month” - renders the year and month
            - “year” - renders the year */

        if ($this->dateParts->count() < 1 && in_array($form, self::$localizedDateFormats)) {
            if ($this->hasDatePartsFromLocales($form)) {
                $datePartsFromLocales = $this->getDatePartsFromLocales($form);
                array_filter($datePartsFromLocales, function(SimpleXMLElement $item) use ($dateParts) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

                    return in_array($item["name"], $dateParts);
                });

For multi-line function calls, the closing parenthesis should be on a new line.

                foreach ($datePartsFromLocales as $datePartNode) {
                    $datePart = $datePartNode["name"];
                    $this->dateParts->set("$form-$datePart", Util\Factory::create($datePartNode));
                }
            } else { //otherwise create default date parts
                foreach ($dateParts as $datePart) {
                    $this->dateParts->add("$form-$datePart", new DatePart(new SimpleXMLElement('<date-part name="' . $datePart . '" form="' . $form . '" />')));
                }
            }
        }
    }


    private function renderNumeric(DateTime $date)

Private method name "Date::renderNumeric" must be prefixed with an underscore

Missing doc comment for function renderNumeric()

    {
        return $date->renderNumeric();
    }

    public function getForm()

Missing doc comment for function getForm()

    {
        return $this->form;
    }

    private function cleanDate($date)

Private method name "Date::cleanDate" must be prefixed with an underscore

Missing doc comment for function cleanDate()

    {
        $ret = [];
        foreach ($date as $key => $datePart) {
            $ret[$key] = Util\NumberHelper::extractNumber(Util\StringHelper::removeBrackets($datePart));
        }
        return $ret;
    }

    /**

Missing short description in doc comment

     * @param array $dateParts

Missing parameter comment

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

     * @param array $data_

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

     */
    private function iterateAndRenderDateParts(array $dateParts, array $data_)

Private method name "Date::iterateAndRenderDateParts" must be prefixed with an underscore

    {
        $ret = "";
        /** @var DatePart $datePart */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        foreach ($this->dateParts as $key => $datePart) {
            /** @noinspection PhpUnusedLocalVariableInspection */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

            list($f, $p) = explode("-", $key);
            if (in_array($p, $dateParts)) {
                $ret .= $datePart->render($data_[0], $this);
            }
        }
        return $ret;
    }
}