Seboettg\CiteProc\Rendering\Number

Complexity

Total Complexity

34

Size/Duplication

Total Lines	188
Duplicated Lines	0 %

Test Coverage

Coverage

97.65%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	buildNumberRangeString()	0	13	3
A	__construct()	0	17	4
A	longOrdinal()	0	8	2
C	render()	0	59	15
A	toDecimalNumber()	0	13	4
A	ordinal()	0	17	6

<?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;

use Seboettg\CiteProc\CiteProc;
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 SimpleXMLElement;
use stdClass;


/**
 * Class Number
 * @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 Number implements Rendering
{

    const RANGE_DELIMITER_HYPHEN = "-";

    const RANGE_DELIMITER_AMPERSAND = "&";

    const RANGE_DELIMITER_COMMA = ",";

    use FormattingTrait,

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

        AffixesTrait,
        TextCaseTrait,
        DisplayTrait;

    /**

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 $form;

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

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

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

Missing parameter comment

     */
    public function __construct(SimpleXMLElement $node)
    {
        //<number variable="edition" form="ordinal"/>
        /** @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 'variable':

Line indented incorrectly; expected 12 spaces, found 16

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

Line indented incorrectly; expected 12 spaces, found 16

                    $this->form = (string)$attribute;
            }
        }

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

    /**

Missing short description in doc comment

     * @param stdClass $data

Missing parameter comment

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

     * @param int|null $citationNumber

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 function render($data, $citationNumber = null)
    {
        $lang = (isset($data->language) && $data->language != 'en') ? $data->language : 'en';

        if (empty($this->variable) || empty($data->{$this->variable})) {
            return "";
        }
        $number = $data->{$this->variable};
        $decimalNumber = $this->toDecimalNumber($number);
        switch ($this->form) {
            case 'ordinal':

Line indented incorrectly; expected 8 spaces, found 12

                if (preg_match("/\s*(\d+)\s*([\-\-&,])\s*(\d+)\s*/", $decimalNumber, $matches)) {

Line indented incorrectly; expected 12 spaces, found 16

                    $num1 = self::ordinal($matches[1]);
                    $num2 = self::ordinal($matches[3]);
                    $text = $this->buildNumberRangeString($num1, $num2, $matches[2]);
                } else {

Line indented incorrectly; expected 12 spaces, found 16

                    $text = self::ordinal($decimalNumber);
                }

Line indented incorrectly; expected 12 spaces, found 16

                break;
            case 'long-ordinal':

