IdP __construct(
integer
$i_id
)
|
|
Constructs an IdP object based on its details in the database.
Cannot be used to define a new IdP in the database! This happens via Federation::createIdP(), which doesn't exist yet :-)
Parameters:
integer |
$i_id: |
the database row identifier |
API Tags:
void addAttribute(
string
$attr_name, mixed
$attr_value
)
|
|
Adds an attribute for the IdP instance into the database. Multiple instances of the same attribute are supported.
Parameters:
string |
$attr_name: |
Name of the attribute. This must be a well-known value from the profile_option_dict table in the DB. |
mixed |
$attr_value: |
Value of the attribute. Can be anything; will be stored in the DB as-is. |
API Tags:
array beginFlushAttributes(
)
|
|
deletes all attributes in this profile except the _file ones, these are reported as array
API Tags:
Return: | list of row id's of file-based attributes which weren't deleted |
Access: | public |
void commitFlushAttributes(
array
$tobedeleted
)
|
|
after a beginFlushAttributes, deletes all attributes which are in the tobedeleted array
Parameters:
array |
$tobedeleted: |
array of database rows which are to be deleted |
API Tags:
deletes the IdP and all its profiles
API Tags:
deletes all attributes of this IdP from the database
API Tags:
array getAttributes(
[
$option_name = 0]
)
|
|
retrieves the IdP-wide attributes
Parameters:
API Tags:
Return: | Array of arrays of attributes which were set for this IdP |
Access: | public |
int isAttributeAvailable(
$option_name
)
|
|
This function returns the count of specific attributes in an IdP This function will not retreive the values attributes (particularly important for large blobs), it is mainly intended as a test for an attribute existance.
Parameters:
API Tags:
Return: | attribute count |
Access: | public |
This function retrieves all registered profiles for this IdP from the database
API Tags:
Return: | List of Profiles of this IdP |
Access: | public |
object new newProfile(
string
$name
)
|
|
Adds a new profile to this IdP.
Only creates the DB entry for the Profile and sets its name. If you want to add attributes later, see Profile::addAttribute()
Parameters:
string |
$name: |
Display Name of the profile |
API Tags:
Return: | Profile object if successful, or FALSE if an error occured |
Access: | public |
This function gets the profile count for a given IdP The count could be retreived from the listProfiles method but this is less expensive.
API Tags:
Return: | profile count |
Access: | public |