class MediaGalleryImportForm in Media Gallery 8

Defines a Media Gallery Import Form.

Hierarchy

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

Expanded class hierarchy of MediaGalleryImportForm

1 string reference to 'MediaGalleryImportForm'

media_gallery_import.routing.yml in modules/media_gallery_import/media_gallery_import.routing.yml: modules/media_gallery_import/media_gallery_import.routing.yml

File

modules/media_gallery_import/src/Form/MediaGalleryImportForm.php, line 16

Namespace

Drupal\media_gallery_import\Form

View source

class MediaGalleryImportForm extends FormBase {

  /**
   * FileSystemInterface.
   *
   * @var \Drupal\Core\File\FileSystemInterface
   */
  private $fileSystemInterface;

  /**
   * EntityTypeManagerInterface.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  private $entityTypeManager;

  /**
   * Constructs a new MediaGalleryImportForm object.
   *
   * @param \Drupal\Core\File\FileSystemInterface $file_system_interface
   *   FileSystemInterface.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   EntityTypeManagerInterface.
   */
  public function __construct(FileSystemInterface $file_system_interface, EntityTypeManagerInterface $entity_type_manager) {
    $this->fileSystemInterface = $file_system_interface;
    $this->entityTypeManager = $entity_type_manager;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = [];
    $form['fieldset'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Import media galleries'),
      '#description' => $this
        ->t('Galleries will be imported from sites/default/files/media_gallery_export'),
    ];
    $form['fieldset']['submit'] = [
      '#value' => $this
        ->t('Import'),
      '#type' => 'submit',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $import_dir = 'public://media_gallery_export';
    if (!$this->fileSystemInterface
      ->prepareDirectory($import_dir)) {
      $this
        ->messenger()
        ->addMessage($this
        ->t('Directory media_gallery_export does not exists! Aborting.'));
      return;
    }
    $import_dir_path = $this->fileSystemInterface
      ->realpath($import_dir);
    $galleries_storage = $this->entityTypeManager
      ->getStorage('media_gallery');
    $galleries_csv = fopen($import_dir_path . '/galleries.csv', 'r');
    while (($galleries_data = fgetcsv($galleries_csv, 0, ';')) !== FALSE) {
      $gallery_id = $galleries_data[0];
      $gallery_title = $galleries_data[1];
      $gallery_desc = $galleries_data[2];

      // Create Gallery if doesn't exists.
      $gallery = $galleries_storage
        ->create([
        'title' => $gallery_title,
        'description' => $gallery_desc,
      ]);
      $gallery
        ->save();
      $gallery_dir = $import_dir . '/' . $gallery_id;
      $gallery_dir_path = $this->fileSystemInterface
        ->realpath($gallery_dir);
      $gallery_csv = fopen($gallery_dir_path . '/gallery.csv', 'r');
      $files_dir = 'public://' . date('Y') . '-' . date('m');
      if (!$this->fileSystemInterface
        ->prepareDirectory($files_dir, FileSystemInterface::CREATE_DIRECTORY)) {
        $this
          ->messenger()
          ->addMessage($this
          ->t('Can not create directory to import files! Aborting.'));
        return;
      }
      while (($gallery_data = fgetcsv($gallery_csv, 255, ';')) !== FALSE) {
        $filename = $gallery_data[0];
        $file_title = $gallery_data[1];
        $file_path = $gallery_dir . '/' . $filename;
        $file_new_path = $files_dir . '/' . $filename;
        copy($file_path, $file_new_path);

        // Create file entity.
        $file = File::create([
          'filename' => $filename,
          'uri' => $file_new_path,
          'status' => 1,
        ]);
        $file
          ->setPermanent();
        $file
          ->save();

        // Create media image entity.
        $image_media = Media::create([
          'bundle' => 'image',
          'field_media_image' => [
            'target_id' => $file
              ->id(),
            'alt' => $file_title,
          ],
        ]);
        $image_media
          ->save();

        // Attach media to gallery.
        $gallery->images[] = $image_media;
        $gallery
          ->save();
      }
      fclose($gallery_csv);
    }
    fclose($galleries_csv);
    $this
      ->messenger()
      ->addMessage($this
      ->t('Your galleries were imported!'));
  }

}

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.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.
MediaGalleryImportForm::$entityTypeManager	private	property	EntityTypeManagerInterface.
MediaGalleryImportForm::$fileSystemInterface	private	property	FileSystemInterface.
MediaGalleryImportForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
MediaGalleryImportForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
MediaGalleryImportForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
MediaGalleryImportForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
MediaGalleryImportForm::__construct	public	function	Constructs a new MediaGalleryImportForm object.
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 MediaGalleryImportForm in Media Gallery 8

Hierarchy

File

Namespace

Members

API Navigation