class PdfGenerator in PDF generator API 8

Defines an PDF generator annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\pdf_api\Annotation\PdfGenerator

4 files declare their use of PdfGenerator

DompdfGenerator.php in src/Plugin/PdfGenerator/DompdfGenerator.php

Contains \Drupal\pdf_api\Plugin\DompdfGenerator.

MpdfGenerator.php in src/Plugin/PdfGenerator/MpdfGenerator.php

Contains \Drupal\pdf_api\Plugin\MpdfGenerator.

TcpdfGenerator.php in src/Plugin/PdfGenerator/TcpdfGenerator.php

Contains \Drupal\pdf_api\Plugin\TcpdfGenerator.

WkhtmltopdfGenerator.php in src/Plugin/PdfGenerator/WkhtmltopdfGenerator.php

Contains \Drupal\pdf_api\Plugin\WkhtmltopdfGenerator.

4 classes are annotated with PdfGenerator

DompdfGenerator in src/Plugin/PdfGenerator/DompdfGenerator.php

A PDF generator plugin for the dompdf library.

MpdfGenerator in src/Plugin/PdfGenerator/MpdfGenerator.php

A PDF generator plugin for the mPDF library.

TcpdfGenerator in src/Plugin/PdfGenerator/TcpdfGenerator.php

A PDF generator plugin for the mPDF library.

WkhtmltopdfGenerator in src/Plugin/PdfGenerator/WkhtmltopdfGenerator.php

A PDF generator plugin for the WKHTMLTOPDF library.

File

src/Annotation/PdfGenerator.php, line 17

Contains \Drupal\pdf_api\Annotation\PdfGenerator.

Namespace

Drupal\pdf_api\Annotation

class PdfGenerator extends Plugin {

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

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

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

  /**
   * Additional administrative information about the generator's behavior.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation (optional)
   */
  public $description = '';

}

Members

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