public function LdapAuthorizationConsumerAbstract::revokeSingleAuthorization in Lightweight Directory Access Protocol (LDAP) 7.2

Same name and namespace in other branches

1. 8.2 ldap_authorization/LdapAuthorizationConsumerAbstract.class.php \LdapAuthorizationConsumerAbstract::revokeSingleAuthorization()
2. 7 ldap_authorization/LdapAuthorizationConsumerAbstract.class.php \LdapAuthorizationConsumerAbstract::revokeSingleAuthorization()

Parameters

drupal user object $user: to have $consumer_id revoked.

string lower case $consumer_id: $consumer_id such as drupal role name, og group name, etc.

mixed $consumer: depends on type of consumer. Drupal roles are strings, og groups are ??

array $user_auth_data: array of $user data specific to this consumer type. stored in $user->data['ldap_authorizations'][<consumer_type>] array.

bool $reset: signifying if caches associated with $consumer_id should be invalidated.

return boolen TRUE on success, FALSE on fail. If user save is FALSE, the user object will not be saved and reloaded, so a returned TRUE may be misleading. $user_auth_data should have successfully revoked consumer id removed.

1 call to LdapAuthorizationConsumerAbstract::revokeSingleAuthorization()

LdapAuthorizationConsumerAbstract::grantsAndRevokes in ldap_authorization/LdapAuthorizationConsumerAbstract.class.php

1 method overrides LdapAuthorizationConsumerAbstract::revokeSingleAuthorization()

LdapAuthorizationConsumerDrupalRole::revokeSingleAuthorization in ldap_authorization/ldap_authorization_drupal_role/LdapAuthorizationConsumerRole.class.php

File

ldap_authorization/LdapAuthorizationConsumerAbstract.class.php, line 445

Abstract class to represent an ldap_authorization consumer behavior such as drupal_role, og_group, etc. each authorization comsumer will extend this class with its own class named LdapAuthorizationConsumer<consumer type> such as…

Class

LdapAuthorizationConsumerAbstract

Code

public function revokeSingleAuthorization(&$user, $consumer_id, $consumer, &$user_auth_data, $user_save = FALSE, $reset = FALSE) {

  // Method must be overridden.
}