Class GrouperWSSoapClient

Description

Used to invoke operations of the Grouper WS.

The methods for this class are the operations available for the GrouperService.

Located in /GrouperSOAPClient.php (line 999)


	
			
Variable Summary
string $location
string $login
string $password
Method Summary
GrouperWSSoapClient __construct (string $location, string $login, string $password, [boolean $debug = false])
AddMemberResults addMember (GroupLookup $group, SubjectLookupArray $members, boolean $replaceAllExisting, SubjectLookup $actAsSubject, string $fieldName, string $transactionType, boolean $includeGroupDetail, boolean $includeSubjectDetail, mixed $subjectAttributeList)
DeleteMemberResults deleteMember (GroupLookup $group, SubjectLookupArray $subjects, SubjectLookup $actAsSubject, string $fieldName, string $transactionType, boolean $includeGroupDetail, boolean $includeSubjectDetail, mixed $subjectAttributeList)
GetGroupsResults getGroups (SubjectLookupArray $subjectLookupList, string $memberFilter, SubjectLookup $actAsSubject, boolean $includeGroupDetail, boolean $includeSubjectDetail, mixed $subjectAttributeList)
GetMembersResults getMembers (GroupLookupArray $groupList, string $memberFilter, SubjectLookup $actAsSubject, string $fieldName, boolean $includeGroupDetail, boolean $includeSubjectDetail, mixed $subjectAttributeList)
StemSaveResults stemSave (mixed $stemToSave, SubjectLookup $actAsSubject, string $transactionType)
Variables
string $location (line 1011)

The location or URL of the Grouper WS

For example the location might be https://grouper.phys.uwm.edu/grouper-ws/services/GrouperService

  • access: public
string $login (line 1019)

The login to use for HTTP basic authentication

  • access: public
string $password (line 1027)

The password to use for HTTP basic authentication

  • access: public
Methods
Constructor __construct (line 1100)

Constructor

  • access: public
GrouperWSSoapClient __construct (string $location, string $login, string $password, [boolean $debug = false])
  • string $location: Location or URL of the Grouper WS
  • string $login: Login to use with HTTP basic auth
  • string $password: Password to use with HTTP basic auth
  • boolean $debug: Toggle debugging to stdout
addMember (line 1169)

Add a member or members to a group

  • access: public
AddMemberResults addMember (GroupLookup $group, SubjectLookupArray $members, boolean $replaceAllExisting, SubjectLookup $actAsSubject, string $fieldName, string $transactionType, boolean $includeGroupDetail, boolean $includeSubjectDetail, mixed $subjectAttributeList)
  • GroupLookup $group: Group to which to add a member or members
  • SubjectLookupArray $members: List of subjects to add to the group
  • boolean $replaceAllExisting: Boolean indicating whether to replace all existing members
  • SubjectLookup $actAsSubject: Subject to act as when invoking operation
  • string $fieldName
  • string $transactionType: One of 'NONE' (or ''), or 'READ_WRITE_NEW'
  • boolean $includeGroupDetail: Boolean indicating whether to include group detail in return
  • boolean $includeSubjectDetail: Boolean indicating wheter to include subject detail in return
  • mixed $subjectAttributeList: Single string or array of strings indicating which subject attributes to include in return
deleteMember (line 1250)

Delete a member or members from a group

  • access: public
DeleteMemberResults deleteMember (GroupLookup $group, SubjectLookupArray $subjects, SubjectLookup $actAsSubject, string $fieldName, string $transactionType, boolean $includeGroupDetail, boolean $includeSubjectDetail, mixed $subjectAttributeList)
  • GroupLookup $group: Group from which to delete a member or members
  • SubjectLookupArray $subjects: List of subjects to delete from the group
  • SubjectLookup $actAsSubject: Subject to act as when invoking operation
  • string $fieldName
  • string $transactionType: One of 'NONE' (or ''), or 'READ_WRITE_NEW'
  • boolean $includeGroupDetail: Boolean indicating whether to include group detail in return
  • boolean $includeSubjectDetail: Boolean indicating wheter to include subject detail in return
  • mixed $subjectAttributeList: Single string or array of strings indicating which subject attributes to include in return
getGroups (line 1393)

Query for the groups to which a member or members belong

  • access: public
GetGroupsResults getGroups (SubjectLookupArray $subjectLookupList, string $memberFilter, SubjectLookup $actAsSubject, boolean $includeGroupDetail, boolean $includeSubjectDetail, mixed $subjectAttributeList)
  • SubjectLookupArray $subjectLookupList: List of subjects for which to lookup groups
  • string $memberFilter: One of 'All', 'Effective', 'Immediate', 'Composite'
  • SubjectLookup $actAsSubject: Subject to act as when invoking operation
  • boolean $includeGroupDetail: Boolean indicating whether to include group detail in return
  • boolean $includeSubjectDetail: Boolean indicating wheter to include subject detail in return
  • mixed $subjectAttributeList: Single string or array of strings indicating which subject attributes to include in return
getMembers (line 1323)

Query for the members of a group or list of groups

  • access: public
GetMembersResults getMembers (GroupLookupArray $groupList, string $memberFilter, SubjectLookup $actAsSubject, string $fieldName, boolean $includeGroupDetail, boolean $includeSubjectDetail, mixed $subjectAttributeList)
  • GroupLookupArray $groupList: List of groups for which to look up members
  • string $memberFilter: One of 'All', 'Effective', 'Immediate', 'Composite'
  • SubjectLookup $actAsSubject: Subject to act as when invoking operation
  • string $fieldName
  • boolean $includeGroupDetail: Boolean indicating whether to include group detail in return
  • boolean $includeSubjectDetail: Boolean indicating wheter to include subject detail in return
  • mixed $subjectAttributeList: Single string or array of strings indicating which subject attributes to include in return
stemSave (line 1458)

Save a stem

  • access: public
StemSaveResults stemSave (mixed $stemToSave, SubjectLookup $actAsSubject, string $transactionType)
  • mixed $stemToSave: Instance or array of instances of StemToSave
  • SubjectLookup $actAsSubject: Subject to act as when invoking operation
  • string $transactionType: One of 'NONE' (or ''), or 'READ_WRITE_NEW'

Documentation generated on Wed, 28 Jan 2009 11:17:29 -0600 by phpDocumentor 1.3.2