PHP Manual
PrevNext

Phar::loadPhar

(no version information, might be only in CVS)

Phar::loadPhar -- Loads any phar archive with an alias

Description

bool Phar::loadPhar ( string filename [, string alias] )

This can be used to read the contents of an external Phar archive. This is most useful for assigning an alias to a phar so that subsequent references to the phar can use the shorter alias.

Parameters

filename

the full or relative path to the phar archive to open

alias

The alias that may be used to refer to the phar archive. Note that many phar archives specify an explicit alias inside the phar archive, and an E_RECOVERABLE_ERROR will be thrown if a new alias is specified in this case.

Return Values

Returns TRUE on success or FALSE on failure.

Errors/Exceptions

E_RECOVERABLE_ERROR is thrown if an alias is passed in and the phar archive already has an explicit alias

Examples

Example 1. A Phar::loadPhar() example

loadPhar can be used anywhere to load an external Phar archive, whereas mapPhar should be used in a loader stub for a Phar.

<?php
Phar::loadPhar('/path/to/phar.phar', 'my.phar');
echo file_get_contents('phar://my.phar/file.txt');
?>

See Also

Phar::mapPhar()

PrevHomeNext
Phar->getVersionUpPhar::mapPhar