php8.5
/
Download
Home/ Manual/ reference / stream/ The streamWrapper class

The streamWrapper class

Guide Edit on GitHub ✎

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

Intro

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.

Class synopsis

class streamWrapper { }

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.

See Also

Streamwrapper

In this section

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

Source: reference/stream/streamwrapper.xml · from the official PHP manual (php/doc-en)