class Archiver

Same name in this branch
  1. 11.x core/lib/Drupal/Core/Archiver/Attribute/Archiver.php \Drupal\Core\Archiver\Attribute\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. 10 core/lib/Drupal/Core/Archiver/Attribute/Archiver.php \Drupal\Core\Archiver\Attribute\Archiver
  4. 10 core/lib/Drupal/Core/Archiver/Annotation/Archiver.php \Drupal\Core\Archiver\Annotation\Archiver

Defines an archiver annotation 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()

Related topics

Annotations
Annotations for class discovery and metadata description.

File

core/lib/Drupal/Core/Archiver/Annotation/Archiver.php, line 21

Namespace

Drupal\Core\Archiver\Annotation
View source 
class Archiver extends Plugin {
    
    /**
     * The archiver plugin ID.
     *
     * @var string
     */
    public $id;
    
    /**
     * The human-readable name of the archiver plugin.
     *
     * @var \Drupal\Core\Annotation\Translation
     *
     * @ingroup plugin_translatable
     */
    public $title;
    
    /**
     * The description of the archiver plugin.
     *
     * @var \Drupal\Core\Annotation\Translation
     *
     * @ingroup plugin_translatable
     */
    public $description;
    
    /**
     * An array of valid extensions for this archiver.
     *
     * @var array
     */
    public $extensions;

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
Archiver::$description public property The description of the archiver plugin.
Archiver::$extensions public property An array of valid extensions for this archiver.
Archiver::$id public property The archiver plugin ID.
Archiver::$title public property The human-readable name of the archiver plugin.
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 6
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass 1
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass 1
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object. 3

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