class ShowForm in Ubercart 8.4

Displays all files that may be purchased and downloaded for administration.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\uc_file\Form\ShowForm

Expanded class hierarchy of ShowForm

1 string reference to 'ShowForm'

uc_file.routing.yml in uc_file/uc_file.routing.yml: uc_file/uc_file.routing.yml

File

uc_file/src/Form/ShowForm.php, line 19

Namespace

Drupal\uc_file\Form

View source

class ShowForm extends FormBase {

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Form constructor.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   */
  public function __construct(ModuleHandlerInterface $module_handler) {
    $this->moduleHandler = $module_handler;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'uc_file_admin_files_show_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['#tree'] = TRUE;
    $form['#attached']['library'][] = 'uc_file/uc_file.styles';
    $header = [
      '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',
      ],
    ];

    // Create pager.
    $query = \Drupal::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 = \Drupal::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)) {
        $options[$file->fid] = [
          '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 {
        $options[$file->fid] = [
          '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.
    $form['file_select'] = [
      '#type' => 'tableselect',
      '#header' => $header,
      '#options' => $options,
      '#empty' => $this
        ->t('No file downloads available.'),
    ];
    $form['uc_file_action'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('File options'),
      '#open' => TRUE,
    ];

    // Set our default actions.
    $file_actions = [
      'uc_file_upload' => $this
        ->t('Upload file'),
      'uc_file_delete' => $this
        ->t('Delete file(s)'),
    ];

    // Check if any hook_uc_file_action('info', $args) are implemented.
    foreach ($this->moduleHandler
      ->getImplementations('uc_file_action') as $module) {
      $name = $module . '_uc_file_action';
      $result = $name('info', NULL);
      if (is_array($result)) {
        foreach ($result as $key => $action) {
          if ($key != 'uc_file_delete' && $key != 'uc_file_upload') {
            $file_actions[$key] = $action;
          }
        }
      }
    }
    $form['uc_file_action']['action'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Action'),
      '#prefix' => '<div class="duration">',
      '#options' => $file_actions,
      '#suffix' => '</div>',
    ];
    $form['uc_file_actions']['actions'] = [
      '#type' => 'actions',
    ];
    $form['uc_file_action']['actions']['submit'] = [
      '#type' => 'submit',
      '#prefix' => '<div class="duration">',
      '#value' => $this
        ->t('Perform action'),
      '#suffix' => '</div>',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    switch ($form_state
      ->getValue([
      'uc_file_action',
      'action',
    ])) {
      case 'uc_file_delete':
        $file_ids = [];
        if (is_array($form_state
          ->getValue('file_select'))) {
          foreach ($form_state
            ->getValue('file_select') as $fid => $value) {
            if ($value) {
              $file_ids[] = $fid;
            }
          }
        }
        if (count($file_ids) == 0) {
          $form_state
            ->setErrorByName('', $this
            ->t('You must select at least one file to delete.'));
        }
        break;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Increment the form step.
    $form_state
      ->set('step', UC_FILE_FORM_ACTION);
    $form_state
      ->setRebuild();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
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.
ShowForm::$moduleHandler	protected	property	The module handler.
ShowForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ShowForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
ShowForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ShowForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
ShowForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
ShowForm::__construct	public	function	Form constructor.
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 ShowForm in Ubercart 8.4

Hierarchy

File

Namespace

Members

API Navigation