Seboettg\CiteProc\Rendering\Name\Name

Complexity

Total Complexity

119

Size/Duplication

Total Lines	597
Duplicated Lines	0 %

Test Coverage

Coverage

91.94%

Importance

Changes

0

21 Methods

Rating	Name	Duplication	Size	Complexity
B	renderDelimiterPrecedesLast()	0	20	7
A	renderNameParts()	0	8	4
A	cloneNamePOSC()	0	19	6
B	render()	0	50	8
A	isNameAsSortOrder()	0	3	1
A	getDelimiter()	0	3	1
B	prepareAbbreviation()	0	41	9
A	renderDelimiterPrecedesLastNever()	0	14	4
A	getFormattedNames()	0	8	2
B	renderSubsequentSubstitution()	0	58	10
B	handleSubsequentAuthorSubstitution()	0	27	7
B	appendEtAl()	0	34	11
A	renderDelimiterPrecedesLastContextual()	0	10	3
A	__construct()	0	30	5
A	getNamesString()	0	19	4
A	getForm()	0	3	1
A	formatName()	0	13	5
D	nameOrder()	0	55	25
A	setDelimiter()	0	3	1
A	addAnd()	0	6	4
A	getParent()	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\CiteProc;
use Seboettg\CiteProc\Exception\CiteProcException;
use Seboettg\CiteProc\Rendering\HasParent;
use Seboettg\CiteProc\Rendering\Rendering;
use Seboettg\CiteProc\Style\InheritableNameAttributesTrait;
use Seboettg\CiteProc\Style\Options\DemoteNonDroppingParticle;
use Seboettg\CiteProc\Style\Options\SubsequentAuthorSubstituteRule;
use Seboettg\CiteProc\Styles\AffixesTrait;
use Seboettg\CiteProc\Styles\DelimiterTrait;
use Seboettg\CiteProc\Styles\FormattingTrait;
use Seboettg\CiteProc\Util\CiteProcHelper;
use Seboettg\CiteProc\Util\Factory;
use Seboettg\CiteProc\Util\NameHelper;
use Seboettg\CiteProc\Util\StringHelper;


