Seboettg\CiteProc\Constraint\AbstractConstraint

Complexity

Total Complexity

9

Size/Duplication

Total Lines	66
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	matchAny()	0	7	2
A	matchAll()	0	7	2
A	validate()	0	10	4

<?php /** @noinspection PhpUnused */

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

Missing short description in doc comment

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

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

/*
 * citeproc-php: AbstractConstraint.php
 * User: Sebastian Böttger <sebastian.boettger@thomascook.de>
 * created at 26.10.19, 14:12
 */

namespace Seboettg\CiteProc\Constraint;

use stdClass;

/**
 * Class AbstractConstraint
 * @package Seboettg\CiteProc\Constraint

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

Tag value for @package tag indented incorrectly; expected 6 spaces but found 1

 * @noinspection PhpUnused
 */

Missing @category tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

abstract class AbstractConstraint implements Constraint
{

    /**

Missing short description in doc comment

     * @var string
     */
    protected $match;

    /**

Missing short description in doc comment

     * @var array
     */
    protected $conditionVariables;

    /**

Missing short description in doc comment

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

     * @param string $variable

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

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

     * @param stdClass $data;

Missing parameter comment

Doc comment for parameter $data; does not match actual variable name $data

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

     */
    protected abstract function matchForVariable($variable, $data);

    /**
     * Variable constructor.
     * @param string $value

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

     * @param string $match
     */
    /** @noinspection PhpUnused */

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

Missing short description in doc comment

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

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

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

    public function __construct($value, $match = "any")
    {
        $this->conditionVariables = explode(" ", $value);
        $this->match = $match;
    }

    /**

Missing short description in doc comment

     * @param $value

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 bool

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

     */
    public function validate($value, $citationNumber = null)
    {
        switch ($this->match) {
            case Constraint::MATCH_ALL:

Line indented incorrectly; expected 8 spaces, found 12

                return $this->matchAll($value);
            case Constraint::MATCH_NONE:

Line indented incorrectly; expected 8 spaces, found 12

                return !$this->matchAny($value); //no match for any value
            case Constraint::MATCH_ANY:

Line indented incorrectly; expected 8 spaces, found 12

            default:

Line indented incorrectly; expected 8 spaces, found 12

                return $this->matchAny($value);
        }
    }

    private function matchAny($value)

Private method name "AbstractConstraint::matchAny" must be prefixed with an underscore

Missing doc comment for function matchAny()

    {
        $conditionMatched = false;
        foreach ($this->conditionVariables as $variable) {
            $conditionMatched |= $this->matchForVariable($variable, $value);
        }
        return (bool)$conditionMatched;
    }

    private function matchAll($value)

Private method name "AbstractConstraint::matchAll" must be prefixed with an underscore

Missing doc comment for function matchAll()

    {
        $conditionMatched = true;
        foreach ($this->conditionVariables as $variable) {
            $conditionMatched &= $this->matchForVariable($variable, $value);
        }
        return (bool)$conditionMatched;
    }
}