function PhpStreamWrapperInterface::stream_metadata
Same name in other branches
- 9 core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php \Drupal\Core\StreamWrapper\PhpStreamWrapperInterface::stream_metadata()
- 10 core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php \Drupal\Core\StreamWrapper\PhpStreamWrapperInterface::stream_metadata()
- 11.x core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php \Drupal\Core\StreamWrapper\PhpStreamWrapperInterface::stream_metadata()
Sets metadata on the stream.
Parameters
string $path: A string containing the URI to the file to set metadata on.
int $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().
mixed $value: 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 of the owner user/group as integer.
- STREAM_META_ACCESS: The argument of the chmod() as integer.
Return value
bool Returns TRUE on success or FALSE on failure. If $option is not implemented, FALSE should be returned.
See also
http://php.net/manual/streamwrapper.stream-metadata.php
2 methods override PhpStreamWrapperInterface::stream_metadata()
- LocalStream::stream_metadata in core/
lib/ Drupal/ Core/ StreamWrapper/ LocalStream.php - Sets metadata on the stream.
- ReadOnlyStream::stream_metadata in core/
lib/ Drupal/ Core/ StreamWrapper/ ReadOnlyStream.php - Does not change meta data as this is a read-only stream wrapper.
File
-
core/
lib/ Drupal/ Core/ StreamWrapper/ PhpStreamWrapperInterface.php, line 116
Class
- PhpStreamWrapperInterface
- Defines a generic PHP stream wrapper interface.
Namespace
Drupal\Core\StreamWrapperCode
public function stream_metadata($path, $option, $value);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.