Functie file_get_contents

De functie file_get_contents leest de inhoud van een bestand en retourneert deze als een string. Aan de eerste parameter wordt het pad naar het bestand doorgegeven, aan de tweede - een vlag voor het inschakelen van het zoekpad, aan de derde - de streamcontext, aan de vierde - de offset voor het begin van het lezen, aan de vijfde - de maximale lengte van de gegevens.

De derde parameter is vooral handig wanneer je bestanden moet zoeken in de standaardmappen die zijn opgegeven in de PHP-configuratie, en niet alleen via een absoluut pad.

Syntaxis

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

Parameters

Parameter	Beschrijving
`filename`	Pad naar het bestand of URL
`use_include_path`	Indien ingesteld op `true`, zal de functie naar het bestand zoeken in de mappen die zijn opgegeven in de include_path parameter in de PHP-instellingen in het bestand `php.ini`. Standaard `false`.
`context`	Streamcontext resource
`offset`	Offset voor het begin van het lezen
`maxlen`	Maximale lengte van te lezen gegevens

Voorbeeld

Inhoud van een lokaal bestand lezen:

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

Resultaat van de code-uitvoering:

'abcde'

Voorbeeld

Een deel van een bestand lezen met opgave van offset en lengte:

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

Resultaat van de code-uitvoering:

'bcd'

Voorbeeld

Inhoud van een webpagina lezen:

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

Resultaat van de code-uitvoering:

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

Voorbeeld

Zoeken naar een bestand in de include_path:

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

Resultaat van de code-uitvoering:

'config_data'

Parameter streamcontext

De parameter context maakt het mogelijk om een streamcontext resource door te geven, die het gedrag van de functie kan aanpassen bij het werken met bestanden of netwerkbronnen.

Een contextresource, gemaakt door de functie stream_context_create. Als er geen speciale instellingen nodig zijn, kan null worden doorgegeven.

Mogelijkheden van de context:

Instellen van HTTP-headers bij verzoeken
Configureren van verbindingstime-outs
Opgeven van een proxyserver
Werken met SSL/TLS parameters
Configureren van toegang tot het bestandssysteem

Voorbeeld van gebruik:

<?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);
?>

Zie ook

de functie file_put_contents,
die gegevens naar een bestand schrijft
de functie fopen,
die een bestand opent
de functie file,
die een bestand in een array van strings leest