Class IbisPerson

Class representing a person returned by the web service API. Note that the identifier is the person's primary identifier (typically their CRSid), regardless of which identifier was used to query for the person.

IbisDto

IbisPerson

Author: Dean Rasheed (dev-group@ucs.cam.ac.uk)
Located at dto/IbisPerson.php

Methods summary

`public boolean`	# `isStaff()` Returns `true` if the person is a member of staff. Returns `true` if the person is a member of staff. Note that this tests for an misAffiliation of `""`, `"staff"` or `"staff,student"` since some members of staff will have a blank misAffiliation. Returns boolean `true` if the person is a member of staff.
`public boolean`	# `isStudent()` Returns `true` if the person is a student. Returns `true` if the person is a student. This tests for an misAffiliation of `"student"` or `"staff,student"`. Returns boolean `true` if the person is a student.

Properties summary

`public boolean`	`$cancelled` Flag indicating if the person is cancelled. Flag indicating if the person is cancelled.	#
`public IbisIdentifier`	`$identifier` The person's primary identifier (typically their CRSid). The person's primary identifier (typically their CRSid).	#
`public string`	`$displayName` The person's display name (if visible). The person's display name (if visible).	#
`public string`	`$registeredName` The person's registered name (if visible). The person's registered name (if visible).	#
`public string`	`$surname` The person's surname (if visible). The person's surname (if visible).	#
`public string`	`$visibleName` The person's display name if that is visible, otherwise their registered name if that is visible, otherwise their surname if that is visible, otherwise the value of their primary identifier (typically their CRSid) which is always visible. The person's display name if that is visible, otherwise their registered name if that is visible, otherwise their surname if that is visible, otherwise the value of their primary identifier (typically their CRSid) which is always visible.	#
`public string`	`$misAffiliation` The person's MIS status (`"staff"`, `"student"`, `"staff,student"` or `""`). The person's MIS status (`"staff"`, `"student"`, `"staff,student"` or `""`).	#
`public IbisIdentifier[]`	`$identifiers` A list of the person's identifiers. This will only be populated if the `fetch` parameter includes the `"all_identifiers"` option. A list of the person's identifiers. This will only be populated if the `fetch` parameter includes the `"all_identifiers"` option.	#
`public IbisAttribute[]`	`$attributes` A list of the person's attributes. This will only be populated if the `fetch` parameter includes the `"all_attrs"` option, or any specific attribute schemes such as `"email"` or `"title"`, or the special pseudo-attribute scheme `"phone_numbers"`. A list of the person's attributes. This will only be populated if the `fetch` parameter includes the `"all_attrs"` option, or any specific attribute schemes such as `"email"` or `"title"`, or the special pseudo-attribute scheme `"phone_numbers"`.	#
`public IbisInstitution[]`	`$institutions` A list of all the institution's to which the person belongs. This will only be populated if the `fetch` parameter includes the `"all_insts"` option. A list of all the institution's to which the person belongs. This will only be populated if the `fetch` parameter includes the `"all_insts"` option.	#
`public IbisGroup[]`	`$groups` A list of all the groups to which the person belongs, including indirect group memberships, via groups that include other groups. This will only be populated if the `fetch` parameter includes the `"all_groups"` option. A list of all the groups to which the person belongs, including indirect group memberships, via groups that include other groups. This will only be populated if the `fetch` parameter includes the `"all_groups"` option.	#
`public IbisGroup[]`	`$directGroups` A list of all the groups that the person directly belongs to. This does not include indirect group memberships - i.e., groups that include these groups. This will only be populated if the `fetch` parameter includes the `"direct_groups"` option. A list of all the groups that the person directly belongs to. This does not include indirect group memberships - i.e., groups that include these groups. This will only be populated if the `fetch` parameter includes the `"direct_groups"` option.	#

Classes

Interfaces

Exceptions

Class IbisPerson

Methods summary

Returns

Returns

Properties summary