OrderReport.php in Commerce Reporting 8

Namespace

Drupal\commerce_reports\Entity

File

src/Entity/OrderReport.php

<?php

namespace Drupal\commerce_reports\Entity;

use Drupal\Core\Entity\ContentEntityBase;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Field\BaseFieldDefinition;

/**
 * Defines the order report entity class.
 *
 * @ContentEntityType(
 *   id = "commerce_order_report",
 *   label = @Translation("Order report"),
 *   label_singular = @Translation("order report"),
 *   label_plural = @Translation("order reports"),
 *   label_count = @PluralTranslation(
 *     singular = "@count order report",
 *     plural = "@count order reports",
 *   ),
 *   bundle_label = @Translation("Order report type"),
 *   bundle_plugin_type = "commerce_report_type",
 *   handlers = {
 *     "access" = "Drupal\commerce\EntityAccessControlHandler",
 *     "permission_provider" = "Drupal\commerce\EntityPermissionProvider",
 *     "list_builder" = "Drupal\commerce_reports\ReportsListBuilder",
 *     "storage" = "Drupal\Core\Entity\Sql\SqlContentEntityStorage",
 *     "views_data" = "\Drupal\commerce_reports\OrderReportViewsData",
 *     "route_provider" = {
 *       "default" = "Drupal\Core\Entity\Routing\AdminHtmlRouteProvider",
 *     },
 *   },
 *   base_table = "commerce_order_report",
 *   admin_permission = "administer commerce_order_report",
 *   fieldable = TRUE,
 *   entity_keys = {
 *     "id" = "report_id",
 *     "bundle" = "type",
 *     "uuid" = "uuid",
 *   },
 *   links = {
 *     "collection" = "/admin/commerce/reports/orders",
 *     "canonical" = "/admin/commerce/reports/orders/{commerce_order_report}",
 *   },
 * )
 */
class OrderReport extends ContentEntityBase implements OrderReportInterface {

  /**
   * {@inheritdoc}
   */
  public function label() {
    if (!$this
      ->isNew()) {
      return t('Order report for @order_number', [
        '@order_number' => $this
          ->getOrder()
          ->getOrderNumber(),
      ]);
    }
    return parent::label();
  }

  /**
   * {@inheritdoc}
   */
  public function getOrder() {
    return $this
      ->get('order_id')->entity;
  }

  /**
   * {@inheritdoc}
   */
  public function getOrderId() {
    return $this
      ->get('order_id')->target_id;
  }

  /**
   * {@inheritdoc}
   */
  public function getCreatedTime() {
    return $this
      ->get('created')->value;
  }

  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields = parent::baseFieldDefinitions($entity_type);
    $fields['order_id'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Order'))
      ->setDescription(t('The parent order.'))
      ->setSetting('target_type', 'commerce_order')
      ->setReadOnly(TRUE);
    $fields['created'] = BaseFieldDefinition::create('created')
      ->setLabel(t('Created'))
      ->setDescription(t('The time when the order report was created.'))
      ->setReadOnly(TRUE);
    $fields['updated'] = BaseFieldDefinition::create('timestamp')
      ->setLabel(t('Updated'))
      ->setDescription(t('The time when the order report was updated.'))
      ->setReadOnly(TRUE);
    return $fields;
  }

}

Classes

Name	Description
OrderReport	Defines the order report entity class.