> For the complete documentation index, see [llms.txt](https://quantumphp.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://quantumphp.gitbook.io/docs/packages/archive/usage.md).

# Usage

Use the factory when you want the framework-managed archive service.

## Create a ZIP archive

```php
use Quantum\Archive\Enums\ArchiveType;
use Quantum\Archive\Factories\ArchiveFactory;

$archive = ArchiveFactory::get(ArchiveType::ZIP);
$archive->setName(storage_dir() . '/exports/reports.zip');

$archive->addMultipleFiles([
    'app.php' => base_dir() . '/shared/config/app.php',
    'session.php' => base_dir() . '/shared/config/session.php',
]);
```

## Create a PHAR archive

```php
use Quantum\Archive\Factories\ArchiveFactory;

$archive = ArchiveFactory::get();
$archive->setName(storage_dir() . '/builds/app.phar');
$archive->addFromString('meta.txt', 'Build generated at deploy time');
```

## Add directories and in-memory content

```php
$archive->addEmptyDir('config');
$archive->addFromString('config/readme.txt', 'Package configuration files');
```

## Extract an archive

```php
$archive->extractTo(storage_dir() . '/tmp/unpacked');
```

For PHAR, you can also pass a selected file list or entry name as the second argument.

For ZIP, that second argument is currently ignored.

## Delete entries

```php
$archive->deleteFile('meta.txt');

$archive->deleteMultipleFiles([
    'config/readme.txt',
    'app.php',
]);
```

## Access adapter-specific behavior

Use `getAdapter()` when you need a capability that is not part of the shared wrapper contract.

```php
use Quantum\Archive\Adapters\PharAdapter;

$archive = ArchiveFactory::get();
$archive->setName(storage_dir() . '/builds/app.phar');

$adapter = $archive->getAdapter();

if ($adapter instanceof PharAdapter) {
    $adapter->removeArchive();
}
```

That pattern is safe only when you know which adapter the factory resolved.

## Common pitfalls

* Forgetting `setName()` makes the first real operation fail.
* Reusing `ArchiveFactory::get()` later in the same process gives you the same archive instance for that adapter type.
* `addMultipleFiles()` is all-or-nothing only at the return-value level; if one later add fails, earlier files may already be in the archive.
* ZIP extractions always extract the full archive, even if you pass a file list.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://quantumphp.gitbook.io/docs/packages/archive/usage.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.