PHP Manual
Streams
The streamWrapper class

The streamWrapper class

(PHP 4 >= 4.3.2, PHP 5, PHP 7)

简介

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 than 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.

类摘要

streamWrapper {

/* 属性 */

public resource $context ;

/* 方法 */

__construct ( void )

__destruct ( void )

public dir_closedir ( void ) : bool

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

public dir_readdir ( void ) : string

public dir_rewinddir ( void ) : bool

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

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

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

public stream_cast ( int $cast_as ) : resource

public stream_close ( void ) : void

public stream_eof ( void ) : bool

public stream_flush ( void ) : bool

public stream_lock ( int $operation ) : bool

public stream_metadata ( string $path , int $option , mixed $value ) : bool

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

public stream_read ( int $count ) : string

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

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

public stream_stat ( void ) : array

public stream_tell ( void ) : int

public stream_truncate ( int $new_size ) : bool

public stream_write ( string $data ) : int

public unlink ( string $path ) : bool

public url_stat ( string $path , int $flags ) : array

}

属性

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.

更新日志

版本	说明
5.0.0	Added the context property.

参见

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 a 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 metadata
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

The streamWrapper class

简介

类摘要

属性

更新日志

参见

Table of Contents