interface ArchiverInterface

Same name in this branch
  1. 11.1.x core/lib/Drupal/Core/Archiver/ArchiverInterface.php \Drupal\Core\Archiver\ArchiverInterface

@author Till Klampaeckel <till@php.net> @author Matthieu Moquet <matthieu@moquet.net> @author Nils Adermann <naderman@naderman.de>

Hierarchy

Expanded class hierarchy of ArchiverInterface

All classes that implement ArchiverInterface

File

vendor/composer/composer/src/Composer/Package/Archiver/ArchiverInterface.php, line 20

Namespace

Composer\Package\Archiver
View source 
interface ArchiverInterface {
    
    /**
     * Create an archive from the sources.
     *
     * @param string   $sources       The sources directory
     * @param string   $target        The target file
     * @param string   $format        The format used for archive
     * @param string[] $excludes      A list of patterns for files to exclude
     * @param bool     $ignoreFilters Whether to ignore filters when looking for files
     *
     * @return string The path to the written archive file
     */
    public function archive(string $sources, string $target, string $format, array $excludes = [], bool $ignoreFilters = false) : string;
    
    /**
     * Format supported by the archiver.
     *
     * @param string $format     The archive format
     * @param ?string $sourceType The source type (git, svn, hg, etc.)
     *
     * @return bool true if the format is supported by the archiver
     */
    public function supports(string $format, ?string $sourceType) : bool;

}

Members

Title Modifiers Object type Summary Overrides
ArchiverInterface::archive public function Create an archive from the sources. 2
ArchiverInterface::supports public function Format supported by the archiver. 2