class EntryPoint in Entity Share 8.3

Same name and namespace in other branches

8 modules/entity_share_server/src/Controller/EntryPoint.php \Drupal\entity_share_server\Controller\EntryPoint
8.2 modules/entity_share_server/src/Controller/EntryPoint.php \Drupal\entity_share_server\Controller\EntryPoint

Controller to generate list of channels URLs.

Hierarchy

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

Expanded class hierarchy of EntryPoint

File

modules/entity_share_server/src/Controller/EntryPoint.php, line 17

Namespace

Drupal\entity_share_server\Controller

View source

class EntryPoint extends ControllerBase {

  /**
   * The channel manipulator.
   *
   * @var \Drupal\entity_share_server\Service\ChannelManipulatorInterface
   */
  protected $channelManipulator;

  /**
   * The resource type repository.
   *
   * @var \Drupal\jsonapi\ResourceType\ResourceTypeRepositoryInterface
   */
  protected $resourceTypeRepository;

  /**
   * The event dispatcher.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  protected $eventDispatcher;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->channelManipulator = $container
      ->get('entity_share_server.channel_manipulator');
    $instance->resourceTypeRepository = $container
      ->get('jsonapi.resource_type.repository');
    $instance->eventDispatcher = $container
      ->get('event_dispatcher');
    return $instance;
  }

  /**
   * Controller to list all the resources.
   */
  public function index() {
    $self = Url::fromRoute('entity_share_server.resource_list')
      ->setOption('absolute', TRUE)
      ->toString();
    $urls = [
      'self' => $self,
    ];
    $data = [
      'channels' => [],
      'field_mappings' => $this
        ->getFieldMappings(),
    ];
    $uuid = 'anonymous';
    if ($this
      ->currentUser()
      ->isAuthenticated()) {

      // Load the user to ensure with have a user entity.

      /** @var \Drupal\user\UserInterface $account */
      $account = $this
        ->entityTypeManager()
        ->getStorage('user')
        ->load($this
        ->currentUser()
        ->id());
      if (!is_null($account)) {
        $uuid = $account
          ->uuid();
      }
    }

    /** @var \Drupal\entity_share_server\Entity\ChannelInterface[] $channels */
    $channels = $this
      ->entityTypeManager()
      ->getStorage('channel')
      ->loadMultiple();
    $languages = $this
      ->languageManager()
      ->getLanguages(LanguageInterface::STATE_ALL);
    foreach ($channels as $channel) {

      // Check access for this user.
      if (in_array($uuid, $channel
        ->get('authorized_users'))) {
        $channel_entity_type = $channel
          ->get('channel_entity_type');
        $channel_bundle = $channel
          ->get('channel_bundle');
        $channel_langcode = $channel
          ->get('channel_langcode');
        $route_name = sprintf('jsonapi.%s--%s.collection', $channel_entity_type, $channel_bundle);
        $url = Url::fromRoute($route_name)
          ->setOption('language', $languages[$channel_langcode])
          ->setOption('absolute', TRUE)
          ->setOption('query', $this->channelManipulator
          ->getQuery($channel));

        // Prepare an URL to get only the UUIDs.
        $url_uuid = clone $url;
        $query = $url_uuid
          ->getOption('query');
        $query = !is_null($query) ? $query : [];
        $url_uuid
          ->setOption('query', $query + [
          'fields' => [
            $channel_entity_type . '--' . $channel_bundle => 'changed',
          ],
        ]);
        $data['channels'][$channel
          ->id()] = [
          'label' => $channel
            ->label(),
          'url' => $url
            ->toString(),
          'url_uuid' => $url_uuid
            ->toString(),
          'channel_entity_type' => $channel_entity_type,
          'channel_bundle' => $channel_bundle,
          'search_configuration' => $this->channelManipulator
            ->getSearchConfiguration($channel),
        ];
      }
    }

    // Collect other channel definitions.
    $event = new ChannelListEvent($data);
    $this->eventDispatcher
      ->dispatch(ChannelListEvent::EVENT_NAME, $event);
    return new JsonResponse([
      'data' => $event
        ->getChannelList(),
      'links' => $urls,
    ]);
  }

  /**
   * Get all field mappings so clients are aware of the server configuration.
   *
   * [
   *   'entity_type_id' => [
   *     'bundle' => [
   *       'internal name' => 'public name',
   *     ],
   *   ],
   * ];
   *
   * @return array
   *   An array as explained in the text above.
   */
  protected function getFieldMappings() {
    $mapping = [];
    $definitions = $this
      ->entityTypeManager()
      ->getDefinitions();
    $resource_types = $this->resourceTypeRepository
      ->all();
    foreach ($resource_types as $resource_type) {
      $entity_type_id = $resource_type
        ->getEntityTypeId();

      // Do not expose config entities and user, as we do not manage them.
      if ($entity_type_id == 'user' || $definitions[$entity_type_id]
        ->getGroup() != 'content') {
        continue;
      }
      $bundle = $resource_type
        ->getBundle();
      $resource_type_fields = $resource_type
        ->getFields();
      foreach ($resource_type_fields as $resource_type_field) {
        $mapping[$entity_type_id][$bundle][$resource_type_field
          ->getInternalName()] = $resource_type_field
          ->getPublicName();
      }
    }
    return $mapping;
  }

}

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::$entityTypeManager	protected	property	The entity type 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.
EntryPoint::$channelManipulator	protected	property	The channel manipulator.
EntryPoint::$eventDispatcher	protected	property	The event dispatcher.
EntryPoint::$resourceTypeRepository	protected	property	The resource type repository.
EntryPoint::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
EntryPoint::getFieldMappings	protected	function	Get all field mappings so clients are aware of the server configuration.
EntryPoint::index	public	function	Controller to list all the resources.
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 EntryPoint in Entity Share 8.3

Hierarchy

File

Namespace

Members

API Navigation