class Archiver

Same name in other branches
  1. 9 core/lib/Drupal/Core/Archiver/Annotation/Archiver.php \Drupal\Core\Archiver\Annotation\Archiver
  2. 8.9.x core/lib/Drupal/Core/Archiver/Annotation/Archiver.php \Drupal\Core\Archiver\Annotation\Archiver
  3. 11.x core/lib/Drupal/Core/Archiver/Attribute/Archiver.php \Drupal\Core\Archiver\Attribute\Archiver
  4. 11.x core/lib/Drupal/Core/Archiver/Annotation/Archiver.php \Drupal\Core\Archiver\Annotation\Archiver

Defines an archiver attribute object.

Plugin Namespace: Plugin\Archiver

For a working example, see \Drupal\system\Plugin\Archiver\Zip

Attributes

#[\Attribute(\Attribute::TARGET_CLASS)]

Hierarchy

  • class \Drupal\Core\Archiver\Attribute\Archiver extends \Drupal\Component\Plugin\Attribute\Plugin

Expanded class hierarchy of Archiver

See also

\Drupal\Core\Archiver\ArchiverManager

\Drupal\Core\Archiver\ArchiverInterface

Plugin API

hook_archiver_info_alter()

4 files declare their use of Archiver
ArchiverManager.php in core/lib/Drupal/Core/Archiver/ArchiverManager.php
Tar.php in core/modules/system/src/Plugin/Archiver/Tar.php
UpdateTestArchiver.php in core/modules/update/tests/modules/update_test/src/Plugin/Archiver/UpdateTestArchiver.php
Zip.php in core/modules/system/src/Plugin/Archiver/Zip.php

File

core/lib/Drupal/Core/Archiver/Attribute/Archiver.php, line 20

Namespace

Drupal\Core\Archiver\Attribute
View source 
class Archiver extends Plugin {
    
    /**
     * Constructs an archiver plugin attribute object.
     *
     * @param string $id
     *   The archiver plugin ID.
     * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $title
     *   The human-readable name of the archiver plugin.
     * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $description
     *   The description of the archiver plugin.
     * @param array $extensions
     *   An array of valid extensions for this archiver.
     * @param class-string|null $deriver
     *   (optional) The deriver class.
     */
    public function __construct(string $id, ?TranslatableMarkup $title = NULL, ?TranslatableMarkup $description = NULL, array $extensions = [], ?string $deriver = NULL) {
    }

}

Members

Title Modifiers Object type Summary
Archiver::__construct public function Constructs an archiver plugin attribute object.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.