class ChannelManipulator in Entity Share 8.3

Helps to manipulate a channel.

@package Drupal\entity_share_server\Service

Hierarchy

• class \Drupal\entity_share_server\Service\ChannelManipulator implements ChannelManipulatorInterface uses StringTranslationTrait

1 string reference to 'ChannelManipulator'

entity_share_server.services.yml in modules/entity_share_server/entity_share_server.services.yml

modules/entity_share_server/entity_share_server.services.yml

1 service uses ChannelManipulator

entity_share_server.channel_manipulator in modules/entity_share_server/entity_share_server.services.yml

Drupal\entity_share_server\Service\ChannelManipulator

File

modules/entity_share_server/src/Service/ChannelManipulator.php, line 20

Namespace

Drupal\entity_share_server\Service

class ChannelManipulator implements ChannelManipulatorInterface {
  use StringTranslationTrait;

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

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

  /**
   * ChannelManipulator constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\jsonapi\ResourceType\ResourceTypeRepositoryInterface $resource_type_repository
   *   The resource type repository.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, ResourceTypeRepositoryInterface $resource_type_repository) {
    $this->entityTypeManager = $entity_type_manager;
    $this->resourceTypeRepository = $resource_type_repository;
  }

  /**
   * {@inheritdoc}
   */
  public function getQuery(ChannelInterface $channel) {
    $query = [];

    // In case of translatable entities. Add a filter on the langcode to
    // only get entities in the channel language.
    if ($channel
      ->get('channel_langcode') != LanguageInterface::LANGCODE_NOT_SPECIFIED) {
      $entity_type = $channel
        ->get('channel_entity_type');
      $entity_keys = $this->entityTypeManager
        ->getStorage($entity_type)
        ->getEntityType()
        ->getKeys();
      $resource_type = $this->resourceTypeRepository
        ->get($entity_type, $channel
        ->get('channel_bundle'));
      $langcode_path = 'langcode';
      if (isset($entity_keys['langcode']) && !empty($entity_keys['langcode']) && $resource_type
        ->hasField($entity_keys['langcode'])) {
        $langcode_path = $resource_type
          ->getPublicName($entity_keys['langcode']);
      }
      $query['filter']['langcode-filter'] = [
        'condition' => [
          'path' => $langcode_path,
          'operator' => '=',
          'value' => $channel
            ->get('channel_langcode'),
        ],
      ];
    }

    // Add groups.
    if (!is_null($channel
      ->get('channel_groups'))) {
      foreach ($channel
        ->get('channel_groups') as $group_id => $group) {
        $query['filter'][$group_id] = [
          'group' => [
            'conjunction' => $group['conjunction'],
          ],
        ];
        if (isset($group['memberof'])) {
          $query['filter'][$group_id]['group']['memberOf'] = $group['memberof'];
        }
      }
    }

    // Add filters.
    if (!is_null($channel
      ->get('channel_filters'))) {
      foreach ($channel
        ->get('channel_filters') as $filter_id => $filter) {
        $query['filter'][$filter_id] = [
          'condition' => [
            'path' => $filter['path'],
            'operator' => $filter['operator'],
          ],
        ];
        if (isset($filter['value'])) {

          // Multiple values operators.
          if (in_array($filter['operator'], OperatorsHelper::getMultipleValuesOperators())) {
            $query['filter'][$filter_id]['condition']['value'] = $filter['value'];
          }
          else {
            $query['filter'][$filter_id]['condition']['value'] = implode($filter['value']);
          }
        }
        if (isset($filter['memberof'])) {
          $query['filter'][$filter_id]['condition']['memberOf'] = $filter['memberof'];
        }
      }
    }

    // Add sorts.
    if (!is_null($channel
      ->get('channel_sorts'))) {
      $sorts = $channel
        ->get('channel_sorts');
      uasort($sorts, [
        SortArray::class,
        'sortByWeightElement',
      ]);
      foreach ($sorts as $sort_id => $sort) {
        $query['sort'][$sort_id] = [
          'path' => $sort['path'],
          'direction' => $sort['direction'],
        ];
      }
    }
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  public function getSearchConfiguration(ChannelInterface $channel) {
    $channel_entity_type = $channel
      ->get('channel_entity_type');
    $channel_bundle = $channel
      ->get('channel_bundle');
    $entity_type = $this->entityTypeManager
      ->getStorage($channel_entity_type)
      ->getEntityType();
    $entity_keys = $entity_type
      ->getKeys();
    $resource_type = $this->resourceTypeRepository
      ->get($channel_entity_type, $channel_bundle);
    $search_configuration = [];
    if (isset($entity_keys['label']) && !empty($entity_keys['label'] && $resource_type
      ->hasField($entity_keys['label']))) {
      $search_configuration['label'] = [
        'path' => $resource_type
          ->getPublicName($entity_keys['label']),
        'label' => $this
          ->t('Label'),
      ];
    }

    // Get the searches from configuration.
    if (!is_null($channel
      ->get('channel_searches'))) {
      foreach ($channel
        ->get('channel_searches') as $search_id => $search) {
        $search_configuration[$search_id] = [
          'path' => $search['path'],
          'label' => $search['label'],
        ];
      }
    }
    return $search_configuration;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ChannelManipulator::$entityTypeManager	protected	property	The entity type manager.
ChannelManipulator::$resourceTypeRepository	protected	property	The resource type repository.
ChannelManipulator::getQuery	public	function	Generate URL query. Overrides ChannelManipulatorInterface::getQuery
ChannelManipulator::getSearchConfiguration	public	function	Get field mapping. Overrides ChannelManipulatorInterface::getSearchConfiguration
ChannelManipulator::__construct	public	function	ChannelManipulator constructor.
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.