You are here

class AddPermissionToRole in JSON-RPC 8

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

A method to add permissions to a role.

Plugin annotation


@JsonRpcMethod(
  id = "user_permissions.add_permission_to_role",
  usage = @Translation("Add the given permission to the specified role."),
  access = {"administer permissions"},
  params = {
    "permission" = @JsonRpcParameterDefinition(schema = {"type": "string"}),
    "role" = @JsonRpcParameterDefinition(factory = "\Drupal\jsonrpc\ParameterFactory\EntityParameterFactory"),
  }
)

Hierarchy

Expanded class hierarchy of AddPermissionToRole

File

modules/jsonrpc_core/src/Plugin/jsonrpc/Method/AddPermissionToRole.php, line 24

Namespace

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

  /**
   * {@inheritdoc}
   */
  public function execute(ParameterBag $params) {
    $permission = $params
      ->get('permission');

    /* @var \Drupal\user\RoleInterface $role */
    $role = $params
      ->get('role');
    try {
      $role
        ->grantPermission($permission);
      $violations = $role
        ->getTypedData()
        ->validate();
      if ($violations
        ->count() !== 0) {
        $error = Error::invalidParams(array_map(function (ConstraintViolationInterface $violation) {
          return $violation
            ->getMessage();
        }, iterator_to_array($violations)));
        throw JsonRpcException::fromError($error);
      }
      return $role
        ->save();
    } catch (EntityStorageException $e) {
      $error = Error::internalError('Unable to save the user role. Error: ' . $e
        ->getMessage(), $role);
      throw JsonRpcException::fromError($error);
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function outputSchema() {
    return [
      'type' => 'number',
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AddPermissionToRole::execute public function Executes the action with the parameters passed in. Overrides ExecutableWithParamsInterface::execute
AddPermissionToRole::outputSchema public static function Provides the schema that describes the results of the RPC method. Overrides JsonRpcMethodBase::outputSchema
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.
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