Seboettg\CiteProc\Style\Sort\Key

Complexity

Total Complexity

15

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getMacro()	0	3	1
A	isNameVariable()	0	3	1
A	isDateVariable()	0	3	1
A	isMacro()	0	3	2
A	getSort()	0	3	1
A	setRangePart()	0	3	1
A	getRangePart()	0	3	1
A	getVariable()	0	3	1
A	isNumberVariable()	0	3	1
A	__construct()	0	14	5

<?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\Style\Sort;
use Seboettg\CiteProc\CiteProc;
use Seboettg\CiteProc\Util\Variables;


/**
 * Class Key
 *
 * The cs:sort element must contain one or more cs:key child elements. The sort key, set as an attribute on cs:key, must
 * be a variable (see Appendix IV - Variables) or macro name. For each cs:key element, the sort direction can be set to
 * either “ascending” (default) or “descending” with the sort attribute. The attributes names-min, names-use-first, and
 * names-use-last may be used to override the values of the corresponding et-al-min/et-al-subsequent-min,
 * et-al-use-first/et-al-subsequent-use-first and et-al-use-last attributes, and affect all names generated via macros
 * called by cs:key.
 *
 * @package Seboettg\CiteProc\Style\Sort
 *
 * @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 Key implements SortKey
{
    /**
     * variable name or macro

Doc comment short description must start with a capital letter

     * @var string

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

     */
    private $variable;

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

    /**
     * the sort direction can be set to either “ascending” (default) or “descending” with the sort attribute

Doc comment short description must start with a capital letter

     * @var string

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

     */
    private $sort = "ascending";

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

    /**
     * macro name

Doc comment short description must start with a capital letter

     * @var string

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

     */
    private $macro;

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

    /**
     * only relevant for date ranges

Doc comment short description must start with a capital letter

     * @var int

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

     */
    private $rangePart = 1;

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

    /**
     * Key constructor.
     * The cs:sort element must contain one or more cs:key child elements. The sort key, set as an attribute on cs:key,
     * must be a variable (see Appendix IV - Variables) or macro name. For each cs:key element, the sort direction can
     * be set to either “ascending” (default) or “descending” with the sort attribute.
     *
     * TODO: The attributes names-min, names-use-first, and names-use-last may be used to override the values of the
     * corresponding et-al-min/et-al-subsequent-min, et-al-use-first/et-al-subsequent-use-first and et-al-use-last
     * attributes, and affect all names generated via macros called by cs:key.
     *
     * @param \SimpleXMLElement $node

Missing parameter comment

     */
    public function __construct(\SimpleXMLElement $node)
    {
        /** @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) {
            $name = $attribute->getName();
            if ($name === "variable") {
                $this->variable = (string) $attribute;
            }
            if ($name === "sort") {
                $this->sort = (string) $attribute;
            }
            if ($name === "macro") {
                $this->variable = "macro";
                $this->macro = (string) $attribute;
            }
        }
    }

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @return string (ascending|descending)
     */
    public function getSort()
    {
        return $this->sort;
    }

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @return bool
     */
    public function isNameVariable()
    {
        return Variables::isNameVariable($this->variable);
    }

    /**

Missing short description in doc comment

     * @return bool
     */
    public function isNumberVariable()
    {
        return Variables::isNumberVariable($this->variable);
    }

    /**

Missing short description in doc comment

     * @return bool
     */
    public function isDateVariable()
    {
        return Variables::isDateVariable($this->variable);
    }

    /**

Missing short description in doc comment

     * @return bool
     */
    public function isMacro()
    {
        return $this->variable === "macro" && !empty(CiteProc::getContext()->getMacro($this->macro));
    }

    /**

Missing short description in doc comment

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

     * @param $rangePart

Missing parameter name

     */

Missing @return tag in function comment

    public function setRangePart($rangePart)
    {
        $this->rangePart = $rangePart;
    }

    /**

Missing short description in doc comment

     * @return int
     */
    public function getRangePart()
    {
        return $this->rangePart;
    }
}