Seboettg\CiteProc\Styles\QuotesTrait

Complexity

Total Complexity

6

Size/Duplication

Total Lines	45
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	replaceOuterQuotes()	0	9	1
A	initQuotesAttributes()	0	4	3
A	addSurroundingQuotes()	0	9	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) 2017 Sebastian Böttger.
 * @license     https://opensource.org/licenses/MIT
 */

namespace Seboettg\CiteProc\Styles;
use Seboettg\CiteProc\CiteProc;
use Seboettg\CiteProc\Util\StringHelper;
use SimpleXMLElement;

/**
 * Trait QuotesTrait
 *
 * The quotes attribute may set on cs:text. When set to “true” (“false” is default), the rendered text is wrapped in
 * quotes (the quotation marks used are terms). The localized punctuation-in-quote option controls whether an adjoining
 * comma or period appears outside (default) or inside the closing quotation mark.
 *
 * @package Seboettg\CiteProc\Styles
 * @author Sebastian Böttger <seboettg@gmail.com>

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

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

trait QuotesTrait
{

    /**

Missing short description in doc comment

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

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

    public function initQuotesAttributes(SimpleXMLElement $node)

Missing doc comment for function initQuotesAttributes()

    {
        if (isset($node['quotes']) && "true" === (string) $node['quotes']) {
            $this->quotes = true;
        }
    }

    /**

Missing short description in doc comment

     * @param string $text

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

     */
    public function addSurroundingQuotes($text)
    {
        if ($this->quotes) {
            $openQuote = CiteProc::getContext()->getLocale()->filter("terms", "open-quote")->single;
            $closeQuote = CiteProc::getContext()->getLocale()->filter("terms", "close-quote")->single;
            $text = $this->replaceOuterQuotes($text, $openQuote, $closeQuote);
            return $openQuote . $text . $closeQuote;
        }
        return $text;
    }

    /**

Missing short description in doc comment

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

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

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

     * @param $text

Missing parameter name

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

     * @param $outerOpenQuote

Missing parameter name

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

     * @param $outerCloseQuote

Missing parameter name

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

     */
    private function replaceOuterQuotes($text, $outerOpenQuote, $outerCloseQuote)

Private method name "QuotesTrait::replaceOuterQuotes" must be prefixed with an underscore

    {

        $innerOpenQuote = CiteProc::getContext()->getLocale()->filter("terms", "open-inner-quote")->single;
        $innerCloseQuote = CiteProc::getContext()->getLocale()->filter("terms", "close-inner-quote")->single;

        $text = StringHelper::replaceOuterQuotes($text, "\"", "\"", $innerOpenQuote, $innerCloseQuote);
        $text = StringHelper::replaceOuterQuotes($text, $outerOpenQuote, $outerCloseQuote, $innerOpenQuote, $innerCloseQuote);
        return $text;
    }
}