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

Class: Federation

Source Location: /core/Federation.php

Class Federation

Class Overview

This class represents an eduroam 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 31]



		
				Author(s):
		
		
		
Information Tags:
License:  http://ticker.eduroam.lu/cat/LICENSE

Properties

Methods

[ Top ]
Property Summary
string   $identifier   Textual short-hand representation of this Federation

[ Top ]
Method Summary
static array   bootstrapFederation()   Lists all Identity Providers in this federation
static array   country_list()  
static void   listAllIdentityProviders()  
static array   listFederations()   Lists all federations that exist in the database
static string   name()  
Federation   __construct()   Constructs a Federation object.
array   listIdentityProviders()   Lists all Identity Providers in this federation
void   newIdP()  
array   printCountryList()   Prepares a list of countries known to the CAT

[ Top ]
Properties
string   $identifier [line 179]

Textual short-hand representation of this Federation

API Tags:
Access:  public


[ Top ]
Methods
static method bootstrapFederation  [line 154]

  static array bootstrapFederation( $fedname, $firstinst  )

Lists all Identity Providers in this federation

Parameters:
   $fedname: 
   $firstinst: 

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


[ Top ]
static method country_list  [line 122]

  static array country_list( )


API Tags:
Return:  The list of countries; consisting of an array where key = shortname, value = display name
Access:  public


[ Top ]
static method listAllIdentityProviders  [line 214]

  static void listAllIdentityProviders( )


API Tags:
Access:  public


[ Top ]
static method listFederations  [line 132]

  static array listFederations( )

Lists all federations that exist in the database


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


[ Top ]
static method name  [line 112]

  static string name( string $code  )

Parameters:
string   $code:  The shortname of the country

API Tags:
Return:  The display name of the country
Access:  public


[ Top ]
Constructor __construct  [line 41]

  Federation __construct( string $fedname  )

Constructs a Federation object.

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

API Tags:
Access:  public


[ Top ]
listIdentityProviders  [line 189]

  array listIdentityProviders( [int $active_only = 0]  )

Lists all Identity Providers in this federation

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

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


[ Top ]
newIdP  [line 164]

  void newIdP( $name  )

Parameters:
   $name: 

API Tags:
Access:  public


[ Top ]
printCountryList  [line 51]

  array printCountryList( [int $active_only = 0]  )

Prepares a list of countries known to the CAT

Parameters:
int   $active_only:  is set and nonzero will cause that only countries with some institutions underneath will be listed

API Tags:
Return:  Array indexed by (uppercase) lang codes and sorted according to the current locale
Access:  public


[ Top ]

Documentation generated on Thu, 13 Oct 2011 08:42:10 +0200 by phpDocumentor 1.4.3