Seboettg\CiteProc\CiteProc

Complexity

Total Complexity

26

Size/Duplication

Total Lines	201
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	renderCssStyles()	0	12	3
A	__destruct()	0	3	1
B	render()	0	41	9
A	citation()	0	3	1
A	getContext()	0	3	1
A	init()	0	9	1
A	__construct()	0	5	1
A	setContext()	0	3	1
A	bibliography()	0	4	1
B	parse()	0	30	7

<?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 InvalidArgumentException;
use Seboettg\CiteProc\Data\DataList;
use Seboettg\CiteProc\Exception\CiteProcException;
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\GlobalOptions;
use Seboettg\CiteProc\Root\Root;
use Seboettg\CiteProc\Styles\Css\CssStyle;
use Seboettg\CiteProc\Util\CiteProcHelper;
use Seboettg\Collection\ArrayList;
use SimpleXMLElement;


/**
 * Class CiteProc
 * @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 CiteProc
{

    /**

Missing short description in doc comment

     * @var Context
     */
    private static $context;

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

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @param Context $context

Missing parameter comment

     */

Missing @return tag in function comment

    public static function setContext($context)
    {
        self::$context = $context;
    }

    private $lang;

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

    /**

Missing short description in doc comment

     * @var string
     */
    private $styleSheet;

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

    /**

Missing short description in doc comment

     * @var SimpleXMLElement
     */
    private $styleSheetXml;

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

    /**

Missing short description in doc comment

     * @var array
     */
    private $markupExtension;

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

    /**
     * CiteProc constructor.
     * @param string $styleSheet xml formatted csl stylesheet

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

Expected 6 spaces after parameter name; 1 found

     * @param string $lang

Missing parameter comment

     * @param array $markupExtension

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

     */
    public function __construct($styleSheet, $lang = "en-US", $markupExtension = [])
    {
        $this->styleSheet = $styleSheet;
        $this->lang = $lang;
        $this->markupExtension = $markupExtension;
    }

    public function __destruct()

Missing doc comment for function __destruct()

    {
        self::$context = null;
    }

    /**

Missing short description in doc comment

     * @param SimpleXMLElement $style

Missing parameter comment

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

     * @throws CiteProcException

Tag @throws cannot be grouped with parameter tags in a doc comment

     */

Missing @return tag in function comment

    private function parse(SimpleXMLElement $style)

Private method name "CiteProc::parse" must be prefixed with an underscore

    {
        $root = new Root();
        $root->initInheritableNameAttributes($style);
        self::$context->setRoot($root);
        $globalOptions = new GlobalOptions($style);
        self::$context->setGlobalOptions($globalOptions);

        /** @var SimpleXMLElement $node */

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 ($style as $node) {
            $name = $node->getName();
            switch ($name) {
                case 'info':

Line indented incorrectly; expected 12 spaces, found 16

                    self::$context->setInfo(new Info($node));
                    break;
                case 'locale':

Line indented incorrectly; expected 12 spaces, found 16

                    self::$context->getLocale()->addXml($node);
                    break;
                case 'macro':

Line indented incorrectly; expected 12 spaces, found 16

                    $macro = new Macro($node, $root);
                    self::$context->addMacro($macro->getName(), $macro);
                    break;
                case 'bibliography':

Line indented incorrectly; expected 12 spaces, found 16

                    $bibliography = new Bibliography($node, $root);
                    self::$context->setBibliography($bibliography);
                    break;
                case 'citation':

Line indented incorrectly; expected 12 spaces, found 16

                    $citation = new Citation($node, $root);
                    self::$context->setCitation($citation);
                    break;
            }
        }
    }

    /**

Missing short description in doc comment

     * @param DataList $data

Missing parameter comment

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

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function bibliography($data)
    {

        return self::$context->getBibliography()->render($data);
    }

    /**

Missing short description in doc comment

     * @param DataList $data

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

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

     * @param ArrayList $citationItems

Missing parameter comment

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

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function citation($data, $citationItems)
    {
        return self::$context->getCitation()->render($data, $citationItems);
    }

    /**

Missing short description in doc comment

     * @param array|DataList $data

Missing parameter comment

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

     * @param string $mode (citation|bibliography)

Expected 9 spaces after parameter type; 1 found

Expected 12 spaces after parameter name; 1 found

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

     * @param array $citationItems

Missing parameter comment

Expected 10 spaces after parameter type; 1 found

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

     * @param bool $citationAsArray

Missing parameter comment

Expected 11 spaces after parameter type; 1 found

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

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     * @throws CiteProcException

Tag @throws cannot be grouped with parameter tags in a doc comment

     */
    public function render($data, $mode = "bibliography", $citationItems = [], $citationAsArray = false)
    {
        if (is_array($data)) {
            $data = CiteProcHelper::cloneArray($data);
        }

        if (!in_array($mode, ['citation', 'bibliography'])) {
            throw new InvalidArgumentException("\"$mode\" is not a valid mode.");
        }

        $this->init($citationAsArray); //initialize

        $res = "";

        if (is_array($data)) {
            $data = new DataList($data);
        } else if (!($data instanceof DataList)) {

$data is always a sub-type of Seboettg\CiteProc\Data\DataList.

            throw new CiteProcException('No valid format for variable data. Either DataList or array expected');
        }

        switch ($mode) {
            case 'bibliography':

Line indented incorrectly; expected 8 spaces, found 12

                self::$context->setMode($mode);
                // set CitationItems to Context
                self::getContext()->setCitationItems($data);
                $res = $this->bibliography($data);
                break;
            case 'citation':

Line indented incorrectly; expected 8 spaces, found 12

                if (is_array($citationItems)) {

Line indented incorrectly; expected 12 spaces, found 16

The condition is_array($citationItems) is always true.

                    $citationItems = new ArrayList($citationItems);
                } else if (!($citationItems instanceof ArrayList)) {

Line indented incorrectly; expected 12 spaces, found 16

                    throw new CiteProcException('No valid format for variable `citationItems`, ArrayList expected.');
                }

Line indented incorrectly; expected 12 spaces, found 16

                self::$context->setMode($mode);
                // set CitationItems to Context
                //self::getContext()->setCitationItems($data); will now set in Layout
                $res = $this->citation($data, $citationItems);
        }
        self::setContext(null);

        return $res;
    }

    /**
     * initializes CiteProc and start parsing XML stylesheet

Doc comment short description must start with a capital letter

     * @param bool $citationAsArray

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

Missing parameter comment

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

     * @throws CiteProcException

Tag @throws cannot be grouped with parameter tags in a doc comment

     */

Missing @return tag in function comment

    public function init($citationAsArray = false)
    {
        self::$context = new Context($this);
        self::$context->setLocale(new Locale\Locale($this->lang)); //init locale
        self::$context->setCitationsAsArray($citationAsArray);
        // set markup extensions
        self::$context->setMarkupExtension($this->markupExtension);
        $this->styleSheetXml = new SimpleXMLElement($this->styleSheet);
        $this->parse($this->styleSheetXml);
    }

    /**

Missing short description in doc comment

     * @return string
     * @throws CiteProcException
     */
    public function renderCssStyles()
    {
        if (self::getContext() === null) {
            $this->init();
        }

        if (self::getContext()->getCssStyle() == null) {
            $cssStyle = new CssStyle(self::getContext()->getBibliographySpecificOptions());
            self::getContext()->setCssStyle($cssStyle);
        }

        return self::getContext()->getCssStyle()->render();
    }
}