Class LIGOGroupManager

Description

Primary class used for interacting with the LIGO group management tool, that is currently Grouper from Internet2.

Located in /LIGOGroupManager.php (line 27)


	
			
Method Summary
LIGOGroupManager __construct ([boolean $debug = false])
NULL addAuthorizer (string $actor, string $userName, string $classification, [string $association = NULL], [string $affiliation = NULL])
NULL addCouncilDelegate (string $actor, string $userName, string $association)
NULL addMember (string $actor, string $userName, string $classification, [string $association = NULL], [string $affiliation = NULL])
NULL addPIO (string $actor, string $userName, string $association)
boolean isAuthorizer (string $userName, string $classification, [string $association = NULL], [string $affiliation = NULL])
boolean isLIGOLabMember (string $userName)
boolean isLSCMember (string $userName)
array obtainAuthorizerGroups (string $userName)
array obtainAuthorizers (string $classification, [string $association = NULL], [string $affiliation = NULL])
NULL removeAuthorizer (string $actor, string $userName, string $classification, [string $association = NULL], [string $affiliation = NULL])
NULL removeCouncilDelegate (string $actor, string $userName, string $association)
NULL removeMember (string $actor, string $userName, string $classification, [string $association = NULL], [string $affiliation = NULL])
NULL removePIO (string $actor, string $userName, string $association)
Methods
Constructor __construct (line 46)

Constructor

  • access: public
LIGOGroupManager __construct ([boolean $debug = false])
  • boolean $debug: Enable or disable printing of debugging information to stdout.
addAuthorizer (line 736)

Add an authorizer for a membership group.

  • access: public
NULL addAuthorizer (string $actor, string $userName, string $classification, [string $association = NULL], [string $affiliation = NULL])
  • string $actor: The LIGO principal to use when invoking the operation.
  • string $userName: The LIGO princial user name.
  • string $classification: The classification of the user.
  • string $association: The association of the user.
  • string $affiliation: The affiliation (if any) of the user.
addCouncilDelegate (line 876)

Add a member to an association Council group

  • access: public
NULL addCouncilDelegate (string $actor, string $userName, string $association)
  • string $actor: The LIGO principal to use when invoking the operation.
  • string $userName: The LIGO princial user name.
  • string $association: The association of the user.
addMember (line 386)

Add a member to a membership group.

  • access: public
NULL addMember (string $actor, string $userName, string $classification, [string $association = NULL], [string $affiliation = NULL])
  • string $actor: The LIGO principal to use when invoking the operation.
  • string $userName: The LIGO princial user name.
  • string $classification: The classification of the user.
  • string $association: The association of the user.
  • string $affiliation: The affiliation (if any) of the user.
addPIO (line 1014)

Add a member to an association PIO group

  • access: public
NULL addPIO (string $actor, string $userName, string $association)
  • string $actor: The LIGO principal to use when invoking the operation.
  • string $userName: The LIGO princial user name.
  • string $association: The association of the user.
isAuthorizer (line 707)

Determine if a user is an authorizer for a MOU or LIGOLab group.

  • access: public
boolean isAuthorizer (string $userName, string $classification, [string $association = NULL], [string $affiliation = NULL])
  • string $userName: The LIGO principal for the user.
  • string $classification: The classification of the user.
  • string $association: The association of the user.
  • string $affiliation: The affiliation (if any) of the user.
isLIGOLabMember (line 307)

Determine if user is a member of the LIGOLab.

  • access: public
boolean isLIGOLabMember (string $userName)
  • string $userName: The LIGO princial user name.
isLSCMember (line 231)

Determine if user is a member of the LSC.

  • access: public
boolean isLSCMember (string $userName)
  • string $userName: The LIGO princial user name.
obtainAuthorizerGroups (line 524)

Obtain the authorizations a person has.

  • return: of arrays
  • access: public
array obtainAuthorizerGroups (string $userName)
  • string $userName: The LIGO prinicipal user name.
obtainAuthorizers (line 631)

Obtain the authorizers for a MOU or LIGOLab group.

  • return: of strings
  • access: public
array obtainAuthorizers (string $classification, [string $association = NULL], [string $affiliation = NULL])
  • string $classification: The classification of the user.
  • string $association: The association of the user.
  • string $affiliation: The affiliation (if any) of the user.
removeAuthorizer (line 809)

Remove an authorizer for a membership group.

  • access: public
NULL removeAuthorizer (string $actor, string $userName, string $classification, [string $association = NULL], [string $affiliation = NULL])
  • string $actor: The LIGO principal to use when invoking the operation.
  • string $userName: The LIGO princial user name.
  • string $classification: The classification of the user.
  • string $association: The association of the user.
  • string $affiliation: The affiliation (if any) of the user.
removeCouncilDelegate (line 947)

Remove a member from an association council group.

  • access: public
NULL removeCouncilDelegate (string $actor, string $userName, string $association)
  • string $actor: The LIGO principal to use when invoking the operation.
  • string $userName: The LIGO princial user name.
  • string $association: The association of the user.
removeMember (line 459)

Remove a member from a membership group.

  • access: public
NULL removeMember (string $actor, string $userName, string $classification, [string $association = NULL], [string $affiliation = NULL])
  • string $actor: The LIGO principal to use when invoking the operation.
  • string $userName: The LIGO princial user name.
  • string $classification: The classification of the user.
  • string $association: The association of the user.
  • string $affiliation: The affiliation (if any) of the user.
removePIO (line 1085)

Remove a member from an association PIO group.

  • access: public
NULL removePIO (string $actor, string $userName, string $association)
  • string $actor: The LIGO principal to use when invoking the operation.
  • string $userName: The LIGO princial user name.
  • string $association: The association of the user.

Documentation generated on Wed, 25 Feb 2009 15:35:11 -0600 by phpDocumentor 1.3.2