class JsonApiBuildSubscriber in JSON:API Extras 8.3

JSON API build subscriber that applies all changes from extra's to the API.

Hierarchy

• class \Drupal\jsonapi_extras\EventSubscriber\JsonApiBuildSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

1 string reference to 'JsonApiBuildSubscriber'

jsonapi_extras.services.yml in ./jsonapi_extras.services.yml

jsonapi_extras.services.yml

1 service uses JsonApiBuildSubscriber

jsonapi_extras.jsonapi_build_subscriber in ./jsonapi_extras.services.yml

Drupal\jsonapi_extras\EventSubscriber\JsonApiBuildSubscriber

File

src/EventSubscriber/JsonApiBuildSubscriber.php, line 16

Namespace

Drupal\jsonapi_extras\EventSubscriber

class JsonApiBuildSubscriber implements EventSubscriberInterface {

  /**
   * @var \Drupal\jsonapi_extras\ResourceType\ConfigurableResourceTypeRepository
   *  The extra's resource repository
   */
  private $repository;

  /**
   * JsonApiBuildSubscriber constructor.
   *
   * @param \Drupal\jsonapi_extras\ResourceType\ConfigurableResourceTypeRepository $repository
   *   Repository from jsonapi_extras is needed to apply configuration.
   */
  public function __construct(ConfigurableResourceTypeRepository $repository) {
    $this->repository = $repository;
  }

  /**
   * What events to subscribe to.
   */
  public static function getSubscribedEvents() {
    $events[ResourceTypeBuildEvents::BUILD][] = [
      'applyResourceConfig',
    ];
    return $events;
  }

  /**
   * Apply resource config through the event.
   *
   * @param \Drupal\jsonapi\ResourceType\ResourceTypeBuildEvent $event
   *   The build event used to change the resources and fields.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function applyResourceConfig(ResourceTypeBuildEvent $event) {
    $resource_config = $this
      ->getResourceConfig($event
      ->getResourceTypeName());
    if ($resource_config instanceof NullJsonapiResourceConfig) {
      return;
    }
    if ($resource_config
      ->get('disabled')) {
      $event
        ->disableResourceType();
    }
    $this
      ->overrideFields($resource_config, $event);
  }

  /**
   * Get a single resource configuration entity by its ID.
   *
   * @param string $resource_config_id
   *   The configuration entity ID.
   *
   * @return \Drupal\jsonapi_extras\Entity\JsonapiResourceConfig
   *   The configuration entity for the resource type.
   */
  protected function getResourceConfig($resource_config_id) {
    $null_resource = new NullJsonapiResourceConfig([
      'id' => $resource_config_id,
    ], 'jsonapi_resource_config');
    try {
      $resource_configs = $this->repository
        ->getResourceConfigs();
      return $resource_configs[$resource_config_id] ?? $null_resource;
    } catch (PluginException $e) {
      return $null_resource;
    }
  }

  /**
   * Gets the fields for the given field names and entity type + bundle.
   *
   * @param \Drupal\jsonapi_extras\Entity\JsonapiResourceConfig $resource_config
   *   The associated resource config.
   * @param \Drupal\jsonapi\ResourceType\ResourceTypeBuildEvent $event
   *   The associated resource config.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function overrideFields(JsonapiResourceConfig $resource_config, ResourceTypeBuildEvent $event) {

    // Use the base class to fetch the non-configurable field mappings.
    $mappings = $resource_config
      ->getFieldMapping();

    // Ignore all the fields that don't have aliases.
    $mappings = array_filter($mappings, function ($field_info) {
      return $field_info !== TRUE;
    });
    $fields = $event
      ->getFields();
    foreach ($mappings as $internal_name => $mapping) {
      if (!isset($fields[$internal_name])) {
        continue;
      }
      if (is_string($mapping)) {
        $event
          ->setPublicFieldName($fields[$internal_name], $mapping);
      }
      if ($mapping === FALSE) {
        $event
          ->disableField($fields[$internal_name]);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
JsonApiBuildSubscriber::$repository	private	property	The extra's resource repository
JsonApiBuildSubscriber::applyResourceConfig	public	function	Apply resource config through the event.
JsonApiBuildSubscriber::getResourceConfig	protected	function	Get a single resource configuration entity by its ID.
JsonApiBuildSubscriber::getSubscribedEvents	public static	function	What events to subscribe to.
JsonApiBuildSubscriber::overrideFields	protected	function	Gets the fields for the given field names and entity type + bundle.
JsonApiBuildSubscriber::__construct	public	function	JsonApiBuildSubscriber constructor.