Seboettg\CiteProc\Rendering\Name\Names

Complexity

Total Complexity

45

Size/Duplication

Total Lines	341
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	1	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	setEtAl()	0	4	1
A	appendLabel()	0	9	2
A	filterEmpty()	0	4	1
A	getEtAl()	0	3	1
A	hasEtAl()	0	3	1
A	addCountValues()	0	11	2
A	getVariables()	0	3	1
A	hasLabel()	0	3	1
A	setLabel()	0	3	1
A	getDelimiter()	0	3	1
A	getLabel()	0	3	1
A	setName()	0	4	1
A	hasName()	0	3	1
B	__construct()	0	33	8
A	getParent()	0	3	1
A	getName()	0	3	1
F	render()	0	67	20

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

use Seboettg\CiteProc\CiteProc;
use Seboettg\CiteProc\Exception\CiteProcException;
use Seboettg\CiteProc\Exception\InvalidStylesheetException;
use Seboettg\CiteProc\Rendering\HasParent;
use Seboettg\CiteProc\Rendering\Label;
use Seboettg\CiteProc\Rendering\Rendering;
use Seboettg\CiteProc\RenderingState;
use Seboettg\CiteProc\Style\InheritableNameAttributesTrait;
use Seboettg\CiteProc\Styles\AffixesTrait;
use Seboettg\CiteProc\Styles\DelimiterTrait;
use Seboettg\CiteProc\Styles\FormattingTrait;
use Seboettg\CiteProc\Util\Factory;
use Seboettg\CiteProc\Util\NameHelper;
use Seboettg\Collection\ArrayList;
use SimpleXMLElement;
use stdClass;

