0 follower

Final Class Yiisoft\DataResponse\DataStream\DataStream

All Classes | Methods
InheritanceYiisoft\DataResponse\DataStream\DataStream
ImplementsPsr\Http\Message\StreamInterface

A lazy stream that formats data only when it's being read.

This stream wraps formatted content (string or stream) and provides methods to change the data or formatter dynamically.

A formatter must be set before reading the stream, otherwise a {@see \LogicException} will be thrown.

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\DataResponse\DataStream\DataStream
__toString() Yiisoft\DataResponse\DataStream\DataStream
changeData() Changes the data. Yiisoft\DataResponse\DataStream\DataStream
changeFormatter() Changes the formatter. Yiisoft\DataResponse\DataStream\DataStream
close() Yiisoft\DataResponse\DataStream\DataStream
detach() Yiisoft\DataResponse\DataStream\DataStream
eof() Yiisoft\DataResponse\DataStream\DataStream
getContents() Yiisoft\DataResponse\DataStream\DataStream
getData() Returns the raw data. Yiisoft\DataResponse\DataStream\DataStream
getFormatter() Returns the formatter. Yiisoft\DataResponse\DataStream\DataStream
getMetadata() Yiisoft\DataResponse\DataStream\DataStream
getSize() Yiisoft\DataResponse\DataStream\DataStream
hasFormatter() Checks whether a formatter has been set. Yiisoft\DataResponse\DataStream\DataStream
isReadable() Yiisoft\DataResponse\DataStream\DataStream
isSeekable() Yiisoft\DataResponse\DataStream\DataStream
isWritable() Yiisoft\DataResponse\DataStream\DataStream
read() Yiisoft\DataResponse\DataStream\DataStream
rewind() Yiisoft\DataResponse\DataStream\DataStream
seek() Yiisoft\DataResponse\DataStream\DataStream
tell() Yiisoft\DataResponse\DataStream\DataStream
write() Yiisoft\DataResponse\DataStream\DataStream

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( mixed $data, Yiisoft\DataResponse\Formatter\FormatterInterface|null $formatter = null )
$data mixed

The raw data to be formatted.
$formatter Yiisoft\DataResponse\Formatter\FormatterInterface|null

The formatter to use.

 

                public function __construct(
    private mixed $data,
    private ?FormatterInterface $formatter = null,
) {}
__toString() public method

public string __toString ( )

                public function __toString(): string
{
    return (string) $this->getFormatted();
}
changeData() public method

Changes the data.

public void changeData ( mixed $data )
$data mixed

The new data.

 

                public function changeData(mixed $data): void
{
    $this->data = $data;
    $this->resetState();
}
changeFormatter() public method

Changes the formatter.

public void changeFormatter ( Yiisoft\DataResponse\Formatter\FormatterInterface $formatter )
$formatter Yiisoft\DataResponse\Formatter\FormatterInterface

The new formatter.

 

                public function changeFormatter(FormatterInterface $formatter): void
{
    $this->formatter = $formatter;
    $this->resetState();
}
close() public method

public void close ( )

                public function close(): void
{
    $this->getFormatted()->close();
}
detach() public method

public mixed detach ( )

                public function detach()
{
    return $this->getFormatted()->detach();
}
eof() public method

public boolean eof ( )

                public function eof(): bool
{
    return $this->getFormatted()->eof();
}
getContents() public method

public string getContents ( )

                public function getContents(): string
{
    return $this->getFormatted()->getContents();
}
getData() public method

Returns the raw data.

public mixed getData ( )
return mixed

The raw data.

 

                public function getData(): mixed
{
    return $this->data;
}
getFormatter() public method

Returns the formatter.

public Yiisoft\DataResponse\Formatter\FormatterInterface|null getFormatter ( )
return Yiisoft\DataResponse\Formatter\FormatterInterface|null

The formatter or null if not set.

 

                public function getFormatter(): ?FormatterInterface
{
    return $this->formatter;
}
getMetadata() public method

public mixed getMetadata ( ?string $key = null )
$key ?string 

                public function getMetadata(?string $key = null)
{
    return $this->getFormatted()->getMetadata($key);
}
getSize() public method

public ?int getSize ( )

                public function getSize(): ?int
{
    return $this->getFormatted()->getSize();
}
hasFormatter() public method

Checks whether a formatter has been set.

public boolean hasFormatter ( )
return boolean

Whether a formatter is set.

 

                public function hasFormatter(): bool
{
    return $this->formatter !== null;
}
isReadable() public method

public boolean isReadable ( )

                public function isReadable(): bool
{
    return $this->getFormatted()->isReadable();
}
isSeekable() public method

public boolean isSeekable ( )

                public function isSeekable(): bool
{
    return $this->getFormatted()->isSeekable();
}
isWritable() public method

public boolean isWritable ( )

                public function isWritable(): bool
{
    return $this->getFormatted()->isWritable();
}
read() public method

public string read ( integer $length )
$length integer 

                public function read(int $length): string
{
    return $this->getFormatted()->read($length);
}
rewind() public method

public void rewind ( )

                public function rewind(): void
{
    $this->getFormatted()->rewind();
}
seek() public method

public void seek ( integer $offset, integer $whence = SEEK_SET )
$offset integer
$whence integer 

                public function seek(int $offset, int $whence = SEEK_SET): void
{
    $this->getFormatted()->seek($offset, $whence);
}
tell() public method

public integer tell ( )

                public function tell(): int
{
    return $this->getFormatted()->tell();
}
write() public method

public integer write ( string $string )
$string string 

                public function write(string $string): int
{
    return $this->getFormatted()->write($string);
}