ArchiverInterface
in
Tags
Table of Contents
- archive() : string
- Create an archive from the sources.
- supports() : bool
- Format supported by the archiver.
Methods
archive()
Create an archive from the sources.
public
archive(string $sources, string $target, string $format[, array<string|int, mixed> $excludes = array() ][, mixed $ignoreFilters = false ]) : string
Parameters
- $sources : string
-
The sources directory
- $target : string
-
The target file
- $format : string
-
The format used for archive
- $excludes : array<string|int, mixed> = array()
-
A list of patterns for files to exclude
- $ignoreFilters : mixed = false
Return values
string —The path to the written archive file
supports()
Format supported by the archiver.
public
supports(string $format, string $sourceType) : bool
Parameters
- $format : string
-
The archive format
- $sourceType : string
-
The source type (git, svn, hg, etc.)
Return values
bool —true if the format is supported by the archiver