Seboettg\CiteProc\Context

Complexity

Total Complexity

39

Size/Duplication

Total Lines	376
Duplicated Lines	0 %

Test Coverage

Coverage

93.81%

Importance

Changes

0

38 Methods

Rating	Name	Duplication	Size	Complexity
A	setRoot()	0	3	1
A	setGlobalOptions()	0	3	1
A	getMacros()	0	3	1
A	setMode()	0	3	1
A	setMarkupExtension()	0	3	1
A	setLocale()	0	3	1
A	getCitation()	0	3	1
A	getMode()	0	3	1
A	setInfo()	0	3	1
A	hasCitationItems()	0	3	1
A	getCssStyle()	0	3	1
A	getBibliography()	0	3	1
A	getGlobalOptions()	0	3	1
A	setSorting()	0	3	1
A	setCitation()	0	3	1
A	getSorting()	0	3	1
A	getRenderingState()	0	3	1
A	isModeCitation()	0	3	1
A	isModeBibliography()	0	3	1
A	addMacro()	0	3	1
A	getMarkupExtension()	0	3	1
A	getRoot()	0	3	1
A	getMacro()	0	3	1
A	setBibliography()	0	3	1
A	setCssStyle()	0	3	1
A	setCitationSpecificOptions()	0	3	1
A	getCitationItems()	0	3	1
A	setCitationsAsArray()	0	3	1
A	setBibliographySpecificOptions()	0	3	1
A	__construct()	0	10	2
A	getResults()	0	3	1
A	getInfo()	0	3	1
A	getCitationSpecificOptions()	0	3	1
A	getLocale()	0	3	1
A	getBibliographySpecificOptions()	0	3	1
A	isCitationsAsArray()	0	3	1
A	setRenderingState()	0	3	1
A	setCitationItems()	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;
use Seboettg\CiteProc\Data\DataList;
use Seboettg\CiteProc\Locale\Locale;
use Seboettg\CiteProc\Root\Info;
use Seboettg\CiteProc\Style\Bibliography;
use Seboettg\CiteProc\Style\Citation;
use Seboettg\CiteProc\Style\Macro;
use Seboettg\CiteProc\Style\Options\BibliographyOptions;
use Seboettg\CiteProc\Style\Options\CitationOptions;
use Seboettg\CiteProc\Style\Options\GlobalOptions;
use Seboettg\CiteProc\Style\Sort\Sort;
use Seboettg\CiteProc\Root\Root;
use Seboettg\CiteProc\Styles\Css\CssStyle;
use Seboettg\Collection\ArrayList;


/**
 * Class Context
 * @package Seboettg\CiteProc

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 Context
{
    /**

Missing short description in doc comment

     * @var ArrayList
     */
    private $macros;

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

    /**

Missing short description in doc comment

     * @var Locale
     */
    private $locale;

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

    /**

Missing short description in doc comment

     * @var Bibliography
     */
    private $bibliography;

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

    /**

Missing short description in doc comment

     * @var Citation
     */
    private $citation;

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

    /**

Missing short description in doc comment

     * @var Sort
     */
    private $sorting;

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

    /**

Missing short description in doc comment

     * @var string
     */
    private $mode;

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

    /**

Missing short description in doc comment

     * @var DataList
     */
    private $citationItems;

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

    /**

Missing short description in doc comment

     * @var ArrayList
     */
    private $results;

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

    /**

Missing short description in doc comment

     * @var Root
     */
    private $root;

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

    /**

Missing short description in doc comment

     * @var GlobalOptions
     */
    private $globalOptions;

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

    /**

Missing short description in doc comment

     * @var BibliographyOptions
     */
    private $bibliographySpecificOptions;

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

    /**

Missing short description in doc comment

     * @var CitationOptions
     */
    private $citationSpecificOptions;

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

    /**

Missing short description in doc comment

     * @var RenderingState
     */
    private $renderingState;

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

    /**

Missing short description in doc comment

     * @var CssStyle
     */
    private $cssStyle;

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

    /**

Missing short description in doc comment

     * @var Info
     */
    private $info;

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

    /**

Missing short description in doc comment

     * @var array
     */
    protected $markupExtension = [];

    /**

Missing short description in doc comment

     * @var bool
     */
    private $citationsAsArray = false;

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

    public function __construct($locale = null)

Missing doc comment for function __construct()

    {
        if (!empty($locale)) {
            $this->locale = $locale;
        }

        $this->macros = new ArrayList();
        $this->citationItems = new DataList();
        $this->results = new ArrayList();
        $this->renderingState = new RenderingState(RenderingState::__default);
    }

    public function addMacro($key, $macro)

Missing doc comment for function addMacro()

    {
        $this->macros->add($key, $macro);
    }

    /**

Missing short description in doc comment

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

     * @param $key

Missing parameter name

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return Macro

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function getMacro($key)
    {
        return $this->macros->get($key);
    }

    /**

Missing short description in doc comment

     * @param Locale $locale

Missing parameter comment

     */

Missing @return tag in function comment

    public function setLocale(Locale $locale)
    {
        $this->locale = $locale;
    }

    /**

Missing short description in doc comment

     * @return Locale
     */
    public function getLocale()
    {
        return $this->locale;
    }

    /**

Missing short description in doc comment

     * @return Bibliography
     */
    public function getBibliography()
    {
        return $this->bibliography;
    }

    /**

Missing short description in doc comment

     * @param Bibliography $bibliography

Missing parameter comment

     */

