function PhpStreamWrapperInterface::stream_cast

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php \Drupal\Core\StreamWrapper\PhpStreamWrapperInterface::stream_cast()
  2. 8.9.x core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php \Drupal\Core\StreamWrapper\PhpStreamWrapperInterface::stream_cast()
  3. 10 core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php \Drupal\Core\StreamWrapper\PhpStreamWrapperInterface::stream_cast()

Retrieve the underlying stream resource.

This method is called in response to stream_select().

Parameters

int $cast_as: Can be STREAM_CAST_FOR_SELECT when stream_select() is calling stream_cast() or STREAM_CAST_AS_STREAM when stream_cast() is called for other uses.

Return value

resource|false The underlying stream resource or FALSE if stream_select() is not supported.

See also

stream_select()

http://php.net/manual/streamwrapper.stream-cast.php

2 methods override PhpStreamWrapperInterface::stream_cast()
DummyExternalReadOnlyWrapper::stream_cast in core/modules/file/tests/file_test/src/StreamWrapper/DummyExternalReadOnlyWrapper.php
Retrieve the underlying stream resource.
LocalStream::stream_cast in core/lib/Drupal/Core/StreamWrapper/LocalStream.php
Retrieve the underlying stream resource.

File

core/lib/Drupal/Core/StreamWrapper/PhpStreamWrapperInterface.php, line 171

Class

PhpStreamWrapperInterface
Defines a generic PHP stream wrapper interface.

Namespace

Drupal\Core\StreamWrapper

Code

public function stream_cast($cast_as);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.