class Archiver

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Archiver/Attribute/Archiver.php \Drupal\Core\Archiver\Attribute\Archiver

Defines an archiver attribute object.

Plugin Namespace: Plugin\Archiver

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

Hierarchy

  • class \Drupal\Core\Archiver\Attribute\Archiver implements \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()

File

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

Namespace

Drupal\Core\Archiver\Attribute
View on git.drupalcode.org
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(public readonly string $id, public readonly ?TranslatableMarkup $title = NULL, public readonly ?TranslatableMarkup $description = NULL, public readonly array $extensions = [], public readonly ?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.