class ExportController in Bibliography & Citation 8

Same name and namespace in other branches

2.0.x modules/bibcite_export/src/Controller/ExportController.php \Drupal\bibcite_export\Controller\ExportController

Class ExportController.

@package Drupal\bibcite_export\Controller

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\bibcite_export\Controller\ExportController

Expanded class hierarchy of ExportController

File

modules/bibcite_export/src/Controller/ExportController.php, line 21

Namespace

Drupal\bibcite_export\Controller

View source

class ExportController extends ControllerBase {

  /**
   * The serializer service.
   *
   * @var \Symfony\Component\Serializer\Serializer
   */
  protected $serializer;

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

  /**
   * {@inheritdoc}
   */
  public function __construct(SerializerInterface $serializer, EntityTypeManagerInterface $entity_type_manager) {
    $this->serializer = $serializer;
    $this->entityTypeManager = $entity_type_manager;
  }

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

  /**
   * Serialize and create response contains file in selected format.
   *
   * @param array $entities
   *   Array of entities objects.
   * @param \Drupal\bibcite\Plugin\BibciteFormatInterface $bibcite_format
   *   Instance of format plugin.
   * @param null|string $filename
   *   Filename. Will be generated if not provided.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   Response object contains serialized reference data.
   */
  protected function processExport(array $entities, BibciteFormatInterface $bibcite_format, $filename = NULL) {
    if (!$filename) {
      $filename = $bibcite_format
        ->getLabel();
    }
    $response = new Response();
    if ($result = $this->serializer
      ->serialize($entities, $bibcite_format
      ->getPluginId())) {
      $response->headers
        ->set('Cache-Control', 'no-cache');
      $response->headers
        ->set('Content-type', 'text/plain');
      $response->headers
        ->set('Content-Disposition', 'attachment; filename="' . $filename . '.' . $bibcite_format
        ->getExtension() . '";');
      $response
        ->sendHeaders();
      $result = is_array($result) ? implode("\n", $result) : $result;
      $response
        ->setContent($result);
    }
    return $response;
  }

  /**
   * Export entity to available export format.
   *
   * @param \Drupal\bibcite\Plugin\BibciteFormatInterface $bibcite_format
   *   Instance of format plugin.
   * @param string $entity_type
   *   Entity type identifier.
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   Entity object.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   Response object contains serialized reference data.
   */
  public function export(BibciteFormatInterface $bibcite_format, $entity_type, EntityInterface $entity) {
    if (!$entity
      ->access('view')) {
      throw new AccessDeniedHttpException();
    }
    if (!$bibcite_format
      ->isExportFormat()) {
      throw new NotFoundHttpException();
    }
    $filename = vsprintf('%s-%s-%s', [
      $entity_type,
      $entity
        ->id(),
      $bibcite_format
        ->getLabel(),
    ]);
    return $this
      ->processExport([
      $entity,
    ], $bibcite_format, $filename);
  }

  /**
   * Export multiple entities to available export formats.
   *
   * @param \Drupal\bibcite\Plugin\BibciteFormatInterface $bibcite_format
   *   Instance of format plugin.
   * @param string $entity_type
   *   Entity type identifier.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   Request object.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   Response object contains serialized reference data.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   *   Throw 404 error if Id parameter is not provided or entities not loaded.
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function exportMultiple(BibciteFormatInterface $bibcite_format, $entity_type, Request $request) {
    if (!$bibcite_format
      ->isExportFormat()) {
      throw new NotFoundHttpException();
    }
    $storage = $this->entityTypeManager
      ->getStorage($entity_type);
    if (!$request->query
      ->has('id')) {
      throw new NotFoundHttpException();
    }
    $ids = explode(' ', $request->query
      ->get('id'));
    $entities = $storage
      ->loadMultiple($ids);
    if (!$entities) {
      throw new NotFoundHttpException();
    }
    $filename = vsprintf('%s-%s', [
      $entity_type,
      $bibcite_format
        ->getLabel(),
    ]);
    return $this
      ->processExport($entities, $bibcite_format, $filename);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
ExportController::$entityTypeManager	protected	property	The entity type manager. Overrides ControllerBase::$entityTypeManager
ExportController::$serializer	protected	property	The serializer service.
ExportController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
ExportController::export	public	function	Export entity to available export format.
ExportController::exportMultiple	public	function	Export multiple entities to available export formats.
ExportController::processExport	protected	function	Serialize and create response contains file in selected format.
ExportController::__construct	public	function
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 ExportController in Bibliography & Citation 8

Hierarchy

File

Namespace

Members

API Navigation