class FirstMethod in JSON-RPC 2.x
First test method.
Plugin annotation
@JsonRpcMethod(
id = "first.test",
usage = @Translation("First test method."),
access = {"access content"},
responseHeaders = {
"foo": "bar",
"lorem": "ipsum",
"hello": "world",
}
)
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_test\Plugin\jsonrpc\Method\FirstMethod
- class \Drupal\jsonrpc\Plugin\JsonRpcMethodBase implements ContainerFactoryPluginInterface, ExecutableWithParamsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of FirstMethod
File
- tests/
modules/ jsonrpc_test/ src/ Plugin/ jsonrpc/ Method/ FirstMethod.php, line 22
Namespace
Drupal\jsonrpc_test\Plugin\jsonrpc\MethodView source
class FirstMethod extends JsonRpcMethodBase {
/**
* {@inheritdoc}
*/
public function execute(ParameterBag $params) {
return mt_rand(0, 100);
}
/**
* {@inheritdoc}
*/
public static function outputSchema() {
return [
'type' => 'number',
];
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FirstMethod:: |
public | function |
Executes the action with the parameters passed in. Overrides ExecutableWithParamsInterface:: |
|
FirstMethod:: |
public static | function |
Provides the schema that describes the results of the RPC method. Overrides JsonRpcMethodBase:: |
|
JsonRpcMethodBase:: |
private | property | The RPC request for the current invocation. | |
JsonRpcMethodBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
4 |
JsonRpcMethodBase:: |
protected | function | The RPC request for the current invocation. | |
JsonRpcMethodBase:: |
protected | function | The RPC method definition for the current invocation. | |
JsonRpcMethodBase:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
4 |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |