Seboettg\CiteProc\Rendering\Name\NamePart

Complexity

Total Complexity

8

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Test Coverage

Coverage

90%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	render()	0	22	4
A	__construct()	0	14	3
A	getName()	0	3	1

<?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\Exception\CiteProcException;
use Seboettg\CiteProc\Styles\AffixesTrait;
use Seboettg\CiteProc\Styles\FormattingTrait;
use Seboettg\CiteProc\Styles\TextCaseTrait;
use SimpleXMLElement;

/**
 * Class NamePart
 *
 * The cs:name element may contain one or two cs:name-part child elements for name-part-specific formatting.
 * cs:name-part must carry the name attribute, set to either “given” or “family”.
 *
 * If set to “given”, formatting and text-case attributes on cs:name-part affect the “given” and “dropping-particle”
 * name-parts. affixes surround the “given” name-part, enclosing any demoted name particles for inverted names.
 *
 * If set to “family”, formatting and text-case attributes affect the “family” and “non-dropping-particle” name-parts.
 * affixes surround the “family” name-part, enclosing any preceding name particles, as well as the “suffix” name-part
 * for non-inverted names.
 *
 * The “suffix” name-part is not subject to name-part formatting. The use of cs:name-part elements does not influence
 * which, or in what order, name-parts are rendered.
 *
 *
 * @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 NamePart
{

    use FormattingTrait,

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

        TextCaseTrait,
        AffixesTrait;

    private $name;

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

    /**

Missing short description in doc comment

     * @var Name
     */
    private $parent;

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

    /**
     * NamePart constructor.
     * @param SimpleXMLElement $node

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

Missing parameter comment

     * @param Name $parent

Missing parameter comment

Expected 13 spaces after parameter type; 1 found

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

        /** @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 ($attribute->getName() === 'name') {
                $this->name = (string) $attribute;
            }
        }

        $this->initFormattingAttributes($node);
        $this->initTextCaseAttributes($node);
        $this->initAffixesAttributes($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 for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return mixed

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)
    {
        if (!isset($data->{$this->name})) {
            return "";
        }

        switch ($this->name) {

            /* If set to “given”, formatting and text-case attributes on cs:name-part affect the “given” and
            “dropping-particle” name-parts. affixes surround the “given” name-part, enclosing any demoted name particles
            for inverted names.*/
            case 'given':

Line indented incorrectly; expected 8 spaces, found 12

                return $this->addAffixes($this->format($this->applyTextCase($data->given)));

            /* if name set to “family”, formatting and text-case attributes affect the “family” and
            “non-dropping-particle” name-parts. affixes surround the “family” name-part, enclosing any preceding name
            particles, as well as the “suffix” name-part for non-inverted names.*/
            case 'family':

Line indented incorrectly; expected 8 spaces, found 12

                return $this->addAffixes($this->format($this->applyTextCase($data->family)));

        }
        throw new CiteProcException("This shouldn't happen.");
    }

    /**

Missing short description in doc comment

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

}