abstract class TopLevelSchemaLinkProviderBase in JSON:API Schema 8

Class TopLevelSchemaLinkProviderBase.

@internal

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\jsonapi_hypermedia\Plugin\LinkProviderBase implements LinkProviderInterface
      • class \Drupal\jsonapi_schema\Plugin\jsonapi_hypermedia\LinkProvider\TopLevelSchemaLinkProviderBase implements ContainerFactoryPluginInterface

File

src/Plugin/jsonapi_hypermedia/LinkProvider/TopLevelSchemaLinkProviderBase.php, line 23

Namespace

Drupal\jsonapi_schema\Plugin\jsonapi_hypermedia\LinkProvider

abstract class TopLevelSchemaLinkProviderBase extends LinkProviderBase implements ContainerFactoryPluginInterface {
  protected static $schemaRouteType = NULL;

  /**
   * The current route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $currentRouteMatch;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    assert(in_array(static::$schemaRouteType, [
      'item',
      'collection',
      'entrypoint',
    ], TRUE));
    $provider = new static($configuration, $plugin_id, $plugin_definition);
    $provider
      ->setCurrentRouteMatch($container
      ->get('current_route_match'));
    return $provider;
  }

  /**
   * Sets the current route match.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   */
  public function setCurrentRouteMatch(RouteMatchInterface $route_match) {
    $this->currentRouteMatch = $route_match;
  }

  /**
   * {@inheritdoc}
   */
  public function getLink($context) {
    assert($context instanceof JsonApiDocumentTopLevel);
    if (static::$schemaRouteType === 'entrypoint') {
      $schema_route_name = "jsonapi_schema." . static::$schemaRouteType;
    }
    else {
      $route = $this->currentRouteMatch
        ->getRouteObject();
      assert($route instanceof Route);
      $resource_type = $route
        ->getDefault(Routes::RESOURCE_TYPE_KEY);
      if (!$resource_type instanceof ResourceType) {
        return AccessRestrictedLink::createInaccessibleLink(new CacheableMetadata());
      }
      $schema_route_name = "jsonapi_schema.{$resource_type->getTypeName()}." . static::$schemaRouteType;
    }
    return AccessRestrictedLink::createLink(AccessResult::allowed(), new CacheableMetadata(), new Url($schema_route_name), $this
      ->getLinkRelationType());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
LinkProviderBase::getLinkKey	public	function	Gets the link object key for the provided link. Overrides LinkProviderInterface::getLinkKey
LinkProviderBase::getLinkRelationType	public	function	Gets the link relation type for the provided link. Overrides LinkProviderInterface::getLinkRelationType	1
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.
TopLevelSchemaLinkProviderBase::$currentRouteMatch	protected	property	The current route match.
TopLevelSchemaLinkProviderBase::$schemaRouteType	protected static	property		3
TopLevelSchemaLinkProviderBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
TopLevelSchemaLinkProviderBase::getLink	public	function	Adds, alters or removes hyperlinks from a link collection. Overrides LinkProviderInterface::getLink
TopLevelSchemaLinkProviderBase::setCurrentRouteMatch	public	function	Sets the current route match.