Seboettg\CiteProc\Style\Citation

Complexity

Total Complexity

3

Size/Duplication

Total Lines	28
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	render()	0	6	2

<?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\Style;

use Seboettg\CiteProc\CiteProc;
use Seboettg\CiteProc\Data\DataList;
use Seboettg\CiteProc\Style\Options\CitationOptions;
use Seboettg\Collection\ArrayList;


/**
 * Class Citation
 *
 * The cs:citation element describes the formatting of citations, which consist of one or more references (“cites”) to
 * bibliographic sources. Citations appear in the form of either in-text citations (in the author (e.g. “[Doe]”),
 * author-date (“[Doe 1999]”), label (“[doe99]”) or number (“[1]”) format) or notes. The required cs:layout child
 * element describes what, and how, bibliographic data should be included in the citations (see Layout).
 *
 * @package Seboettg\CiteProc\Node\Style
 *
 * @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 Citation extends StyleElement
{

    private $node;

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

    /**

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

     * Citation 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, $parent)
    {
        parent::__construct($node, $parent);
        $citationOptions = new CitationOptions($node);
        CiteProc::getContext()->setCitationSpecificOptions($citationOptions);
        $this->node = $node;
    }

    /**

Missing short description in doc comment

     * @param array|DataList $data

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param ArrayList $citationItems

Missing parameter comment

Expected 6 spaces after parameter type; 1 found

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function render($data, $citationItems)
    {
        if (!$this->attributesInitialized) {
            $this->initInheritableNameAttributes($this->node);
        }
        return $this->layout->render($data, $citationItems);

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

    }

}