You are here

public function LocalStream::stream_seek in Drupal 8

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/StreamWrapper/LocalStream.php \Drupal\Core\StreamWrapper\LocalStream::stream_seek()
  2. 10 core/lib/Drupal/Core/StreamWrapper/LocalStream.php \Drupal\Core\StreamWrapper\LocalStream::stream_seek()

Seeks to specific location in a stream.

This method is called in response to fseek().

The read/write position of the stream should be updated according to the offset and whence.

Parameters

int $offset: The byte offset to seek to.

int $whence: Possible values:

  • SEEK_SET: Set position equal to offset bytes.
  • SEEK_CUR: Set position to current location plus offset.
  • SEEK_END: Set position to end-of-file plus offset.

Defaults to SEEK_SET.

Return value

bool TRUE if the position was updated, FALSE otherwise.

Overrides PhpStreamWrapperInterface::stream_seek

See also

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

File

core/lib/Drupal/Core/StreamWrapper/LocalStream.php, line 244

Class

LocalStream
Defines a Drupal stream wrapper base class for local files.

Namespace

Drupal\Core\StreamWrapper

Code

public function stream_seek($offset, $whence = SEEK_SET) {

  // fseek returns 0 on success and -1 on a failure.
  // stream_seek   1 on success and  0 on a failure.
  return !fseek($this->handle, $offset, $whence);
}