Date::cleanDate() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/master' into..." - seboettg/citeproc-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( e3f840...58d424 )

by Sebastian
created 2017-11-11 09:48 UTC
Date::cleanDate() A

↳ Parent: Date
Complexity

Conditions	2
Paths	2
Size

Total Lines	8
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	2
eloc	5
nc	2
nop	1
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
<?php
/*
 * 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 Seboettg\CiteProc\CiteProc;
use Seboettg\CiteProc\Exception\CiteProcException;
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;


/**
 * Class Date
 * @package Seboettg\CiteProc\Rendering
 *
 * @author Sebastian Böttger <[email protected]>
 */
class Date
{

    use AffixesTrait,
        DisplayTrait,
        FormattingTrait,
        TextCaseTrait;

    // 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 = [
        'numeric',
        'text'
    ];

    /**
     * @var ArrayList
     */
    private $dateParts;

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

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

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

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

        /** @var \SimpleXMLElement $attribute */
        foreach ($node->attributes() as $attribute) {

            switch ($attribute->getName()) {
                case 'form':
                    $this->form = (string) $attribute;
                    break;
                case 'variable':
                    $this->variable = (string) $attribute;
                    break;
                case 'date-parts':
                    $this->datePartsAttribute = (string) $attribute;
            }
        }
        /** @var \SimpleXMLElement $child */
        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);
    }

    /**
     * @param $data
     * @return string
     */
    public function render($data)
    {
        $ret = "";
        $var = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        if (isset($data->{$this->variable})) {
            $var = $data->{$this->variable};
        } else {
            return "";
        }

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

        $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 */
            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->raw) && !preg_match("/(\p{L}+)\s?([\-\-\&,])\s?(\p{L}+)/u", $var->raw) && $this->dateParts->count() > 0) {

                //$var->{"date-parts"} = [];
            } else*/
            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'});
                /** @var DatePart $datePart */
                foreach ($this->dateParts as $key => $datePart) {
                    list($f, $p) = explode("-", $key);
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;
                    if (in_array($p, $dateParts)) {
                        $ret .= $datePart->render($data_[0], $this);
                    }
                }
            } 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);
                $delim = "";
                $toRender = 0;
                if ($interval->y > 0) {
                    $toRender |= self::DATE_RANGE_STATE_YEAR;
                    $delim = $this->dateParts->get($this->form . "-year")->getRangeDelimiter();
                }
                if ($interval->m > 0 && $from->getMonth() - $to->getMonth() !== 0) {
                    $toRender |= self::DATE_RANGE_STATE_MONTH;
                    $delim = $this->dateParts->get($this->form . "-month")->getRangeDelimiter();
                }
                if ($interval->d > 0 && $from->getDay() - $to->getDay() !== 0) {
                    $toRender |= self::DATE_RANGE_STATE_DAY;
                    $delim = $this->dateParts->get($this->form . "-day")->getRangeDelimiter();
                }

                $ret = $this->renderDateRange($toRender, $from, $to, $delim);
            }

            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)) {
            $data = $this->createDateTime($var->{'date-parts'});
            $ret = $this->renderNumeric($data[0]);
        }

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

    private function createDateTime($dates)
    {
        $data = [];
        foreach ($dates as $date) {
            $date = $this->cleanDate($date);
            if ($date[0] < 1000) {
                $dateTime = new DateTime(0, 0, 0);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                $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;
    }

    /**
     * @param integer $differentParts
     * @param DateTime $from
     * @param DateTime $to
     * @param $delim
     * @return string
     */
    private function renderDateRange($differentParts, DateTime $from, DateTime $to, $delim)
    {
        $ret = "";
        $dateParts_ = [];
        switch ($differentParts) {
            case self::DATE_RANGE_STATE_YEAR:
                foreach ($this->dateParts as $key => $datePart) {
                    if (strpos($key, "year") !== false) {
                        $ret .= $this->renderOneRangePart($datePart, $from, $to, $delim);
                    }
                    if (strpos($key, "month") !== false) {
                        $day = !empty($d = $from->getMonth()) ? $d : "";
                        $ret .= $day;
                    }
                    if (strpos($key, "day") !== false) {

                        $day = !empty($d = $from->getDay()) ? $datePart->render($from, $this) : "";
                        $ret .= $day;
                    }
                }
                break;
            case self::DATE_RANGE_STATE_MONTH:
                /**
                 * @var string $key
                 * @var DatePart $datePart
                 */
                foreach ($this->dateParts as $key => $datePart) {
                    if (strpos($key, "year") !== false) {
                        $ret .= $datePart->render($from, $this);
                    }
                    if (strpos($key, "month")) {
                        $ret .= $this->renderOneRangePart($datePart, $from, $to, $delim);
                    }
                    if (strpos($key, "day") !== false) {

                        $day = !empty($d = $from->getDay()) ? $datePart->render($from, $this) : "";
                        $ret .= $day;
                    }
                }
                break;
            case self::DATE_RANGE_STATE_DAY:
                /**
                 * @var string $key
                 * @var DatePart $datePart
                 */
                foreach ($this->dateParts as $key => $datePart) {
                    if (strpos($key, "year") !== false) {
                        $ret .= $datePart->render($from, $this);
                    }
                    if (strpos($key, "month") !== false) {
                        $ret .= $datePart->render($from, $this);
                    }
                    if (strpos($key, "day")) {
                        $ret .= $this->renderOneRangePart($datePart, $from, $to, $delim);
                    }
                }
                break;
            case self::DATE_RANGE_STATE_YEARMONTHDAY:
                $i = 0;
                foreach ($this->dateParts as $datePart) {

                    if ($i === $this->dateParts->count() - 1) {
                        $ret .= $datePart->renderPrefix();
                        $ret .= $datePart->renderWithoutAffixes($from, $this);
                    } else {
                        $ret .= $datePart->render($from, $this);
                    }
                    ++$i;
                }
                $ret .= $delim;
                $i = 0;
                foreach ($this->dateParts as $datePart) {

                    if ($i == 0) {
                        $ret .= $datePart->renderWithoutAffixes($to, $this);
                        $ret .= $datePart->renderSuffix();
                    } else {
                        $ret .= $datePart->render($to, $this);
                    }
                    ++$i;
                }
                break;
            case self::DATE_RANGE_STATE_YEARMONTH:

                $dp = $this->dateParts->toArray();
                $i = 0;
                $dateParts_ = [];
                array_walk($dp, function($datePart, $key) use (&$i, &$dateParts_, $differentParts) {
                    if (strpos($key, "year") !== false || strpos($key, "month") !== false) {
                        $dateParts_["yearmonth"][] = $datePart;
                    }
                    if (strpos($key, "day") !== false) {
                        $dateParts_["day"] = $datePart;
                    }
                });
                break;
            case self::DATE_RANGE_STATE_YEARDAY:

                $dp = $this->dateParts->toArray();
                $i = 0;
                $dateParts_ = [];
                array_walk($dp, function($datePart, $key) use (&$i, &$dateParts_, $differentParts) {
                    if (strpos($key, "year") !== false || strpos($key, "day") !== false) {
                        $dateParts_["yearday"][] = $datePart;
                    }
                    if (strpos($key, "month") !== false) {
                        $dateParts_["month"] = $datePart;
                    }
                });
                break;
            case self::DATE_RANGE_STATE_MONTHDAY:

                $dp = $this->dateParts->toArray();
                $i = 0;
                $dateParts_ = [];
                array_walk($dp, function($datePart, $key) use (&$i, &$dateParts_, $differentParts) {
                    //$bit = sprintf("%03d", decbin($differentParts));

                    if (strpos($key, "month") !== false || strpos($key, "day") !== false) {
                        $dateParts_["monthday"][] = $datePart;
                    }
                    if (strpos($key, "year") !== false) {
                        $dateParts_["year"] = $datePart;
                    }
                });
                break;
        }
        switch ($differentParts) {
            case self::DATE_RANGE_STATE_YEARMONTH:
            case self::DATE_RANGE_STATE_YEARDAY:
            case self::DATE_RANGE_STATE_MONTHDAY:
                /**
                 * @var $key
                 * @var DatePart $datePart */
                foreach ($dateParts_ as $key => $datePart) {
                    if (is_array($datePart)) {

                        $f  = $datePart[0]->render($from, $this);
                        $f .= $datePart[1]->renderPrefix();
                        $f .= $datePart[1]->renderWithoutAffixes($from, $this);
                        $t  = $datePart[0]->renderWithoutAffixes($to, $this);
                        $t .= $datePart[0]->renderSuffix();
                        $t .= $datePart[1]->render($to, $this);
                        $ret .= $f . $delim . $t;
                    } else {
                        $ret .= $datePart->render($from, $this);
                    }
                }
                break;
        }
        return $ret;
    }

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

    /**
     * @param string $format
     * @return bool
     */
    private function hasDatePartsFromLocales($format)
    {
        $dateXml = CiteProc::getContext()->getLocale()->getDateXml();
        return !empty($dateXml[$format]);
    }

    /**
     * @param string $format
     * @return array
     */
    private function getDatePartsFromLocales($format)
    {
        $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) {
                /** @var \SimpleXMLElement $element */
                $dateForm = (string) $element->attributes()["form"];
                return $dateForm === $format;
            });

            //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;
    }

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

    /**
     * @param $data
     * @param $var
     * @throws CiteProcException
     */
    private function prepareDatePartsInVariable($data, $var)
    {
        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 {
                // try to parse date parts from "raw" attribute
                $var->{'date-parts'} = Util\DateHelper::parseDateParts($data->{$this->variable});
                //} catch (CiteProcException $e) {

                //    if (!preg_match("/(\p{L}+)\s?([\-\-\&,])\s?(\p{L}+)/u", $data->{$this->variable}->raw)) {

                //        return $this->addAffixes($this->format($this->applyTextCase($data->{$this->variable}->raw)));

                //    }
                //}
            } else {
                throw new CiteProcException("No valid date format");
                //return "";
            }
        }
    }

    /**
     * @param string $form
     */
    private function prepareDatePartsChildren($dateParts, $form)
    {
        /* 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) {
                    return in_array($item["name"], $dateParts);
                });

                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)
    {
        return $date->renderNumeric();
    }

    public function getForm()
    {
        return $this->form;
    }

    private function cleanDate($date)
    {
        $ret = [];
        foreach ($date as $key => $datePart) {
            $ret[$key] = Util\NumberHelper::extractNumber(Util\StringHelper::removeBrackets($datePart));
        }
        return $ret;
    }
}
seboettg / citeproc-php

Push — master ( e3f840...58d424 )

Date::cleanDate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
