You are here

Home » API reference » Album Photos 8.4 » PhotosDirectoryImportForm.php

class PhotosDirectoryImportForm in Album Photos 8.4

Same name and namespace in other branches
  1. 8.5 src/Form/PhotosDirectoryImportForm.php \Drupal\photos\Form\PhotosDirectoryImportForm
  2. 6.0.x src/Form/PhotosDirectoryImportForm.php \Drupal\photos\Form\PhotosDirectoryImportForm

Defines a form to upload photos to this site.

Hierarchy

Expanded class hierarchy of PhotosDirectoryImportForm

1 string reference to 'PhotosDirectoryImportForm'
photos.routing.yml in ./photos.routing.yml
photos.routing.yml

File

src/Form/PhotosDirectoryImportForm.php, line 19

Namespace

Drupal\photos\Form
View source 
class PhotosDirectoryImportForm extends FormBase {

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

  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The file system service.
   *
   * @var \Drupal\Core\File\FileSystem
   */
  protected $fileSystem;

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

  /**
   * Constructor.
   *
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_manager
   *   The entity manager service.
   * @param \Drupal\Core\File\FileSystem $file_system
   *   The file system service.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   */
  public function __construct(Connection $connection, EntityTypeManagerInterface $entity_manager, FileSystem $file_system, ModuleHandlerInterface $module_handler) {
    $this->connection = $connection;
    $this->entityTypeManager = $entity_manager;
    $this->fileSystem = $file_system;
    $this->moduleHandler = $module_handler;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $submit_text = $this
      ->t('Move images');
    $show_submit = TRUE;

    // Add warning that images will be moved to the album's directory.
    $instructions = $this
      ->t('Add photos to an album from a directory that is already on the server. First choose a user.
                     Then select an album. Then enter the directory where the photos are located. Note that the photos
                     will be moved to the selected albums directory. Warning: large zip files could fail depending on
                     server processing power. If it does fail, try unzipping the folders and running the batch again.');
    $form['instructions'] = [
      '#markup' => '<div>' . $instructions . '</div>',
    ];
    if ($uid = $form_state
      ->getValue('user')) {

      // Look up user albums and generate options for select list.
      $albums = $this->connection
        ->query("SELECT nid, title FROM {node_field_data} WHERE uid = :uid AND type = 'photos'", [
        ':uid' => $uid,
      ]);
      $options = [];
      foreach ($albums as $album) {
        $options[$album->nid] = '[nid:' . $album->nid . '] ' . $album->title;
      }
      if (empty($options)) {

        // No albums found for selected user.
        $add_album_link = Link::fromTextAndUrl($this
          ->t('Add new album.'), Url::fromUri('base:node/add/photos'))
          ->toString();
        $form['add_album'] = [
          '#markup' => '<div>' . $this
            ->t('No albums found.') . ' ' . $add_album_link . '</div>',
        ];
        $show_submit = FALSE;
      }
      else {

        // Select album.
        $form['uid'] = [
          '#type' => 'hidden',
          '#value' => $uid,
        ];
        $form['album'] = [
          '#type' => 'select',
          '#title' => $this
            ->t('Select album'),
          '#options' => $options,
        ];

        // Directory.
        $form['directory'] = [
          '#title' => $this
            ->t('Directory'),
          '#type' => 'textfield',
          '#required' => TRUE,
          '#default_value' => '',
          '#description' => $this
            ->t('Directory containing images. Include / for absolute path. Include
            public:// or private:// to scan a directory in the public or private filesystem.'),
        ];

        // Copy.
        $form['copy'] = [
          '#title' => $this
            ->t('Copy files instead of moving them.'),
          '#type' => 'checkbox',
          '#default_value' => 0,
        ];
      }
    }
    else {

      // User autocomplete.
      $form['user'] = [
        '#type' => 'entity_autocomplete',
        '#title' => $this
          ->t('Username'),
        '#description' => $this
          ->t('Enter a user name.'),
        '#target_type' => 'user',
        '#tags' => FALSE,
        '#required' => TRUE,
        '#default_value' => '',
        '#process_default_value' => FALSE,
      ];
      $submit_text = $this
        ->t('Select user');
    }
    if ($show_submit) {
      $form['actions']['submit'] = [
        '#type' => 'submit',
        '#value' => $submit_text,
        '#weight' => 10,
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $directory = $form_state
      ->getValue('directory');

    // Check if directory exists.
    if (!empty($directory) && !is_dir($directory)) {
      return $form_state
        ->setErrorByName('directory', $this
        ->t('Could not find directory. Please check the path.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('photos.settings');
    $user_value = $form_state
      ->getValue('user');
    $copy = $form_state
      ->getValue('copy');
    if ($user_value) {
      $form_state
        ->setRebuild();
    }
    else {

      // @todo check if file is already in use before moving?
      // - If in use copy?
      $album = $form_state
        ->getValue('album');
      $directory = $form_state
        ->getValue('directory');
      $nid = $album;
      $album_uid = $form_state
        ->getValue('uid');

      // If photos_access is enabled check viewid.
      $scheme = 'default';
      $album_viewid = 0;
      if ($this->moduleHandler
        ->moduleExists('photos_access')) {
        $node = $this->entityTypeManager
          ->getStorage('node')
          ->load($nid);
        if (isset($node->privacy) && isset($node->privacy['viewid'])) {
          $album_viewid = $node->privacy['viewid'];
          if ($album_viewid > 0) {

            // Check for private file path.
            if (PrivateStream::basePath()) {
              $scheme = 'private';
            }
            else {

              // Set warning message.
              \Drupal::messenger()
                ->addWarning($this
                ->t('Warning: image
                files can still be accessed by visiting the direct URL. For
                better security, ask your website admin to setup a private
                file path.'));
            }
          }
        }
      }
      $account = $this->entityTypeManager
        ->getStorage('user')
        ->load($album_uid);

      // Check if zip is included.
      $allow_zip = $config
        ->get('photos_upzip') ? '|zip|ZIP' : '';
      $file_extensions = 'png|PNG|jpg|JPG|jpeg|JPEG|gif|GIF' . $allow_zip;
      $files = $this->fileSystem
        ->scanDirectory($directory, '/^.*\\.(' . $file_extensions . ')$/');

      // Prepare batch.
      $batch_args = [
        $files,
        $account,
        $nid,
        $scheme,
        $allow_zip,
        $file_extensions,
        $copy,
      ];
      $batch = [
        'title' => $this
          ->t('Moving images to gallery'),
        'operations' => [
          [
            '\\Drupal\\photos\\PhotosUpload::moveImageFiles',
            $batch_args,
          ],
        ],
        'finished' => '\\Drupal\\photos\\PhotosUpload::finishedMovingImageFiles',
      ];
      batch_set($batch);
    }
  }

}

Members

Namesort descending 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.
PhotosDirectoryImportForm::$connection protected property The database connection.
PhotosDirectoryImportForm::$entityTypeManager protected property The entity manager.
PhotosDirectoryImportForm::$fileSystem protected property The file system service.
PhotosDirectoryImportForm::$moduleHandler protected property The module handler.
PhotosDirectoryImportForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
PhotosDirectoryImportForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
PhotosDirectoryImportForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PhotosDirectoryImportForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
PhotosDirectoryImportForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
PhotosDirectoryImportForm::__construct public function Constructor.
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.