Phar::offsetUnset

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

Phar::offsetUnset — remove a file from a phar

Описание

public bool Phar::offsetUnset ( string $offset )

Замечание:

Для корректной работы с объектами Phar этому методу необходима установка значения php.ini phar.readonly в 0. В противном случае, будет выброшено исключение PharException.

This is an implementation of the ArrayAccess interface allowing direct manipulation of the contents of a Phar archive using array access brackets. offsetUnset is used for deleting an existing file, and is called by the unset() language construct.

Список параметров

offset - The filename (relative path) to modify in a Phar.

Возвращаемые значения

Возвращает TRUE в случае успешного завершения или FALSE в случае возникновения ошибки.

Ошибки

if phar.readonly is 1, BadMethodCallException is thrown, as modifying a Phar is only allowed when phar.readonly is set to 0. Throws PharException if there are any problems flushing changes made to the Phar archive to disk.

Примеры

Пример #1 A Phar::offsetUnset() example

$p = new Phar('/path/to/my.phar', 0, 'my.phar');
try {
    // deletes file.txt from my.phar by calling offsetUnset
    unset($p['file.txt']);
} catch (Exception $e) {
    echo 'Could not delete file.txt: ', $e;
}

Смотрите также

• Phar::offsetExists() - determines whether a file exists in the phar
• 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::unlinkArchive() - Completely remove a phar archive from disk and from memory
• Phar::delete() - Delete a file within a phar archive

User Contributed Notes

There are no user contributed notes for this page.

Описание класса phar, примеры использования класса phar.

Описание на ru2.php.net
Описание на php.ru