/**
 * Class Name
 *
 * The cs:name element, an optional child element of cs:names, can be used to describe the formatting of individual
 * names, and the separation of names within a name variable.
 *
 * @package Seboettg\CiteProc\Rendering\Name
 *
 * @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 Name implements HasParent
{
    use InheritableNameAttributesTrait,

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

        FormattingTrait,
        AffixesTrait,
        DelimiterTrait;

    /**

Missing short description in doc comment

     * @var array
     */
    protected $nameParts;

    /**
     * Specifies the text string used to separate names in a name variable. Default is ”, ” (e.g. “Doe, Smith”).
     * @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

    /**

Missing short description in doc comment

     * @var Names
     */
    private $parent;

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

    /**

Missing short description in doc comment

     * @var \SimpleXMLElement
     */
    private $node;

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

    /**

Missing short description in doc comment

     * @var string
     */
    private $etAl;

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

    /**

Missing short description in doc comment

     * @var string
     */
    private $variable;

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

    /**
     * Name constructor.
     * @param \SimpleXMLElement $node

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

Missing parameter comment

     * @param Names $parent

Missing parameter comment

Expected 13 spaces after parameter type; 1 found

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

        $this->nameParts = [];

        /** @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-part":

Line indented incorrectly; expected 12 spaces, found 16

                    /** @var NamePart $namePart */

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

                    $namePart = Factory::create($child, $this);
                    $this->nameParts[$namePart->getName()] = $namePart;
            }
        }

        foreach ($node->attributes() as $attribute) {
            switch ($attribute->getName()) {
                case 'form':

Line indented incorrectly; expected 12 spaces, found 16

                    $this->form = (string)$attribute;
                    break;
            }

        }

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

    /**

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.

     * @param array $name

Missing parameter comment

Expected 8 spaces after parameter type; 1 found

Doc comment for parameter $name does not match actual variable name $data

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param integer|null $citationNumber

Missing parameter comment

Doc comment for parameter $citationNumber does not match actual variable name $var

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, $var, $citationNumber = null)
    {
        $this->variable = $var;
        $name = $data->{$var};
        if (!$this->attributesInitialized) {
            $this->initInheritableNameAttributes($this->node);
        }
        if ("text" === $this->and) {
            $this->and = CiteProc::getContext()->getLocale()->filter('terms', 'and')->single;
        } elseif ('symbol' === $this->and) {
            $this->and = '&';
        }

        $resultNames = $this->handleSubsequentAuthorSubstitution($name, $citationNumber);

        if (empty($resultNames)) {
            return CiteProc::getContext()->getCitationItems()->getSubsequentAuthorSubstitute();
        }

        $resultNames = $this->prepareAbbreviation($resultNames);

        /* When set to “true” (the default is “false”), name lists truncated by et-al abbreviation are followed by
        the name delimiter, the ellipsis character, and the last name of the original name list. This is only
        possible when the original name list has at least two more names than the truncated name list (for this
        the value of et-al-use-first/et-al-subsequent-min must be at least 2 less than the value of
        et-al-min/et-al-subsequent-use-first). */
        if ($this->etAlUseLast) {
            $this->and = "…"; // set "and"
            $this->etAl = null; //reset $etAl;
        }

        /* add "and" */
        $this->addAnd($resultNames);

        $text = $this->renderDelimiterPrecedesLast($resultNames);

        if (empty($text)) {
            $text = implode($this->delimiter, $resultNames);
        }

        $text = $this->appendEtAl($name, $text, $resultNames);

        /* A third value, “count”, returns the total number of names that would otherwise be rendered by the use of the
        cs:names element (taking into account the effects of et-al abbreviation and editor/translator collapsing),
        which allows for advanced sorting. */
        if ($this->form == 'count') {
            return (int)count($resultNames);
        }

        return $text;
    }

    /**

Missing short description in doc comment

     * @param \stdClass $nameItem

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param int $rank

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag cannot be grouped with parameter tags in a doc comment

     */
    private function formatName($nameItem, $rank)

Private method name "Name::formatName" must be prefixed with an underscore

    {

        $nameObj = $this->cloneNamePOSC($nameItem);

        $useInitials = $this->initialize && !is_null($this->initializeWith) && $this->initializeWith !== false;
        if ($useInitials && isset($nameItem->given)) {
            $nameObj->given = StringHelper::initializeBySpaceOrHyphen($nameItem->given, $this->initializeWith);
        }

        $renderedResult = $this->getNamesString($nameObj, $rank);
        CiteProcHelper::applyAdditionMarkupFunction($nameItem, $this->parent->getVariables()[0], $renderedResult);
        return trim($renderedResult);
    }

    /**

Missing short description in doc comment

     * @param \stdClass $name

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param int $rank

Missing parameter comment

Expected 7 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag cannot be grouped with parameter tags in a doc comment

     */
    private function getNamesString($name, $rank)

Private method name "Name::getNamesString" must be prefixed with an underscore

    {
        $text = "";

        if (!isset($name->family)) {
            return $text;
        }

        $text = $this->nameOrder($name, $rank);

        //contains nbsp prefixed by normal space or followed by normal space?
        $text = htmlentities($text);
        if (strpos($text, "  ") !== false || strpos($text, "  ") !== false) {

            $text = preg_replace("/[\s]+/", "", $text); //remove normal spaces
            return preg_replace("/ +/", " ", $text);
        }
        $text = html_entity_decode(preg_replace("/[\s]+/", " ", $text));
        return $this->format(trim($text));
    }

    /**

Missing short description in doc comment

     * @param \stdClass $name

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return \stdClass

Tag cannot be grouped with parameter tags in a doc comment

     */
    private function cloneNamePOSC($name)

