streamWrapper::stream_metadata
(PHP 5 >= 5.4.0, PHP 7)
streamWrapper::stream_metadata — Change stream metadata
Description
public streamWrapper::stream_metadata ( string $path , int $option , mixed $value ) : bool
This method is called 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.Parameters
-
path
-
The file path or URL to set metadata. Note that in the case of a URL, it must be a :// delimited URL. Other URL forms are not supported.
-
option
-
One of:
-
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
-
If
option
is-
STREAM_META_TOUCH
: Array consisting of two arguments of the touch() function. -
STREAM_META_OWNER_NAME
orSTREAM_META_GROUP_NAME
: The name of the owner user/group as string. -
STREAM_META_OWNER
orSTREAM_META_GROUP
: The value owner user/group argument as int. -
STREAM_META_ACCESS
: The argument of the chmod() as int.
-
Return Values
Returns true
on success or false
on failure. If option
is not implemented, false
should be returned.
© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/streamwrapper.stream-metadata.php