class ExportAllForm in Bibliography & Citation 8

Same name and namespace in other branches

2.0.x modules/bibcite_export/src/Form/ExportAllForm.php \Drupal\bibcite_export\Form\ExportAllForm

Export all reference data to any available export format.

Hierarchy

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

Expanded class hierarchy of ExportAllForm

1 string reference to 'ExportAllForm'

bibcite_export.routing.yml in modules/bibcite_export/bibcite_export.routing.yml: modules/bibcite_export/bibcite_export.routing.yml

File

modules/bibcite_export/src/Form/ExportAllForm.php, line 16

Namespace

Drupal\bibcite_export\Form

View source

class ExportAllForm extends FormBase {

  /**
   * Private temp store instance.
   *
   * @var \Drupal\Core\TempStore\PrivateTempStore
   */
  protected $tempStorage;

  /**
   * Bibcite format manager service.
   *
   * @var \Drupal\bibcite\Plugin\BibciteFormatManagerInterface
   */
  protected $formatManager;

  /**
   * {@inheritdoc}
   */
  public function __construct(PrivateTempStoreFactory $temp_store_factory, BibciteFormatManagerInterface $format_manager) {
    $this->tempStorage = $temp_store_factory
      ->get('bibcite_export');
    $this->formatManager = $format_manager;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['format'] = [
      '#title' => $this
        ->t('Export format'),
      '#type' => 'select',
      '#options' => array_map(function ($format) {
        return $format['label'];
      }, $this->formatManager
        ->getExportDefinitions()),
      '#required' => TRUE,
    ];
    if ($files = $this->tempStorage
      ->get('export_files')) {
      $form['files'] = [
        '#theme' => 'item_list',
        '#title' => $this
          ->t('Files'),
        '#items' => $this
          ->createFilesList($files),
      ];
    }
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Export'),
    ];
    return $form;
  }

  /**
   * Create files list based on info from temp storage.
   *
   * @param array $files_info
   *   Files info from temp storage.
   *
   * @return array
   *   Render array of link items.
   */
  protected function createFilesList(array $files_info) {
    $items = [];
    foreach ($files_info as $key => $file_info) {
      if ($file = $this
        ->loadFile($file_info['id'])) {
        $format = $this->formatManager
          ->createInstance($file_info['format']);
        $date = date('m-d-Y H:i:s', $file_info['timestamp']);
        $title = sprintf('%s - %s - %s', $file
          ->label(), $format
          ->getLabel(), $date);
        $items[$key] = [
          '#type' => 'link',
          '#title' => $title,
          '#url' => Url::fromRoute('bibcite_export.download', [
            'file' => $file
              ->id(),
          ]),
        ];
      }
      else {
        $this
          ->deleteFileInfoFromStorage($key);
      }
    }
    return $items;
  }

  /**
   * Load file by fid.
   *
   * If file does not exist in the file system then delete him from database.
   *
   * @param int $fid
   *   File ID.
   *
   * @return \Drupal\Core\Entity\EntityInterface|bool
   *   File object or FALSE if file does not exist.
   */
  protected function loadFile($fid) {
    if ($file = File::load($fid)) {
      if (file_exists($file
        ->getFileUri())) {
        return $file;
      }
      else {
        $file
          ->delete();
      }
    }
    return FALSE;
  }

  /**
   * Delete info about file from temp storage.
   *
   * @param int $key
   *   Key of the file element.
   */
  protected function deleteFileInfoFromStorage($key) {
    $files_info = $this->tempStorage
      ->get('export_files');
    unset($files_info[$key]);
    $this->tempStorage
      ->set('export_files', $files_info);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $format = $this->formatManager
      ->hasDefinition($form_state
      ->getValue('format'));
    if (!isset($format)) {
      $form_state
        ->setErrorByName('format', $this
        ->t('Trying export to non-existing format.'));
    }
    $storage = \Drupal::entityTypeManager()
      ->getStorage('bibcite_reference');
    $total = $storage
      ->getQuery()
      ->count()
      ->execute();
    if (!$total) {
      $form_state
        ->setError($form, $this
        ->t('There is no data to export.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $format = $this->formatManager
      ->createInstance($form_state
      ->getValue('format'));
    $batch = [
      'title' => t('Export all reference data'),
      'operations' => [
        [
          'bibcite_export_batch_all',
          [
            'bibcite_reference',
            $format,
          ],
        ],
      ],
      'file' => drupal_get_path('module', 'bibcite_export') . '/bibcite_export.batch.inc',
      'finished' => 'bibcite_export_batch_finished',
    ];
    batch_set($batch);
  }

}

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
ExportAllForm::$formatManager	protected	property	Bibcite format manager service.
ExportAllForm::$tempStorage	protected	property	Private temp store instance.
ExportAllForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ExportAllForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
ExportAllForm::createFilesList	protected	function	Create files list based on info from temp storage.
ExportAllForm::deleteFileInfoFromStorage	protected	function	Delete info about file from temp storage.
ExportAllForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ExportAllForm::loadFile	protected	function	Load file by fid.
ExportAllForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
ExportAllForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
ExportAllForm::__construct	public	function
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 ExportAllForm in Bibliography & Citation 8

Hierarchy

File

Namespace

Members

API Navigation