Missing @return tag in function comment

    public function setBibliography(Bibliography $bibliography)
    {
        $this->bibliography = $bibliography;
    }

    /**

Missing short description in doc comment

     * @return Citation
     */
    public function getCitation()
    {
        return $this->citation;
    }

    /**

Missing short description in doc comment

     * @param Citation $citation

Missing parameter comment

     */

Missing @return tag in function comment

    public function setCitation($citation)
    {
        $this->citation = $citation;
    }

    /**

Missing short description in doc comment

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

     * @param $citationsAsArray

Missing parameter name

     */

Missing @return tag in function comment

    public function setCitationsAsArray($citationsAsArray = true)
    {
        $this->citationsAsArray = $citationsAsArray;
    }

    public function isCitationsAsArray()

Missing doc comment for function isCitationsAsArray()

    {
        return $this->citationsAsArray;
    }

    public function setSorting($sorting)

Missing doc comment for function setSorting()

    {
        $this->sorting = $sorting;
    }

    public function getSorting()

Missing doc comment for function getSorting()

    {
        return $this->sorting;
    }

    /**
     * return the render mode (citation|bibliography)

Doc comment short description must start with a capital letter

     * @return string

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

     */
    public function getMode()
    {
        return $this->mode;
    }

    /**

Missing short description in doc comment

     * @param string $mode

Missing parameter comment

     */

Missing @return tag in function comment

    public function setMode($mode)
    {
        $this->mode = $mode;
    }

    /**
     * returns true if the render mode is set to citation

Doc comment short description must start with a capital letter

     * @return bool

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

     */
    public function isModeCitation()
    {
        return $this->mode === "citation";
    }

    /**
     * returns true if the render mode is set to bibliography

Doc comment short description must start with a capital letter

     * @return bool

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

     */
    public function isModeBibliography()
    {
        return $this->mode === "bibliography";
    }

    /**

Missing short description in doc comment

     * @return DataList
     */
    public function getCitationItems()
    {
        return $this->citationItems;
    }

    /**

Missing short description in doc comment

     * @param DataList $citationItems

Missing parameter comment

     */

Missing @return tag in function comment

    public function setCitationItems(&$citationItems)
    {
        $this->citationItems = $citationItems;
    }

    public function hasCitationItems()

Missing doc comment for function hasCitationItems()

    {
        return ($this->citationItems->count() > 0);
    }

    /**

Missing short description in doc comment

     * @return ArrayList
     */
    public function getMacros()
    {
        return $this->macros;
    }

    /**

Missing short description in doc comment

     * @return ArrayList
     */
    public function getResults()
    {
        return $this->results;
    }

    /**

Missing short description in doc comment

     * @return Root
     */
    public function getRoot()
    {
        return $this->root;
    }

    /**

Missing short description in doc comment

     * @param Root $root

Missing parameter comment

     */

Missing @return tag in function comment

    public function setRoot(Root $root)
    {
        $this->root = $root;
    }

    /**

Missing short description in doc comment

     * @return GlobalOptions
     */
    public function getGlobalOptions()
    {
        return $this->globalOptions;
    }

    /**

Missing short description in doc comment

     * @param GlobalOptions $globalOptions

Missing parameter comment

     */

Missing @return tag in function comment

    public function setGlobalOptions(GlobalOptions $globalOptions)
    {
        $this->globalOptions = $globalOptions;
    }

    /**

Missing short description in doc comment

     * @return RenderingState
     */
    public function getRenderingState()
    {
        return $this->renderingState;
    }

    /**

Missing short description in doc comment

     * @param RenderingState|string $renderingState

Missing parameter comment

     */

Missing @return tag in function comment

    public function setRenderingState(RenderingState $renderingState)
    {
        $this->renderingState = $renderingState;
    }

    /**

Missing short description in doc comment

     * @return BibliographyOptions
     */
    public function getBibliographySpecificOptions()
    {
        return $this->bibliographySpecificOptions;
    }

    /**

Missing short description in doc comment

     * @param BibliographyOptions $bibliographySpecificOptions

Missing parameter comment

     */

Missing @return tag in function comment

    public function setBibliographySpecificOptions(BibliographyOptions $bibliographySpecificOptions)
    {
        $this->bibliographySpecificOptions = $bibliographySpecificOptions;
    }

    /**

Missing short description in doc comment

     * @return CitationOptions
     */
    public function getCitationSpecificOptions()
    {
        return $this->citationSpecificOptions;
    }

    /**

Missing short description in doc comment

     * @param CitationOptions $citationSpecificOptions

Missing parameter comment

     */

Missing @return tag in function comment

    public function setCitationSpecificOptions(CitationOptions $citationSpecificOptions)
    {
        $this->citationSpecificOptions = $citationSpecificOptions;
    }

    /**

Missing short description in doc comment

     * @param CssStyle $cssStyle

Missing parameter comment

     */

Missing @return tag in function comment

    public function setCssStyle(CssStyle $cssStyle)
    {
        $this->cssStyle = $cssStyle;
    }

    /**

Missing short description in doc comment

     * @return CssStyle
     */
    public function getCssStyle()
    {
        return $this->cssStyle;
    }

    public function setInfo(Info $info)

Missing doc comment for function setInfo()

    {
        $this->info = $info;
    }

    public function getInfo()

Missing doc comment for function getInfo()

    {
        return $this->info;
    }

    /**

Missing short description in doc comment

     * @return array
     */
    public function getMarkupExtension()
    {
        return $this->markupExtension;
    }

    /**

Missing short description in doc comment

     * @param array $markupExtension

Missing parameter comment

     */

Missing @return tag in function comment

    public function setMarkupExtension($markupExtension)
    {
        $this->markupExtension = $markupExtension;
    }
}