You are here

class ListPermissions in JSON-RPC 8

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

RPC method to list all the permissions.

Plugin annotation


@JsonRpcMethod(
  id = "user_permissions.list",
  usage = @Translation("List all the permissions available in the site."),
  access = {"administer permissions"},
  params = {
    "page" = @JsonRpcParameterDefinition(factory = "\Drupal\jsonrpc\ParameterFactory\PaginationParameterFactory"),
  }
)

Hierarchy

Expanded class hierarchy of ListPermissions

File

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

Namespace

Drupal\jsonrpc_core\Plugin\jsonrpc\Method
View source
class ListPermissions extends UserPermissionsBase {

  /**
   * {@inheritdoc}
   */
  public function execute(ParameterBag $params) {
    $page = $params
      ->get('page');
    return array_slice($this->permissions
      ->getPermissions(), $page['offset'], $page['limit']);
  }

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

    // TODO: Fix the schema.
    return [
      'type' => 'foo',
    ];
  }

}

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.
ListPermissions::execute public function Executes the action with the parameters passed in. Overrides ExecutableWithParamsInterface::execute
ListPermissions::outputSchema public static function Provides the schema that describes the results of the RPC method. Overrides JsonRpcMethodBase::outputSchema
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.
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.
UserPermissionsBase::$permissions protected property The permissions handler service.
UserPermissionsBase::create public static function Creates an instance of the plugin. Overrides JsonRpcMethodBase::create
UserPermissionsBase::__construct public function UserPermissions constructor. Overrides JsonRpcMethodBase::__construct