PHP: Phar::offsetExists - Manual (original) (raw)

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 1.0.0)

Phar::offsetExists — Determines whether a file exists in the phar

Description

public Phar::offsetExists(string $localName): bool

This is an implementation of the ArrayAccess interface allowing direct manipulation of the contents of a Phar archive using array access brackets.

offsetExists() is called whenever isset() is called.

Parameters

localName

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

Return Values

Returns [true](reserved.constants.php#constant.true) if the file exists within the phar, or [false](reserved.constants.php#constant.false) if not.

Examples

Example #1 A Phar::offsetExists() example

<?php $p = new Phar(dirname(__FILE__) . '/my.phar', 0, 'my.phar'); $p['firstfile.txt'] = 'first file'; $p['secondfile.txt'] = 'second file'; // the next set of lines call offsetExists() indirectly var_dump(isset($p['firstfile.txt'])); var_dump(isset($p['nothere.txt'])); ?>

The above example will output:

See Also

• Phar::offsetGet() - Gets a PharFileInfo object for a specific file
• Phar::offsetSet() - Set the contents of an internal file to those of an external file
• Phar::offsetUnset() - Remove a file from a phar