Seboettg\CiteProc\Style\Options\GlobalOptions

Complexity

Total Complexity

9

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getDemoteNonDroppingParticles()	0	3	1
A	__construct()	0	13	6
A	isInitializeWithHyphen()	0	3	1
A	getPageRangeFormat()	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 GlobalOptions
{

    /**

Missing short description in doc comment

     * @var bool
     */
    private $initializeWithHyphen = true;

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

    /**

Missing short description in doc comment

     * @var PageRangeFormats
     */
    private $pageRangeFormat;

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

    /**

Missing short description in doc comment

     * @var DemoteNonDroppingParticle
     */
    private $demoteNonDroppingParticles;

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

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

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

Missing parameter comment

     */
    public function __construct(SimpleXMLElement $node)
    {
        /** @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 'initialize-with-hyphen':

Line indented incorrectly; expected 12 spaces, found 16

                    $this->initializeWithHyphen = "false" === (string) $attribute ? false : true;
                    break;
                case 'page-range-format':

Line indented incorrectly; expected 12 spaces, found 16

                    $this->pageRangeFormat = new PageRangeFormats((string) $attribute);
                    break;
                case 'demote-non-dropping-particle':

Line indented incorrectly; expected 12 spaces, found 16

                    $this->demoteNonDroppingParticles = new DemoteNonDroppingParticle((string) $attribute);
            }
        }
    }

    /**
     * Specifies whether compound given names (e.g. “Jean-Luc”) should be initialized with a hyphen (“J.-L.”, value
     * “true”, default) or without (“J.L.”, value “false”).
     * @return bool

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

     */
    public function isInitializeWithHyphen()
    {
        return $this->initializeWithHyphen;
    }

    /**
     * Activates expansion or collapsing of page ranges: “chicago” (“321–28”), “expanded” (e.g. “321–328”),
     * “minimal” (“321–8”), or “minimal-two” (“321–28”). Delimits page ranges
     * with the “page-range-delimiter” term (introduced with CSL 1.0.1, and defaults to an en-dash). If the attribute is
     * not set, page ranges are rendered without reformatting.
     * @return PageRangeFormats

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

     */
    public function getPageRangeFormat()
    {
        return $this->pageRangeFormat;
    }

    /**
     * Sets the display and sorting behavior of the non-dropping-particle in inverted names (e.g. “Koning, W. de”).
     * @return DemoteNonDroppingParticle

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

     */
    public function getDemoteNonDroppingParticles()
    {
        return $this->demoteNonDroppingParticles;
    }

}