streamWrapper::stream_open

(PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8)

streamWrapper::stream_openAbre arquivo ou URL

Descrição

public streamWrapper::stream_open(
    string $path,
    string $mode,
    int $options,
    ?string &$opened_path
): bool

Este método é chamado imediatamente após o empacotador ser inicializado (por exemplo por fopen() e file_get_contents()).

Parâmetros

path

Especifica a URL que foi passada à função original.

Note:

A URL pode ser quebrada em partes com parse_url(). Note que apenas URLs delimitadas por :// são suportadas. : e :/ são delimitadores tecnicamente válidos, porém não suportados.

mode

O modo usado para abrir o arquivo, como detalhado para fopen().

Note:

Importante lembrar de verificar se o parâmetro mode é válido para o caminho (path) requisitado.

options

Contém opções adicionais definidas pela API de fluxos. Pode conter uma ou mais das opcções a seguir somadas (com a operação OR).

Opção Descrição
STREAM_USE_PATH Se o caminho path for relativo, a pesquisa pelo recurso utilizará include_path.
STREAM_REPORT_ERRORS Se esta opção estiver definida, o programador é responsável por emitir erros usando trigger_error() durante abertura do fluxo. Se não estiver definida, o programador não deve emitir erros.
opened_path

Se o caminho path for aberto com sucesso, e STREAM_USE_PATH estiver definida em options, opened_path deve ser definida para o caminho completo do arquivo/recurso que foi realmente aberto.

Valor Retornado

Retorna true em caso de sucesso ou false em caso de falha.

Erros/Exceções

Emite um E_WARNING se a chamada a este método falhar (ou seja, não implementado).

Notas

Note:

A propriedade streamWrapper::$context será atualizada se um contexto válido for passado para a função invocadora.

Veja Também

  • fopen() - Abre um arquivo ou URL
  • parse_url() - Analisa uma URL e retorna seus componentes