php8.5
Home/ Manual/ phar / Phar/ Phar::offsetExists

Phar::offsetExists

PHP function Edit on GitHub ✎

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

Determines whether a file exists in the phar

Description

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 if the file exists within the phar, or false if not.

Examples

A Phar::offsetExists() example

php
<?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:

output
bool(true)
bool(false)

See Also

Source: reference/phar/Phar/offsetExists.xml · from the official PHP manual (php/doc-en)