(PHP 5)
file_put_contents — Escreve uma string para um arquivo
Esta função é idêntica à chamar fopen(), fwrite() e fclose() sucessivamente para escrever dados em um arquivo.
Se filename
não existir, o arquivo é criado.
Do contrário, o arquivo existente é sobrescrito, a não ser que
a flag FILE_APPEND
seja definida.
filename
O caminho para o arquivo onde escrever os dados.
data
Os dados a serem escritos. Pode ser uma string, um array ou um recurso stream (explicado abaixo).
Se data
for um recurso stream, o
buffer restante desse stream será copiado para o arquivo especificado,
semelhante à utilização da stream_copy_to_stream().
Você também pode especificar o parâmetro data
como um
array unidimensional. Isso é equivalente a
file_put_contents($filename, implode('', $array)).
flags
O valor de flags
pode ser qualquer combinação das
seguintes flags (com algumas restrições), unidas com o operador binário OR
(|).
Flag | Descrição |
---|---|
FILE_USE_INCLUDE_PATH
|
Procura o arquivo filename nos diretórios de include.
Veja include_path para mais
informações.
|
FILE_APPEND
|
Se o arquivo filename já existir, acrescenta
os dados ao arquivo ao invés de sobrescrevê-lo.
|
LOCK_EX
|
Adquire um bloqueio exclusivo enquanto estiver escrevendo. |
FILE_TEXT
|
Os dados de data são escritos em modo texto.
Se a semântica unicode estiver habilitada, o encoding padrão é UTF-8.
Você pode especificar um encoding diferente criando um
contexto personalizado ou alterando o encoding padrão utilizando
stream_default_encoding(). Esta flag não pode ser
usada com FILE_BINARY e está disponível apenas
a partir do PHP 6.
|
FILE_BINARY
|
Os dados de data serão escritos em modo binário.
Esta é a opção padrão e não pode ser utilizada com
FILE_TEXT . Esta flag está disponível apenas a partir
do PHP 6.
|
context
Um recurso de contexto válido criado com stream_context_create().
A função retorna a quantidade de bytes que foi escrita no arquivo ou
FALSE
em caso de falha.
Versão | Descrição |
---|---|
5.0.0 | Adicionado suporte a contexto |
5.1.0 |
Adicionado suporte a LOCK_EX e a possibilidade de passar
um recurso de stream para o parâmetro data
|
6.0.0 |
Adicionado suporte às flags FILE_TEXT e
FILE_BINARY
|
Nota: Esta função é binary-safe.
Você pode usar uma URL como um nome de arquivo nesta função se fopen wrappers estiver habilitado. Veja fopen() para mais detalhes em como especificar o nome do arquivo e Supported Protocols and Wrappers para uma lista de protocolos URL suportados.