class FrxDocument in Forena Reports 8

Defines an FrxDocument item annotation object

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\forena\Annotation\FrxDocument

See also

\Drupal\forena\DocumentPluginManager

10 classes are annotated with FrxDocument

CSV in src/FrxPlugin/Document/CSV.php

Provides CSV file exports

DocRaptorPDF in forena_pdf/src/FrxPlugin/Document/DocRaptorPDF.php

Provides PDF file exports using Doc Raptor PDF Generation Service

Drupal in src/FrxPlugin/Document/Drupal.php

Provides Drupal Rendering in a themed drupal page.

EmailMerge in src/FrxPlugin/Document/EmailMerge.php

Provides MS Excel Exports

Excel in src/FrxPlugin/Document/Excel.php

Provides MS Excel Exports

... See full list

File

src/Annotation/FrxDocument.php, line 21

Namespace

Drupal\forena\Annotation

class FrxDocument extends Plugin {

  /**
   * FrxAPI Document Plugin id
   *
   * @var string
   */
  public $id;

  /**
   * Descriptive name of plugin
   *
   * @var string
   */
  public $name;

  /**
   * Extenstion of Document Type
   *
   * @var string
   */
  public $ext;

}

Members

Name	Modifiers	Type	Description	Overrides
FrxDocument::$ext	public	property	Extenstion of Document Type
FrxDocument::$id	public	property	FrxAPI Document Plugin id
FrxDocument::$name	public	property	Descriptive name of 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	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