Palmtree\Csv\Normalizer\StringNormalizer

Complexity

Total Complexity

7

Size/Duplication

Total Lines	51
Duplicated Lines	0 %

Test Coverage

Coverage

58.81%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setTrim()	0	5	1
A	getNormalizedValue()	0	7	2
A	addTrimChar()	0	5	1
A	setTrimChars()	0	5	1
A	shouldTrim()	0	3	1
A	getTrimChars()	0	3	1

<?php

namespace Palmtree\Csv\Normalizer;

/**
 * StringNormalizer formats a CSV cell as a string.
 * It will trim the string by default.
 */
class StringNormalizer extends AbstractNormalizer
{
    /** @var bool */
    private $trim = true;
    /** @var array */
    private $trimChars = [' ', "\t", "\n", "\r", "\0", "\x0B"];

    /**
     * Sets whether the string should be trimmed. Defaults to true.
     */
    public function setTrim(bool $trim): self
    {
        $this->trim = $trim;

        return $this;
    }

    /**
     * Sets the character mask passed to trim(). Defaults to the mask used by trim itself.
     */
    public function setTrimChars(array $trimChars): self
    {
        $this->trimChars = $trimChars;

        return $this;
    }

    public function addTrimChar(string $char): self
    {
        $this->trimChars[] = $char;

        return $this;
    }

    public function getTrimChars(): array
    {
        return $this->trimChars;
    }

    public function shouldTrim(): bool
    {
        return $this->trim;
    }

    protected function getNormalizedValue(string $value): string
    {
        if ($this->trim) {
            $value = \trim($value, \implode('', $this->trimChars));
        }

        return $value;
    }
}