abstract class JsonRpcMethodBase in JSON-RPC 2.x

Base implementation for JSON RPC methods.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\jsonrpc\Plugin\JsonRpcMethodBase implements ContainerFactoryPluginInterface, ExecutableWithParamsInterface

8 files declare their use of JsonRpcMethodBase

Cache.php in modules/jsonrpc_core/src/Plugin/jsonrpc/Method/Cache.php

FirstMethod.php in tests/modules/jsonrpc_test/src/Plugin/jsonrpc/Method/FirstMethod.php

MaintenanceModeEnabled.php in modules/jsonrpc_core/src/Plugin/jsonrpc/Method/MaintenanceModeEnabled.php

Plugins.php in modules/jsonrpc_core/src/Plugin/jsonrpc/Method/Plugins.php

RouteBuilder.php in modules/jsonrpc_core/src/Plugin/jsonrpc/Method/RouteBuilder.php

... See full list

File

src/Plugin/JsonRpcMethodBase.php, line 15

Namespace

Drupal\jsonrpc\Plugin

abstract class JsonRpcMethodBase extends PluginBase implements ContainerFactoryPluginInterface, ExecutableWithParamsInterface {

  /**
   * The RPC request for the current invocation.
   *
   * @var \Drupal\jsonrpc\Object\Request
   */
  private $rpcRequest;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, string $plugin_id, MethodInterface $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->rpcRequest = $configuration[HandlerInterface::JSONRPC_REQUEST_KEY];
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * The RPC request for the current invocation.
   *
   * @return \Drupal\jsonrpc\Object\Request
   *   The request object.
   */
  protected function currentRequest() {
    return $this->rpcRequest;
  }

  /**
   * The RPC method definition for the current invocation.
   *
   * @return \Drupal\jsonrpc\MethodInterface
   *   The method definitionm.
   */
  protected function methodDefinition() {
    return $this
      ->getPluginDefinition();
  }

  /**
   * Provides the schema that describes the results of the RPC method.
   *
   * Use NULL if the method does not provide results (is a notification).
   *
   * @return null|array
   *   The JSON Schema or a null in case of a notification.
   */
  public static abstract function outputSchema();

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
ExecutableWithParamsInterface::execute	public	function	Executes the action with the parameters passed in.	9
JsonRpcMethodBase::$rpcRequest	private	property	The RPC request for the current invocation.
JsonRpcMethodBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	4
JsonRpcMethodBase::currentRequest	protected	function	The RPC request for the current invocation.
JsonRpcMethodBase::methodDefinition	protected	function	The RPC method definition for the current invocation.
JsonRpcMethodBase::outputSchema	abstract public static	function	Provides the schema that describes the results of the RPC method.	9
JsonRpcMethodBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	4
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.