php8.5
Home/ Manual/ spl / splfileobject/ SplFileObject::__construct

SplFileObject::__construct

PHP function Edit on GitHub ✎

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

Construct a new file object

Description

SplFileObject::__construct(string $filename, string $mode = "r", bool $useIncludePath = false, resource|null $context = null)

Construct a new file object.

Parameters

filename

The file to read.

Fopen-wrapper

mode

The mode in which to open the file. See fopen() for a list of allowed modes.

useIncludePath

Whether to search in the include_path for filename.

context

A valid context resource created with stream_context_create().

Errors/Exceptions

Throws a RuntimeException if the filename cannot be opened.

Throws a LogicException if the filename is a directory.

Examples

SplFileObject::__construct example

This example opens the current file and iterates over its contents line by line.

php
<?php
$file = new SplFileObject(__FILE__);
foreach ($file as $line_num => $line) {
    echo "Line $line_num is $line";
}
?>

The above example will output something similar to:

output
Line 0 is <?php
Line 1 is $file = new SplFileObject(__FILE__);
Line 2 is foreach ($file as $line_num => $line) {
Line 3 is     echo "Line $line_num is $line";
Line 4 is }
Line 5 is ?>

See Also

Source: reference/spl/splfileobject/construct.xml · from the official PHP manual (php/doc-en)