/**
 * Class Names
 * @package Seboettg\CiteProc\Rendering\Name

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 Names implements Rendering, HasParent
{
    use DelimiterTrait,

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

        AffixesTrait,
        FormattingTrait,
        InheritableNameAttributesTrait;

    /**
     * Variables (selected with the required variable attribute), each of which can contain multiple names (e.g. the
     * “author” variable contains all the author names of the cited item). If multiple variables are selected
     * (separated by single spaces, see example below), each variable is independently rendered in the order specified.
     *
     * @var ArrayList
     */
    private $variables;

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

    /**
     * The Name element, an optional child element of Names, can be used to describe the formatting of individual
     * names, and the separation of names within a name variable.
     *
     * @var Name
     */
    private $name;

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

    /**
     * The optional Label element must be included after the Name and EtAl elements, but before
     * the Substitute element. When used as a child element of Names, Label does not carry the variable
     * attribute; it uses the variable(s) set on the parent Names element instead.
     *
     * @var Label
     */
    private $label;

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

    /**
     * The optional Substitute element, which must be included as the last child element of Names, adds
     * substitution in case the name variables specified in the parent cs:names element are empty. The substitutions
     * are specified as child elements of Substitute, and must consist of one or more rendering elements (with the
     * exception of Layout). A shorthand version of Names without child elements, which inherits the attributes
     * values set on the cs:name and EtAl child elements of the original Names element, may also be used. If
     * Substitute contains multiple child elements, the first element to return a non-empty result is used for
     * substitution. Substituted variables are suppressed in the rest of the output to prevent duplication. An example,
     * where an empty “author” name variable is substituted by the “editor” name variable, or, when no editors exist,
     * by the “title” macro:
     *
     * <macro name="author">
     *     <names variable="author">
     *         <substitute>
     *             <names variable="editor"/>
     *             <text macro="title"/>
     *         </substitute>
     *     </names>
     * </macro>
     *
     * @var Substitute
     */
    private $substitute;

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

    /**
     * Et-al abbreviation, controlled via the et-al-... attributes (see Name), can be further customized with the
     * optional cs:et-al element, which must follow the cs:name element (if present). The term attribute may be set to
     * either “et-al” (the default) or to “and others” to use either term. The formatting attributes may also be used,
     * for example to italicize the “et-al” term:
     *
     * @var EtAl
     */
    private $etAl;

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

    /**
     * The delimiter attribute may be set on cs:names to separate the names of the different name variables (e.g. the
     * semicolon in “Doe, Smith (editors); Johnson (translator)”).
     *
     * @var string
     */
    private $delimiter = ", ";

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

    private $parent;

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

    /**

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

     * Names constructor.
     * @param SimpleXMLElement $node

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

Missing parameter comment

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

     * @param $parent

Missing parameter name

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

     * @throws InvalidStylesheetException

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

     */
    public function __construct(SimpleXMLElement $node, $parent)
    {
        $this->initInheritableNameAttributes($node);
        $this->parent = $parent;
        /** @var SimpleXMLElement $child */

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->children() as $child) {

            switch ($child->getName()) {
                case "name":

Line indented incorrectly; expected 12 spaces, found 16

                    $this->name = Factory::create($child, $this);
                    break;
                case "label":

Line indented incorrectly; expected 12 spaces, found 16

                    $this->label = Factory::create($child);
                    break;
                case "substitute":

Line indented incorrectly; expected 12 spaces, found 16

                    $this->substitute = new Substitute($child, $this);
                    break;
                case "et-al":

Line indented incorrectly; expected 12 spaces, found 16

                    $this->etAl = Factory::create($child);
            }
        }

        /** @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) {
            if ("variable" === $attribute->getName()) {
                $this->variables = new ArrayList(explode(" ", (string) $attribute));
                break;
            }
        }

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

    /**
     * This outputs the contents of one or more name variables (selected with the required variable attribute), each
     * of which can contain multiple names (e.g. the “author” variable contains all the author names of the cited item).
     * If multiple variables are selected (separated by single spaces), each variable is independently rendered in the
     * order specified, with one exception: when the selection consists of “editor” and “translator”, and when the
     * contents of these two name variables is identical, then the contents of only one name variable is rendered. In
     * addition, the “editortranslator” term is used if the Names element contains a Label element, replacing the
     * default “editor” and “translator” terms (e.g. resulting in “Doe (editor & translator)”).
     *
     * @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

     * @throws CiteProcException

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

     */
    public function render($data, $citationNumber = null)
    {
        $str = "";

        /* when the selection consists of “editor” and “translator”, and when the contents of these two name variables
        is identical, then the contents of only one name variable is rendered. In addition, the “editortranslator”
        term is used if the cs:names element contains a cs:label element, replacing the default “editor” and
        “translator” terms (e.g. resulting in “Doe (editor & translator)”) */
        if ($this->variables->hasValue("editor") && $this->variables->hasValue("translator")) {
            if (isset($data->editor) && isset($data->translator) && NameHelper::sameNames($data->editor, $data->translator)) {
                if (isset($this->name)) {
                    $str .= $this->name->render($data, 'editor');
                } else {
                    $arr = [];
                    foreach ($data->editor as $editor) {
                        $edt = $this->format($editor->family . ", " . $editor->given);
                        $results[] = NameHelper::addExtendedMarkup('editor', $editor, $edt);
                    }
                    $str .= implode($this->delimiter, $arr);
                }
                if (isset($this->label)) {
                    $this->label->setVariable("editortranslator");
                    $str .= $this->label->render($data);
                }
                $vars = $this->variables->toArray();
                $vars = array_filter($vars, function($value) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

                    return !($value === "editor" || $value === "translator");
                });

For multi-line function calls, the closing parenthesis should be on a new line.

                $this->variables->setArray($vars);
            }
        }

        $results = [];
        foreach ($this->variables as $var) {

            if (!empty($data->{$var})) {
                if (!empty($this->name)) {
                    $res = $this->name->render($data, $var, $citationNumber);
                    $name = $res;
                    if (!empty($this->label)) {
                        $name = $this->appendLabel($data, $var, $name);
                    }
                    //add multiple counting values
                    if (is_numeric($name) && $this->name->getForm() === "count") {
                        $results = $this->addCountValues($res, $results);
                    } else {
                        $results[] = $this->format($name);
                    }
                } else {
                    foreach ($data->{$var} as $name) {
                        $formatted = $this->format($name->given . " " . $name->family);
                        $results[] = NameHelper::addExtendedMarkup($var, $name, $formatted);
                    }
                }
                // suppress substituted variables
                if (CiteProc::getContext()->getRenderingState()->getValue() === RenderingState::SUBSTITUTION) {
                    unset($data->{$var});
                }
            } else {
                if (!empty($this->substitute)) {
                    $results[] = $this->substitute->render($data);
                }
            }
        }
        $results = $this->filterEmpty($results);
        $str .= implode($this->delimiter, $results);
        return !empty($str) ? $this->addAffixes($str) : "";
    }


    /**

Missing short description in doc comment

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

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

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

     * @param $data

Missing parameter name

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

     * @param $var

Missing parameter name

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

     * @param $name

Missing parameter name

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 appendLabel($data, $var, $name)

Private method name "Names::appendLabel" must be prefixed with an underscore

    {
        $this->label->setVariable($var);
        if (in_array($this->label->getForm(), ["verb", "verb-short"])) {
            $name = $this->label->render($data) . $name;
        } else {
            $name .= $this->label->render($data);
        }
        return $name;
    }

    /**

Missing short description in doc comment

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

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

     * @param $res

Missing parameter name

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

     * @param $results

Missing parameter name

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

     * @return array

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

     */
    private function addCountValues($res, $results)

