class AccessUnpublishedRouteLoad in Access unpublished 8

Loads a route with an optional token.

Plugin annotation

@DataProducer(
  id = "access_unpublished_route_load",
  name = @Translation("Load route with token"),
  description = @Translation("Loads a route with an optional token."),
  produces = @ContextDefinition("any",
    label = @Translation("Route")
  ),
  consumes = {
    "path" = @ContextDefinition("string",
      label = @Translation("Path")
    ),
    "token" = @ContextDefinition("string",
      label = @Translation("Token"),
      required = FALSE
    )
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
    • class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
      • class \Drupal\graphql\Plugin\GraphQL\DataProducer\DataProducerPluginBase implements DataProducerPluginInterface uses DataProducerPluginCachingTrait
        • class \Drupal\graphql\Plugin\GraphQL\DataProducer\Routing\RouteLoad implements ContainerFactoryPluginInterface
          • class \Drupal\access_unpublished\Plugin\GraphQL\DataProducer\AccessUnpublishedRouteLoad

Deprecated

in access_unpublished:8.x-1.3 and is removed from access_unpublished:2.0.0. Use Drupal\access_unpublished\Plugin\GraphQL\DataProducer\AccessUnpublishedTokenSet instead and compose it in your field resolver.

See also

https://www.drupal.org/project/access_unpublished/issues/3217330

File

src/Plugin/GraphQL/DataProducer/AccessUnpublishedRouteLoad.php, line 37

Namespace

Drupal\access_unpublished\Plugin\GraphQL\DataProducer

class AccessUnpublishedRouteLoad extends RouteLoad {

  /**
   * The token getter service.
   *
   * @var \Drupal\access_unpublished\TokenGetter
   */
  protected $tokenGetter;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $routeLoad = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $routeLoad
      ->setTokenGetter($container
      ->get('access_unpublished.token_getter'));
    return $routeLoad;
  }

  /**
   * Sets the token getter service.
   *
   * @param \Drupal\access_unpublished\TokenGetter $tokenGetter
   *   The token getter service.
   */
  protected function setTokenGetter(TokenGetter $tokenGetter) {
    $this->tokenGetter = $tokenGetter;
  }

  /**
   * {@inheritdoc}
   */
  public function resolveUnpublished($path, $token, RefinableCacheableDependencyInterface $metadata) {
    $this->tokenGetter
      ->setToken($token);
    return parent::resolve($path, $metadata);
  }

  /**
   * {@inheritdoc}
   */
  public function resolveField(FieldContext $field) {
    $context = $this
      ->getContextValues();
    return call_user_func_array([
      $this,
      'resolveUnpublished',
    ], array_merge($context, [
      $field,
    ]));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AccessUnpublishedRouteLoad::$tokenGetter	protected	property	The token getter service.
AccessUnpublishedRouteLoad::create	public static	function	@codeCoverageIgnore Overrides RouteLoad::create
AccessUnpublishedRouteLoad::resolveField	public	function	Resolves the queried field with the given context. Overrides DataProducerPluginBase::resolveField
AccessUnpublishedRouteLoad::resolveUnpublished	public	function
AccessUnpublishedRouteLoad::setTokenGetter	protected	function	Sets the token getter service.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
DataProducerPluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
DataProducerPluginBase::getContextDefinitions	public	function	Gets the context definitions of the plugin. Overrides ContextAwarePluginBase::getContextDefinitions
DataProducerPluginCachingTrait::edgeCachePrefix	public	function
DataProducerPluginCachingTrait::getContextValues	abstract public	function
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
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.
RouteLoad::$pathValidator	protected	property	The path validator service.
RouteLoad::$redirectRepository	protected	property	Optional redirect module repository.
RouteLoad::resolve	public	function	Resolver.
RouteLoad::__construct	public	function	Route constructor. Overrides ContextAwarePluginBase::__construct
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.
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2