You are here

class RouteBuilder in JSON-RPC 8

Same name and namespace in other branches
  1. 2.x modules/jsonrpc_core/src/Plugin/jsonrpc/Method/RouteBuilder.php \Drupal\jsonrpc_core\Plugin\jsonrpc\Method\RouteBuilder

RPC method to rebuild the routes.

Plugin annotation


@JsonRpcMethod(
  id = "route_builder.rebuild",
  access = {"administer site configuration"},
  usage = @Translation("Rebuilds the application's router. Result is TRUE if the rebuild succeeded, FALSE otherwise"),
)

Hierarchy

Expanded class hierarchy of RouteBuilder

File

modules/jsonrpc_core/src/Plugin/jsonrpc/Method/RouteBuilder.php, line 19

Namespace

Drupal\jsonrpc_core\Plugin\jsonrpc\Method
View source
class RouteBuilder extends JsonRpcMethodBase {

  /**
   * The route builder service.
   *
   * @var \Drupal\Core\Routing\RouteBuilderInterface
   */
  protected $routeBuilder;

  /**
   * RouteBuilder constructor.
   *
   * {@inheritdoc}
   */
  public function __construct(array $configuration, string $plugin_id, $plugin_definition, RouteBuilderInterface $route_builder) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->routeBuilder = $route_builder;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('router.builder'));
  }

  /**
   * {@inheritdoc}
   */
  public function execute(ParameterBag $params) {
    return $this->routeBuilder
      ->rebuild();
  }

  /**
   * {@inheritdoc}
   */
  public static function outputSchema() {
    return NULL;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 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.
RouteBuilder::$routeBuilder protected property The route builder service.
RouteBuilder::create public static function Creates an instance of the plugin. Overrides JsonRpcMethodBase::create
RouteBuilder::execute public function Executes the action with the parameters passed in. Overrides ExecutableWithParamsInterface::execute
RouteBuilder::outputSchema public static function Provides the schema that describes the results of the RPC method. Overrides JsonRpcMethodBase::outputSchema
RouteBuilder::__construct public function RouteBuilder constructor. Overrides JsonRpcMethodBase::__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.