You are here

class ReportTable in Commerce Reporting 8

Table report controller.

Hierarchy

Expanded class hierarchy of ReportTable

File

src/Controller/ReportTable.php, line 13

Namespace

Drupal\commerce_reports\Controller
View source
class ReportTable extends ControllerBase {

  /**
   * The report type manager.
   *
   * @var \Drupal\commerce_reports\ReportTypeManager
   */
  protected $reportTypeManager;

  /**
   * The report query builder.
   *
   * @var \Drupal\commerce_reports\ReportQueryBuilder
   */
  protected $reportQueryBuilder;

  /**
   * Creates a new ReportTable object.
   *
   * @param \Drupal\commerce_reports\ReportTypeManager $report_type_manager
   *   The report type manager.
   * @param \Drupal\commerce_reports\ReportQueryBuilder $report_query_builder
   *   The report query builder.
   */
  public function __construct(ReportTypeManager $report_type_manager, ReportQueryBuilder $report_query_builder) {
    $this->reportTypeManager = $report_type_manager;
    $this->reportQueryBuilder = $report_query_builder;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.commerce_report_type'), $container
      ->get('commerce_reports.query_builder'));
  }

  /**
   * Views a report.
   *
   * @param string $report_type_id
   *   The report type plugin ID.
   * @param string $type
   *   The report type. valid values are week, day, or month fallback.
   *
   * @return array
   *   The render array.
   */
  public function viewReport($report_type_id, $type = 'month') {
    if ($type == 'week') {
      $date_format = 'W - Y';
    }
    elseif ($type == 'day') {
      $date_format = 'j F Y';
    }
    else {
      $date_format = 'F Y';
    }
    if (!$this->reportTypeManager
      ->hasDefinition($report_type_id)) {
      throw new \InvalidArgumentException("Invalid report type ID for {$report_type_id}");
    }

    /** @var \Drupal\commerce_reports\Plugin\Commerce\ReportType\ReportTypeInterface $report_type */
    $report_type = $this->reportTypeManager
      ->createInstance($report_type_id);
    $query = $this->reportQueryBuilder
      ->getQuery($report_type, $date_format);
    $results = $query
      ->execute();
    return $report_type
      ->buildReportTable($results);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
ReportTable::$reportQueryBuilder protected property The report query builder.
ReportTable::$reportTypeManager protected property The report type manager.
ReportTable::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
ReportTable::viewReport public function Views a report.
ReportTable::__construct public function Creates a new ReportTable object.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.