League\Csv\EncloseField

Complexity

Total Complexity

13

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	6	2
A	addTo()	0	8	1
A	sequence()	0	15	3
A	isValidSequence()	0	4	1
A	__invoke()	0	4	1
A	forceEnclosure()	0	4	1
A	onCreate()	0	5	2
A	filter()	0	10	2

<?php
/**
* This file is part of the League.csv library
*
* @license http://opensource.org/licenses/MIT
* @link https://github.com/thephpleague/csv/
* @version 9.0.1
* @package League.csv
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);

namespace League\Csv;

use OutOfRangeException;
use php_user_filter;

/**
 * A stream filter to improve enclosure character usage
 *
 * @see https://tools.ietf.org/html/rfc4180#section-2
 * @see https://bugs.php.net/bug.php?id=38301
 *
 * @package League.csv
 * @since   9.0.0
 * @author  Ignace Nyamagana Butera <nyamsprod@gmail.com>
 */
class EncloseField extends php_user_filter
{
    const FILTERNAME = 'convert.league.csv.enclosure';

    /**
     * the filter name used to instantiate the class with
     *
     * @var string
     */
    public $filtername;

    /**
     * Contents of the params parameter passed to stream_filter_append
     * or stream_filter_prepend functions
     *
     * @var mixed
     */
    public $params;

    /**
     * Default sequence
     *
     * @var string
     */
    protected $sequence;

    /**
     * Characters that triggers enclosure in PHP
     *
     * @var string
     */
    protected static $force_enclosure = "\n\r\t ";

    /**
     * Static method to register the class as a stream filter
     */
    public static function register()
    {
        if (!in_array(self::FILTERNAME, stream_get_filters())) {
            stream_filter_register(self::FILTERNAME, __CLASS__);
        }
    }

    /**
     * Static method to add the stream filter to a {@link Writer} object
     *
     * @param Writer $csv
     * @param string $sequence
     *
     * @return AbstractCsv
     */
    public static function addTo(Writer $csv, string $sequence): Writer
    {
        self::register();

        return $csv
            ->addFormatter((new self())->sequence($sequence))
            ->addStreamFilter(self::FILTERNAME, ['sequence' => $sequence]);
    }

    /**
     * Set the Sequence to be used to update enclosure usage
     *
     * @param string $sequence sequence used to work around fputcsv limitation
     *
     * @return self
     */
    public function sequence(string $sequence): self
    {
        if ($sequence === $this->sequence) {
            return $this;
        }

        if (!$this->isValidSequence($sequence)) {
            throw new OutOfRangeException('The sequence must contain at least one character to force enclosure');
        }

        $clone = clone $this;
        $clone->sequence = $sequence;

        return $clone;
    }

    /**
     * Filter type and sequence parameters
     *
     * - The sequence to force enclosure MUST contains one of the following character ("\n\r\t ")
     *
     * @param string $sequence
     *
     * @return bool
     */
    protected static function isValidSequence(string $sequence): bool
    {
        return strlen($sequence) != strcspn($sequence, self::$force_enclosure);
    }

    /**
     * @inheritdoc
     */
    public function __invoke(array $record): array
    {
        return array_map([$this, 'forceEnclosure'], $record);
    }

    /**
     * Format the record field to force the addition of the enclosure by fputcsv
     *
     * @param mixed $value
     *
     * @return string
     */
    protected function forceEnclosure($value)
    {
        return $this->sequence.$value;
    }

    /**
     * @inheritdoc
     */
    public function onCreate()
    {
        return isset($this->params['sequence'])
            && $this->isValidSequence($this->params['sequence']);
    }

    /**
     * @inheritdoc
     */
    public function filter($in, $out, &$consumed, $closing)
    {
        while ($res = stream_bucket_make_writeable($in)) {
            $res->data = str_replace($this->params['sequence'], '', $res->data);
            $consumed += $res->datalen;
            stream_bucket_append($out, $res);
        }

        return PSFS_PASS_ON;
    }
}