File::getIterator()
The external iterator receiver.
Table of Contents
Description
File::getIterator(): Traversable;
This method is a requirement to be able to implement the IteratorAggregate
interface and aims to make the object iterable directly. You won’t use this method directly, iteration control structures such as for
, foreach
and while
will call this method automatically. For this class, this method will be passed to File::stream()
.
Example
$file = new File('.\path\to\file.txt');
// Using `for` loop
for ($i = 0, $j = count($file); $i < $j; ++$i) {
echo $i . ': ' . $file[$i] . '<br>';
}
// Using `foreach` loop
foreach ($file as $k => $v) {
echo $k . ': ' . $v . '<br>';
}
File::URL()
Converts private file path to public URL.
File::_()
The dynamic method initiator.
File::__call()
Proxy for missing methods.
File::__callStatic()
Proxy for missing static methods.
File::__construct()
The constructor.
File::__get()
Proxy for missing properties.
File::__isset()
Checks if a method returns non-null value.
File::__serialize()
Provides data to be serialized.
File::__toString()
Proxy for the current object, casted as a string.
File::__unserialize()
Converts the serialized data back to its object.
File::_seal()
Gets the file permissions as numeric mode.
File::_size()
Gets the file sizes in bytes.
File::content()
Gets the file content.
File::count()
Counts number of lines in the file content.
File::exist()
Checks if the file exists.
File::from()
Object instantiator.
File::getIterator()
The external iterator receiver.
File::jsonSerialize()
Returns the data to be serialized as JSON.
File::name()
Gets the file name.
File::offsetExists()
Checks if a line at a specified index exists in the file.
File::offsetGet()
Gets a line at a specified index in the file.
File::parent()
Gets the file’s parent folder.
File::route()
Returns the file’s relative path.
File::seal()
Gets the file permissions as an octal value.
File::size()
Gets the file sizes in human readable string format.
File::stream()
Streams the file content chunk by chunk.
File::time()
Gets the file creation time.
File::type()
Gets the file MIME type.
File::x()
Gets the file extension.