You are here

class LinkStatusHandler in Link checker 8

Defines a Link status handler plugin item annotation object.

Hierarchy

Expanded class hierarchy of LinkStatusHandler

See also

\Drupal\linkchecker\Plugin\LinkStatusHandlerManager

Plugin API

2 classes are annotated with LinkStatusHandler
Repair301 in src/Plugin/LinkStatusHandler/Repair301.php
Repairs 301 links.
Unpublish404 in src/Plugin/LinkStatusHandler/Unpublish404.php
Unpublish entities on 404 link response.

File

src/Annotation/LinkStatusHandler.php, line 15

Namespace

Drupal\linkchecker\Annotation
View source
class LinkStatusHandler extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The label of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * An array of status codes which the handler supports.
   *
   * @var array
   */
  public $status_codes = [];

  /**
   * Flag that indicates if plugin is enabled.
   *
   * This flag will help to disable some plugins with hook info alter.
   *
   * @var bool
   */
  public $enabled = TRUE;

}

Members

Namesort descending Modifiers Type Description Overrides
LinkStatusHandler::$enabled public property Flag that indicates if plugin is enabled.
LinkStatusHandler::$id public property The plugin ID.
LinkStatusHandler::$label public property The label of the plugin.
LinkStatusHandler::$status_codes public property An array of status codes which the handler supports.
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 5
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
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
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
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. 2