class Plugins in JSON-RPC 2.x

Lists the plugin definitions of a given type.

Plugin annotation

@JsonRpcMethod(
  id = "plugins.list",
  usage = @Translation("List defined plugins."),
  access = {"administer site configuration"},
  params = {
    "page" = @JsonRpcParameterDefinition(factory = "\Drupal\jsonrpc\ParameterFactory\PaginationParameterFactory"),
    "service" = @JsonRpcParameterDefinition(
      schema={"type"="string"},
      required=true
    ),
  }
)

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
      • class \Drupal\jsonrpc_core\Plugin\jsonrpc\Method\Plugins

File

modules/jsonrpc_core/src/Plugin/jsonrpc/Method/Plugins.php, line 30

Namespace

Drupal\jsonrpc_core\Plugin\jsonrpc\Method

class Plugins extends JsonRpcMethodBase {

  /**
   * A plugin manager.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $pluginManager;

  /**
   * Plugins constructor.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, PluginManagerInterface $plugin_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->pluginManager = $plugin_manager;
  }

  /**
   * Creates a new Plugin.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   The service container.
   * @param array $configuration
   *   The configuration.
   * @param string $plugin_id
   *   The plugin ID.
   * @param mixed $plugin_definition
   *   The plugin definition.
   *
   * @return \Drupal\jsonrpc_core\Plugin\jsonrpc\Method\Plugins
   *   The plugin method.
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    /* @var \Drupal\jsonrpc\Object\Request $request */
    $request = $configuration[HandlerInterface::JSONRPC_REQUEST_KEY];

    /* @var \Drupal\Component\Plugin\PluginManagerInterface $plugin_manager */
    try {
      $plugin_manager = $container
        ->get($request
        ->getParameter('service'));
    } catch (ServiceNotFoundException $e) {
      throw JsonRpcException::fromError(Error::invalidParams($e
        ->getMessage()));
    }
    return new static($configuration, $plugin_id, $plugin_definition, $plugin_manager);
  }

  /**
   * {@inheritdoc}
   *
   * @throws \Drupal\jsonrpc\Exception\JsonRpcException
   */
  public function execute(ParameterBag $params) {
    $pager = $params
      ->get('page');
    $definitions = $this->pluginManager
      ->getDefinitions();
    foreach ($definitions as $definition) {
      if (!is_array($definition)) {
        throw JsonRpcException::fromError(Error::invalidParams('Object-based plugin definitions are not yet supported.'));
      }
    }
    if (!$pager) {
      return $definitions;
    }
    return array_slice($definitions, $pager['offset'], $pager['limit']);
  }

  /**
   * {@inheritdoc}
   */
  public static function outputSchema() {
    return [
      'type' => 'object',
      'patternProperties' => [
        '.{1,}' => [
          'class' => [
            'type' => 'string',
          ],
          'uri' => [
            'type' => 'string',
          ],
          'description' => [
            'type' => 'string',
          ],
          'provider' => [
            'type' => 'string',
          ],
          'id' => [
            'type' => 'string',
          ],
        ],
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
JsonRpcMethodBase::$rpcRequest	private	property	The RPC request for the current invocation.
JsonRpcMethodBase::currentRequest	protected	function	The RPC request for the current invocation.
JsonRpcMethodBase::methodDefinition	protected	function	The RPC method definition for the current invocation.
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.
Plugins::$pluginManager	protected	property	A plugin manager.
Plugins::create	public static	function	Creates a new Plugin. Overrides JsonRpcMethodBase::create
Plugins::execute	public	function	Overrides ExecutableWithParamsInterface::execute
Plugins::outputSchema	public static	function	Provides the schema that describes the results of the RPC method. Overrides JsonRpcMethodBase::outputSchema
Plugins::__construct	public	function	Plugins constructor. Overrides JsonRpcMethodBase::__construct
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.