Seboettg\CiteProc\CiteProc

Complexity

Total Complexity

13

Size/Duplication

Total Lines	135
Duplicated Lines	0 %

Test Coverage

Coverage

91.84%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	setStyleSheet()	0	5	1
A	__destruct()	0	3	1
A	render()	0	8	2
A	setLocale()	0	5	1
A	renderCssStyles()	0	4	1
A	getContext()	0	3	1
A	init()	0	23	4
A	__construct()	0	7	1
A	setContext()	0	3	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;
use Seboettg\CiteProc\Data\DataList;
use Seboettg\CiteProc\Exception\CiteProcException;
use Seboettg\CiteProc\Util\CiteProcHelper;
use Seboettg\CiteProc\Util\Parser;
use Seboettg\CiteProc\Util\Renderer;
use Seboettg\Collection\ArrayList;

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

    /**
     * @return ?Context
     */
    public static function getContext(): ?Context
    {
        return self::$context;
    }

    /**
     * @param ?Context $context
     */
    public static function setContext(?Context $context)
    {
        self::$context = $context;
    }

    /** @var Config\Locale|null */
    protected $locale;

    /** @var StyleSheet */
    protected $styleSheet;

    /** @var array */
    protected $markupExtension;

    /** @var bool */
    protected $styleSheetParsed = false;

    /** @var bool */
    protected $localeParsed = false;

    /** @var Parser */
    protected $parser;

    /** @var Renderer */
    protected $renderer;

    /**
     * CiteProc constructor.
     * @param StyleSheet $styleSheet
     * @param ?Config\Locale $locale
     * @param array $markupExtension
     */
    public function __construct(StyleSheet $styleSheet, ?Config\Locale $locale = null, array $markupExtension = [])

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

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

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

    {
        $this->styleSheet = $styleSheet;
        $this->locale = ($locale ?? Config\Locale::EN_US());
        $this->markupExtension = $markupExtension;
        self::$context = new Context();
        $this->parser = new Parser();
    }

    public function __destruct()
    {
        self::$context = null;
    }

    public function setLocale(?Config\Locale $locale): CiteProcInterface
    {
        $this->locale = $locale;
        $this->localeParsed = false;
        return $this;
    }

    public function setStyleSheet(StyleSheet $stylesheet): CiteProcInterface
    {
        $this->styleSheet = $stylesheet;
        $this->styleSheetParsed = false;
        return $this;
    }

    /**
     * @param array|DataList $data
     * @param Config\RenderingMode $mode (citation|bibliography)
     * @param array $citationItems
     * @param bool $citationAsArray
     * @return string
     * @throws CiteProcException
     */
    public function render($data, Config\RenderingMode $mode, $citationItems = [], $citationAsArray = false)

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

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

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

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

    {
        if (is_array($data)) {
            $data = CiteProcHelper::cloneArray($data);
        }
        self::$context->setMode($mode);
        $this->init($citationAsArray); //initialize
        return $this->renderer->render($data, $mode, $citationItems);

The expression return $this->renderer->render($data, $mode, $citationItems) also could return the type array|string[] which is incompatible with the documented return type string.

    }

    /**
     * initializes CiteProc and start parsing XML stylesheet
     * @param bool $citationAsArray
     * @return CiteProcInterface
     * @throws CiteProcException
     */
    public function init($citationAsArray = false): CiteProcInterface

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

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

    {
        if (null === self::$context) {
            self::$context = new Context();
        }
        if (!$this->localeParsed) {
            $this->parser->parseLocale($this->locale);

It seems like $this->locale can also be of type null; however, parameter $locale of Seboettg\CiteProc\Util\Parser::parseLocale() does only seem to accept Seboettg\CiteProc\Config\Locale, maybe add an additional type check?

            $this->localeParsed = true;
        }
        self::$context->setCitationsAsArray($citationAsArray);
        // set markup extensions
        self::$context->setMarkupExtension($this->markupExtension);
        if (!$this->styleSheetParsed) {
            $this->parser->parseStylesheet(($this->styleSheet)());
            $this->styleSheetParsed = true;
        }
        $this->renderer = new Renderer(
            self::$context->getBibliography(),
            self::$context->getCitation(),
            self::$context->getBibliographySpecificOptions()
        );
        self::$context->addObserver($this->renderer);
        return $this;
    }

    /**
     * @return string
     * @throws CiteProcException
     */
    public function renderCssStyles(): string
    {
        $this->init(); //initialize
        return $this->renderer->renderCssStyles();
    }
}