Phar::running

(No version information available, might be only in CVS)

Phar::running — Returns the full path on disk or full phar URL to the currently executing Phar archive

Description

bool Phar::running ([ bool $retphar ] )

Returns the full path to the running phar archive. This is intended for use much like the __FILE__ magic constant, and only has effect inside an executing phar archive.

Inside the stub of an archive, Phar::running() returns "". Simply use __FILE__ to access the current running phar inside a stub.

Parameters

retphar

TRUE by default. If FALSE, the full path on disk to the phar archive is returned. If TRUE (default value), a full phar URL is returned.

Return Values

Returns TRUE if the filename is valid.

Examples

Example #1 A Phar::running() example

For the following example, assume the file is within phar archive /path/to/phar/my.phar and the file is located at path my/file.txt within the phar archive.

<?php
$a = Phar::running(); // $a is "phar:///path/to/my.phar"
$b = Phar::running(false); // $b is "/path/to/my.phar"
?>