League\Csv\RFC4180FieldFilter

Complexity

Total Complexity

10

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	addTo()	0	12	2
B	onCreate()	0	22	4
A	filterMode()	0	8	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.0
* @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 InvalidArgumentException;
use php_user_filter;
use Throwable;

/**
 *  A stream filter to conform the written CSV field to RFC4180
 *  This stream filter should be attach to a League\Csv\Writer object
 *
 * @package League.csv
 * @since   9.0.0
 * @author  Ignace Nyamagana Butera <nyamsprod@gmail.com>
 */
class RFC4180FieldFilter extends php_user_filter
{
    use ValidatorTrait;

    const STREAM_FILTERNAME = 'rfc4180.league.csv';

    /**
     * The value being search for
     *
     * @var string
     */
    protected $search;

    /**
     * The replacement value that replace found $search values
     *
     * @var string
     */
    protected $replace;

    /**
     * Static method to add the stream filter to a Writer object
     *
     * @param AbstractCsv $csv
     */
    public static function addTo(AbstractCsv $csv)
    {
        if (!in_array(self::STREAM_FILTERNAME, stream_get_filters())) {
            stream_filter_register(self::STREAM_FILTERNAME, __CLASS__);
        }

        $csv->addStreamFilter(self::STREAM_FILTERNAME, [
            'enclosure' => $csv->getEnclosure(),
            'escape' => $csv->getEscape(),
            'mode' => $csv->getStreamFilterMode(),
        ]);
    }

    /**
     * @inheritdoc
     */
    public function onCreate()
    {
        if (!isset($this->params['enclosure'], $this->params['escape'], $this->params['mode'])) {
            return false;
        }

        try {
            $enclosure = $this->filterControl($this->params['enclosure'], 'enclosure', __METHOD__);
            $escape = $this->filterControl($this->params['escape'], 'escape', __METHOD__);
            $mode = $this->filterMode($this->params['mode']);

            $this->search = $escape.$enclosure;
            $this->replace = $escape.$enclosure.$enclosure;
            if (STREAM_FILTER_READ === $mode) {
                $this->replace = $enclosure.$enclosure;
            }

            return true;
        } catch (Throwable $e) {
            return false;
        }
    }

    /**
     * Filter the given mode
     *
     * @param int $mode stream filter mode
     *
     * @throws InvalidArgumentException if the mode value is unknown
     *
     * @return int
     */
    protected function filterMode(int $mode)
    {
        if (in_array($mode, [STREAM_FILTER_READ, STREAM_FILTER_WRITE])) {
            return $mode;
        }

        throw new InvalidArgumentException(sprintf('The given filter mode `%s` is unknown or unsupported', $mode));
    }

    /**
     * @inheritdoc
     */
    public function filter($in, $out, &$consumed, $closing)
    {
        while ($bucket = stream_bucket_make_writeable($in)) {
            $bucket->data = str_replace($this->search, $this->replace, $bucket->data);
            $consumed += $bucket->datalen;
            stream_bucket_append($out, $bucket);
        }

        return PSFS_PASS_ON;
    }
}