Seboettg\CiteProc\Rendering\Name\Substitute

Complexity

Total Complexity

14

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	render()	0	21	5
B	__construct()	0	35	9

<?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\InvalidStylesheetException;
use Seboettg\CiteProc\Rendering\Rendering;
use Seboettg\CiteProc\RenderingState;
use Seboettg\CiteProc\Util\Factory;
use Seboettg\Collection\ArrayList;
use SimpleXMLElement;
use stdClass;


/**
 * Class Substitute
 * The optional cs:substitute element, which must be included as the last child element of cs: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 cs:substitute, and must consist of one or more rendering elements (with the exception of cs:layout).
 *
 * A shorthand version of cs:names without child elements, which inherits the attributes values set on the cs:name and
 * cs:et-al child elements of the original cs:names element, may also be used.
 *
 * If cs: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:
 * <pre>
 *   <macro name="author">
 *      <names variable="author">
 *        <substitute>
 *          <names variable="editor"/>
 *          <text macro="title"/>
 *        </substitute>
 *      </names>
 *   </macro>
 * </pre>
 * @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 Substitute implements Rendering
{

    /**

Missing short description in doc comment

     * @var ArrayList
     */
    private $children;

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

    /**

Missing short description in doc comment

     * @var Names
     */
    private $parent;

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

    /**
     * Substitute 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 Names $parent

Missing parameter comment

Expected 12 spaces after parameter type; 1 found

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

     * @throws InvalidStylesheetException

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

     */
    public function __construct(SimpleXMLElement $node, Names $parent)
    {
        $this->parent = $parent;
        $this->children = new ArrayList();
        foreach ($node->children() as $child) {

            /** @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

            if ($child->getName() === "names") {

                /** @var Names $names */

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

                $names = Factory::create($child, $this);

                /* A shorthand version of cs:names without child elements, which inherits the attributes values set on
                the cs:name and cs:et-al child elements of the original cs:names element, may also be used. */
                if (!$names->hasEtAl()) {
                    // inherit et-al
                    if ($this->parent->hasEtAl()) {
                        $names->setEtAl($this->parent->getEtAl());
                    }
                }
                if (!$names->hasName()) {
                    // inherit name
                    if ($this->parent->hasName()) {
                        $names->setName($this->parent->getName());
                    }
                }
                // inherit label
                if (!$names->hasLabel() && $this->parent->hasLabel()) {
                    $names->setLabel($this->parent->getLabel());
                }

                $this->children->append($names);
            } else {
                $object = Factory::create($child, $this);
                $this->children->append($object);
            }
        }
    }

    /**

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)
    {
        $ret = [];
        if (CiteProc::getContext()->getRenderingState()->getValue() !== RenderingState::SORTING) {
            CiteProc::getContext()->setRenderingState(new RenderingState(RenderingState::SUBSTITUTION));
        }

        /** @var Rendering $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 ($this->children as $child) {
            /* If cs:substitute contains multiple child elements, the first element to return a
            non-empty result is used for substitution. */
            $res = $child->render($data, $citationNumber);
            if (!empty($res)) {
                $ret[] = $res;
                break;
            }
        }
        if (CiteProc::getContext()->getRenderingState()->getValue() === RenderingState::SUBSTITUTION) {
            CiteProc::getContext()->setRenderingState(new RenderingState(RenderingState::RENDERING));
        }
        return implode("", $ret);
    }
}