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

Class: Federation

Source Location: /core/IdP.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/IdP.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   listFederations()   Lists all federations that exist in the database
Federation   __construct()   Constructs a Federation object.
array   listIdentityProviders()   Lists all Identity Providers in this federation
array   listIdentityProvidersForDisco()   Tomasz should document this function, and why it has to be different from the previous listIdentityProviders

[ Top ]
Properties
string   $identifier [line 101]

Textual short-hand representation of this Federation

API Tags:
Access:  public


[ Top ]
Methods
static method listFederations  [line 54]

  static array listFederations( )

Lists all federations that exist in the database


API Tags:
Return:  (Array of Federation instances)
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 76]

  array listIdentityProviders( )

Lists all Identity Providers in this federation


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


[ Top ]
listIdentityProvidersForDisco  [line 112]

  array listIdentityProvidersForDisco( )

Tomasz should document this function, and why it has to be different from the previous listIdentityProviders


API Tags:
Return:  some array with stuff
Access:  public


[ Top ]

Documentation generated on Thu, 14 Jul 2011 10:11:51 +0200 by phpDocumentor 1.4.3