Seboettg\CiteProc\Constraint\IsNumeric

Complexity

Total Complexity

8

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Test Coverage

Coverage

77.78%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	parseValue()	0	13	5
A	__construct()	0	3	1
A	validate()	0	7	2

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

use NumberFormatter;
use Seboettg\CiteProc\CiteProc;
use Seboettg\CiteProc\Util\NumberHelper;


/**
 * Class IsNumeric
 * @package Seboettg\CiteProc\Choose\Constraint

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 IsNumeric implements ConstraintInterface
{

    private $isNumeric;

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

    public function __construct($value)

Missing doc comment for function __construct()

    {
        $this->isNumeric = $value;
    }

    /**

Missing short description in doc comment

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

     * @param $value

Missing parameter name

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param int|null $citationNumber

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return bool

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function validate($value, $citationNumber = null)
    {
        if (isset($value->{$this->isNumeric})) {
            return $this->parseValue($value->{$this->isNumeric});
        }

        return false;
    }

    /**

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

     * Tests whether the given variables (Appendix IV - Variables) contain numeric content. Content is considered
     * numeric if it solely consists of numbers. Numbers may have prefixes and suffixes (“D2”, “2b”, “L2d”), and may be
     * separated by a comma, hyphen, or ampersand, with or without spaces (“2, 3”, “2-4”, “2 & 4”). For example, “2nd”
     * tests “true” whereas “second” and “2nd edition” test “false”.
     *
     * @param $evalValue

Missing parameter name

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return bool

Tag cannot be grouped with parameter tags in a doc comment

     */
    private function parseValue($evalValue)

Private method name "IsNumeric::parseValue" must be prefixed with an underscore

    {
        if (is_numeric($evalValue)) {
            return true;
        } else if (preg_match(NumberHelper::PATTERN_ORDINAL, $evalValue)) {
            $numberFormatter = new NumberFormatter(CiteProc::getContext()->getLocale()->getLanguage(), NumberFormatter::ORDINAL);
            return $numberFormatter->parse($evalValue) !== false;
        } else if (preg_match(NumberHelper::PATTERN_ROMAN, $evalValue)) {
            return NumberHelper::roman2Dec($evalValue) !== false;
        } else if (preg_match(NumberHelper::PATTERN_COMMA_AMPERSAND_RANGE, $evalValue)) {
            return true;
        }
        return false;
    }
}