phpDocumentor Developer
[ class tree: Developer ] [ index: Developer ] [ all elements ]

Class: Federation

Source Location: /core/Federation.php

Class Federation

Class Overview

This class represents an consortium federation.

It is semantically a country(!). Do not confuse this with a TLD; a federation may span more than one TLD, and a TLD may be distributed across multiple federations.

Example: a federation "fr" => "France" may also contain other TLDs which belong to France in spite of their different TLD Example 2: Domains ending in .edu are present in multiple different federations

Located in /core/Federation.php [line 43]



		
				Author(s):
		
		
		
Information Tags:
License:  see

Properties

Methods

[ Top ]
Property Summary
static array   $FederationList   all known federation, in an array with ISO short name as an index, and localised version of the pretty-print name as value.
string   $identifier   Textual short-hand representation of this Federation

[ Top ]
Method Summary
static void   downloadStats()  
static void   getExternalDBEntityDetails()  
static void   listAllIdentityProviders()   Lists all identity providers in the database which have at least one profile adding information required by DiscoJuice.
Federation   __construct()   Constructs a Federation object.
void   listFederationAdmins()  
array   listIdentityProviders()   Lists all Identity Providers in this federation
void   listUnmappedExternalEntities()  
int   newIdP()   Creates a new IdP inside the federation.

[ Top ]
Properties
static array   $FederationList = array() [line 59]

all known federation, in an array with ISO short name as an index, and localised version of the pretty-print name as value.

The static value is only filled with meaningful content after the first object has been instantiated. That is because it is not possible to define static properties with function calls like _().

API Tags:
Access:  public


[ Top ]
string   $identifier [line 170]

Textual short-hand representation of this Federation

API Tags:
Access:  public


[ Top ]
Methods
static method downloadStats  [line 272]

  static void downloadStats( [ $federationid = NULL], [ $astablerows = FALSE]  )

Parameters:
   $federationid: 
   $astablerows: 

API Tags:
Access:  public


[ Top ]
static method getExternalDBEntityDetails  [line 249]

  static void getExternalDBEntityDetails( $external_id  )

Parameters:
   $external_id: 

API Tags:
Access:  public


[ Top ]
static method listAllIdentityProviders  [line 324]

  static void listAllIdentityProviders( [int $active_only = 0], [ $country = 0]  )

Lists all identity providers in the database which have at least one profile adding information required by DiscoJuice.

Parameters:
int   $active_only:  if and set to non-zero will cause listing of only those institutions which have some valid profiles defined.
   $country: 

API Tags:
Access:  public


[ Top ]
Constructor __construct  [line 68]

  Federation __construct( [string $fedname = 0]  )

Constructs a Federation object.

Parameters:
string   $fedname:  - textual representation of the Federation object Example: "lu" (for Luxembourg)

API Tags:
Access:  public


[ Top ]
listFederationAdmins  [line 205]

  void listFederationAdmins( )


API Tags:
Access:  public


[ Top ]
listIdentityProviders  [line 179]

  array listIdentityProviders( [int $active_only = 0]  )

Lists all Identity Providers in this federation

Parameters:
int   $active_only:  if set to non-zero will list only those institutions which have some valid profiles defined.

API Tags:
Return:  (Array of IdP instances)
Access:  public


[ Top ]
listUnmappedExternalEntities  [line 217]

  void listUnmappedExternalEntities( )


API Tags:
Access:  public


[ Top ]
newIdP  [line 152]

  int newIdP( string $owner_id, string $level, string $mail  )

Creates a new IdP inside the federation.

Parameters:
string   $owner_id:  Persistent identifier of the user for whom this IdP is created (first administrator)
string   $level:  Privilege level of the first administrator (was he blessed by a federation admin or a peer?)
string   $mail:  e-mail address with which the user was invited to administer (useful for later user identification if the user chooses a "funny" real name)

API Tags:
Return:  identifier of the new IdP
Access:  public


[ Top ]

Documentation generated on Wed, 08 Apr 2015 07:12:46 +0000 by phpDocumentor 1.4.4