(PHP >= 5.3.0, PECL phar >= 1.0.0)

Phar::loadPharLoads any phar archive with an alias


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, or for loading Phar archives that only contain data and are not intended for execution/inclusion in PHP scripts.



the full or relative path to the phar archive to open


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 a PharException will be thrown if a new alias is specified in this case.

Return Values

Returns TRUE on success or FALSE on failure.


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


Example #1 A Phar::loadPhar() example

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

try {
} catch (
PharException $e) {

See Also

  • Phar::mapPhar() - Reads the currently executed file (a phar) and registers its manifest

Copyright © 2010-2024 Platon Technologies, s.r.o.           Home | Man pages | tLDP | Documents | Utilities | About
Design by styleshout