Line indented incorrectly; expected 8 spaces, found 12

                if (preg_match("/\s*(\d+)\s*([\-\-&,])\s*(\d+)\s*/", $decimalNumber, $matches)) {

Line indented incorrectly; expected 12 spaces, found 16

                    if ($this->textCase === "capitalize-first" || $this->textCase === "sentence") {

Line indented incorrectly; expected 16 spaces, found 20

                        $num1 = self::longOrdinal($matches[1]);
                        $num2 = self::longOrdinal($matches[3]);
                    } else {

Line indented incorrectly; expected 16 spaces, found 20

                        $num1 = $this->applyTextCase(self::longOrdinal($matches[1]));
                        $num2 = $this->applyTextCase(self::longOrdinal($matches[3]));
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    $text = $this->buildNumberRangeString($num1, $num2, $matches[2]);
                } else {

Line indented incorrectly; expected 12 spaces, found 16

                    $text = self::longOrdinal($decimalNumber);
                }

Line indented incorrectly; expected 12 spaces, found 16

                break;
            case 'roman':

Line indented incorrectly; expected 8 spaces, found 12

                if (preg_match("/\s*(\d+)\s*([\-\-&,])\s*(\d+)\s*/", $decimalNumber, $matches)) {

Line indented incorrectly; expected 12 spaces, found 16

                    $num1 = Util\NumberHelper::dec2roman($matches[1]);
                    $num2 = Util\NumberHelper::dec2roman($matches[3]);
                    $text = $this->buildNumberRangeString($num1, $num2, $matches[2]);
                } else {

Line indented incorrectly; expected 12 spaces, found 16

                    $text = Util\NumberHelper::dec2roman($decimalNumber);
                }

Line indented incorrectly; expected 12 spaces, found 16

                break;
            case 'numeric':

Line indented incorrectly; expected 8 spaces, found 12

            default:

Line indented incorrectly; expected 8 spaces, found 12

                /*
                 During the extraction, numbers separated by a hyphen are stripped of intervening spaces (“2 - 4”
                 becomes “2-4”). Numbers separated by a comma receive one space after the comma (“2,3” and “2 , 3”
                 become “2, 3”), while numbers separated by an ampersand receive one space before and one after the
                 ampersand (“2&3” becomes “2 & 3”).
                 */
                $decimalNumber = $data->{$this->variable};
                if (preg_match("/\s*(\d+)\s*([\-\-&,])\s*(\d+)\s*/", $decimalNumber, $matches)) {

Line indented incorrectly; expected 12 spaces, found 16

                    $text = $this->buildNumberRangeString($matches[1], $matches[3], $matches[2]);
                } else {

Line indented incorrectly; expected 12 spaces, found 16

                    $text = $decimalNumber;
                }

Line indented incorrectly; expected 12 spaces, found 16

                break;
        }
        return $this->wrapDisplayBlock($this->addAffixes($this->format($this->applyTextCase($text, $lang))));
    }

    /**

Missing short description in doc comment

     * @param $num

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 static function ordinal($num)
    {
        if (($num / 10) % 10 == 1) {
            $ordinalSuffix = CiteProc::getContext()->getLocale()->filter('terms', 'ordinal')->single;
        } elseif ($num % 10 == 1) {
            $ordinalSuffix = CiteProc::getContext()->getLocale()->filter('terms', 'ordinal-01')->single;
        } elseif ($num % 10 == 2) {
            $ordinalSuffix = CiteProc::getContext()->getLocale()->filter('terms', 'ordinal-02')->single;
        } elseif ($num % 10 == 3) {
            $ordinalSuffix = CiteProc::getContext()->getLocale()->filter('terms', 'ordinal-03')->single;
        } else {
            $ordinalSuffix = CiteProc::getContext()->getLocale()->filter('terms', 'ordinal-04')->single;
        }
        if (empty($ordinalSuffix)) {
            $ordinalSuffix = CiteProc::getContext()->getLocale()->filter('terms', 'ordinal')->single;
        }
        return $num . $ordinalSuffix;
    }

    /**

Missing short description in doc comment

     * @param $num

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 static function longOrdinal($num)
    {
        $num = sprintf("%02d", $num);
        $ret = CiteProc::getContext()->getLocale()->filter('terms', 'long-ordinal-' . $num)->single;
        if (!$ret) {
            return self::ordinal($num);
        }
        return $ret;
    }

    /**

Missing short description in doc comment

     * @param string|int $num1

Missing parameter comment

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

     * @param string|int $num2

Missing parameter comment

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

     * @param string $delim

Missing parameter comment

Expected 5 spaces after parameter type; 1 found

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 function buildNumberRangeString($num1, $num2, $delim)
    {

        if (self::RANGE_DELIMITER_AMPERSAND === $delim) {
            $numRange = "$num1 " . htmlentities(self::RANGE_DELIMITER_AMPERSAND) . " $num2";
        } else {
            if (self::RANGE_DELIMITER_COMMA === $delim) {
                $numRange = $num1 . htmlentities(self::RANGE_DELIMITER_COMMA) . " $num2";
            } else {
                $numRange = $num1 . self::RANGE_DELIMITER_HYPHEN . $num2;
            }
        }
        return $numRange;
    }

    /**

Missing short description in doc comment

     * @param string $number

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 toDecimalNumber($number)

Private method name "Number::toDecimalNumber" must be prefixed with an underscore

    {
        $decimalNumber = $number;
        if (Util\NumberHelper::isRomanNumber($number) || Util\NumberHelper::isRomanRange($number)) {
            if (preg_match("/\s*([^\-\-&,]+)\s*([\-\-&,])\s*([^\-\-&,]+)\s*/", $number, $matches)) {
                $num1 = Util\NumberHelper::roman2Dec($matches[1]);
                $num2 = Util\NumberHelper::roman2Dec($matches[3]);
                $decimalNumber = $num1 . $matches[2] . $num2;
            } else {
                $decimalNumber = Util\NumberHelper::roman2Dec($number);
            }
        }
        return $decimalNumber;
    }
}