Класс CallbackStream

Реализация потоков PSR HTTP.

Это отличается от потока Laminas\Diactoros\Callback тем, что позволяет использовать echo внутри обратного вызова и изящно обрабатывает случай, когда обратный вызов не возвращает строку.

В идеале мы можем исправить/обновить diactoros, но нам нужно разобраться с этим в проекте diactoros. До тех пор мы будем использовать эту обходную реализацию для обеспечения обратной совместимости с существующими приложениями CakePHP.

Пространство имен: Cake\Http

Краткое описание свойств

$callback protected

callable|null

Краткое описание методов

__construct() public
__toString() public

Считывает все данные из потока в строку, от начала до конца.
attach() public

Присоединяет новую функцию обратного вызова к экземпляру.
close() public

Закрывает поток и все связанные ресурсы.
detach() public

Отделяет любые связанные ресурсы от потока.
eof() public

Возвращает true, если поток достиг конца.
getContents() public

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

Получает метаданные потока в виде ассоциативного массива или извлекает определённый ключ.
getSize() public

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

Возвращает, является ли поток читаемым.
isSeekable() public

Возвращает, допускает ли поток поиск.
isWritable() public

Возвращает, является ли поток записываемым.
read() public

Считывает данные из потока.
rewind() public

Перемещает указатель на начало потока.
seek() public

Перемещает указатель на определённую позицию в потоке.
tell() public

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

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

Подробное описание методов

__construct() public

__construct(callable $callback)

Параметры

callable $callback

Исключения

Exception\InvalidArgumentException

__toString() public

__toString(): string

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

Этот метод ОБЯЗАН попытаться переместиться к началу потока перед чтением данных и читать поток до тех пор, пока не будет достигнут конец.

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

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

Возвращаемое значение

string

attach() public

attach(callable $callback): void

Присоединяет новую функцию обратного вызова к экземпляру.

Параметры

callable $callback

Возвращаемое значение

void

close() public

close(): void

Закрывает поток и все связанные ресурсы.

Возвращаемое значение

void

detach() public

detach(): null|callable

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

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

Возвращаемое значение

null|callable

eof() public

eof(): bool

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

Возвращаемое значение

bool

getContents() public

getContents(): string

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

Возвращаемое значение

string

getMetadata() public

getMetadata(string $key = null): array|mixed|null

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

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

Параметры

string $key optional

Возвращаемое значение

array|mixed|null

getSize() public

getSize(): ?int

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

Возвращаемое значение

?int

isReadable() public

isReadable(): bool

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

Возвращаемое значение

bool

isSeekable() public

isSeekable(): bool

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

Возвращаемое значение

bool

isWritable() public

isWritable(): bool

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

Возвращаемое значение

bool

read() public

read(int $length): string

Считывает данные из потока.

Параметры

int $length

Возвращаемое значение

string

rewind() public

rewind(): void

Перемещает указатель на начало потока.

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

Возвращаемое значение

void

seek() public

seek(int $offset, int $whence = SEEK_SET): void

Перемещает указатель на определённую позицию в потоке.

Параметры

int $offset
int $whence optional

Возвращаемое значение

void

tell() public

tell(): int

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

Возвращаемое значение

int

write() public

write(string $string): void

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

Параметры

string $string

Возвращаемое значение

void

Подробное описание свойств

`$callback` protected

Тип

callable|null

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.2/class-Cake.Http.CallbackStream.html

Класс CallbackStream

Краткое описание свойств

Краткое описание методов

__construct() public

__toString() public

attach() public

close() public

detach() public

eof() public

getContents() public

getMetadata() public

getSize() public

isReadable() public

isSeekable() public

isWritable() public

read() public

rewind() public

seek() public

tell() public

write() public

Подробное описание методов

__construct() public

Параметры

Исключения

__toString() public

Возвращаемое значение

attach() public

Параметры

Возвращаемое значение

close() public

Возвращаемое значение

detach() public

Возвращаемое значение

eof() public

Возвращаемое значение

getContents() public

Возвращаемое значение

getMetadata() public

Параметры

Возвращаемое значение

getSize() public

Возвращаемое значение

isReadable() public

Возвращаемое значение

isSeekable() public

Возвращаемое значение

isWritable() public

Возвращаемое значение

read() public

Параметры

Возвращаемое значение

rewind() public

Возвращаемое значение

seek() public

Параметры

Возвращаемое значение

tell() public

Возвращаемое значение

write() public

Параметры

Возвращаемое значение

Подробное описание свойств

$callback protected

Тип

`$callback` protected