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

Same name and namespace in other branches

1. 8.2 ldap_authorization/LdapAuthorizationConsumerAbstract.class.php \LdapAuthorizationConsumerAbstract::grantSingleAuthorization()

Parameters

object $user: as drupal user object to have $consumer_id granted.

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: in form array('my drupal role' => 'date_granted' => 1351814718, 'consumer_id_mixed_case' => 'My Drupal Role', )

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

Return value

boolean FALSE on failure or TRUE on success

1 call to LdapAuthorizationConsumerAbstract::grantSingleAuthorization()

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

1 method overrides LdapAuthorizationConsumerAbstract::grantSingleAuthorization()

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

Extends grantSingleAuthorization()

File

ldap_authorization/LdapAuthorizationConsumerAbstract.class.php, line 466

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 grantSingleAuthorization(&$user, $consumer_id, $consumer, &$user_auth_data, $user_save = FALSE, $reset = FALSE) {

  // Method must be overridden.
}