Home/ Manual/ phar / PharData/ PharData::__construct

PharData::__construct

PHP function Edit on GitHub ✎

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

Construct a non-executable tar or zip archive object

Description

PharData::__construct(string $filename, int $flags = FilesystemIterator::SKIP_DOTS | FilesystemIterator::UNIX_PATHS, string|null $alias = null, int $format = 0)

Parameters

filename: Path to an existing tar/zip archive or to-be-created archive
flags: Flags to pass to Phar parent class RecursiveDirectoryIterator.
alias: Alias with which this Phar archive should be referred to in calls to stream functionality.
format: One of the file format constants available within the Phar class.

Errors/Exceptions

Throws BadMethodCallException if called twice; UnexpectedValueException if the Phar archive can't be opened.

Examples

A PharData::__construct() example

php

<?php
try {
    $p = new PharData('/path/to/my.tar', Phar::CURRENT_AS_FILEINFO | Phar::KEY_AS_FILENAME);
} catch (UnexpectedValueException $e) {
    die('Could not open my.tar');
} catch (BadMethodCallException $e) {
    echo 'technically, this cannot happen';
}
echo file_get_contents('phar:///path/to/my.tar/example.txt');
?>

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