Example class registered as stream wrapper

Last updated: Sat, 07 Jan 2012

The streamWrapper class

(No version information available, might only be in SVN)

Einführung

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

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

Hinweis:
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.

Klassenbeschreibung

streamWrapper {

/* Eigenschaften */

public resource $streamWrapper->context ;

/* Methoden */

streamWrapper::__construct ( void )

streamWrapper::__destruct ( 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 )

}

Eigenschaften

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.

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

Changelog

Version	Beschreibung
5.0.0	Added the context property.

Siehe auch

Inhaltsverzeichnis

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_write — Write to stream
streamWrapper::unlink — Delete a file
streamWrapper::url_stat — Retrieve information about a file

add a note User Contributed Notes
streamWrapper

There are no user contributed notes for this page.

streamWrapper::__construct

Example class registered as stream wrapper

Last updated: Sat, 07 Jan 2012