Scholar Repository
Home>Manual>Returns the full path on disk or full phar URL to the currently executing Phar archive

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


Phar::running

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

Phar::runningReturns the full path on disk or full phar URL to the currently executing Phar archive

Description

string Phar::running ([ bool $retphar = true ] )

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

If FALSE, the full path on disk to the phar archive is returned. If TRUE, a full phar URL is returned.

Return Values

Returns the filename if valid, empty string otherwise.

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"
?>

Home>Manual>Returns the full path on disk or full phar URL to the currently executing Phar archive