Seboettg\CiteProc\Context

Complexity

Total Complexity

50

Size/Duplication

Total Lines	432
Duplicated Lines	0 %

Test Coverage

Coverage

88.24%

Importance

Changes

0

48 Methods

Rating	Name	Duplication	Size	Complexity
A	setRoot()	0	3	1
A	setGlobalOptions()	0	3	1
A	getMacros()	0	3	1
A	setMode()	0	4	1
A	setMarkupExtension()	0	3	1
A	getNameOptions()	0	3	1
A	getCitation()	0	3	1
A	setLocale()	0	3	1
A	getMode()	0	3	1
A	setInfo()	0	3	1
A	getCitedItems()	0	3	1
A	getCssStyle()	0	3	1
A	hasCitationItems()	0	3	1
A	getBibliography()	0	3	1
A	addObserver()	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	setCitedItems()	0	4	1
A	isModeCitation()	0	3	1
A	isModeBibliography()	0	3	1
A	addMacro()	0	3	1
A	setNameOptions()	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	15	2
A	getResults()	0	3	1
A	getCitationData()	0	3	1
A	getInfo()	0	3	1
A	getCitationSpecificOptions()	0	3	1
A	setCitationData()	0	4	1
A	getLocale()	0	3	1
A	getBibliographySpecificOptions()	0	3	1
A	getCitationItemById()	0	5	1
A	appendCitedItem()	0	4	1
A	isCitationsAsArray()	0	3	1
A	notifyObservers()	0	5	2
A	setRenderingState()	0	4	1
A	setCitationItems()	0	4	1

<?php
/*
 * 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\Config\RenderingMode;
use Seboettg\CiteProc\Config\RenderingState;
use Seboettg\CiteProc\Data\DataList;
use Seboettg\CiteProc\Locale\Locale;
use Seboettg\CiteProc\Rendering\Observer\CitationDataChangedEvent;
use Seboettg\CiteProc\Rendering\Observer\CitationItemsChangedEvent;
use Seboettg\CiteProc\Rendering\Observer\CitedItemsChanged;
use Seboettg\CiteProc\Rendering\Observer\ModeChangedEvent;
use Seboettg\CiteProc\Rendering\Observer\RenderingEvent;
use Seboettg\CiteProc\Rendering\Observer\RenderingObservable;
use Seboettg\CiteProc\Rendering\Observer\RenderingObserver;
use Seboettg\CiteProc\Rendering\Observer\StateChangedEvent;
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\Options\NameOptions;
use Seboettg\CiteProc\Style\Sort\Sort;
use Seboettg\CiteProc\Root\Root;
use Seboettg\CiteProc\Styles\Css\CssStyle;
use Seboettg\Collection\ArrayList;
use Seboettg\Collection\ArrayList\ArrayListInterface;

/**
 * Class Context
 * @package Seboettg\CiteProc
 *
 * @author Sebastian Böttger <seboettg@gmail.com>
 */
class Context implements RenderingObservable
{
    /** @var ArrayListInterface */
    private $macros;

    /** @var Locale */
    private $locale;

    /** @var Bibliography */
    private $bibliography;

    /** @var Citation */
    private $citation;

    /** @var Sort */
    private $sorting;

    /** @var RenderingMode */
    private $mode;

    /** @var DataList */
    private $citationData;

    /** @var ArrayListInterface */
    private $citationItems;

    /** @var ArrayListInterface */
    private $results;

    /** @var Root */
    private $root;

    /** @var GlobalOptions */
    private $globalOptions;

    /** @var BibliographyOptions */
    private $bibliographySpecificOptions;

    /** @var CitationOptions */
    private $citationSpecificOptions;

    /** @var RenderingState */
    private $renderingState;

    /** @var CssStyle */
    private $cssStyle;

    /** @var Info */
    private $info;

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

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

    /** @var ArrayListInterface */
    private $citedItems;

    /** @var ArrayListInterface */
    private $observers;

    /** @var NameOptions */
    private $nameOptions;

    public function __construct($locale = null)

Incorrect spacing between argument "$locale" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$locale"; expected 0 but found 1

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

        $this->macros = new ArrayList();
        $this->citationData = new DataList();
        $this->results = new ArrayList();
        $this->renderingState = RenderingState::RENDERING();
        $this->mode = RenderingMode::BIBLIOGRAPHY();
        $this->citedItems = new ArrayList();
        $this->citationItems = new ArrayList();
        $this->observers = new ArrayList();
        $this->nameOptions = new NameOptions();
    }

    public function addObserver(RenderingObserver $observer): void
    {
        $this->observers->append($observer);
    }

    private function notifyObservers(RenderingEvent $event)
    {
        /** @var RenderingObserver $observer */
        foreach ($this->observers as $observer) {
            $observer->notify($event);
        }
    }

    public function getNameOptions(): NameOptions
    {
        return $this->nameOptions;
    }

    public function setNameOptions(NameOptions $nameOptions): void
    {
        $this->nameOptions = $nameOptions;
    }

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

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

    /**
     * @param Locale $locale
     */
    public function setLocale(Locale $locale)
    {
        $this->locale = $locale;
    }

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

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

    /**
     * @param Bibliography $bibliography
     */
    public function setBibliography(Bibliography $bibliography)
    {
        $this->bibliography = $bibliography;
    }

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

    /**
     * @param Citation $citation
     */
    public function setCitation(Citation $citation)
    {
        $this->citation = $citation;
    }

    /**
     * @param $citationsAsArray
     */
    public function setCitationsAsArray($citationsAsArray = true)

