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.streamWrapper
Почист и полокален преглед на PHP референцата, со задржана структура од PHP.net и подобра читливост за примери, секции и белешки.
streamWrapper
Референца за `class.streamwrapper.php` со подобрена типографија и навигација.
Класата streamWrapper
(PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8)
Вовед
Ви овозможува да имплементирате сопствени рачки за протоколи и потоци за употреба со сите други функции на датотечниот систем (како што се fopen(), fread() итн.).
Забелешка:
, повикана за време на настан. NOT вистинска класа, само прототип за тоа како треба да изгледа класа што дефинира сопствен протокол.
Забелешка:
Имплементирањето на методите на начин различен од опишаниот овде може да доведе до недефинирано однесување.
Инстанца од оваа класа се иницијализира штом функцијата за поток се обиде да пристапи до протоколот со кој е поврзана.
Синопсис на класата
Својства
- resource context
-
Тековниот context, или
nullако не е предаден контекст на повикувачката функција.Користете го stream_context_get_options() за парсирање на контекстот.
Забелешка:
Ова својство must да биде јавно за PHP да може да го пополни со вистинскиот ресурс на контекстот.
Содржина
- 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 — Советувачко заклучување на датотеки
- 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 — Преземи информации за датотека
Белешки од корисници 4 белешки
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#125220a 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);
}
?>