Class Phalcon\Http\Message\Stream

Source on GitHub

Пространства имен Phalcon\Http\Message
Использует Phalcon\Helper\Arr, Exception, Psr\Http\Message\StreamInterface, RuntimeException
Реализует StreamInterface

PSR-7 Поток

Свойства

/**
 * @var resource | null
 */
protected handle;

/**
 * @var resource | string
 */
protected stream;

Методы

public function __construct( mixed $stream, string $mode = string );

Конструктор потока.

public function __destruct();

Закрывает поток, когда разрушается.

public function __toString(): string;

Читает все данные из потока в строку, от начала до конца.

Этот метод ДОЛЖЕН попытаться выполнить поиск начала потока перед чтением данных и прочитать поток до достижения конца.

Предупреждение: это может попытаться загрузить большой объем данных в память.

Этот метод НЕ ДОЛЖЕН вызывать исключение, чтобы соответствовать операциям приведения строк в PHP.

@see http://php.net/manual/en/language.oop5.magic.php#object.tostring

public function close(): void;

Закрывает поток и любые базовые ресурсы.

public function detach(): resource | null;

Отделяет любые базовые ресурсы от потока.

После того как поток был отсоединен, он находится в непригодном для использования состоянии.

public function eof(): bool;

Возвращает true, если поток находится в конце потока.

public function getContents(): string;

Возвращает оставшееся содержимое в строке

public function getMetadata( mixed $key = null );

Получить потоковые метаданные в виде ассоциативного массива или получить определенный ключ.

Возвращенные ключи идентичны ключам, возвращаемым из функции PHP stream_get_meta_data ().

public function getSize(): null | int;

Получите размер потока, если он известен.

public function isReadable(): bool;

Возвращает, доступен ли поток для чтения.

public function isSeekable(): bool;

Возвращает, является ли поток доступным для поиска.

public function isWritable(): bool;

Возвращает, доступен ли поток для записи.

public function read( mixed $length ): string;

Искать в начале потока.

Если поток недоступен для поиска, этот метод вызовет исключение; в противном случае он выполнит поиск seek(0).

public function seek( mixed $offset, mixed $whence = int ): void;

Устанавливает поток - существующий экземпляр

public function tell(): int;

Возвращает текущую позицию файла указателя чтения / записи

public function write( mixed $data ): int;

Записать данные в поток.