You are here

interface LinkProviderManagerInterface in JSON:API Hypermedia 8

Interface LinkProviderManagerInterface.

@internal

Hierarchy

Expanded class hierarchy of LinkProviderManagerInterface

All classes that implement LinkProviderManagerInterface

See also

\Drupal\jsonapi_hypermedia\Annotation\JsonapiHypermediaLinkProvider

\Drupal\jsonapi_hypermedia\Plugin\LinkProviderManager

\Drupal\jsonapi_hypermedia\LinkProviderInterface

1 file declares its use of LinkProviderManagerInterface
JsonapiHypermediaLinkCollectionNormalizer.php in src/Normalizer/JsonapiHypermediaImpostor/JsonapiHypermediaLinkCollectionNormalizer.php

File

src/Plugin/LinkProviderManagerInterface.php, line 17

Namespace

Drupal\jsonapi_hypermedia\Plugin
View source
interface LinkProviderManagerInterface extends PluginManagerInterface, CachedDiscoveryInterface {

  /**
   * Gets a LinkCollection of 3rd-party links for the given context object.
   *
   * @param \Drupal\jsonapi\JsonApiResource\JsonApiDocumentTopLevel|\Drupal\jsonapi\JsonApiResource\ResourceObject|\Drupal\jsonapi\JsonApiResource\Relationship $context
   *   The link context object.
   *
   * @return \Drupal\jsonapi\JsonApiResource\LinkCollection
   *   The link collection.
   */
  public function getLinkCollection($context);

}

Members

Namesort descending Modifiers Type Description Overrides
CachedDiscoveryInterface::clearCachedDefinitions public function Clears static and persistent plugin definition caches. 2
CachedDiscoveryInterface::useCaches public function Disable the use of caches. 2
DiscoveryInterface::getDefinition public function Gets a specific plugin definition. 4
DiscoveryInterface::getDefinitions public function Gets the definition of all plugins for this type. 3
DiscoveryInterface::hasDefinition public function Indicates if a specific plugin definition exists. 2
FactoryInterface::createInstance public function Creates a pre-configured instance of a plugin. 7
LinkProviderManagerInterface::getLinkCollection public function Gets a LinkCollection of 3rd-party links for the given context object. 1
MapperInterface::getInstance public function Gets a preconfigured instance of a plugin. 4