Seboettg\CiteProc\Styles\FormattingTrait

Complexity

Total Complexity

16

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
C	format()	0	32	13
A	initFormattingAttributes()	0	14	3

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


use Seboettg\Collection\ArrayList;
use SimpleXMLElement;

/**
 * Trait FormattingTrait
 * @package Seboettg\CiteProc\Styles

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

 * @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 FormattingTrait
{

    /**

Missing short description in doc comment

     * @var array
     */
    static $formattingAttributes = ['font-style', 'font-family', 'font-weight', 'font-variant', 'text-decoration', 'vertical-align'];

    /**

Missing short description in doc comment

     * @var ArrayList
     */
    private $formattingOptions;

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

    /**

Missing short description in doc comment

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

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

    /**

Missing short description in doc comment

     * @var string
     */
    private $format;

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

    /**

Missing short description in doc comment

     * @param SimpleXMLElement $node

Missing parameter comment

     */

Missing @return tag in function comment

    protected function initFormattingAttributes(SimpleXMLElement $node)
    {
        $this->formattingOptions = new ArrayList();

        /** @var SimpleXMLElement $attribute */

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 ($node->attributes() as $attribute) {

            /** @var string $name */

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

            $name = (string) $attribute->getName();
            $value = (string) $attribute;

            if (in_array($name, self::$formattingAttributes)) {
                $this->formattingOptions->add($name, $value);
                continue;
            }
        }
    }


    protected function format($text)

Missing doc comment for function format()

    {
        if (empty($text)) {
            return $text;
        }

        if (!empty($this->formattingOptions)) {
            $format = "";
            foreach ($this->formattingOptions as $option => $optionValue) {
                if ($optionValue === "italic") {
                    $text = "<i>$text</i>";
                } else if ($optionValue === "bold") {
                    $text = "<b>$text</b>";
                } else if ($optionValue === "normal") {
                    //$text = $text;
                } else if ($option === "vertical-align") {
                    if ($optionValue === "sub") {
                        $text = "<sub>$text</sub>";
                    } else if ($optionValue === "sup") {
                        $text = "<sup>$text</sup>";
                    }
                } else if ($option === "text-decoration" && $optionValue === "none") {

                } else {
                    $format .= "$option: $optionValue;";
                }
            }
            if (!empty($format)) {
                $text = '<span style="' . $format . '">' . $text . '</span>';
            }
        }
        return $text;
    }
}