Private method name "Names::addCountValues" must be prefixed with an underscore

    {
        $lastElement = current($results);
        $key = key($results);
        if (!empty($lastElement)) {
            $lastElement += $res;
            $results[$key] = $lastElement;
        } else {
            $results[] = $res;
        }
        return $results;
    }

    /**

Missing short description in doc comment

     * @return bool
     */
    public function hasEtAl()
    {
        return !empty($this->etAl);
    }

    /**

Missing short description in doc comment

     * @return EtAl
     */
    public function getEtAl()
    {
        return $this->etAl;
    }

    /**

Missing short description in doc comment

     * @param EtAl $etAl

Missing parameter comment

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

     * @return $this

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

     */
    public function setEtAl(EtAl $etAl)
    {
        $this->etAl = $etAl;
        return $this;
    }

    /**

Missing short description in doc comment

     * @return bool
     */
    public function hasName()
    {
        return !empty($this->name);
    }

    /**

Missing short description in doc comment

     * @return Name
     */
    public function getName()
    {
        return $this->name;
    }

    /**

Missing short description in doc comment

     * @param Name $name

Missing parameter comment

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

     * @return $this

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

     */
    public function setName(Name $name)
    {
        $this->name = $name;
        return $this;
    }

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @return ArrayList
     */
    public function getVariables()
    {
        return $this->variables;
    }

    /**

Missing short description in doc comment

     * @return bool
     */
    public function hasLabel()
    {
        return !empty($this->label);
    }

    /**

Missing short description in doc comment

     * @return Label
     */
    public function getLabel()
    {
        return $this->label;
    }

    /**

Missing short description in doc comment

     * @param Label $label

Missing parameter comment

     */

Missing @return tag in function comment

    public function setLabel($label)
    {
        $this->label = $label;
    }

    /**

Missing short description in doc comment

     * @return mixed
     */
    public function getParent()
    {
        return $this->parent;
    }

    private function filterEmpty(array $results)

Missing doc comment for function filterEmpty()

Private method name "Names::filterEmpty" must be prefixed with an underscore

    {
        return array_filter($results, function($item) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

            return !empty($item);
        });

For multi-line function calls, the closing parenthesis should be on a new line.

    }

}