class ActionForm in Ubercart 8.4

Performs file action (upload, delete, hooked in actions).

Hierarchy

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

Expanded class hierarchy of ActionForm

1 string reference to 'ActionForm'

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

File

uc_file/src/Form/ActionForm.php, line 14

Namespace

Drupal\uc_file\Form

View source

class ActionForm 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_form_action';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $file_ids = array_filter($form_state
      ->getValue('file_select'));
    $form['file_ids'] = [
      '#type' => 'value',
      '#value' => $file_ids,
    ];
    $form['action'] = [
      '#type' => 'value',
      '#value' => $form_state
        ->getValue([
        'uc_file_action',
        'action',
      ]),
    ];
    $file_ids = _uc_file_sort_names(_uc_file_get_dir_file_ids($file_ids, FALSE));
    switch ($form_state
      ->getValue([
      'uc_file_action',
      'action',
    ])) {
      case 'uc_file_delete':
        $affected_list = $this
          ->buildJsFileDisplay($file_ids);
        $has_directory = FALSE;
        foreach ($file_ids as $file_id) {

          // Gather a list of user-selected filenames.
          $file = uc_file_get_by_id($file_id);
          $filename = $file->filename;
          $file_list[] = substr($filename, -1) == "/" ? $filename . ' (' . $this
            ->t('directory') . ')' : $filename;

          // Determine if there are any directories in this list.
          $path = uc_file_qualify_file($filename);
          if (is_dir($path)) {
            $has_directory = TRUE;
          }
        }

        // Base files/dirs the user selected.
        $form['selected_files'] = [
          '#theme' => 'item_list',
          '#items' => $file_list,
          '#attributes' => [
            'class' => [
              'selected-file-name',
            ],
          ],
        ];
        $form = confirm_form($form, $this
          ->t('Delete file(s)'), 'admin/store/products/files', $this
          ->t('Deleting a file will remove all its associated file downloads and product features. Removing a directory will remove any files it contains and their associated file downloads and product features.'), $this
          ->t('Delete affected files'), $this
          ->t('Cancel'));

        // Don't show the recursion checkbox unless we have any directories.
        if ($has_directory && $affected_list[TRUE] !== FALSE) {
          $form['recurse_directories'] = [
            '#type' => 'checkbox',
            '#title' => $this
              ->t('Delete selected directories and their sub directories'),
          ];

          // Default to FALSE. Although we have the JS behavior to update with
          // the state of the checkbox on load, this should improve the
          // experience of users who don't have JS enabled over not defaulting
          // to any info.
          $form['affected_files'] = [
            '#theme' => 'item_list',
            '#items' => $affected_list[FALSE],
            '#title' => $this
              ->t('Affected files'),
            '#attributes' => [
              'class' => [
                'affected-file-name',
              ],
            ],
          ];
        }
        break;
      case 'uc_file_upload':

        // Calculate the maximum size of uploaded files in bytes.
        $post_max_size = ini_get('post_max_size');
        if (is_numeric($post_max_size)) {

          // Handle the case where 'post_max_size' has no suffix.
          // An explicit cast is needed because floats are not allowed.
          $max_bytes = (int) $post_max_size;
        }
        else {

          // Handle the case where 'post_max_size' has a suffix of
          // 'M', 'K', or 'G' (case insensitive).
          $max_bytes = (int) substr($post_max_size, 0, -1);
          $suffix = strtolower(substr($post_max_size, -1));
          switch ($suffix) {
            case 'k':
              $max_bytes *= 1024;
              break;
            case 'm':
              $max_bytes *= 1048576;
              break;
            case 'g':
              $max_bytes *= 1073741824;
              break;
          }
        }

        // Gather list of directories under the selected one(s).
        // '/' is always available.
        $directories = [
          '' => '/',
        ];
        $files = \Drupal::database()
          ->query("SELECT * FROM {uc_files}");
        foreach ($files as $file) {
          if (is_dir($this
            ->config('uc_file.settings')
            ->get('base_dir') . "/" . $file->filename)) {
            $directories[$file->filename] = $file->filename;
          }
        }
        $form['upload_dir'] = [
          '#type' => 'select',
          '#title' => $this
            ->t('Directory'),
          '#description' => $this
            ->t('The directory on the server where the file should be put. The default directory is the root of the file downloads directory.'),
          '#options' => $directories,
        ];
        $form['upload'] = [
          '#type' => 'file',
          '#title' => $this
            ->t('File'),
          '#description' => $this
            ->t("The maximum file size that can be uploaded is %size bytes. You will need to use a different method to upload the file to the directory (e.g. (S)FTP, SCP) if your file exceeds this size. Files you upload using one of these alternate methods will be automatically detected. Note: A value of '0' means there is no size limit.", [
            '%size' => number_format($max_bytes),
          ]),
        ];
        $form['#attributes']['class'][] = 'foo';
        $form = confirm_form($form, $this
          ->t('Upload file'), 'admin/store/products/files', '', $this
          ->t('Upload file'), $this
          ->t('Cancel'));

        // Must add this after confirm_form, as it runs over
        // $form['#attributes']. Issue logged at d#319723.
        $form['#attributes']['enctype'] = 'multipart/form-data';
        break;
      default:

        // This action isn't handled by us, so check if any
        // hook_uc_file_action('form', $args) are implemented.
        foreach ($this->moduleHandler
          ->getImplementations('uc_file_action') as $module) {
          $name = $module . '_uc_file_action';
          $result = $name('form', [
            'action' => $form_state
              ->getValue([
              'uc_file_action',
              'action',
            ]),
            'file_ids' => $file_ids,
          ]);
          $form = is_array($result) ? array_merge($form, $result) : $form;
        }
        break;
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    switch ($form_state
      ->getValue('action')) {
      case 'uc_file_upload':

        // Upload the file and get its object.
        if ($temp_file = file_save_upload('upload', [
          'file_validate_extensions' => [],
        ])) {

          // Check if any hook_uc_file_action('upload_validate', $args)
          // are implemented.
          foreach ($this->moduleHandler
            ->getImplementations('uc_file_action') as $module) {
            $name = $module . '_uc_file_action';
            $name('upload_validate', [
              'file_object' => $temp_file,
              'form_id' => $form_id,
              'form_state' => $form_state,
            ]);
          }

          // Save the uploaded file for later processing.
          $form_state
            ->set('temp_file', $temp_file);
        }
        else {
          $form_state
            ->setErrorByName('', $this
            ->t('An error occurred while uploading the file'));
        }
        break;
      default:

        // This action isn't handled by us, so check if any
        // hook_uc_file_action('validate', $args) are implemented.
        foreach ($this->moduleHandler
          ->getImplementations('uc_file_action') as $module) {
          $name = $module . '_uc_file_action';
          $name('validate', [
            'form_id' => $form_id,
            'form_state' => $form_state,
          ]);
        }
        break;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    switch ($form_state
      ->getValue('action')) {
      case 'uc_file_delete':

        // File deletion status.
        $status = TRUE;

        // Delete the selected file(s), with recursion if selected.
        $status = uc_file_remove_by_id($form_state
          ->getValue('file_ids'), !$form_state
          ->isValueEmpty('recurse_directories')) && $status;
        if ($status) {
          $this
            ->messenger()
            ->addMessage($this
            ->t('The selected file(s) have been deleted.'));
        }
        else {
          $this
            ->messenger()
            ->addWarning($this
            ->t('One or more files could not be deleted.'));
        }
        break;
      case 'uc_file_upload':

        // Build the destination location. We start with the base directory,
        // then add any directory which was explicitly selected.
        $dir = $this
          ->config('uc_file.settings')
          ->get('base_dir') . '/' . $form_state
          ->getValue('upload_dir');
        if (is_dir($dir)) {

          // Retrieve our uploaded file.
          $file_object = $form_state
            ->get('temp_file');

          // Copy the file to its final location.
          if (copy($file_object->uri, $dir . '/' . $file_object->filename)) {

            // Check for hook_uc_file_action('upload', $args) implementations.
            foreach ($this->moduleHandler
              ->getImplementations('uc_file_action') as $module) {
              $name = $module . '_uc_file_action';
              $name('upload', [
                'file_object' => $file_object,
                'form_id' => $form_id,
                'form_state' => $form_state,
              ]);
            }

            // Update the file list.
            uc_file_refresh();
            $this
              ->messenger()
              ->addMessage($this
              ->t('The file %file has been uploaded to %dir', [
              '%file' => $file_object->filename,
              '%dir' => $dir,
            ]));
          }
          else {
            $this
              ->messenger()
              ->addError($this
              ->t('An error occurred while copying the file to %dir', [
              '%dir' => $dir,
            ]));
          }
        }
        else {
          $this
            ->messenger()
            ->addError($this
            ->t('Can not move file to %dir', [
            '%dir' => $dir,
          ]));
        }
        break;
      default:

        // This action isn't handled by us, so check if any
        // hook_uc_file_action('submit', $args) are implemented.
        foreach ($this->moduleHandler
          ->getImplementations('uc_file_action') as $module) {
          $name = $module . '_uc_file_action';
          $name('submit', [
            'form_id' => $form_id,
            'form_state' => $form_state,
          ]);
        }
        break;
    }

    // Return to the original form state.
    $form_state
      ->setRebuild(FALSE);
    $this
      ->redirect('uc_file.downloads');
  }

  /**
   * @todo Replace with == operator?
   */
  protected function displayArraysEquivalent($recur, $no_recur) {

    // Different sizes.
    if (count($recur) != count($no_recur)) {
      return FALSE;
    }

    // Check the elements.
    for ($i = 0; $i < count($recur); $i++) {
      if ($recur[$i] != $no_recur[$i]) {
        return FALSE;
      }
    }
    return TRUE;
  }

  /**
   * Shows all possible files in selectable list.
   */
  protected function buildJsFileDisplay($file_ids) {

    // Gather the files if recursion IS selected.
    // Get 'em all ready to be punched into the file list.
    $recursion_file_ids = _uc_file_sort_names(_uc_file_get_dir_file_ids($file_ids, TRUE));
    foreach ($recursion_file_ids as $file_id) {
      $file = uc_file_get_by_id($file_id);
      $recursion[] = '<li>' . $file->filename . '</li>';
    }

    // Gather the files if recursion ISN'T selected.
    // Get 'em all ready to be punched into the file list.
    $no_recursion_file_ids = $file_ids;
    foreach ($no_recursion_file_ids as $file_id) {
      $file = uc_file_get_by_id($file_id);
      $no_recursion[] = '<li>' . $file->filename . '</li>';
    }

    // We'll disable the recursion checkbox if they're equal.
    $equivalent = $this
      ->displayArraysEquivalent($recursion_file_ids, $no_recursion_file_ids);

    // The list to show if the recursion checkbox is $key.
    $result[TRUE] = $equivalent ? FALSE : $recursion;
    $result[FALSE] = $no_recursion;

    // Set up some JS to dynamically update the list based on the
    // recursion checkbox state.
    drupal_add_js('uc_file_list[false] = ' . Json::encode('<li>' . implode('</li><li>', $no_recursion) . '</li>') . ';', 'inline');
    drupal_add_js('uc_file_list[true] = ' . Json::encode('<li>' . implode('</li><li>', $recursion) . '</li>') . ';', 'inline');
    return $result;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ActionForm::$moduleHandler	protected	property	The module handler.
ActionForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ActionForm::buildJsFileDisplay	protected	function	Shows all possible files in selectable list.
ActionForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
ActionForm::displayArraysEquivalent	protected	function	@todo Replace with == operator?
ActionForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ActionForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
ActionForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
ActionForm::__construct	public	function	Form constructor.
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.
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 ActionForm in Ubercart 8.4

Hierarchy

File

Namespace

Members

API Navigation