Palmtree\Csv\Formatter\StringFormatter

Complexity

Total Complexity

8

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

95%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
A	setTrim()	0	6	1
A	setTrimCharMask()	0	6	1
A	getTrimCharMask()	0	4	1
A	isTrim()	0	4	1
A	getFormattedValue()	0	8	2

<?php

namespace Palmtree\Csv\Formatter;

/**
 * StringFormatter formats a CSV cell as a string.
 * It will trim the string by default.
 */
class StringFormatter extends AbstractFormatter
{
    protected $trim = true;
    protected $trimCharMask = " \t\n\r\0\x0B";

    public function __construct($formatter = null, $trim = true, $trimCharMask = null)
    {
        parent::__construct($formatter);

        $this->setTrim($trim);

        if ($trimCharMask) {
            $this->setTrimCharMask($trimCharMask);
        }
    }

    /**
     * @param bool $trim
     *
     * @return StringFormatter
     */
    public function setTrim($trim)
    {
        $this->trim = $trim;

        return $this;
    }

    /**
     * @param null|string $trimCharMask
     *
     * @return StringFormatter
     */
    public function setTrimCharMask($trimCharMask)
    {
        $this->trimCharMask = $trimCharMask;

        return $this;
    }

    /**
     * @return string
     */
    public function getTrimCharMask()
    {
        return $this->trimCharMask;
    }

    /**
     * @return bool
     */
    public function isTrim()
    {
        return $this->trim;
    }

    protected function getFormattedValue($value)
    {
        if ($this->isTrim()) {
            $value = trim($value, $this->getTrimCharMask());
        }

        return $value;
    }
}