first
This commit is contained in:
Tim Bendt
447
system/vendor/league/csv/src/Stream.php
vendored
Executable file
447
system/vendor/league/csv/src/Stream.php
vendored
Executable file
@@ -0,0 +1,447 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* League.Csv (https://csv.thephpleague.com)
|
||||
*
|
||||
* (c) Ignace Nyamagana Butera <nyamsprod@gmail.com>
|
||||
*
|
||||
* 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 ReturnTypeWillChange;
|
||||
use SeekableIterator;
|
||||
use SplFileObject;
|
||||
use TypeError;
|
||||
use function array_keys;
|
||||
use function array_walk_recursive;
|
||||
use function fclose;
|
||||
use function feof;
|
||||
use function fflush;
|
||||
use function fgetcsv;
|
||||
use function fgets;
|
||||
use function fopen;
|
||||
use function fpassthru;
|
||||
use function fputcsv;
|
||||
use function fread;
|
||||
use function fseek;
|
||||
use function fwrite;
|
||||
use function get_resource_type;
|
||||
use function gettype;
|
||||
use function is_array;
|
||||
use function is_resource;
|
||||
use function rewind;
|
||||
use function stream_filter_append;
|
||||
use function stream_filter_remove;
|
||||
use function stream_get_meta_data;
|
||||
use function strlen;
|
||||
use const PHP_VERSION_ID;
|
||||
use const SEEK_SET;
|
||||
|
||||
/**
|
||||
* An object oriented API to handle a PHP stream resource.
|
||||
*
|
||||
* @internal used internally to iterate over a stream resource
|
||||
*/
|
||||
final class Stream implements SeekableIterator
|
||||
{
|
||||
/** @var array<string, array<resource>> Attached filters. */
|
||||
private array $filters = [];
|
||||
/** @var resource */
|
||||
private $stream;
|
||||
private bool $should_close_stream = false;
|
||||
/** @var mixed can be a null false or a scalar type value. Current iterator value. */
|
||||
private $value;
|
||||
/** Current iterator key. */
|
||||
private int $offset;
|
||||
/** Flags for the Document.*/
|
||||
private int $flags = 0;
|
||||
private string $delimiter = ',';
|
||||
private string $enclosure = '"';
|
||||
private string $escape = '\\';
|
||||
private bool $is_seekable = false;
|
||||
|
||||
/**
|
||||
* @param mixed $stream stream type resource
|
||||
*/
|
||||
public function __construct($stream)
|
||||
{
|
||||
if (!is_resource($stream)) {
|
||||
throw new TypeError('Argument passed must be a stream resource, '.gettype($stream).' given.');
|
||||
}
|
||||
|
||||
if ('stream' !== ($type = get_resource_type($stream))) {
|
||||
throw new TypeError('Argument passed must be a stream resource, '.$type.' resource given');
|
||||
}
|
||||
|
||||
$this->is_seekable = stream_get_meta_data($stream)['seekable'];
|
||||
$this->stream = $stream;
|
||||
}
|
||||
|
||||
public function __destruct()
|
||||
{
|
||||
array_walk_recursive($this->filters, fn ($filter): bool => @stream_filter_remove($filter));
|
||||
|
||||
if ($this->should_close_stream && is_resource($this->stream)) {
|
||||
fclose($this->stream);
|
||||
}
|
||||
|
||||
unset($this->stream);
|
||||
}
|
||||
|
||||
public function __clone()
|
||||
{
|
||||
throw UnavailableStream::dueToForbiddenCloning(self::class);
|
||||
}
|
||||
|
||||
public function __debugInfo(): array
|
||||
{
|
||||
return stream_get_meta_data($this->stream) + [
|
||||
'delimiter' => $this->delimiter,
|
||||
'enclosure' => $this->enclosure,
|
||||
'escape' => $this->escape,
|
||||
'stream_filters' => array_keys($this->filters),
|
||||
];
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a new instance from a file path.
|
||||
*
|
||||
* @param resource|null $context
|
||||
*
|
||||
* @throws Exception if the stream resource can not be created
|
||||
*/
|
||||
public static function createFromPath(string $path, string $open_mode = 'r', $context = null): self
|
||||
{
|
||||
$args = [$path, $open_mode];
|
||||
if (null !== $context) {
|
||||
$args[] = false;
|
||||
$args[] = $context;
|
||||
}
|
||||
|
||||
$resource = @fopen(...$args);
|
||||
if (!is_resource($resource)) {
|
||||
throw UnavailableStream::dueToPathNotFound($path);
|
||||
}
|
||||
|
||||
$instance = new self($resource);
|
||||
$instance->should_close_stream = true;
|
||||
|
||||
return $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a new instance from a string.
|
||||
*/
|
||||
public static function createFromString(string $content = ''): self
|
||||
{
|
||||
/** @var resource $resource */
|
||||
$resource = fopen('php://temp', 'r+');
|
||||
fwrite($resource, $content);
|
||||
|
||||
$instance = new self($resource);
|
||||
$instance->should_close_stream = true;
|
||||
|
||||
return $instance;
|
||||
}
|
||||
|
||||
/**
|
||||
* returns the URI of the underlying stream.
|
||||
*
|
||||
* @see https://www.php.net/manual/en/splfileinfo.getpathname.php
|
||||
*/
|
||||
public function getPathname(): string
|
||||
{
|
||||
return stream_get_meta_data($this->stream)['uri'];
|
||||
}
|
||||
|
||||
/**
|
||||
* append a filter.
|
||||
*
|
||||
* @see http://php.net/manual/en/function.stream-filter-append.php
|
||||
*
|
||||
* @throws InvalidArgument if the filter can not be appended
|
||||
*/
|
||||
public function appendFilter(string $filtername, int $read_write, array $params = null): void
|
||||
{
|
||||
$res = @stream_filter_append($this->stream, $filtername, $read_write, $params ?? []);
|
||||
if (!is_resource($res)) {
|
||||
throw InvalidArgument::dueToStreamFilterNotFound($filtername);
|
||||
}
|
||||
|
||||
$this->filters[$filtername][] = $res;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set CSV control.
|
||||
*
|
||||
* @see http://php.net/manual/en/SplFileObject.setcsvcontrol.php
|
||||
*/
|
||||
public function setCsvControl(string $delimiter = ',', string $enclosure = '"', string $escape = '\\'): void
|
||||
{
|
||||
[$this->delimiter, $this->enclosure, $this->escape] = $this->filterControl($delimiter, $enclosure, $escape, __METHOD__);
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter Csv control characters.
|
||||
*
|
||||
* @throws InvalidArgument If the Csv control character is not one character only.
|
||||
*/
|
||||
private function filterControl(string $delimiter, string $enclosure, string $escape, string $caller): array
|
||||
{
|
||||
if (1 !== strlen($delimiter)) {
|
||||
throw InvalidArgument::dueToInvalidDelimiterCharacter($delimiter, $caller);
|
||||
}
|
||||
|
||||
if (1 !== strlen($enclosure)) {
|
||||
throw InvalidArgument::dueToInvalidEnclosureCharacter($enclosure, $caller);
|
||||
}
|
||||
|
||||
if (1 === strlen($escape) || ('' === $escape && 70400 <= PHP_VERSION_ID)) {
|
||||
return [$delimiter, $enclosure, $escape];
|
||||
}
|
||||
|
||||
throw InvalidArgument::dueToInvalidEscapeCharacter($escape, $caller);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set CSV control.
|
||||
*
|
||||
* @see http://php.net/manual/en/SplFileObject.getcsvcontrol.php
|
||||
*
|
||||
* @return array<string>
|
||||
*/
|
||||
public function getCsvControl(): array
|
||||
{
|
||||
return [$this->delimiter, $this->enclosure, $this->escape];
|
||||
}
|
||||
|
||||
/**
|
||||
* Set CSV stream flags.
|
||||
*
|
||||
* @see http://php.net/manual/en/SplFileObject.setflags.php
|
||||
*/
|
||||
public function setFlags(int $flags): void
|
||||
{
|
||||
$this->flags = $flags;
|
||||
}
|
||||
|
||||
/**
|
||||
* Write a field array as a CSV line.
|
||||
*
|
||||
* @see http://php.net/manual/en/SplFileObject.fputcsv.php
|
||||
*
|
||||
* @return int|false
|
||||
*/
|
||||
public function fputcsv(array $fields, string $delimiter = ',', string $enclosure = '"', string $escape = '\\', string $eol = "\n")
|
||||
{
|
||||
$controls = $this->filterControl($delimiter, $enclosure, $escape, __METHOD__);
|
||||
if (80100 <= PHP_VERSION_ID) {
|
||||
$controls[] = $eol;
|
||||
}
|
||||
|
||||
return fputcsv($this->stream, $fields, ...$controls);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get line number.
|
||||
*
|
||||
* @see http://php.net/manual/en/SplFileObject.key.php
|
||||
*/
|
||||
public function key(): int
|
||||
{
|
||||
return $this->offset;
|
||||
}
|
||||
|
||||
/**
|
||||
* Read next line.
|
||||
*
|
||||
* @see http://php.net/manual/en/SplFileObject.next.php
|
||||
*/
|
||||
public function next(): void
|
||||
{
|
||||
$this->value = false;
|
||||
$this->offset++;
|
||||
}
|
||||
|
||||
/**
|
||||
* Rewind the file to the first line.
|
||||
*
|
||||
* @see http://php.net/manual/en/SplFileObject.rewind.php
|
||||
*
|
||||
* @throws Exception if the stream resource is not seekable
|
||||
*/
|
||||
public function rewind(): void
|
||||
{
|
||||
if (!$this->is_seekable) {
|
||||
throw UnavailableFeature::dueToMissingStreamSeekability();
|
||||
}
|
||||
|
||||
rewind($this->stream);
|
||||
$this->offset = 0;
|
||||
$this->value = false;
|
||||
if (0 !== ($this->flags & SplFileObject::READ_AHEAD)) {
|
||||
$this->current();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Not at EOF.
|
||||
*
|
||||
* @see http://php.net/manual/en/SplFileObject.valid.php
|
||||
*/
|
||||
public function valid(): bool
|
||||
{
|
||||
if (0 !== ($this->flags & SplFileObject::READ_AHEAD)) {
|
||||
return $this->current() !== false;
|
||||
}
|
||||
|
||||
return !feof($this->stream);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the current line of the file.
|
||||
*
|
||||
* @see http://php.net/manual/en/SplFileObject.current.php
|
||||
*
|
||||
* @return mixed The value of the current element.
|
||||
*/
|
||||
#[ReturnTypeWillChange]
|
||||
public function current()
|
||||
{
|
||||
if (false !== $this->value) {
|
||||
return $this->value;
|
||||
}
|
||||
|
||||
$this->value = $this->getCurrentRecord();
|
||||
|
||||
return $this->value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the current line as a CSV Record.
|
||||
*
|
||||
* @return array|false
|
||||
*/
|
||||
private function getCurrentRecord()
|
||||
{
|
||||
$flag = 0 !== ($this->flags & SplFileObject::SKIP_EMPTY);
|
||||
do {
|
||||
$ret = fgetcsv($this->stream, 0, $this->delimiter, $this->enclosure, $this->escape);
|
||||
} while ($flag && is_array($ret) && null === $ret[0]);
|
||||
|
||||
return $ret;
|
||||
}
|
||||
|
||||
/**
|
||||
* Seek to specified line.
|
||||
*
|
||||
* @see http://php.net/manual/en/SplFileObject.seek.php
|
||||
*
|
||||
* @param int $position
|
||||
* @throws Exception if the position is negative
|
||||
*/
|
||||
public function seek($position): void
|
||||
{
|
||||
if ($position < 0) {
|
||||
throw InvalidArgument::dueToInvalidSeekingPosition($position, __METHOD__);
|
||||
}
|
||||
|
||||
$this->rewind();
|
||||
while ($this->key() !== $position && $this->valid()) {
|
||||
$this->current();
|
||||
$this->next();
|
||||
}
|
||||
|
||||
if (0 !== $position) {
|
||||
$this->offset--;
|
||||
}
|
||||
|
||||
$this->current();
|
||||
}
|
||||
|
||||
/**
|
||||
* Output all remaining data on a file pointer.
|
||||
*
|
||||
* @see http://php.net/manual/en/SplFileObject.fpatssthru.php
|
||||
*
|
||||
* @return int|false
|
||||
*/
|
||||
public function fpassthru()
|
||||
{
|
||||
return fpassthru($this->stream);
|
||||
}
|
||||
|
||||
/**
|
||||
* Read from file.
|
||||
*
|
||||
* @see http://php.net/manual/en/SplFileObject.fread.php
|
||||
*
|
||||
* @param int<0, max> $length The number of bytes to read
|
||||
*
|
||||
* @return string|false
|
||||
*/
|
||||
public function fread(int $length)
|
||||
{
|
||||
return fread($this->stream, $length);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a line from file.
|
||||
*
|
||||
* @see http://php.net/manual/en/SplFileObject.fgets.php
|
||||
*
|
||||
* @return string|false
|
||||
*/
|
||||
public function fgets()
|
||||
{
|
||||
return fgets($this->stream);
|
||||
}
|
||||
|
||||
/**
|
||||
* Seek to a position.
|
||||
*
|
||||
* @see http://php.net/manual/en/SplFileObject.fseek.php
|
||||
*
|
||||
* @throws Exception if the stream resource is not seekable
|
||||
*/
|
||||
public function fseek(int $offset, int $whence = SEEK_SET): int
|
||||
{
|
||||
if (!$this->is_seekable) {
|
||||
throw UnavailableFeature::dueToMissingStreamSeekability();
|
||||
}
|
||||
|
||||
return fseek($this->stream, $offset, $whence);
|
||||
}
|
||||
|
||||
/**
|
||||
* Write to stream.
|
||||
*
|
||||
* @see http://php.net/manual/en/SplFileObject.fwrite.php
|
||||
*
|
||||
* @return int|false
|
||||
*/
|
||||
public function fwrite(string $str, int $length = null)
|
||||
{
|
||||
$args = [$this->stream, $str];
|
||||
if (null !== $length) {
|
||||
$args[] = $length;
|
||||
}
|
||||
|
||||
return fwrite(...$args);
|
||||
}
|
||||
|
||||
/**
|
||||
* Flushes the output to a file.
|
||||
*
|
||||
* @see http://php.net/manual/en/SplFileObject.fwrite.php
|
||||
*/
|
||||
public function fflush(): bool
|
||||
{
|
||||
return fflush($this->stream);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user