Erebot  latest
A modular IRC bot for PHP 5.3+
Erebot\XGlobStream Class Reference

A stream wrapper which performs a glob on files and returns the content of all matching files, wrapped in XML boilerplate. More...

+ Inheritance diagram for Erebot\XGlobStream:

Public Member Functions

 stream_close ()
 
 stream_eof ()
 
 stream_open ($path, $mode, $options, &$openedPath)
 
 stream_read ($count)
 
 stream_seek ($offset, $whence)
 
 stream_tell ()
 
- Public Member Functions inherited from Erebot\StreamWrapperBase
 __construct ()
 Constructs a new instance of this stream wrapper. More...
 
 stream_close ()
 Close a resource. More...
 
 stream_eof ()
 Tests for end-of-file on a file pointer. More...
 
 stream_open ($path, $mode, $options, &$openedPath)
 Opens file or URL. More...
 
 stream_read ($count)
 Read from stream. More...
 
 stream_seek ($offset, $whence)
 Seeks to specific location in a stream. More...
 
 stream_stat ()
 Retrieve information about a file resource. More...
 
 stream_tell ()
 Retrieve the current position of a stream. More...
 
 url_stat ($path, $flags)
 Retrieve information about a file. More...
 

Public Attributes

 $context
 Stream context, set automatically by PHP.
 
const TAG = 'wrapping'
 The XML tag used to wrap the content.
 
const XMLNS = 'http://www.erebot.net/xmlns/xglob'
 The XML namespace the content will be wrapped into.
 
- Public Attributes inherited from Erebot\StreamWrapperBase
const SEEK_CUR = SEEK_CUR
 Set position to current location plus offset.
 
const SEEK_END = SEEK_END
 Set position to end-of-file plus offset.
 
const SEEK_SET = SEEK_SET
 Set position equal to offset bytes.
 
const STREAM_REPORT_ERRORS = STREAM_REPORT_ERRORS
 Whether the stream wrapper should report errors or not. More...
 
const STREAM_URL_STAT_LINK = STREAM_URL_STAT_LINK
 For links, whether to return information about the link itself or the resource it links to. More...
 
const STREAM_URL_STAT_QUIET = STREAM_URL_STAT_QUIET
 Whether to report errors in Erebot::StreamWrapperBase::url_stat() or not. More...
 
const STREAM_USE_PATH = STREAM_USE_PATH
 If path is relative, search for the resource using the include_path.
 

Protected Attributes

 $content
 Content of the stream.
 
 $position
 Current position in the stream.
 

Detailed Description

A stream wrapper which performs a glob on files and returns the content of all matching files, wrapped in XML boilerplate.

Provides a PHP stream wrapper for files with a glob-like feature.

Definition at line 32 of file XGlobStream.php.


The documentation for this class was generated from the following file: