Funktsioon file_get_contents

Funktsioon file_get_contents loeb faili sisu ja tagastab selle stringina. Esimeseks parameetriks edastatakse faili tee, teiseks - lipp otsingutee kasutamiseks, kolmandaks - voo kontekst, neljandaks - nihke alguspunkt lugemiseks, viiendaks - andmete maksimaalne pikkus.

Kolmas parameeter on eriti kasulik, kui on vaja otsida faile PHP konfiguratsioonis määratud standardkataloogidest, mitte ainult absoluutselt teelt.

Süntaks

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

Parameetrid

Parameeter	Kirjeldus
`filename`	Faili tee või URL
`use_include_path`	Kui seatud väärtusele `true`, otsib funktsioon faili kataloogidest, mis on määratud include_path parameetris PHP seadistustes failis `php.ini`. Vaikimisi `false`.
`context`	Voo konteksti ressurss
`offset`	Nihe lugemise alguspunkti jaoks
`maxlen`	Loetavate andmete maksimaalne pikkus

Näide

Kohaliku faili sisu lugemine:

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

Koodi täitmise tulemus:

'abcde'

Näide

Faili osa lugemine nihke ja pikkuse määramisega:

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

Koodi täitmise tulemus:

'bcd'

Näide

Veebilehe sisu lugemine:

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

Koodi täitmise tulemus:

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

Näide

Faili otsimine include_path'ist:

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

Koodi täitmise tulemus:

'config_data'

Voo konteksti parameeter

Parameeter context võimaldab edastada voo konteksti ressursi, mis võib muuta funktsiooni käitumist failidega või võrguressurssidega töötamisel.

Funktsiooni stream_context_create poolt loodud konteksti ressurss. Kui erilisi seadeid pole vaja, võib edastada null.

Konteksti võimalused:

HTTP-päiste seadistamine päringute jaoks
Ühenduse ajalõppude seadistamine
Puhverserveri määramine
Töötamine SSL/TLS parameetritega
Failisüsteemi juurdepääsu seadistamine

Töö näide:

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

Vaata ka

funktsiooni file_put_contents,
mis kirjutab andmed faili
funktsiooni fopen,
mis avab faili
funktsiooni file,
mis loeb faili stringide massiivi