Seboettg\CiteProc\Styles\ConsecutivePunctuationCharacterTrait

Complexity

Total Complexity

18

Size/Duplication

Total Lines	77
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	removeConsecutiveChars()	0	15	4
A	removeConsecutivePunctuation()	0	11	4
B	getChildsAffixesAndDelimiter()	0	15	10

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

/**
 * Trait ConsecutivePunctuationCharacterTrait
 * @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 ConsecutivePunctuationCharacterTrait
{

    /**

Missing short description in doc comment

     * @var array
     */
    private $childrenPrefixes = [];

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

    /**

Missing short description in doc comment

     * @var array
     */
    private $childrenSuffixes = [];

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

    /**

Missing short description in doc comment

     * @var array
     */
    private $childrenDelimiter = [];

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

    /**

Missing short description in doc comment

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

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

     * @param $punctuationSign

Missing parameter name

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

     * @param $subject

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

     */
    public function removeConsecutivePunctuation($punctuationSign, $subject)
    {
        if (empty($punctuationSign) || preg_match("/^\s+$/", $punctuationSign)) {
            return $subject;
        }
        $pattern = '/' . preg_quote(trim($punctuationSign)) . '{2,}/';
        if (preg_match($pattern, $subject)) {
            $res = preg_replace($pattern, $punctuationSign, $subject);
            return $res;
        }
        return $subject;
    }

    /**

Missing short description in doc comment

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

     * @param $child

Missing parameter name

     */

Missing @return tag in function comment

    protected function getChildsAffixesAndDelimiter($child)
    {
        if (method_exists($child, "renderPrefix")) {
            if (!empty($child->renderPrefix()) && !in_array($child->renderPrefix(), $this->childrenPrefixes)) {
                $this->childrenPrefixes[] = $child->renderPrefix();
            }
        }
        if (method_exists($child, "renderSuffix")) {
            if (!empty($child->renderSuffix()) && !in_array($child->renderSuffix(), $this->childrenSuffixes)) {
                $this->childrenSuffixes[] = $child->renderSuffix();
            }
        }
        if (method_exists($child, "getDelimiter")) {
            if (!empty($child->getDelimiter()) && !in_array($child->getDelimiter(), $this->childrenDelimiter)) {
                $this->childrenDelimiter[] = $child->getDelimiter();
            }
        }
    }

    /**

Missing short description in doc comment

     * @param string $string

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 removeConsecutiveChars($string)
    {
        foreach ($this->childrenPrefixes as $prefix) {
            $string = $this->removeConsecutivePunctuation($prefix, $string);
        }
        foreach ($this->childrenSuffixes as $suffix) {
            $string = $this->removeConsecutivePunctuation($suffix, $string);
        }
        foreach ($this->childrenDelimiter as $delimiter) {
            $string = $this->removeConsecutivePunctuation($delimiter, $string);
        }

        $string = preg_replace("/\s{2,}/", " ", $string);

        return $string;
    }
}