config/install/jsonapi.resource_info.yml | 1 - config/schema/jsonapi.schema.yml | 3 - jsonapi.services.yml | 7 +- ...JsonApiResource.php => JsonApiResourceType.php} | 33 ++-- src/Configuration/ResourceConfig.php | 196 --------------------- src/Configuration/ResourceConfigInterface.php | 127 ------------- src/Configuration/ResourceManagerInterface.php | 56 ------ src/EntityCollection.php | 4 +- src/EntityCollectionInterface.php | 5 +- .../Deriver/EntityDeriver.php} | 152 +++++++--------- src/Plugin/Deriver/ResourceDeriver.php | 82 --------- src/Plugin/JsonApiResourceInterface.php | 14 -- .../JsonApiResourceTypeInterface.php} | 86 ++++----- ...eManager.php => JsonApiResourceTypeManager.php} | 29 ++- src/Plugin/jsonapi/BundleJsonApiResource.php | 24 --- .../resource_type/EntityJsonApiResourceType.php} | 56 +++--- src/Routing/Routes.php | 114 ++++++------ 17 files changed, 228 insertions(+), 761 deletions(-) diff --git a/config/install/jsonapi.resource_info.yml b/config/install/jsonapi.resource_info.yml index b17ff5a..54fbb44 100644 --- a/config/install/jsonapi.resource_info.yml +++ b/config/install/jsonapi.resource_info.yml @@ -1,2 +1 @@ -prefix: api id_field: uuid diff --git a/config/schema/jsonapi.schema.yml b/config/schema/jsonapi.schema.yml index e7ddc88..3238540 100644 --- a/config/schema/jsonapi.schema.yml +++ b/config/schema/jsonapi.schema.yml @@ -1,9 +1,6 @@ jsonapi.resource_info: type: config_object mapping: - prefix: - type: string - label: 'Prefix' id_field: type: string label: 'API field' diff --git a/jsonapi.services.yml b/jsonapi.services.yml index 99f5075..5f88434 100644 --- a/jsonapi.services.yml +++ b/jsonapi.services.yml @@ -50,9 +50,6 @@ services: class: Drupal\jsonapi\Encoder\JsonEncoder tags: - { name: encoder, priority: 21, format: 'api_json' } - jsonapi.resource.manager: - class: Drupal\jsonapi\Configuration\ResourceManager - arguments: ['@entity_type.manager', '@entity_type.bundle.info', '@config.factory', '@module_handler'] jsonapi.route_enhancer: class: Drupal\jsonapi\Routing\RouteEnhancer tags: @@ -85,8 +82,8 @@ services: arguments: ['@entity.manager'] jsonapi.error_handler: class: Drupal\jsonapi\Error\ErrorHandler - plugin.manager.resource.processor: - class: Drupal\jsonapi\Plugin\JsonApiResourceManager + plugin.manager.jsonapi.resource_type: + class: Drupal\jsonapi\Plugin\JsonApiResourceTypeManager parent: default_plugin_manager jsonapi.exception_subscriber: class: Drupal\jsonapi\EventSubscriber\DefaultExceptionSubscriber diff --git a/src/Annotation/JsonApiResource.php b/src/Annotation/JsonApiResourceType.php similarity index 45% rename from src/Annotation/JsonApiResource.php rename to src/Annotation/JsonApiResourceType.php index 277de71..a648df2 100644 --- a/src/Annotation/JsonApiResource.php +++ b/src/Annotation/JsonApiResourceType.php @@ -5,14 +5,19 @@ namespace Drupal\jsonapi\Annotation; use Drupal\Component\Annotation\Plugin; /** - * Defines a JSON API Resource item annotation object. + * Defines a JSON API resource 'type' annotation object. * - * @see \Drupal\jsonapi\Plugin\JsonApiResourceManager + * Plugin Namespace: Plugin\jsonapi\resource_type + * + * @see \Drupal\jsonapi\Plugin\JsonApiResourceTypeManager + * @see \Drupal\jsonapi\Plugin\JsonApiResourceTypeInterface * @see plugin_api * + * @see http://jsonapi.org/format/#document-resource-identifier-objects — 'type' + * * @Annotation */ -class JsonApiResource extends Plugin { +class JsonApiResourceType extends Plugin { /** * The plugin ID. @@ -31,31 +36,17 @@ class JsonApiResource extends Plugin { public $label; /** - * The entity type ID. + * The JSON API resource type. * * @var string */ - public $entityType; + public $type; /** - * The bundle ID. + * The serialization class to deserialize serialized data into. * * @var string */ - public $bundle; - - /** - * Information about the data resources. - * - * @var array - */ - public $data; - - /** - * TRUE if the plugin is enabled. - * - * @var bool - */ - public $enabled; + public $serialization_class; } diff --git a/src/Configuration/ResourceConfig.php b/src/Configuration/ResourceConfig.php deleted file mode 100644 index d3b9f55..0000000 --- a/src/Configuration/ResourceConfig.php +++ /dev/null @@ -1,196 +0,0 @@ -globalConfig; - } - - /** - * {@inheritdoc} - */ - public function getEntityTypeId() { - return $this->entityTypeId; - } - - /** - * {@inheritdoc} - */ - public function setEntityTypeId($entity_type_id) { - $this->entityTypeId = $entity_type_id; - $this->deserializationTargetClass = $this->entityTypeManager - ->getDefinition($entity_type_id) - ->getClass(); - } - - /** - * {@inheritdoc} - */ - public function getTypeName() { - return $this->typeName; - } - - /** - * {@inheritdoc} - */ - public function setTypeName($type_name) { - $this->typeName = $type_name; - } - - /** - * {@inheritdoc} - */ - public function getPath() { - return $this->path; - } - - /** - * {@inheritdoc} - */ - public function setPath($path) { - $this->path = $path; - } - - /** - * {@inheritdoc} - */ - public function getBundleId() { - return $this->bundleId; - } - - /** - * {@inheritdoc} - */ - public function setBundleId($bundle_id) { - $this->bundleId = $bundle_id; - } - - /** - * {@inheritdoc} - */ - public function getStorage() { - return $this->entityTypeManager->getStorage($this->entityTypeId); - } - - /** - * {@inheritdoc} - */ - public function getDeserializationTargetClass() { - return $this->deserializationTargetClass; - } - - /** - * {@inheritdoc} - */ - public function getIdKey() { - return $this->getGlobalConfig()->get('id_field'); - } - - /** - * {@inheritdoc} - */ - public function isEnabled() { - return $this->isEnabled; - } - - /** - * {@inheritdoc} - */ - public function enable() { - $this->isEnabled = TRUE; - } - - /** - * {@inheritdoc} - */ - public function disable() { - $this->isEnabled = FALSE; - } - - /** - * Instantiates a ResourceConfig object. - * - * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory - * The configuration factory. - * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager - * The entity type manager. - */ - public function __construct(ConfigFactoryInterface $config_factory, EntityTypeManagerInterface $entity_type_manager) { - $this->globalConfig = $config_factory->get('jsonapi.resource_info'); - $this->entityTypeManager = $entity_type_manager; - } - -} diff --git a/src/Configuration/ResourceConfigInterface.php b/src/Configuration/ResourceConfigInterface.php deleted file mode 100644 index 95af84c..0000000 --- a/src/Configuration/ResourceConfigInterface.php +++ /dev/null @@ -1,127 +0,0 @@ -entityTypeManager = $entity_type_manager; $this->bundleManager = $bundle_manager; - $this->configFactory = $config_factory; - $this->moduleHandler = $module_handler; } /** * {@inheritdoc} */ - public function all($include_disabled = FALSE) { - if (!$this->all) { - $entity_type_ids = array_keys($this->entityTypeManager->getDefinitions()); - foreach ($entity_type_ids as $entity_type_id) { - // Add a ResourceConfig per bundle. - $this->all = array_merge($this->all, array_map(function ($bundle) use ($entity_type_id) { - $resource_config = new ResourceConfig($this->configFactory, $this->entityTypeManager); - $resource_config->setEntityTypeId($entity_type_id); - $resource_config->setBundleId($bundle); - $resource_config->setPath(sprintf('/%s/%s', $entity_type_id, $bundle)); - $resource_config->setTypeName(sprintf('%s--%s', $entity_type_id, $bundle)); - return $resource_config; - }, array_keys($this->bundleManager->getBundleInfo($entity_type_id)))); - } - // Allow altering the resource configuration. This is used, among other, to - // disable resources. - $this->moduleHandler->alter('jsonapi_resources', $this->all); - } - // Filter out the disabled resources if necessary. - return $include_disabled ? - $this->all : - array_filter($this->all, function ($resource) { - /* @var \Drupal\jsonapi\Configuration\ResourceConfigInterface $resource */ - return $resource->isEnabled(); - }); + public static function create(ContainerInterface $container, $base_plugin_id) { + return new static( + $container->get('entity_type.manager'), + $container->get('entity_type.bundle.info') + ); } /** * {@inheritdoc} */ - public function get($entity_type_id, $bundle_id) { - if (empty($entity_type_id)) { - throw new PreconditionFailedHttpException('Server error. The current route is malformed.'); - } - foreach ($this->all(TRUE) as $resource) { - if ($resource->getEntityTypeId() == $entity_type_id && $resource->getBundleId() == $bundle_id) { - return $resource; - } + public function getDerivativeDefinitions($base_plugin_definition) { + if (isset($this->derivatives)) { + return $this->derivatives; } - return NULL; - } + $this->derivatives = []; - /** - * {@inheritdoc} - */ - public function getEntityTypeManager() { - return $this->entityTypeManager; - } + $entity_types = $this->entityTypeManager->getDefinitions(); + foreach ($entity_types as $entity_type_id => $entity_type) { + $plugin_definition = [ + 'serialization_class' => $entity_type->getClass(), + 'route_options' => [ + 'parameters' => [ + $entity_type_id => [ + 'type' => 'entity:' . $entity_type_id, + ], + ], + ], + 'route_path_part_for_individual_resource' => $entity_type_id, + ] + $base_plugin_definition; - /** - * {@inheritdoc} - */ - public function hasBundle($entity_type_id) { - return (bool) $this->getEntityTypeManager() - ->getDefinition($entity_type_id) - ->getBundleEntityType(); - } + // First derive a JSON API Resource Type for this entity type (this covers + // all bundles). + $id = sprintf('%s', $entity_type_id); + $this->derivatives[$id] = [ + 'id' => $id, + 'type_hierarchy' => [$entity_type_id], + 'route_requirements' => [ + '_entity_type' => $entity_type_id, + ], + ] + $plugin_definition; + // Now derive an additional JSON API Resource Type for every bundle that + // exists for this entity type. + // @todo ensure new bundles are picked up immediately, see \Drupal\Core\Entity\EntityTypeBundleInfo::clearCachedBundles(). + if ($entity_type->getBundleEntityType() !== NULL) { + $bundles = array_keys($this->bundleManager->getBundleInfo($entity_type_id)); + foreach ($bundles as $bundle) { + $id = sprintf('%s.%s', $entity_type_id, $bundle); + $this->derivatives[$id] = [ + 'id' => $id, + 'type_hierarchy' => [$entity_type_id, $bundle], + 'route_requirements' => [ + '_entity_type' => $entity_type_id, + '_bundle' => $bundle, + ], + ] + $plugin_definition; + } + } + } + return $this->derivatives; + } } diff --git a/src/Plugin/Deriver/ResourceDeriver.php b/src/Plugin/Deriver/ResourceDeriver.php deleted file mode 100644 index 3048b62..0000000 --- a/src/Plugin/Deriver/ResourceDeriver.php +++ /dev/null @@ -1,82 +0,0 @@ -resourceManager = $resource_manager; - } - - /** - * {@inheritdoc} - */ - public static function create(ContainerInterface $container, $base_plugin_id) { - /* @var \Drupal\jsonapi\Configuration\ResourceManagerInterface $resource_manager */ - $resource_manager = $container->get('jsonapi.resource.manager'); - return new static($resource_manager); - } - - /** - * {@inheritdoc} - */ - public function getDerivativeDefinitions($base_definition) { - if (isset($this->derivatives)) { - return $this->derivatives; - } - $this->derivatives = []; - // Add in the default plugin configuration and the resource type. - /* @var \Drupal\jsonapi\Configuration\ResourceConfigInterface[] $resource_configs */ - $resource_configs = $this->resourceManager->all(); - foreach ($resource_configs as $resource) { - $global_config = $resource->getGlobalConfig(); - $prefix = $global_config->get('prefix'); - $id = sprintf('%s.dynamic.%s', $prefix, $resource->getTypeName()); - $this->derivatives[$id] = [ - 'id' => $id, - 'entityType' => $resource->getEntityTypeId(), - 'bundle' => $resource->getBundleId(), - 'hasBundle' => $this->resourceManager->hasBundle($resource->getEntityTypeId()), - 'type' => $resource->getTypeName(), - 'data' => [ - 'prefix' => $prefix, - 'partialPath' => '/' . $prefix . $resource->getPath() - ] - ]; - - $this->derivatives[$id] += $base_definition; - } - return $this->derivatives; - } - -} diff --git a/src/Plugin/JsonApiResourceInterface.php b/src/Plugin/JsonApiResourceInterface.php deleted file mode 100644 index 560b703..0000000 --- a/src/Plugin/JsonApiResourceInterface.php +++ /dev/null @@ -1,14 +0,0 @@ - 'access content', - 'controller' => Routes::FRONT_CONTROLLER, - 'enabled' => TRUE, - ]; - - /** - * Constructor for JsonApiResourceManager objects. + * Constructor for JsonApiResourceTypeManager objects. * * @param \Traversable $namespaces * An object that implements \Traversable which contains the root paths @@ -36,10 +23,14 @@ class JsonApiResourceManager extends DefaultPluginManager { * The module handler to invoke the alter hook with. */ public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) { - parent::__construct('Plugin/jsonapi', $namespaces, $module_handler, 'Drupal\jsonapi\Plugin\JsonApiResourceInterface', 'Drupal\jsonapi\Annotation\JsonApiResource'); + // For now, only allow the JSON API module to provide JSON API Resource Type + // plugins. The API is not yet finalized, and it's not yet clear whether it + // would make sense to allow additional types beyond entity types and entity + // type bundles. + $limited_namespaces = new \ArrayObject(['\Drupal\jsonapi' => $namespaces['Drupal\jsonapi']]); - $this->alterInfo('jsonapi_resource_info'); - $this->setCacheBackend($cache_backend, 'jsonapi_resource_plugins'); + parent::__construct('Plugin/jsonapi', $limited_namespaces, $module_handler, 'Drupal\jsonapi\Plugin\JsonApiResourceInterface', 'Drupal\jsonapi\Annotation\JsonApiResourceType'); + $this->setCacheBackend($cache_backend, 'jsonapi_resource_type_plugins'); } } diff --git a/src/Plugin/jsonapi/BundleJsonApiResource.php b/src/Plugin/jsonapi/BundleJsonApiResource.php deleted file mode 100644 index bf97da3..0000000 --- a/src/Plugin/jsonapi/BundleJsonApiResource.php +++ /dev/null @@ -1,24 +0,0 @@ -access('view', NULL, TRUE); if (!$entity_access->isAllowed()) { throw new SerializableHttpException(403, 'The current user is not allowed to GET the selected resource.'); @@ -121,7 +126,8 @@ class EntityResource implements EntityResourceInterface { * @throws \Drupal\jsonapi\Error\SerializableHttpException * If validation errors are found. */ - protected function validate(EntityInterface $entity) { + protected function validate($entity) { + assert($entity instanceof EntityInterface); if (!$entity instanceof FieldableEntityInterface) { return; } @@ -148,7 +154,8 @@ class EntityResource implements EntityResourceInterface { /** * {@inheritdoc} */ - public function createIndividual(EntityInterface $entity, Request $request) { + public function createIndividual($entity, Request $request) { + assert($entity instanceof EntityInterface); $entity_access = $entity->access('create', NULL, TRUE); if (!$entity_access->isAllowed()) { @@ -162,7 +169,8 @@ class EntityResource implements EntityResourceInterface { /** * {@inheritdoc} */ - public function patchIndividual(EntityInterface $entity, EntityInterface $parsed_entity, Request $request) { + public function patchIndividual($entity, EntityInterface $parsed_entity, Request $request) { + assert($entity instanceof EntityInterface); $entity_access = $entity->access('update', NULL, TRUE); if (!$entity_access->isAllowed()) { throw new SerializableHttpException(403, 'The current user is not allowed to GET the selected resource.'); @@ -192,7 +200,8 @@ class EntityResource implements EntityResourceInterface { /** * {@inheritdoc} */ - public function deleteIndividual(EntityInterface $entity, Request $request) { + public function deleteIndividual($entity, Request $request) { + assert($entity instanceof EntityInterface); $entity_access = $entity->access('delete', NULL, TRUE); if (!$entity_access->isAllowed()) { throw new SerializableHttpException(403, 'The current user is not allowed to DELETE the selected resource.'); @@ -242,7 +251,8 @@ class EntityResource implements EntityResourceInterface { /** * {@inheritdoc} */ - public function getRelated(EntityInterface $entity, $related_field, Request $request) { + public function getRelated($entity, $related_field, Request $request) { + assert($entity instanceof EntityInterface); /* @var $field_list \Drupal\Core\Field\FieldItemListInterface */ if (!($field_list = $entity->get($related_field)) || !$this->isRelationshipField($field_list)) { throw new SerializableHttpException(404, sprintf('The relationship %s is not present in this resource.', $related_field)); @@ -266,7 +276,8 @@ class EntityResource implements EntityResourceInterface { /** * {@inheritdoc} */ - public function getRelationship(EntityInterface $entity, $related_field, Request $request, $response_code = 200) { + public function getRelationship($entity, $related_field, Request $request, $response_code = 200) { + assert($entity instanceof EntityInterface); if (!($field_list = $entity->get($related_field)) || !$this->isRelationshipField($field_list)) { throw new SerializableHttpException(404, sprintf('The relationship %s is not present in this resource.', $related_field)); } @@ -277,7 +288,8 @@ class EntityResource implements EntityResourceInterface { /** * {@inheritdoc} */ - public function createRelationship(EntityInterface $entity, $related_field, $parsed_field_list, Request $request) { + public function createRelationship($entity, $related_field, $parsed_field_list, Request $request) { + assert($entity instanceof EntityInterface); if ($parsed_field_list instanceof Response) { // This usually means that there was an error, so there is no point on // processing further. @@ -312,7 +324,8 @@ class EntityResource implements EntityResourceInterface { /** * {@inheritdoc} */ - public function patchRelationship(EntityInterface $entity, $related_field, $parsed_field_list, Request $request) { + public function patchRelationship($entity, $related_field, $parsed_field_list, Request $request) { + assert($entity instanceof EntityInterface); if ($parsed_field_list instanceof Response) { // This usually means that there was an error, so there is no point on // processing further. @@ -371,7 +384,8 @@ class EntityResource implements EntityResourceInterface { /** * {@inheritdoc} */ - public function deleteRelationship(EntityInterface $entity, $related_field, $parsed_field_list, Request $request) { + public function deleteRelationship($entity, $related_field, $parsed_field_list, Request $request) { + assert($entity instanceof EntityInterface); if ($parsed_field_list instanceof Response) { // This usually means that there was an error, so there is no point on // processing further. diff --git a/src/Routing/Routes.php b/src/Routing/Routes.php index 2cd1413..606163c 100644 --- a/src/Routing/Routes.php +++ b/src/Routing/Routes.php @@ -4,8 +4,10 @@ namespace Drupal\jsonapi\Routing; use Drupal\Core\Authentication\AuthenticationCollectorInterface; use Drupal\Core\DependencyInjection\ContainerInjectionInterface; +use Drupal\Core\Entity\EntityTypeBundleInfoInterface; +use Drupal\Core\Entity\EntityTypeManagerInterface; use Drupal\Core\Field\EntityReferenceFieldItemList; -use Drupal\jsonapi\Plugin\JsonApiResourceManager; +use Drupal\jsonapi\Plugin\JsonApiResourceTypeManager; use Drupal\jsonapi\Resource\DocumentWrapperInterface; use Symfony\Cmf\Component\Routing\RouteObjectInterface; use Symfony\Component\DependencyInjection\ContainerInterface; @@ -27,11 +29,23 @@ class Routes implements ContainerInjectionInterface { const FRONT_CONTROLLER = '\Drupal\jsonapi\RequestHandler::handle'; /** - * The resource manager interface. + * @var \Drupal\jsonapi\Plugin\JsonApiResourceTypeManager + */ + protected $jsonApiResourceTypeManager; + + /** + * The entity type manager. + * + * @var \Drupal\Core\Entity\EntityTypeManagerInterface + */ + protected $entityTypeManager; + + /** + * The bundle manager. * - * @var \Drupal\jsonapi\Plugin\JsonApiResourceManager + * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface */ - protected $resourcePluginManager; + protected $bundleManager; /** * The authentication collector. @@ -41,7 +55,7 @@ class Routes implements ContainerInjectionInterface { protected $authCollector; /** - * List of providers. + * List of authentication provider IDs. * * @var string[] */ @@ -50,13 +64,17 @@ class Routes implements ContainerInjectionInterface { /** * Instantiates a Routes object. * - * @param \Drupal\jsonapi\Plugin\JsonApiResourceManager $resource_plugin_manager - * The resource manager. + * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager + * The entity type manager. + * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $bundle_manager + * The bundle manager. * @param \Drupal\Core\Authentication\AuthenticationCollectorInterface $auth_collector - * The resource manager. + * The authentication collector. */ - public function __construct(JsonApiResourceManager $resource_plugin_manager, AuthenticationCollectorInterface $auth_collector) { - $this->resourcePluginManager = $resource_plugin_manager; + public function __construct(JsonApiResourceTypeManager $json_api_resource_type_manager, EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfoInterface $bundle_manager, AuthenticationCollectorInterface $auth_collector) { + $this->jsonApiResourceTypeManager = $json_api_resource_type_manager; + $this->entityTypeManager = $entity_type_manager; + $this->bundleManager = $bundle_manager; $this->authCollector = $auth_collector; } @@ -64,12 +82,12 @@ class Routes implements ContainerInjectionInterface { * {@inheritdoc} */ public static function create(ContainerInterface $container) { - /* @var \Drupal\jsonapi\Plugin\JsonApiResourceManager $resource_plugin_manager */ - $resource_plugin_manager = $container->get('plugin.manager.resource.processor'); - /* @var \Drupal\Core\Authentication\AuthenticationCollectorInterface $auth_collector */ - $auth_collector = $container->get('authentication_collector'); - - return new static($resource_plugin_manager, $auth_collector); + return new static( + $container->get('plugin.manager.jsonapi.resource_type'), + $container->get('entity_type.manager'), + $container->get('entity_type.bundle.info'), + $container->get('authentication_collector') + ); } /** @@ -77,19 +95,14 @@ class Routes implements ContainerInjectionInterface { */ public function routes() { $collection = new RouteCollection(); - foreach ($this->resourcePluginManager->getDefinitions() as $plugin_id => $plugin_definition) { - if (empty($plugin_definition['enabled'])) { - continue; - } - $entity_type = $plugin_definition['entityType']; - // For the entity type resources the bundle is NULL. - $bundle = $plugin_definition['bundle']; - $partial_path = $plugin_definition['data']['partialPath']; - $route_keys = explode(':', $plugin_id); - $route_key = end($route_keys) . '.'; + + foreach ($this->jsonApiResourceTypeManager->getDefinitions() as $id => $definition) { + $route_name_prefix = 'jsonapi.' . implode('.', $definition['type_hierarchy']); + $path_prefix = '/api/' . implode('/', $definition['type_hierarchy']); + // Add the collection route. $defaults = [ - RouteObjectInterface::CONTROLLER_NAME => $plugin_definition['controller'], + RouteObjectInterface::CONTROLLER_NAME => static::FRONT_CONTROLLER, ]; // Options that apply to all routes. $options = [ @@ -98,70 +111,53 @@ class Routes implements ContainerInjectionInterface { ]; // Collection endpoint, like /api/file/photo. - $route_collection = (new Route($partial_path)) + $route_collection = (new Route($path_prefix)) ->addDefaults($defaults) - ->setRequirement('_entity_type', $entity_type) - ->setRequirement('_permission', $plugin_definition['permission']) + ->addRequirements($definition['route_requirements']) ->setRequirement('_format', 'api_json') ->setRequirement('_custom_parameter_names', 'TRUE') ->setOption('serialization_class', DocumentWrapperInterface::class) ->setMethods(['GET', 'POST']); - if ($bundle) { - $route_collection->setRequirement('_bundle', $bundle); - } $route_collection->addOptions($options); - $collection->add($route_key . 'collection', $route_collection); + $collection->add($route_name_prefix . '.collection', $route_collection); // Individual endpoint, like /api/file/photo/123. - $parameters = [$entity_type => ['type' => 'entity:' . $entity_type]]; - $route_individual = (new Route(sprintf('%s/{%s}', $partial_path, $entity_type))) + $route_individual = (new Route(sprintf('%s/{%s}', $path_prefix, $definition['route_path_part_for_individual_resource']))) ->addDefaults($defaults) - ->setRequirement('_entity_type', $entity_type) - ->setRequirement('_permission', $plugin_definition['permission']) + ->addRequirements($definition['route_requirements']) ->setRequirement('_format', 'api_json') ->setRequirement('_custom_parameter_names', 'TRUE') - ->setOption('parameters', $parameters) + ->addOptions($definition['route_options']) ->setOption('_auth', $this->authProviderList()) ->setOption('serialization_class', DocumentWrapperInterface::class) ->setMethods(['GET', 'PATCH', 'DELETE']); - if ($bundle) { - $route_individual->setRequirement('_bundle', $bundle); - } $route_individual->addOptions($options); - $collection->add($route_key . 'individual', $route_individual); + $collection->add($route_name_prefix . '.individual', $route_individual); // Related resource, like /api/file/photo/123/comments. - $route_related = (new Route(sprintf('%s/{%s}/{related}', $partial_path, $entity_type))) + $route_related = (new Route(sprintf('%s/{%s}/{related}', $path_prefix, $definition['route_path_part_for_individual_resource']))) ->addDefaults($defaults) - ->setRequirement('_entity_type', $entity_type) - ->setRequirement('_permission', $plugin_definition['permission']) + ->addRequirements($definition['route_requirements']) ->setRequirement('_format', 'api_json') ->setRequirement('_custom_parameter_names', 'TRUE') - ->setOption('parameters', $parameters) + ->addOptions($definition['route_options']) ->setOption('_auth', $this->authProviderList()) ->setMethods(['GET']); - if ($bundle) { - $route_related->setRequirement('_bundle', $bundle); - } $route_related->addOptions($options); - $collection->add($route_key . 'related', $route_related); + $collection->add($route_name_prefix . '.related', $route_related); // Related endpoint, like /api/file/photo/123/relationships/comments. - $route_relationship = (new Route(sprintf('%s/{%s}/relationships/{related}', $partial_path, $entity_type))) + $route_relationship = (new Route(sprintf('%s/{%s}/relationships/{related}', $path_prefix, $definition['route_path_part_for_individual_resource']))) ->addDefaults($defaults + ['_on_relationship' => TRUE]) - ->setRequirement('_entity_type', $entity_type) - ->setRequirement('_permission', $plugin_definition['permission']) + ->addRequirements($definition['route_requirements']) ->setRequirement('_format', 'api_json') ->setRequirement('_custom_parameter_names', 'TRUE') - ->setOption('parameters', $parameters) + ->addOptions($definition['route_options']) ->setOption('_auth', $this->authProviderList()) ->setOption('serialization_class', EntityReferenceFieldItemList::class) ->setMethods(['GET', 'POST', 'PATCH', 'DELETE']); - if ($bundle) { - $route_relationship->setRequirement('_bundle', $bundle); - } $route_relationship->addOptions($options); - $collection->add($route_key . 'relationship', $route_relationship); + $collection->add($route_name_prefix . '.relationship', $route_relationship); } return $collection;