You are here

Home » API reference » Ubercart 8.4 » StockReports.php

class StockReports in Ubercart 8.4

Displays a stock report for products with stock tracking enabled.

Hierarchy

Expanded class hierarchy of StockReports

File

uc_stock/src/Controller/StockReports.php, line 12

Namespace

Drupal\uc_stock\Controller
View source 
class StockReports extends ControllerBase {

  /**
   * {@inheritdoc}
   */
  public function report() {

    //$page_size = (isset($_GET['nopage'])) ? UC_REPORT_MAX_RECORDS : variable_get('uc_report_table_size', 30);
    $page_size = 30;
    $csv_rows = [];
    $rows = [];
    $header = [
      [
        'data' => $this
          ->t('SKU'),
        'field' => 'sku',
        'sort' => 'asc',
      ],
      [
        'data' => $this
          ->t('Product'),
        'field' => 'title',
      ],
      [
        'data' => $this
          ->t('Stock'),
        'field' => 'stock',
      ],
      [
        'data' => $this
          ->t('Threshold'),
        'field' => 'threshold',
      ],
      [
        'data' => $this
          ->t('Operations'),
      ],
    ];
    $csv_rows[] = [
      $this
        ->t('SKU'),
      $this
        ->t('Product'),
      $this
        ->t('Stock'),
      $this
        ->t('Threshold'),
    ];
    $query = \Drupal::database()
      ->select('uc_product_stock', 's')
      ->extend('\\Drupal\\Core\\Database\\Query\\PagerSelectExtender')
      ->extend('\\Drupal\\Core\\Database\\Query\\TableSortExtender')
      ->orderByHeader($header)
      ->limit($page_size)
      ->fields('s', [
      'nid',
      'sku',
      'stock',
      'threshold',
    ]);
    $query
      ->leftJoin('node_field_data', 'n', 's.nid = n.nid');
    $query
      ->addField('n', 'title');
    $query
      ->condition('active', 1)
      ->condition('title', '', '<>');

    // @todo Replace arg().
    // if (arg(4) == 'threshold') {
    //   $query->where('threshold >= stock');
    // }
    $result = $query
      ->execute();
    foreach ($result as $stock) {
      $op = '';
      if ($this
        ->currentUser()
        ->hasPermission('administer product stock')) {
        $op = [
          '#type' => 'operations',
          '#links' => [
            'edit' => [
              'title' => $this
                ->t('Edit'),
              'url' => Url::fromRoute('uc_stock.edit', [
                'node' => $stock->nid,
              ], [
                'query' => [
                  'destination' => 'admin/store/reports/stock',
                ],
              ]),
            ],
          ],
        ];
      }

      // Add the data to a table row for display.
      $rows[] = [
        'data' => [
          [
            'data' => $stock->sku,
          ],
          [
            'data' => [
              '#type' => 'link',
              '#title' => $stock->title,
              '#url' => Url::fromRoute('entity.node.canonical', [
                'node' => $stock->nid,
              ]),
            ],
          ],
          [
            'data' => $stock->stock,
          ],
          [
            'data' => $stock->threshold,
          ],
          [
            'data' => $op,
          ],
        ],
        'class' => [
          $stock->threshold >= $stock->stock ? 'uc-stock-below-threshold' : 'uc-stock-above-threshold',
        ],
      ];

      // Add the data to the CSV contents for export.
      $csv_rows[] = [
        $stock->sku,
        $stock->title,
        $stock->stock,
        $stock->threshold,
      ];
    }

    // Cache the CSV export.
    $controller = new Reports();
    $csv_data = $controller
      ->store_csv('uc_stock', $csv_rows);
    $build['form'] = $this
      ->formBuilder()
      ->getForm('\\Drupal\\uc_stock\\Form\\StockReportForm');
    $build['report'] = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
      '#attributes' => [
        'width' => '100%',
        'class' => [
          'uc-stock-table',
        ],
      ],
    ];
    $build['pager'] = [
      '#type' => 'pager',
    ];
    $build['links'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'uc-reports-links',
        ],
      ],
    ];
    $build['links']['export_csv'] = [
      '#type' => 'link',
      '#title' => $this
        ->t('Export to CSV file'),
      '#url' => Url::fromRoute('uc_report.getcsv', [
        'report_id' => $csv_data['report'],
        'user_id' => $csv_data['user'],
      ]),
      '#suffix' => '&nbsp;&nbsp;&nbsp;',
    ];

    //    if (isset($_GET['nopage'])) {
    //      $build['links']['toggle_pager'] = [
    //        '#type' => 'link',
    //        '#title' => $this->t('Show paged records'),
    //        '#url' => Url::fromRoute('uc_stock.reports'),
    //      ];
    //    }
    //    else {
    $build['links']['toggle_pager'] = [
      '#type' => 'link',
      '#title' => $this
        ->t('Show all records'),
      '#url' => Url::fromRoute('uc_stock.reports', [], [
        'query' => [
          'nopage' => '1',
        ],
      ]),
    ];

    //    }
    return $build;
  }

}

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::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 40
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.
StockReports::report public function
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.