class FileController in Ubercart 8.4

Handles administrative view of files that may be purchased and downloaded.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\uc_file\Controller\FileController

Expanded class hierarchy of FileController

File

uc_file/src/Controller/FileController.php, line 14

Namespace

Drupal\uc_file\Controller

View source

class FileController extends ControllerBase {

  /**
   * The database service.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * The form builder service.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('database'), $container
      ->get('form_builder'));
  }

  /**
   * Constructs a FileController object.
   *
   * @param \Drupal\Core\Database\Connection $database
   *   A database connection.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder service.
   */
  public function __construct(Connection $database, FormBuilderInterface $form_builder) {
    $this->database = $database;
    $this->formBuilder = $form_builder;
  }

  /**
   * Displays list of all files available to attach to products.
   *
   * @return array
   *   A render array.
   */
  public function show() {
    $build['#tree'] = TRUE;
    $build['#attached']['library'][] = 'uc_file/uc_file.scripts';

    // Form that provides operations.
    $build['file_action_form'] = $this->formBuilder
      ->getForm('Drupal\\uc_file\\Form\\FileActionForm');

    // Table of files to operate on.
    $header = [
      // Fake out tableselect JavaScript into operating on our table.
      [
        'data' => '',
        'class' => [
          'select-all',
        ],
      ],
      'filename' => [
        'data' => $this
          ->t('File'),
        'field' => 'f.filename',
        'sort' => 'asc',
      ],
      'title' => [
        'data' => $this
          ->t('Product'),
        'field' => 'n.title',
      ],
      'model' => [
        'data' => $this
          ->t('SKU'),
        'field' => 'fp.model',
        'class' => [
          RESPONSIVE_PRIORITY_LOW,
        ],
      ],
    ];

    // Create pager.
    $query = $this->database
      ->select('uc_files', 'f')
      ->extend('Drupal\\Core\\Database\\Query\\PagerSelectExtender')
      ->extend('Drupal\\Core\\Database\\Query\\TableSortExtender')
      ->orderByHeader($header)
      ->limit(UC_FILE_PAGER_SIZE);
    $query
      ->leftJoin('uc_file_products', 'fp', 'f.fid = fp.fid');
    $query
      ->leftJoin('uc_product_features', 'pf', 'fp.pfid = pf.pfid');
    $query
      ->leftJoin('node_field_data', 'n', 'pf.nid = n.nid');
    $query
      ->addField('n', 'nid');
    $query
      ->addField('f', 'filename');
    $query
      ->addField('n', 'title');
    $query
      ->addField('fp', 'model');
    $query
      ->addField('f', 'fid');
    $query
      ->addField('pf', 'pfid');
    $count_query = $this->database
      ->select('uc_files');
    $count_query
      ->addExpression('COUNT(*)');
    $query
      ->setCountQuery($count_query);
    $result = $query
      ->execute();
    $options = [];
    foreach ($result as $file) {

      // All files are shown here, including files which are not attached to products.
      if (isset($file->nid)) {

        // These are attached to products.
        $options[$file->fid] = [
          'checked' => [
            'data' => [
              '#type' => 'checkbox',
              '#default_value' => 0,
            ],
          ],
          'filename' => [
            'data' => [
              '#plain_text' => $file->filename,
            ],
            'class' => is_dir(uc_file_qualify_file($file->filename)) ? [
              'uc-file-directory-view',
            ] : [],
          ],
          'title' => [
            'data' => [
              '#type' => 'link',
              '#title' => $file->title,
              '#url' => Url::fromRoute('entity.node.canonical', [
                'node' => $file->nid,
              ]),
            ],
          ],
          'model' => [
            'data' => [
              '#plain_text' => $file->model,
            ],
          ],
        ];
      }
      else {

        // These are not attached to products.
        $options[$file->fid] = [
          'checked' => [
            'data' => [
              '#type' => 'checkbox',
              '#default_value' => 0,
            ],
          ],
          'filename' => [
            'data' => [
              '#plain_text' => $file->filename,
            ],
            'class' => is_dir(uc_file_qualify_file($file->filename)) ? [
              'uc-file-directory-view',
            ] : [],
          ],
          'title' => '',
          'model' => '',
        ];
      }
    }

    // Create checkboxes for each file.
    $build['file_select'] = [
      '#type' => 'table',
      '#header' => $header,
      '#rows' => $options,
      '#empty' => $this
        ->t('No file downloads available.'),
    ];
    $build['file_select_pager'] = [
      '#type' => 'pager',
    ];
    return $build;
  }

}

Members

Name	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::$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.
FileController::$database	protected	property	The database service.
FileController::$formBuilder	protected	property	The form builder service. Overrides ControllerBase::$formBuilder
FileController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
FileController::show	public	function	Displays list of all files available to attach to products.
FileController::__construct	public	function	Constructs a FileController object.
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.
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.

You are here

class FileController in Ubercart 8.4

Hierarchy

File

Namespace

Members

API Navigation