Class IbisAttribute

Class representing an attribute of a person or institution returned by the web service API. Note that for institution attributes, the IbisAttribute::$instid, IbisAttribute::$visibility and IbisAttribute::$owningGroupid fields will be null.

IbisDto

IbisAttribute

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

Methods summary

`public string`	# `encodedString()` Encode this attribute as an ASCII string suitable for passing as a parameter to a web service API method. This string is compatible with `valueOf(java.lang.String)` on the corresponding Java class, used on the server to decode the attribute parameter. Encode this attribute as an ASCII string suitable for passing as a parameter to a web service API method. This string is compatible with `valueOf(java.lang.String)` on the corresponding Java class, used on the server to decode the attribute parameter. NOTE: This requires that the attribute's `IbisAttribute::$scheme` field be set, and typically the `IbisAttribute::$value` or `IbisAttribute::$binaryData` should also be set. Returns string The string encoding of this attribute.

Properties summary

`public integer`	`$attrid` The unique internal identifier of the attribute. The unique internal identifier of the attribute.	#
`public string`	`$scheme` The attribute's scheme. The attribute's scheme.	#
`public string`	`$value` The attribute's value (except for binary attributes). The attribute's value (except for binary attributes).	#
`public string`	`$binaryData` The binary data held in the attribute (e.g., a JPEG photo). The binary data held in the attribute (e.g., a JPEG photo).	#
`public string`	`$comment` Any comment associated with the attribute. Any comment associated with the attribute.	#
`public string`	`$instid` For a person attribute, the optional institution that the attribute is associated with. This will not be set for institution attributes. For a person attribute, the optional institution that the attribute is associated with. This will not be set for institution attributes.	#
`public string`	`$visibility` For a person attribute, it's visibility (`"private"`, `"institution"`, `"university"` or `"world"`). This will not be set for institution attributes. For a person attribute, it's visibility (`"private"`, `"institution"`, `"university"` or `"world"`). This will not be set for institution attributes.	#
`public DateTime`	`$effectiveFrom` For time-limited attributes, the date from which it takes effect. For time-limited attributes, the date from which it takes effect.	#
`public DateTime`	`$effectiveTo` For time-limited attributes, the date after which it is no longer effective. For time-limited attributes, the date after which it is no longer effective.	#
`public string`	`$owningGroupid` For a person attribute, the ID of the group that owns it (typically the user agent group that created it). For a person attribute, the ID of the group that owns it (typically the user agent group that created it).	#

Classes

Interfaces

Exceptions

Class IbisAttribute

Methods summary

Returns

Properties summary