PHP: get a PharFileInfo object for a specific file

Description

int Phar::offsetGet ( string $offset )

This is an implementation of the ArrayAccess interface allowing direct manipulation of the contents of a Phar archive using array access brackets. offsetGet is used for retrieving files from a Phar archive.

Parameters

offset: The filename (relative path) to look for in a Phar.

Return Values

A PharFileInfo object is returned that can be used to iterate over a file's contents or to retrieve information about the current file.

Errors/Exceptions

This method throws BadMethodCallException if the file does not exist in the Phar archive.

Examples

Example #1 A Phar::offsetGet() example

As with all classes that implement the ArrayAccess interface, offsetGet is automatically called when using the [] angle bracket operator


<?php

$p = new Phar(dirname(__FILE__) . '/myphar.phar', 0, 'myphar.phar');

$p['exists.txt'] = "file exists\n";

try {

    // automatically calls offsetGet()

    echo $p['exists.txt'];

    echo $p['doesnotexist.txt'];

} catch (BadMethodCallException $e) {

    echo $e;

}

?>

The above example will output:

file exists
Entry doesnotexist.txt does not exist

Phar::offsetGet

Description

Parameters

Return Values

Errors/Exceptions

Examples

See Also