Incorrect spacing between argument "$citationsAsArray" and equals sign; expected 0 but found 1

Incorrect spacing between default value and equals sign for argument "$citationsAsArray"; expected 0 but found 1

    {
        $this->citationsAsArray = $citationsAsArray;
    }

    public function isCitationsAsArray()
    {
        return $this->citationsAsArray;
    }

    public function setSorting($sorting)
    {
        $this->sorting = $sorting;
    }

    public function getSorting()
    {
        return $this->sorting;
    }

    /**
     * return the render mode (citation|bibliography)
     * @return string
     */
    public function getMode()
    {
        return $this->mode;
    }

    /**
     * @param RenderingMode $mode
     */
    public function setMode(RenderingMode $mode)
    {
        $this->mode = $mode;
        $this->notifyObservers(new ModeChangedEvent($mode));
    }

    /**
     * returns true if the render mode is set to citation
     * @return bool
     */
    public function isModeCitation(): bool
    {
        return $this->mode->equals(RenderingMode::CITATION());
    }

    /**
     * returns true if the render mode is set to bibliography
     * @return bool
     */
    public function isModeBibliography(): bool
    {
        return $this->mode->equals(RenderingMode::BIBLIOGRAPHY());
    }

    /**
     * @return DataList
     */
    public function getCitationData(): DataList
    {
        return $this->citationData;
    }

    /**
     * @param ArrayListInterface|DataList $citationData
     */
    public function setCitationData($citationData)
    {
        $this->citationData = $citationData;
        $this->notifyObservers(new CitationDataChangedEvent($citationData));
    }

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

    /**
     * @param ArrayListInterface $citationItems
     */
    public function setCitationItems(ArrayListInterface $citationItems): void
    {
        $this->citationItems = $citationItems;
        $this->notifyObservers(new CitationItemsChangedEvent($citationItems));
    }

    public function hasCitationItems()
    {
        return ($this->citationData->count() > 0);
    }

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

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

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

    /**
     * @param Root $root
     */
    public function setRoot(Root $root)
    {
        $this->root = $root;
    }

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

    /**
     * @param GlobalOptions $globalOptions
     */
    public function setGlobalOptions(GlobalOptions $globalOptions): void
    {
        $this->globalOptions = $globalOptions;
    }

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

    /**
     * @param RenderingState|string $renderingState
     */
    public function setRenderingState(RenderingState $renderingState)
    {
        $this->renderingState = $renderingState;
        $this->notifyObservers(new StateChangedEvent($renderingState));
    }

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

    /**
     * @param BibliographyOptions $bibliographySpecificOptions
     */
    public function setBibliographySpecificOptions(BibliographyOptions $bibliographySpecificOptions)
    {
        $this->bibliographySpecificOptions = $bibliographySpecificOptions;
    }

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

    /**
     * @param CitationOptions $citationSpecificOptions
     */
    public function setCitationSpecificOptions(CitationOptions $citationSpecificOptions)
    {
        $this->citationSpecificOptions = $citationSpecificOptions;
    }

    /**
     * @param CssStyle $cssStyle
     */
    public function setCssStyle(CssStyle $cssStyle)
    {
        $this->cssStyle = $cssStyle;
    }

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

    public function setInfo(Info $info)
    {
        $this->info = $info;
    }

    public function getInfo()
    {
        return $this->info;
    }

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

    /**
     * @param callable[] $markupExtension
     */
    public function setMarkupExtension(array $markupExtension)
    {
        $this->markupExtension = $markupExtension;
    }

    public function getCitationItemById($id)
    {
        return $this->citationItems->filter(function ($item) use ($id) {
            return $item->id === $id;
        })->current();
    }

    /**
     * @return ArrayListInterface
     */
    public function getCitedItems(): ArrayListInterface
    {
        return $this->citedItems;
    }

    /**
     * @param ArrayListInterface $citedItems
     */
    public function setCitedItems(ArrayListInterface $citedItems): void
    {
        $this->citedItems = $citedItems;
        $this->notifyObservers(new CitedItemsChanged($citedItems));
    }

    public function appendCitedItem($citedItem)
    {
        $this->citedItems->append($citedItem);
        $this->notifyObservers(new CitedItemsChanged($this->citedItems));
    }
}