Seboettg\CiteProc\Rendering\Group

Complexity

Total Complexity

32

Size/Duplication

Total Lines	134
Duplicated Lines	0 %

Test Coverage

Coverage

96.3%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getParent()	0	3	1
A	__construct()	0	11	2
A	formatting()	0	20	6
D	render()	0	50	23

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

use Seboettg\CiteProc\Styles\AffixesTrait;
use Seboettg\CiteProc\Styles\ConsecutivePunctuationCharacterTrait;
use Seboettg\CiteProc\Styles\DelimiterTrait;
use Seboettg\CiteProc\Styles\DisplayTrait;
use Seboettg\CiteProc\Styles\FormattingTrait;
use Seboettg\CiteProc\Util\Factory;
use Seboettg\Collection\ArrayList;


/**
 * Class Group
 * The cs:group rendering element must contain one or more rendering elements (with the exception of cs:layout).
 * cs:group may carry the delimiter attribute to separate its child elements, as well as affixes and display attributes
 * (applied to the output of the group as a whole) and formatting attributes (transmitted to the enclosed elements).
 * cs:group implicitly acts as a conditional: cs:group and its child elements are suppressed if a) at least one
 * rendering element in cs:group calls a variable (either directly or via a macro), and b) all variables that are
 * called are empty. This accommodates descriptive cs:text elements.
 *
 * @package Seboettg\CiteProc\Rendering
 *
 * @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 Group implements Rendering, HasParent
{
    use DelimiterTrait,

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

        AffixesTrait,
        DisplayTrait,
        FormattingTrait,
        ConsecutivePunctuationCharacterTrait;

    const CLASS_PATH = 'Seboettg\CiteProc\Rendering';

    /**

Missing short description in doc comment

     * @var ArrayList
     */
    private $children;

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

    /**
     * cs:group may carry the delimiter attribute to separate its child elements

Doc comment short description must start with a capital letter

     * @var

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

     */
    private $delimiter = "";

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

    private $parent;

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

    /**

Missing short description in doc comment

     * @var array
     */
    private $renderedChildsWithVariable = [];

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

    public function __construct(\SimpleXMLElement $node, $parent)

Missing doc comment for function __construct()

    {
        $this->parent = $parent;
        $this->children = new ArrayList();
        foreach ($node->children() as $child) {
            $this->children->append(Factory::create($child, $this));
        }
        $this->initDisplayAttributes($node);
        $this->initAffixesAttributes($node);
        $this->initDelimiterAttributes($node);
        $this->initFormattingAttributes($node);
    }

    /**

Missing short description in doc comment

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

     * @param $data

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 string

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function render($data, $citationNumber = null)
    {
        $textParts = array();
        $terms = $variables = $haveVariables = $elementCount = 0;
        foreach ($this->children as $child) {
            $elementCount++;

            if (($child instanceof Text) &&
                ($child->getSource() == 'term' ||

Each line in a multi-line IF statement must begin with a boolean operator

                    $child->getSource() == 'value')) {

Multi-line IF statement not indented correctly; expected 16 spaces but found 20

Each line in a multi-line IF statement must begin with a boolean operator

Closing parenthesis of a multi-line IF statement must be on a new line

                ++$terms;
            }

            if (($child instanceof Label)) {
                ++$terms;
            }
            if (method_exists($child, "getSource") && $child->getSource() == 'variable' &&
                !empty($child->getVariable()) && $child->getVariable() != "date" &&

Each line in a multi-line IF statement must begin with a boolean operator

                !empty($data->{$child->getVariable()})

Each line in a multi-line IF statement must begin with a boolean operator

            ) {
                ++$variables;
            }

            $text = $child->render($data, $citationNumber);
            $delimiter = $this->delimiter;
            if (!empty($text)) {
                if ($delimiter && ($elementCount < count($this->children))) {
                    //check to see if the delimiter is already the last character of the text string
                    //if so, remove it so we don't have two of them when the group will be merged
                    $stext = strip_tags(trim($text));
                    if ((strrpos($stext, $delimiter[0]) + 1) == strlen($stext) && strlen($stext) > 1) {
                        $text = str_replace($stext, '----REPLACE----', $text);
                        $stext = substr($stext, 0, -1);
                        $text = str_replace('----REPLACE----', $stext, $text);
                    }
                }
                $textParts[] = $text;

                if (method_exists($child, "getSource") && $child->getSource() == 'variable' ||

Consider adding parentheses for clarity. Current Interpretation: (method_exists($child, 'getSource') && $child->getSource() == 'variable') || method_exists($child, 'getVariable') && $child->getVariable() != 'date' && ! empty($child->getVariable()), Probably Intended Meaning: method_exists($child, 'getSource') && ($child->getSource() == 'variable' || method_exists($child, 'getVariable') && $child->getVariable() != 'date' && ! empty($child->getVariable()))

                   (method_exists($child, "getVariable") && $child->getVariable() != "date" && !empty($child->getVariable()))) {

Multi-line IF statement not indented correctly; expected 20 spaces but found 19

Each line in a multi-line IF statement must begin with a boolean operator

Closing parenthesis of a multi-line IF statement must be on a new line

                    $haveVariables++;
                }

                if (method_exists($child, "getSource") && $child->getSource() == 'macro') {
                    $haveVariables++;
                }
            }
        }
        return $this->formatting($textParts, $variables, $haveVariables, $terms);
    }

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

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

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

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

     * @param $textParts

Missing parameter name

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param $variables

Missing parameter name

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param $haveVariables

Missing parameter name

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param $terms

Missing parameter name

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag cannot be grouped with parameter tags in a doc comment

     */
    protected function formatting($textParts, $variables, $haveVariables, $terms)
    {
        if (empty($textParts)) {
            return "";
        }

        if ($variables && !$haveVariables) {
            return ""; // there has to be at least one other none empty value before the term is output
        }

        if (count($textParts) == $terms) {
            return ""; // there has to be at least one other none empty value before the term is output
        }

        $text = implode($this->delimiter, $textParts); // insert the delimiter if supplied.
        if (!empty($text)) {
            return $this->wrapDisplayBlock($this->addAffixes($this->format(($text))));
        }

        return "";
    }
}