Private method name "Name::cloneNamePOSC" must be prefixed with an underscore

    {
        $nameObj = new \stdClass();
        if (isset($name->family)) {
            $nameObj->family = $name->family;
        }
        if (isset($name->given)) {
            $nameObj->given = $name->given;
        }
        if (isset($name->{'non-dropping-particle'})) {
            $nameObj->{'non-dropping-particle'} = $name->{'non-dropping-particle'};
        }
        if (isset($name->{'dropping-particle'})) {
            $nameObj->{'dropping-particle'} = $name->{'dropping-particle'};
        }
        if (isset($name->{'suffix'})) {
            $nameObj->{'suffix'} = $name->{'suffix'};
        }
        return $nameObj;
    }

    /**

Missing short description in doc comment

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

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

Parameter $resultNames 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 $text

Missing parameter name

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param $resultNames

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 appendEtAl($data, $text, $resultNames)
    {
        //append et al abbreviation
        if (count($data) > 1 &&
            !empty($resultNames) &&

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

            !empty($this->etAl) &&

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

            !empty($this->etAlMin) &&

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

            !empty($this->etAlUseFirst) &&

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

            count($data) != count($resultNames)

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

        ) {


            /* By default, when a name list is truncated to a single name, the name and the “et-al” (or “and others”)
            term are separated by a space (e.g. “Doe et al.”). When a name list is truncated to two or more names, the
            name delimiter is used (e.g. “Doe, Smith, et al.”). This behavior can be changed with the
            delimiter-precedes-et-al attribute. */

            switch ($this->delimiterPrecedesEtAl) {
                case 'never':

Line indented incorrectly; expected 12 spaces, found 16

                    $text = $text . " " . $this->etAl;
                    break;
                case 'always':

Line indented incorrectly; expected 12 spaces, found 16

                    $text = $text . $this->delimiter . $this->etAl;
                    break;
                case 'contextual':

Line indented incorrectly; expected 12 spaces, found 16

                default:

Line indented incorrectly; expected 12 spaces, found 16

                    if (count($resultNames) === 1) {

Line indented incorrectly; expected 16 spaces, found 20

                        $text .= " " . $this->etAl;
                    } else {

Line indented incorrectly; expected 16 spaces, found 20

                        $text .= $this->delimiter . $this->etAl;
                    }

Line indented incorrectly; expected 16 spaces, found 20

            }
        }
        return $text;
    }

    /**

Missing short description in doc comment

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

     * @param $resultNames

Missing parameter name

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return array

Tag cannot be grouped with parameter tags in a doc comment

     */
    protected function prepareAbbreviation($resultNames)
    {
        $cnt = count($resultNames);
        /* Use of et-al-min and et-al-user-first enables et-al abbreviation. If the number of names in a name variable
        matches or exceeds the number set on et-al-min, the rendered name list is truncated after reaching the number of
        names set on et-al-use-first.  */

        if (isset($this->etAlMin) && isset($this->etAlUseFirst)) {

            if ($this->etAlMin <= $cnt) {
                if ($this->etAlUseLast && $this->etAlMin - $this->etAlUseFirst >= 2) {
                    /* et-al-use-last: When set to “true” (the default is “false”), name lists truncated by et-al
                    abbreviation are followed by the name delimiter, the ellipsis character, and the last name of the
                    original name list. This is only possible when the original name list has at least two more names
                    than the truncated name list (for this the value of et-al-use-first/et-al-subsequent-min must be at
                    least 2 less than the value of et-al-min/et-al-subsequent-use-first).*/

                    $lastName = array_pop($resultNames); //remove last Element and remember in $lastName

                }
                for ($i = $this->etAlUseFirst; $i < $cnt; ++$i) {
                    unset($resultNames[$i]);
                }

                $resultNames = array_values($resultNames);

                if (!empty($lastName)) { // append $lastName if exist
                    $resultNames[] = $lastName;
                }

                if ($this->parent->hasEtAl()) {
                    $this->etAl = $this->parent->getEtAl()->render(null);
                    return $resultNames;
                } else {
                    $this->etAl = CiteProc::getContext()->getLocale()->filter('terms', 'et-al')->single;
                    return $resultNames;
                }
            }
            return $resultNames;
        }
        return $resultNames;
    }

    /**

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 \stdClass $preceding

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return array

Tag cannot be grouped with parameter tags in a doc comment

     */
    protected function renderSubsequentSubstitution($data, $preceding)
    {
        $resultNames = [];
        $subsequentSubstitution = CiteProc::getContext()->getCitationItems()->getSubsequentAuthorSubstitute();
        $subsequentSubstitutionRule = CiteProc::getContext()->getCitationItems()->getSubsequentAuthorSubstituteRule();

        /**

Missing short description in doc comment

         * @var string $type
         * @var \stdClass $name
         */
        foreach ($data as $rank => $name) {

            switch ($subsequentSubstitutionRule) {

                /* “partial-each” - when one or more rendered names in the name variable match those in the preceding
                bibliographic entry, the value of subsequent-author-substitute substitutes for each matching name.
                Matching starts with the first name, and continues up to the first mismatch. */
                case SubsequentAuthorSubstituteRule::PARTIAL_EACH:

Line indented incorrectly; expected 12 spaces, found 16

                    if (NameHelper::precedingHasAuthor($preceding, $name)) {

Line indented incorrectly; expected 16 spaces, found 20

                        $resultNames[] = $subsequentSubstitution;
                    } else {

Line indented incorrectly; expected 16 spaces, found 20

                        $resultNames[] = $this->formatName($name, $rank);
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    break;


                /* “partial-first” - as “partial-each”, but substitution is limited to the first name of the name
                variable. */
                case SubsequentAuthorSubstituteRule::PARTIAL_FIRST:

Line indented incorrectly; expected 12 spaces, found 16

                    if ($rank === 0) {

Line indented incorrectly; expected 16 spaces, found 20

                        if ($preceding->author[0]->family === $name->family) {

Line indented incorrectly; expected 20 spaces, found 24

                            $resultNames[] = $subsequentSubstitution;
                        } else {

Line indented incorrectly; expected 20 spaces, found 24

                            $resultNames[] = $this->formatName($name, $rank);
                        }

Line indented incorrectly; expected 20 spaces, found 24

                    } else {

Line indented incorrectly; expected 16 spaces, found 20

                        $resultNames[] = $this->formatName($name, $rank);
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    break;

                /* “complete-each” - requires a complete match like “complete-all”, but now the value of
                subsequent-author-substitute substitutes for each rendered name. */
                case SubsequentAuthorSubstituteRule::COMPLETE_EACH:

Line indented incorrectly; expected 12 spaces, found 16

                    try {

Line indented incorrectly; expected 16 spaces, found 20

                        if (NameHelper::identicalAuthors($preceding, $data)) {

Line indented incorrectly; expected 20 spaces, found 24

                            $resultNames[] = $subsequentSubstitution;
                        } else {

Line indented incorrectly; expected 20 spaces, found 24

                            $resultNames[] = $this->formatName($name, $rank);
                        }

Line indented incorrectly; expected 20 spaces, found 24

                    } catch (CiteProcException $e) {

Line indented incorrectly; expected 16 spaces, found 20

                        $resultNames[] = $this->formatName($name, $rank);
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    break;
            }
        }
        return $resultNames;
    }

    /**

Missing short description in doc comment

     * @param array $data

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param int $citationNumber

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return array

Tag cannot be grouped with parameter tags in a doc comment

     */
    private function handleSubsequentAuthorSubstitution($data, $citationNumber)

Private method name "Name::handleSubsequentAuthorSubstitution" must be prefixed with an underscore

    {
        $hasPreceding = CiteProc::getContext()->getCitationItems()->hasKey($citationNumber - 1);
        $subsequentSubstitution = CiteProc::getContext()->getCitationItems()->getSubsequentAuthorSubstitute();
        $subsequentSubstitutionRule = CiteProc::getContext()->getCitationItems()->getSubsequentAuthorSubstituteRule();
        $preceding = CiteProc::getContext()->getCitationItems()->get($citationNumber - 1);


        if ($hasPreceding && !is_null($subsequentSubstitution) && !empty($subsequentSubstitutionRule)) {
            /** @var \stdClass $preceding */

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 ($subsequentSubstitutionRule == SubsequentAuthorSubstituteRule::COMPLETE_ALL) {

The condition $subsequentSubstitutionRule == Seboettg\CiteProc\Style\Options\SubsequentAuthorSubstituteRule::COMPLETE_ALL is always false.

                try {
                    if (NameHelper::identicalAuthors($preceding, $data)) {
                        return [];
                    } else {
                        $resultNames = $this->getFormattedNames($data);
                    }
                } catch (CiteProcException $e) {
                    $resultNames = $this->getFormattedNames($data);
                }
            } else {
                $resultNames = $this->renderSubsequentSubstitution($data, $preceding);
            }
        } else {
            $resultNames = $this->getFormattedNames($data);
        }
        return $resultNames;
    }


    /**

Missing short description in doc comment

     * @param array $data

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return array

Tag cannot be grouped with parameter tags in a doc comment

     */
    protected function getFormattedNames($data)
    {
        $resultNames = [];
        foreach ($data as $rank => $name) {
            $formatted = $this->formatName($name, $rank);
            $resultNames[] = NameHelper::addExtendedMarkup($this->variable, $name, $formatted);
        }
        return $resultNames;
    }

    /**

Missing short description in doc comment

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

     * @param $resultNames

Missing parameter name

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return array

Tag cannot be grouped with parameter tags in a doc comment

     */
    protected function renderDelimiterPrecedesLastNever($resultNames)
    {
        $text = "";
        if (!$this->etAlUseLast) {
            if (count($resultNames) === 1) {
                $text = $resultNames[0];
            } else if (count($resultNames) === 2) {
                $text = implode(" ", $resultNames);
            } else { // >2
                $lastName = array_pop($resultNames);
                $text = implode($this->delimiter, $resultNames) . " " . $lastName;
            }
        }
        return $text;
    }

    /**

Missing short description in doc comment

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

     * @param $resultNames

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 renderDelimiterPrecedesLastContextual($resultNames)
    {
        if (count($resultNames) === 1) {
            $text = $resultNames[0];
        } else if (count($resultNames) === 2) {
            $text = implode(" ", $resultNames);
        } else {
            $text = implode($this->delimiter, $resultNames);
        }
        return $text;
    }

    /**

Missing short description in doc comment

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

     * @param $resultNames

Missing parameter name

     */

Missing @return tag in function comment

    protected function addAnd(&$resultNames)
    {
        $count = count($resultNames);
        if (!empty($this->and) && $count > 1 && empty($this->etAl)) {
            $new = $this->and . ' ' . end($resultNames); // add and-prefix of the last name if "and" is defined
            $resultNames[count($resultNames) - 1] = $new; //set prefixed last name at the last position of $resultNames array
        }
    }

    /**

Missing short description in doc comment

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

     * @param $resultNames

Missing parameter name

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return array|string

Tag cannot be grouped with parameter tags in a doc comment

     */
    protected function renderDelimiterPrecedesLast($resultNames)
    {
        $text = "";
        if (!empty($this->and) && empty($this->etAl)) {
            switch ($this->delimiterPrecedesLast) {
                case 'after-inverted-name':

Line indented incorrectly; expected 12 spaces, found 16

                    //TODO: implement
                    break;
                case 'always':

Line indented incorrectly; expected 12 spaces, found 16

                    $text = implode($this->delimiter, $resultNames);
                    break;
                case 'never':

Line indented incorrectly; expected 12 spaces, found 16

                    $text = $this->renderDelimiterPrecedesLastNever($resultNames);
                    break;
                case 'contextual':

Line indented incorrectly; expected 12 spaces, found 16

                default:

Line indented incorrectly; expected 12 spaces, found 16

                    $text = $this->renderDelimiterPrecedesLastContextual($resultNames);
            }
        }
        return $text;
    }


    /**

Missing short description in doc comment

     * @param \stdClass $data

Missing parameter comment

     * @param integer $rank

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     *
     * @return string
     */
    private function nameOrder($data, $rank)

Private method name "Name::nameOrder" must be prefixed with an underscore

    {
        $nameAsSortOrder = (($this->nameAsSortOrder === "first" && $rank === 0) || $this->nameAsSortOrder === "all");
        $demoteNonDroppingParticle = CiteProc::getContext()->getGlobalOptions()->getDemoteNonDroppingParticles();

        if (StringHelper::isLatinString(NameHelper::normalizeName($data)) || StringHelper::isCyrillicString(NameHelper::normalizeName($data))) {
            if ($this->form === "long" && $nameAsSortOrder &&
                ((string)$demoteNonDroppingParticle === DemoteNonDroppingParticle::NEVER ||

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

                    (string)$demoteNonDroppingParticle === DemoteNonDroppingParticle::SORT_ONLY)

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

            ) {

                // [La] [Fontaine], [Jean] [de], [III]
                NameHelper::prependParticleTo($data, "family", "non-dropping-particle");
                NameHelper::appendParticleTo($data, "given", "dropping-particle");

                list($family, $given) = $this->renderNameParts($data);

                $text = $family . (!empty($given) ? $this->sortSeparator . $given : "");
                $text .= !empty($data->suffix) ? $this->sortSeparator . $data->suffix : "";
            } else if ($this->form === "long" && $nameAsSortOrder &&
                (is_null($demoteNonDroppingParticle) ||

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

                    (string)$demoteNonDroppingParticle === DemoteNonDroppingParticle::DISPLAY_AND_SORT)

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

            ) {
                // [Fontaine], [Jean] [de] [La], [III]

                NameHelper::appendParticleTo($data, "given", "dropping-particle");
                NameHelper::appendParticleTo($data, "given", "non-dropping-particle");
                list($family, $given) = $this->renderNameParts($data);
                $text = $family;
                $text .= !empty($given) ? $this->sortSeparator . $given : "";
                $text .= !empty($data->suffix) ? $this->sortSeparator . $data->suffix : "";

            } else if ($this->form === "long" && $nameAsSortOrder && empty($demoteNonDroppingParticle)) {
                list($family, $given) = $this->renderNameParts($data);
                $text = $family;
                $text .= !empty($given) ? $this->delimiter . $given : "";
                $text .= !empty($data->suffix) ? $this->sortSeparator . $data->suffix : "";
            } else if ($this->form === "short") {
                // [La] [Fontaine]
                NameHelper::prependParticleTo($data, "family", "non-dropping-particle");
                $text = $data->family;
            } else { //form "long" (default)

                // [Jean] [de] [La] [Fontaine] [III]
                NameHelper::prependParticleTo($data, "family", "non-dropping-particle");
                NameHelper::prependParticleTo($data, "family", "dropping-particle");
                NameHelper::appendParticleTo($data, "family", "suffix");
                list($family, $given) = $this->renderNameParts($data);
                $text = !empty($given) ? $given . " " . $family : $family;
            }
        } else {
            $text = $this->form === "long" ? $data->family.$data->given : $data->family;
        }

        return $text;
    }

    /**

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

     * @return array

Tag cannot be grouped with parameter tags in a doc comment

     */
    private function renderNameParts($data)

Private method name "Name::renderNameParts" must be prefixed with an underscore

    {
        $given = "";
        $family = array_key_exists("family", $this->nameParts) ? $this->nameParts["family"]->render($data) : $data->family;
        if (isset($data->given)) {
            $given = array_key_exists("given", $this->nameParts) ? $this->nameParts["given"]->render($data) : $data->given;
        }
        return [$family, $given];
    }


    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @param mixed $delimiter

Missing parameter comment

     */

Missing @return tag in function comment

    public function setDelimiter($delimiter)
    {
        $this->delimiter = $delimiter;
    }

    /**

Missing short description in doc comment

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

}