Funktionen file_get_contents

Funktionen file_get_contents læser indholdet af en fil og returnerer det som en streng. Til den første parameter overføres stien til filen, til den anden - flaget for inkludering af søgestien, til den tredje - strømkonteksten, til den fjerde - offset for start af læsning, til den femte - den maksimale datalængde.

Den tredje parameter er især nyttig, når man skal søge efter filer i standardmapper, angivet i PHP-konfigurationen, og ikke kun efter absolut sti.

Syntaks

phpfile_get_contents(
  string $filename,
  bool $use_include_path = false,
  ?resource $context = null,
  int $offset = 0,
  ?int $maxlen = null
): string|false

Parametre

Parameter Beskrivelse
filename Sti til fil eller URL
use_include_path Hvis sat til true, vil funktionen søge efter filen i mapperne, angivet i parameteren include_path i PHP-indstillingerne i filen php.ini. Som standard false.
context Ressource for strømkontekst
offset Offset for start af læsning
maxlen Maksimal længde af læste data

Eksempel

Læsning af indholdet af en lokal fil:

php<?php
  $res = file_get_contents('data.txt');
  echo $res;
?>

Resultat af kodeudførelse:

php'abcde'

Eksempel

Læsning af en del af en fil med angivelse af offset og længde:

php<?php
  $res = file_get_contents('data.txt', false, null, 1, 3);
  echo $res;
?>

Resultat af kodeudførelse:

php'bcd'

Eksempel

Læsning af indholdet af en webside:

php<?php
  $res = file_get_contents('https://example.com');
  echo substr($res, 0, 50) . '...';
?>

Resultat af kodeudførelse:

php'<!doctype html><html><head><title>Example D...'

Eksempel

Søgning efter fil i include_path:

php<?php
  $res = file_get_contents('config.ini', true);
  echo $res;
?>

Resultat af kodeudførelse:

php'config_data'

Parameter for strømkontekst

Parameteren context tillader at overføre en ressource for strømkontekst, som kan modificere funktionens adfærd ved arbejde med filer eller netværksressourcer.

Ressource for kontekst, oprettet af funktionen stream_context_create. Hvis der ikke kræves særlige indstillinger, kan man overføre null.

Muligheder for kontekst:

Eksempel på arbejde:

php<?php
  $opts = [
    'http' => [
      'method' => "GET",
      'header' => "Accept-language: en\r\n"
    ]
  ];
  $context = stream_context_create($opts);
  $res = file_get_contents('https://example.com', false, $context);
?>

Se også

  • funktionen file_put_contents,
    som skriver data til en fil
  • funktionen fopen,
    som åbner en fil
  • funktionen file,
    som læser en fil til en strengarray