PHP Manual: The streamWrapper class

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

class streamWrapper {

/* Properties */

public resource $context;

/* Methods */

public __construct()

public bool dir_closedir()

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

public string dir_readdir()

public bool dir_rewinddir()

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()

public bool stream_eof()

public bool stream_flush()

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,
    stringnull &$opened_path
)

public stringfalse 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 arrayfalse stream_stat()

public int stream_tell()

public bool stream_truncate(int $new_size)

public int stream_write(string $data)

public bool unlink(string $path)

public arrayfalse url_stat(string $path, int $flags)

public __destruct()

}

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.