class CommerceReportType in Commerce Reporting 8

Defines the commerce report type plugin annotation object.

Plugin namespace: Plugin\Commerce\ReportType.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\commerce_reports\Annotation\CommerceReportType

See also

Plugin API

4 classes are annotated with CommerceReportType

OrderItemsReport in src/Plugin/Commerce/ReportType/OrderItemsReport.php

Provides the Order Items Report.

OrderReport in src/Plugin/Commerce/ReportType/OrderReport.php

Provides the basic Order Report.

PromotionReport in src/Plugin/Commerce/ReportType/PromotionReport.php

Provide a report for Promotions on behalf of commerce_promotion.

TaxReport in src/Plugin/Commerce/ReportType/TaxReport.php

Provide a report for Taxes on behalf of commerce_tax.

File

src/Annotation/CommerceReportType.php, line 16

Namespace

Drupal\commerce_reports\Annotation

class CommerceReportType extends Plugin {

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

  /**
   * The commerce report type label.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $label;

  /**
   * The commerce report type create label.
   *
   * @ingroup plugin_translatable
   *
   * @var \Drupal\Core\Annotation\Translation
   */
  public $create_label;

}

Members

Name	Modifiers	Type	Description	Overrides
CommerceReportType::$create_label	public	property	The commerce report type create label.
CommerceReportType::$id	public	property	The plugin ID.
CommerceReportType::$label	public	property	The commerce report type label.
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