PHP Function Reference

PHP streamWrapper stream_metadata() Method



The PHP streamWrapper::stream_metadata() method is used to change the stream metadata. This method is called in response to set metadata on the stream. It is called when one of the following functions is called on a stream URL:

Please note that some of these operations may not be available on your system.

Syntax

public streamWrapper::stream_metadata(path, option, value)

Parameters

path Required. Specify the file path or URL to set metadata. In the case of a URL, it must be a :// delimited URL. Other URL forms are not supported.
option Required. It can be one of the following:
  • STREAM_META_TOUCH - The method was called in response to touch()
  • STREAM_META_OWNER_NAME - The method was called in response to chown() with string parameter
  • STREAM_META_OWNER - The method was called in response to chown()
  • STREAM_META_GROUP_NAME - The method was called in response to chgrp()
  • STREAM_META_GROUP - The method was called in response to chgrp()
  • STREAM_META_ACCESS - The method was called in response to chmod()
value Required. If option is:
  • STREAM_META_TOUCH - Array consisting of two arguments of the touch() function.
  • STREAM_META_OWNER_NAME or STREAM_META_GROUP_NAME - The name of the owner user/group as string.
  • STREAM_META_OWNER or STREAM_META_GROUP - The value owner user/group argument as int.
  • STREAM_META_ACCESS - The argument of the chmod() as int.

Return Value

Returns true on success or false on failure. If option is not implemented, false is returned.


❮ PHP Streams Reference