EncloseField.php — Independent Analytics – WordPress Analytics Plugin 2.14.1

independent-analytics / vendor / league / csv / src / EncloseField.php

independent-analytics / vendor / league / csv / src Last commit date

EncloseField.php

114 lines

1	<?php
2
3	/**
4	* League.Csv (https://csv.thephpleague.com)
5	*
6	* (c) Ignace Nyamagana Butera <nyamsprod@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11	declare (strict_types=1);
12	namespace IAWPSCOPED\League\Csv;
13
14	use InvalidArgumentException;
15	use php_user_filter;
16	use function array_map;
17	use function in_array;
18	use function str_replace;
19	use function strcspn;
20	use function stream_bucket_append;
21	use function stream_bucket_make_writeable;
22	use function stream_filter_register;
23	use function stream_get_filters;
24	use function strlen;
25	/**
26	* A stream filter to improve enclosure character usage.
27	*
28	* @see https://tools.ietf.org/html/rfc4180#section-2
29	* @see https://bugs.php.net/bug.php?id=38301
30	* @internal
31	*/
32	class EncloseField extends php_user_filter
33	{
34	const FILTERNAME = 'convert.league.csv.enclosure';
35	/**
36	* Default sequence.
37	*
38	* @var string
39	*/
40	protected $sequence;
41	/**
42	* Characters that triggers enclosure in PHP.
43	*
44	* @var string
45	*/
46	protected static $force_enclosure = "\n\r\t ";
47	/**
48	* Static method to return the stream filter filtername.
49	*/
50	public static function getFiltername() : string
51	{
52	return self::FILTERNAME;
53	}
54	/**
55	* Static method to register the class as a stream filter.
56	*/
57	public static function register() : void
58	{
59	if (!in_array(self::FILTERNAME, stream_get_filters(), \true)) {
60	stream_filter_register(self::FILTERNAME, self::class);
61	}
62	}
63	/**
64	* Static method to add the stream filter to a {@link Writer} object.
65	*
66	* @throws InvalidArgumentException if the sequence is malformed
67	* @throws Exception
68	*/
69	public static function addTo(Writer $csv, string $sequence) : Writer
70	{
71	self::register();
72	if (!self::isValidSequence($sequence)) {
73	throw new InvalidArgumentException('The sequence must contain at least one character to force enclosure');
74	}
75	$formatter = function (array $record) use($sequence) : array {
76	return array_map(function (?string $value) use($sequence) : string {
77	return $sequence . $value;
78	}, $record);
79	};
80	return $csv->addFormatter($formatter)->addStreamFilter(self::FILTERNAME, ['sequence' => $sequence]);
81	}
82	/**
83	* Filter type and sequence parameters.
84	*
85	* The sequence to force enclosure MUST contains one of the following character ("\n\r\t ")
86	*/
87	protected static function isValidSequence(string $sequence) : bool
88	{
89	return strlen($sequence) != strcspn($sequence, self::$force_enclosure);
90	}
91	/**
92	* {@inheritdoc}
93	*/
94	public function onCreate() : bool
95	{
96	return isset($this->params['sequence']) && self::isValidSequence($this->params['sequence']);
97	}
98	/**
99	* @param resource $in
100	* @param resource $out
101	* @param int $consumed
102	* @param bool $closing
103	*/
104	public function filter($in, $out, &$consumed, $closing) : int
105	{
106	while ($res = stream_bucket_make_writeable($in)) {
107	$res->data = str_replace($this->params['sequence'], '', $res->data);
108	$consumed += $res->datalen;
109	stream_bucket_append($out, $res);
110	}
111	return \PSFS_PASS_ON;
112	}
113	}
114