class PrintableFormat in Printer and PDF versions for Drupal 8+ 8

Defines an printable format annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\printable\Annotation\PrintableFormat

2 classes are annotated with PrintableFormat

PdfFormat in modules/printable_pdf/src/Plugin/PrintableFormat/PdfFormat.php

Provides a plugin to display a PDF version of a page.

PrintFormat in src/Plugin/PrintableFormat/PrintFormat.php

Provides a plugin to display a printable version of a page.

File

src/Annotation/PrintableFormat.php, line 12

Namespace

Drupal\printable\Annotation

class PrintableFormat extends Plugin {

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

  /**
   * The name of the module providing the type.
   *
   * @var string
   */
  public $module;

  /**
   * The human-readable name of the format.
   *
   * This is used as an administrative summary of what the format does.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $title;

  /**
   * Additional administrative information about the format's behavior.
   *
   * @var \Drupal\Core\Annotation\TranslationOptional
   *
   * @ingroup plugin_translatable
   */
  public $description = '';

}

Members

Name	Modifiers	Type	Description	Overrides
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
PrintableFormat::$description	public	property	Additional administrative information about the format's behavior.
PrintableFormat::$id	public	property	The plugin ID.
PrintableFormat::$module	public	property	The name of the module providing the type.
PrintableFormat::$title	public	property	The human-readable name of the format.