class RoleExpireRemoveExpireTime in Role Expire 2.x

Provides a 'Remove expire time' action.

Plugin annotation

@RulesAction(
  id = "role_expire_remove_expire_time",
  label = @Translation("Remove expire time for user roles"),
  category = @Translation("Role expire"),
  context_definitions = {
    "user" = @ContextDefinition("entity:user",
      label = @Translation("User")
    ),
    "roles" = @ContextDefinition("string",
      label = @Translation("Roles ID"),
      multiple = TRUE
    )
  }
)

Hierarchy

• class \Drupal\role_expire\Plugin\RulesAction\RoleExpireRemoveExpireTime extends \Drupal\rules\Core\RulesActionBase

File

src/Plugin/RulesAction/RoleExpireRemoveExpireTime.php, line 27

Namespace

Drupal\role_expire\Plugin\RulesAction

class RoleExpireRemoveExpireTime extends RulesActionBase {

  /**
   * Assign expire time for user and role.
   *
   * @param \Drupal\user\UserInterface $account
   *   User object.
   * @param string $roles
   *   Array of User roles ID.
   *
   * @throws \Drupal\rules\Exception\InvalidArgumentException
   */
  protected function doExecute(UserInterface $account, array $roles) {
    foreach ($roles as $role) {

      // Skip adding the expire time for the role if user doesn't have it.
      if ($account
        ->hasRole($role)) {
        try {
          \Drupal::service('role_expire.api')
            ->deleteRecord($account
            ->id(), $role);
        } catch (\InvalidArgumentException $e) {
          throw new InvalidArgumentException($e
            ->getMessage());
        }
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RoleExpireRemoveExpireTime::doExecute	protected	function	Assign expire time for user and role.