php_user_filter::onCreate
streamWrapper::__construct
Streams
PHP Manual

# The streamWrapper class

(PHP 4 >= 4.3.2, PHP 5)

## Introduction

Allows you to implement your own protocol handlers and streams for use with all the other filesystem functions (such as fopen(), fread() etc.).

> Note:

> This is NOT a real class, only a prototype of how a class defining its own protocol should be.

> Note:

> Implementing the methods in other ways then described here can lead to undefined behaviour.

An instance of this class is initialized as soon as a stream function tries to access the protocol it is associated with.

## Class synopsis

streamWrapper {
/* Properties */
public resource $context ;
/* Methods */
__construct ( void )
__destruct ( void )
public bool dir_closedir ( void )
public bool dir_opendir ( string `$path` , int `$options` )
public string dir_readdir ( void )
public bool dir_rewinddir ( void )
public bool mkdir ( string `$path` , int `$mode` , int `$options` )
public bool rename ( string `$path_from` , string `$path_to` )
public bool rmdir ( string `$path` , int `$options` )
public resource stream_cast ( int `$cast_as` )
public void stream_close ( void )
public bool stream_eof ( void )
public bool stream_flush ( void )
public bool stream_lock ( int `$operation` )
public bool stream_metadata ( string `$path` , int `$option` , mixed `$value` )
public bool stream_open ( string `$path` , string `$mode` , int `$options` , string `&$opened_path` )
public string stream_read ( int `$count` )
public bool stream_seek ( int `$offset` , int `$whence` = SEEK_SET )
public bool stream_set_option ( int `$option` , int `$arg1` , int `$arg2` )
public array stream_stat ( void )
public int stream_tell ( void )
public bool stream_truncate ( int `$new_size` )
public int stream_write ( string `$data` )
public bool unlink ( string `$path` )
public array url_stat ( string `$path` , int `$flags` )
}

## Properties

resource context

  The current context, or `NULL` if no context was passed to the caller function.

  Use the stream_context_get_options() to parse the context.

  > Note:

  > This property must be public so PHP can populate it with the actual context resource.

## Changelog

Version | Description
--- | ---
5.0.0 | Added the context property.

## See Also

- Example class registered as stream wrapper
- stream_wrapper_register()
- stream_wrapper_unregister()
- stream_wrapper_restore()

## Table of Contents

- streamWrapper::__construct — Constructs a new stream wrapper
- streamWrapper::__destruct — Destructs an existing stream wrapper
- streamWrapper::dir_closedir — Close directory handle
- streamWrapper::dir_opendir — Open directory handle
- streamWrapper::dir_readdir — Read entry from directory handle
- streamWrapper::dir_rewinddir — Rewind directory handle
- streamWrapper::mkdir — Create a directory
- streamWrapper::rename — Renames a file or directory
- streamWrapper::rmdir — Removes a directory
- streamWrapper::stream_cast — Retrieve the underlaying resource
- streamWrapper::stream_close — Close an resource
- streamWrapper::stream_eof — Tests for end-of-file on a file pointer
- streamWrapper::stream_flush — Flushes the output
- streamWrapper::stream_lock — Advisory file locking
- streamWrapper::stream_metadata — Change stream options
- streamWrapper::stream_open — Opens file or URL
- streamWrapper::stream_read — Read from stream
- streamWrapper::stream_seek — Seeks to specific location in a stream
- streamWrapper::stream_set_option — Change stream options
- streamWrapper::stream_stat — Retrieve information about a file resource
- streamWrapper::stream_tell — Retrieve the current position of a stream
- streamWrapper::stream_truncate — Truncate stream
- streamWrapper::stream_write — Write to stream
- streamWrapper::unlink — Delete a file
- streamWrapper::url_stat — Retrieve information about a file

php_user_filter::onCreate
streamWrapper::__construct
Streams
PHP Manual