Class IbisGroup

Class representing a group returned by the web service API.

IbisDto

Extended by

IbisGroup

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

Properties summary

`public boolean`	`$cancelled` Flag indicating if the group is cancelled. Flag indicating if the group is cancelled.	#
`public string`	`$groupid` The group's numeric ID (actually a string e.g., "100656"). The group's numeric ID (actually a string e.g., "100656").	#
`public string`	`$name` The group's unique name (e.g., "cs-editors"). The group's unique name (e.g., "cs-editors").	#
`public string`	`$title` The group's title. The group's title.	#
`public string`	`$description` The more detailed description of the group. The more detailed description of the group.	#
`public string`	`$email` The group's email address. The group's email address.	#
`public IbisInstitution`	`$membersOfInst` The details of the institution for which this group forms all or part of the membership. This will only be set for groups that are membership groups of institutions if the `fetch` parameter includes the `"members_of_inst"` option. The details of the institution for which this group forms all or part of the membership. This will only be set for groups that are membership groups of institutions if the `fetch` parameter includes the `"members_of_inst"` option.	#
`public IbisPerson[]`	`$members` A list of the group's members, including (recursively) any members of any included groups. This will only be populated if the `fetch` parameter includes the `"all_members"` option. A list of the group's members, including (recursively) any members of any included groups. This will only be populated if the `fetch` parameter includes the `"all_members"` option.	#
`public IbisPerson[]`	`$directMembers` A list of the group's direct members, not including any members included via groups included by this group. This will only be populated if the `fetch` parameter includes the `"direct_members"` option. A list of the group's direct members, not including any members included via groups included by this group. This will only be populated if the `fetch` parameter includes the `"direct_members"` option.	#
`public IbisInstitution[]`	`$owningInsts` A list of the institutions to which this group belongs. This will only be populated if the `fetch` parameter includes the `"owning_insts"` option. A list of the institutions to which this group belongs. This will only be populated if the `fetch` parameter includes the `"owning_insts"` option.	#
`public IbisInstitution[]`	`$managesInsts` A list of the institutions managed by this group. This will only be populated if the `fetch` parameter includes the `"manages_insts"` option. A list of the institutions managed by this group. This will only be populated if the `fetch` parameter includes the `"manages_insts"` option.	#
`public IbisGroup[]`	`$managesGroups` A list of the groups managed by this group. This will only be populated if the `fetch` parameter includes the `"manages_groups"` option. A list of the groups managed by this group. This will only be populated if the `fetch` parameter includes the `"manages_groups"` option.	#
`public IbisGroup[]`	`$managedByGroups` A list of the groups that manage this group. This will only be populated if the `fetch` parameter includes the `"managed_by_groups"` option. A list of the groups that manage this group. This will only be populated if the `fetch` parameter includes the `"managed_by_groups"` option.	#
`public IbisGroup[]`	`$readsGroups` A list of the groups that this group has privileged access to. Members of this group will be able to read the members of any of those groups, regardless of the membership visibilities. This will only be populated if the `fetch` parameter includes the `"reads_groups"` option. A list of the groups that this group has privileged access to. Members of this group will be able to read the members of any of those groups, regardless of the membership visibilities. This will only be populated if the `fetch` parameter includes the `"reads_groups"` option.	#
`public IbisGroup[]`	`$readByGroups` A list of the groups that have privileged access to this group. Members of those groups will be able to read the members of this group, regardless of the membership visibilities. This will only be populated if the `fetch` parameter includes the `"read_by_groups"` option. A list of the groups that have privileged access to this group. Members of those groups will be able to read the members of this group, regardless of the membership visibilities. This will only be populated if the `fetch` parameter includes the `"read_by_groups"` option.	#
`public IbisGroup[]`	`$includesGroups` A list of the groups directly included in this group. Any members of the included groups (and recursively any groups that they include) will automatically be included in this group. This will only be populated if the `fetch` parameter includes the `"includes_groups"` option. A list of the groups directly included in this group. Any members of the included groups (and recursively any groups that they include) will automatically be included in this group. This will only be populated if the `fetch` parameter includes the `"includes_groups"` option.	#
`public IbisGroup[]`	`$includedByGroups` A list of the groups that directly include this group. Any members of this group will automatically be included in those groups (and recursively in any groups that include those groups). This will only be populated if the `fetch` parameter includes the `"included_by_groups"` option. A list of the groups that directly include this group. Any members of this group will automatically be included in those groups (and recursively in any groups that include those groups). This will only be populated if the `fetch` parameter includes the `"included_by_groups"` option.	#