SplFileObject::fseek

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

SplFileObject::fseek — Posiciona-se para uma posição

Descrição

public SplFileObject::fseek(int $offset, int $whence = SEEK_SET): int

Posiciona-se para uma posição no arquivo medida em bytes a partir do início do arquivo, obtida ao adicionar o offset à posição especificada por whence.

Parâmetros

offset

O deslocamento. Um valor negativo pode ser usado para mover-se para trás no arquivo o que é útil quando SEEK_END é usado como o valor de whence.

whence

Os valores de whence são:

  • SEEK_SET - Define a posição igual a offset bytes.
  • SEEK_CUR - Define a posição para a localização atual mais offset.
  • SEEK_END - Define a posição para o final do arquivo mais offset.

Se whence não for especificado, é assumido como SEEK_SET.

Valor Retornado

Retorna 0 se a busca for bem-sucedida, -1 caso contrário. Note que buscar além do EOF não é considerado um erro.

Exemplos

Example #1 Exemplo de SplFileObject::fseek()

<?php
$file = new SplFileObject("somefile.txt");

// Lê a primeira linha
$data = $file->fgets();

// Move de volta para o início do arquivo
// Mesmo como $file->rewind();
$file->fseek(0);
?>

Veja Também

  • fseek() - Procura (seeks) em um ponteiro de arquivo