public function S3fsStream::stream_open in S3 File System 4.0.x

Same name and namespace in other branches

1. 8.3 src/StreamWrapper/S3fsStream.php \Drupal\s3fs\StreamWrapper\S3fsStream::stream_open()
2. 8.2 src/StreamWrapper/S3fsStream.php \Drupal\s3fs\StreamWrapper\S3fsStream::stream_open()

Opens file or URL.

This method is called immediately after the wrapper is initialized (e.g. by fopen() and file_get_contents()).

Note the streamWrapper::$context property is updated if a valid context is passed to the caller function.

Parameters

string $path: Specifies the URL that was passed to the original function. Note that the URL can be broken apart with parse_url(). Note that only URLs delimited by "://" are supported. ":" and ":/" while technically valid URLs, are not.

string $mode: The mode used to open the file, as detailed for fopen(). Note, remember to check if the mode is valid for the path requested.

int $options: Holds additional flags set by the streams API. It can hold one or more of the following values ORed together:

• STREAM_USE_PATH: If path is relative, search for the resource using the include_path.
• STREAM_REPORT_ERRORS: If this flag is set, you are responsible for raising errors using trigger_error() during opening of the stream. If this flag is not set, you should not raise any errors.

string $opened_path: If the path is opened successfully, and STREAM_USE_PATH is set in options, opened_path should be set to the full path of the file/resource that was actually opened.

Return value

bool Returns TRUE on success or FALSE on failure.

Overrides PhpStreamWrapperInterface::stream_open

See also

fopen()

parse_url()

http://php.net/manual/en/streamwrapper.stream-open.php

File

src/StreamWrapper/S3fsStream.php, line 680

Class

S3fsStream

Defines a Drupal s3 (s3://) stream wrapper class.

Namespace

Drupal\s3fs\StreamWrapper

Code

public function stream_open($uri, $mode, $options, &$opened_path) {

  // phpcs:enable
  if (mb_strlen($uri) > S3fsServiceInterface::MAX_URI_LENGTH) {
    return FALSE;
  }
  $this
    ->setUri($uri);
  $converted = $this
    ->convertUriToKeyedPath($uri);
  $s3options = $this
    ->getOptions();

  // Allow other modules to alter the stream open params.
  \Drupal::moduleHandler()
    ->alter('s3fs_stream_open_params', $s3options[$this->protocol], $converted);
  stream_context_set_option($this->context, $s3options);
  return parent::stream_open($converted, $mode, $options, $opened_path);
}