streamWrapper - PHP articles, tutorials and screencasts - PHP 5, MySQL, PostgreSQL, AJAX, Web 2.0

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 $streamWrapper->context ;

/* Methods */

streamWrapper::__construct ( void )

public bool streamWrapper::dir_closedir ( void )

public bool streamWrapper::dir_opendir ( string $path , int $options )

public string streamWrapper::dir_readdir ( void )

public bool streamWrapper::dir_rewinddir ( void )

public bool streamWrapper::mkdir ( string $path , int $mode , int $options )

public bool streamWrapper::rename ( string $path_from , string $path_to )

public bool streamWrapper::rmdir ( string $path , int $options )

public resource streamWrapper::stream_cast ( int $cast_as )

public void streamWrapper::stream_close ( void )

public bool streamWrapper::stream_eof ( void )

public bool streamWrapper::stream_flush ( void )

public bool streamWrapper::stream_lock ( mode $operation )

public bool streamWrapper::stream_metadata ( int $path , int $option , int $var )

public bool streamWrapper::stream_open ( string $path , string $mode , int $options , string &$opened_path )

public string streamWrapper::stream_read ( int $count )

public bool streamWrapper::stream_seek ( int $offset , int $whence = SEEK_SET )

public bool streamWrapper::stream_set_option ( int $option , int $arg1 , int $arg2 )

public array streamWrapper::stream_stat ( void )

public int streamWrapper::stream_tell ( void )

public int streamWrapper::stream_write ( string $data )

public bool streamWrapper::unlink ( string $path )

public array streamWrapper::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.

The streamWrapper class

Introduction

Class synopsis

Properties

Changelog

See Also

Table of Contents

PHP Manual