PharData::offsetSet

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

PharData::offsetSetset the contents of a file within the tar/zip to those of an external file or string

Description

void PharData::offsetSet ( string $offset , string $value )

This is an implementation of the ArrayAccess interface allowing direct manipulation of the contents of a tar/zip archive using array access brackets. offsetSet is used for modifying an existing file, or adding a new file to a tar/zip archive.

Parameters

offset

The filename (relative path) to modify in a tar or zip archive.

value

Content of the file.

Return Values

No return values.

Errors/Exceptions

Throws PharException if there are any problems flushing changes made to the tar/zip archive to disk.

Examples

Example #1 A PharData::offsetSet() example

offsetSet should not be accessed directly, but instead used via array access with the [] operator.

<?php
$p 
= new PharData('/path/to/my.tar');
try {
    
// calls offsetSet
    
$p['file.txt'] = 'Hi there';
} catch (
Exception $e) {
    echo 
'Could not modify file.txt:'$e;
}
?>

See Also

  • Phar::offsetSet() - set the contents of an internal file to those of an external file


Copyright © 2010-2024 Platon Technologies, s.r.o.           Home | Man pages | tLDP | Documents | Utilities | About
Design by styleshout