class Archiver

Same name in this branch
  1. 11.1.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

Hierarchy

Expanded class hierarchy of Archiver

See also

\Drupal\Core\Archiver\ArchiverManager

\Drupal\Core\Archiver\ArchiverInterface

Plugin API

hook_archiver_info_alter()

3 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
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 Overriden Title Overrides
Archiver::__construct public function Constructs an archiver plugin attribute object. Overrides Plugin::__construct
AttributeBase::$class protected property The class used for this attribute class.
AttributeBase::$provider protected property The provider of the attribute class.
AttributeBase::get public function Gets the value of an attribute. Overrides AttributeInterface::get 6
AttributeBase::getClass public function Gets the class of the attribute class. Overrides AttributeInterface::getClass 1
AttributeBase::getId public function Gets the unique ID for this attribute class. Overrides AttributeInterface::getId
AttributeBase::getProvider public function Gets the name of the provider of the attribute class. Overrides AttributeInterface::getProvider
AttributeBase::setClass public function Sets the class of the attributed class. Overrides AttributeInterface::setClass 1
AttributeBase::setProvider public function Sets the name of the provider of the attribute class. Overrides AttributeInterface::setProvider