Класс streamWrapper
(PHP 4 >= 4.3.2, PHP 5, PHP 7)
Введение
Позволяет реализовывать собственные обработчики протоколов и потоков для дальнейшего использования со всеми функциями по работе с файловой системой (такими как fopen(), fread() и т.п.).
Замечание:
Это НЕ реальный класс, а лишь прототип, предоставленный в качестве наглядного пособия.
Замечание:
Реализация методов, отличная от описанной здесь, может привести к нестабильному поведению.
Объект класса инициализируется в тот момент, когда потоковая функция пытается получить доступ к протоколу, с которым этот класс ассоциирован.
Обзор классов
Свойства
- resource context
-
Текущий контекстили
NULL, если в вызывающую функцию не было передано никакого контекста.Используйте функцию stream_context_get_options() для анализа и разбора контекста.
Замечание:
Это свойство должно быть общедоступным (иметь модификатор public), чтобы PHP мог ассоциировать его с актуальным контекстом.
Список изменений
| Версия | Описание |
|---|---|
| 5.0.0 | Добавлено свойство context. |
Содержание
- streamWrapper::__construct — Создает новый объект-обертку для потока
- streamWrapper::__destruct — Уничтожает существующую обертку потока
- streamWrapper::dir_closedir — Обработчик закрытия директории
- streamWrapper::dir_opendir — Обработчик открытия директории
- streamWrapper::dir_readdir — Обработчик чтения содержимого директории
- streamWrapper::dir_rewinddir — Обработчик перемещения на начало директории
- streamWrapper::mkdir — Создание директории
- streamWrapper::rename — Переименовывает файл или директорию
- streamWrapper::rmdir — Удаляет директорию
- streamWrapper::stream_cast — Получает ресурс уровнем ниже
- streamWrapper::stream_close — Закрывает ресурс
- streamWrapper::stream_eof — Проверяет достижение конца файла по файловому указателю
- streamWrapper::stream_flush — Сохранение данных вывода
- streamWrapper::stream_lock — Advisory file locking
- streamWrapper::stream_metadata — Изменяет настройки потока
- streamWrapper::stream_open — Открывает файл или URL
- streamWrapper::stream_read — Читает из потока
- streamWrapper::stream_seek — Перемещение на заданную позицию в потоке
- streamWrapper::stream_set_option — Изменение настроек потока
- streamWrapper::stream_stat — Получение информации о файловом ресурсе
- streamWrapper::stream_tell — Определение текущей позиции потока
- streamWrapper::stream_truncate — Усечение потока
- streamWrapper::stream_write — Запись в поток
- streamWrapper::unlink — Удаление файла
- streamWrapper::url_stat — Получение информации о файле
Коментарии
a php interface for wrapper
<?php
interface WrapperInterface
{
/**
* resource context
*
* @var resource
*/
//public $context;
/**
* constructor
*
*/
public function __construct();
/**
*
*
* @return bool
*/
public function dir_closedir();
/**
* Enter description here...
*
* @param string $path
* @param int $options
* @return bool
*/
public function dir_opendir($path , $options);
/**
* Enter description here...
*
* @return string
*/
public function dir_readdir();
/**
* Enter description here...
*
* @return bool
*/
public function dir_rewinddir();
/**
* Enter description here...
*
* @param string $path
* @param int $mode
* @param int $options
* @return bool
*/
public function mkdir($path , $mode , $options);
/**
* Enter description here...
*
* @param string $path_from
* @param string $path_to
* @return bool
*/
public function rename($path_from , $path_to);
/**
* Enter description here...
*
* @param string $path
* @param int $options
* @return bool
*/
public function rmdir($path , $options);
/**
* Enter description here...
*
* @param int $cast_as
* @return resource
*/
public function stream_cast($cast_as);
/**
* Enter description here...
*
*/
public function stream_close();
/**
* Enter description here...
*
* @return bool
*/
public function stream_eof();
/**
* Enter description here...
*
* @return bool
*/
public function stream_flush();
/**
* Enter description here...
*
* @param mode $operation
* @return bool
*/
public function stream_lock($operation);
/**
* Enter description here...
*
* @param string $path
* @param string $mode
* @param int $options
* @param string &$opened_path
* @return bool
*/
public function stream_open($path , $mode , $options , &$opened_path);
/**
* Enter description here...
*
* @param int $count
* @return string
*/
public function stream_read($count);
/**
* Enter description here...
*
* @param int $offset
* @param int $whence = SEEK_SET
* @return bool
*/
public function stream_seek($offset , $whence = SEEK_SET);
/**
* Enter description here...
*
* @param int $option
* @param int $arg1
* @param int $arg2
* @return bool
*/
public function stream_set_option($option , $arg1 , $arg2);
/**
* Enter description here...
*
* @return array
*/
public function stream_stat();
/**
* Enter description here...
*
* @return int
*/
public function stream_tell();
/**
* Enter description here...
*
* @param string $data
* @return int
*/
public function stream_write($data);
/**
* Enter description here...
*
* @param string $path
* @return bool
*/
public function unlink($path);
/**
* Enter description here...
*
* @param string $path
* @param int $flags
* @return array
*/
public function url_stat($path , $flags);
}
?>
It's worth noting that the interface defined by yannick at gmail should not always be implemented by a stream wrapper class, as several of the methods should not be implemented if the class has no use for them (as per the manual).
Specifically, mkdir, rename, rmdir, and unlink are methods that "should not be defined" if the wrapper has no use for them. The consequence is that the appropriate error message will not be returned.
If the interface is implemented, you won't have the flexibility to not implement those methods.
Not trying to be academic, but it was useful for me.
Here is a very simple stream wrapper which calls your callback function for reads:
<?php
class CallbackUrl
{
const WRAPPER_NAME = 'callback';
public $context;
private $_cb;
private $_eof = false;
private static $_isRegistered = false;
public static function getContext($cb)
{
if (!self::$_isRegistered) {
stream_wrapper_register(self::WRAPPER_NAME, get_class());
self::$_isRegistered = true;
}
if (!is_callable($cb)) return false;
return stream_context_create(array(self::WRAPPER_NAME => array('cb' => $cb)));
}
public function stream_open($path, $mode, $options, &$opened_path)
{
if (!preg_match('/^r[bt]?$/', $mode) || !$this->context) return false;
$opt = stream_context_get_options($this->context);
if (!is_array($opt[self::WRAPPER_NAME]) ||
!isset($opt[self::WRAPPER_NAME]['cb']) ||
!is_callable($opt[self::WRAPPER_NAME]['cb'])) return false;
$this->_cb = $opt[self::WRAPPER_NAME]['cb'];
return true;
}
public function stream_read($count)
{
if ($this->_eof || !$count) return '';
if (($s = call_user_func($this->_cb, $count)) == '') $this->_eof = true;
return $s;
}
public function stream_eof()
{
return $this->_eof;
}
}
class Test {
private $_s;
public function __construct($s)
{
$this->_s = $s;
}
public function read($count) {
return fread($this->_s, $count);
}
}
$t = new Test(fopen('/etc/services', 'r'));
$fd = fopen('callback://', 'r', false, CallbackUrl::getContext(array($t, 'read')));
while(($buf = fread($fd, 128)) != '') {
print $buf;
}
?>
THIS METHODS NOT REQUIRED, you can implement only part of their: directories, files, etc.For example, "glob://" support minimal syntax, glob() more powerful, you can replace/extend native wrapper: check options in table https://www.php.net/manual/ru/wrappers.glob , you need create wrapper only with 'dir_...dir' methods. For more info, see https://www.php.net/manual/en/class.globiterator.php#125220