class RemoveJsonapiFormatCompilerPass in JSON:API 8

Removes 'api_json' format from the 'serializer.formats' container parameter.

We want the 'api_json' format to not be supported in the REST module. But the JSON API module also should not have to define al alternative 'serializer' service. This is achieved through removing the 'api_json' format from the 'serializer.formats' container parameter. The consequences of doing that:

• the REST module no longer allows this format to be used
• the 'serialization.exception.default' service does not support 'api_json', hence a custom exception subscriber is needed, which this module has: 'jsonapi.exception_subscriber'
• the 'serializer' service does support 'api_json'

In other words: the 'serializer' service supports 'api_json', but nothing is aware of it. You could only know by calling 'serializer:supportsEncoding()'.

@internal

Hierarchy

• class \Drupal\jsonapi\DependencyInjection\Compiler\RemoveJsonapiFormatCompilerPass implements \Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface

See also

\Drupal\serialization\RegisterSerializationClassesCompilerPass

\Drupal\jsonapi\JsonapiServiceProvider::register()

\Drupal\jsonapi\EventSubscriber\DefaultExceptionSubscriber

\Drupal\Tests\jsonapi\Functional\RestJsonApiUnsupported

1 file declares its use of RemoveJsonapiFormatCompilerPass

JsonapiServiceProvider.php in src/JsonapiServiceProvider.php

File

src/DependencyInjection/Compiler/RemoveJsonapiFormatCompilerPass.php, line 33

Namespace

Drupal\jsonapi\DependencyInjection\Compiler

class RemoveJsonapiFormatCompilerPass implements CompilerPassInterface {

  /**
   * Updates the 'serializer.formats' container parameter.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container
   *   The container to process.
   */
  public function process(ContainerBuilder $container) {
    if ($container
      ->hasParameter('serializer.formats')) {
      $filtered_formats = array_filter($container
        ->getParameter('serializer.formats'), function ($format) {
        return $format !== 'api_json';
      });
      $container
        ->setParameter('serializer.formats', array_values($filtered_formats));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RemoveJsonapiFormatCompilerPass::process	public	function	Updates the 'serializer.formats' container parameter.