Documentation

Horde_Stream_Wrapper_String
in package

A stream wrapper that will treat a native PHP string as a stream.

Tags
author

Chuck Hagenbuch chuck@horde.org

author

Michael Slusarz slusarz@horde.org

category

Horde

copyright

2007-2017 Horde LLC

license

http://www.horde.org/licenses/bsd BSD

Table of Contents

WRAPPER_NAME  = 'horde-stream-wrapper-string'
$context  : resource
The current context.
$_pos  : int
String position.
$_string  : string
The string.
$_id  : int
Unique ID tracker for the streams.
getStream()  : resource
Create a stream from a PHP string.
stream_close()  : mixed
stream_eof()  : mixed
stream_open()  : mixed
stream_read()  : mixed
stream_seek()  : mixed
stream_stat()  : mixed
stream_tell()  : mixed
stream_write()  : mixed

Constants

WRAPPER_NAME

public mixed WRAPPER_NAME = 'horde-stream-wrapper-string'

Properties

$context

The current context.

public resource $context

$_pos

String position.

protected int $_pos

$_string

The string.

protected string $_string

$_id

Unique ID tracker for the streams.

private static int $_id = 0

Methods

getStream()

Create a stream from a PHP string.

public static getStream(string &$string) : resource
Parameters
$string : string

A PHP string variable.

Tags
since
2.1.0
Return values
resource

A PHP stream pointing to the variable.

stream_close()

public stream_close() : mixed
Tags
see
streamWrapper::stream_close()
Return values
mixed

stream_eof()

public stream_eof() : mixed
Tags
see
streamWrapper::stream_eof()
Return values
mixed

stream_open()

public stream_open(mixed $path, mixed $mode, mixed $options, mixed &$opened_path) : mixed
Parameters
$path : mixed
$mode : mixed
$options : mixed
$opened_path : mixed
Tags
see
streamWrapper::stream_open()
Return values
mixed

stream_read()

public stream_read(mixed $count) : mixed
Parameters
$count : mixed
Tags
see
streamWrapper::stream_read()
Return values
mixed

stream_seek()

public stream_seek(mixed $offset, mixed $whence) : mixed
Parameters
$offset : mixed
$whence : mixed
Tags
see
streamWrapper::stream_seek()
Return values
mixed

stream_stat()

public stream_stat() : mixed
Tags
see
streamWrapper::stream_stat()
Return values
mixed

stream_tell()

public stream_tell() : mixed
Tags
see
streamWrapper::stream_tell()
Return values
mixed

stream_write()

public stream_write(mixed $data) : mixed
Parameters
$data : mixed
Tags
see
streamWrapper::stream_write()
Return values
mixed

Search results