Seboettg\CiteProc\Style\Options\BibliographyOptions

Complexity

Total Complexity

22

Size/Duplication

Total Lines	173
Duplicated Lines	0 %

Test Coverage

Coverage

67.31%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	getSubsequentAuthorSubstituteRule()	0	3	1
A	setHangingIndent()	0	3	1
A	getSubsequentAuthorSubstitute()	0	3	1
A	getHangingIndent()	0	3	1
A	getSecondFieldAlign()	0	3	1
A	getLineSpacing()	0	3	1
A	setLineSpacing()	0	3	1
A	getEntrySpacing()	0	3	1
A	setSubsequentAuthorSubstitute()	0	3	1
A	setSubsequentAuthorSubstituteRule()	0	3	1
B	__construct()	0	27	10
A	setEntrySpacing()	0	3	1
A	setSecondFieldAlign()	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) 2017 Sebastian Böttger.
 * @license     https://opensource.org/licenses/MIT
 */

namespace Seboettg\CiteProc\Style\Options;

use SimpleXMLElement;

/**
 * Class GlobalOptionsTrait
 * @package Seboettg\CiteProc\Style

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

 * @author Sebastian Böttger <seboettg@gmail.com>

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

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class BibliographyOptions
{

    /**
     * If set, the value of this attribute replaces names in a bibliographic entry that also occur in the preceding
     * entry. The exact method of substitution depends on the value of the subsequent-author-substitute-rule attribute.
     * Substitution is limited to the names of the first cs:names element rendered. (Bibliography-specific option)
     *
     * @var string
     */
    private $subsequentAuthorSubstitute;

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

    /**
     * Specifies when and how names are substituted as a result of subsequent-author-substitute.
     * (Bibliography-specific option)
     *
     * @var SubsequentAuthorSubstituteRule
     */
    private $subsequentAuthorSubstituteRule;

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

    /**
     * If set to “true” (“false” is the default), bibliographic entries are rendered with hanging-indents.
     * @var string

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

     */
    private $hangingIndent = false;

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

    /**
     * If set, subsequent lines of bibliographic entries are aligned along the second field. With “flush”, the first
     * field is flush with the margin. With “margin”, the first field is put in the margin, and subsequent lines are
     * aligned with the margin.
     * @var string

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

     */
    private $secondFieldAlign;

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

    /**
     * Specifies vertical line distance. Defaults to “1” (single-spacing), and can be set to any positive integer to
     * specify a multiple of the standard unit of line height (e.g. “2” for double-spacing).
     * @var string

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

     */
    private $lineSpacing;

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

    /**
     * Specifies vertical distance between bibliographic entries. By default (with a value of “1”), entries are
     * separated by a single additional line-height (as set by the line-spacing attribute). Can be set to any
     * non-negative integer to specify a multiple of this amount.
     * @var string

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

     */
    private $entrySpacing;

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

    public function __construct(SimpleXMLElement $node)

Missing doc comment for function __construct()

    {

        /** @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) {
            switch ($attribute->getName()) {
                case 'subsequent-author-substitute':

Line indented incorrectly; expected 12 spaces, found 16

                    $this->subsequentAuthorSubstitute = (string) $attribute;
                    break;
                case 'subsequent-author-substitute-rule':

Line indented incorrectly; expected 12 spaces, found 16

                    $this->subsequentAuthorSubstituteRule = new SubsequentAuthorSubstituteRule((string) $attribute);
                    break;
                case 'hanging-indent':

Line indented incorrectly; expected 12 spaces, found 16

                    $this->hangingIndent = "true" === (string) $attribute ? true : false;

The property $hangingIndent was declared of type string, but 'true' === (string)$attribute ? true : false is of type boolean. Maybe add a type cast?

                    break;
                case 'second-field-align':

Line indented incorrectly; expected 12 spaces, found 16

                    $this->secondFieldAlign = (string) $attribute;
                    break;
                case 'line-spacing':

Line indented incorrectly; expected 12 spaces, found 16

                    $this->lineSpacing = (string) $attribute;
                    break;
                case 'entry-spacing':

Line indented incorrectly; expected 12 spaces, found 16

                    $this->entrySpacing = (string) $attribute;
            }
        }
        if (empty($this->subsequentAuthorSubstituteRule)) {
            $this->subsequentAuthorSubstituteRule = new SubsequentAuthorSubstituteRule("complete-all");
        }
    }

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @param string $subsequentAuthorSubstitute

Missing parameter comment

     */

Missing @return tag in function comment

    public function setSubsequentAuthorSubstitute($subsequentAuthorSubstitute)
    {
        $this->subsequentAuthorSubstitute = $subsequentAuthorSubstitute;
    }

    /**

Missing short description in doc comment

     * @return SubsequentAuthorSubstituteRule
     */
    public function getSubsequentAuthorSubstituteRule()
    {
        return $this->subsequentAuthorSubstituteRule;
    }

    /**

Missing short description in doc comment

     * @param SubsequentAuthorSubstituteRule $subsequentAuthorSubstituteRule

Missing parameter comment

     */

Missing @return tag in function comment

    public function setSubsequentAuthorSubstituteRule($subsequentAuthorSubstituteRule)
    {
        $this->subsequentAuthorSubstituteRule = $subsequentAuthorSubstituteRule;
    }

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @param string $hangingIndent

Missing parameter comment

     */

Missing @return tag in function comment

    public function setHangingIndent($hangingIndent)
    {
        $this->hangingIndent = $hangingIndent;
    }

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @param string $secondFieldAlign

Missing parameter comment

     */

Missing @return tag in function comment

    public function setSecondFieldAlign($secondFieldAlign)
    {
        $this->secondFieldAlign = $secondFieldAlign;
    }

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @param string $lineSpacing

Missing parameter comment

     */

Missing @return tag in function comment

    public function setLineSpacing($lineSpacing)
    {
        $this->lineSpacing = $lineSpacing;
    }

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @param string $entrySpacing

Missing parameter comment

     */

Missing @return tag in function comment

    public function setEntrySpacing($entrySpacing)
    {
        $this->entrySpacing = $entrySpacing;
    }


}