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

Class: Profile

Source Location: /core/IdP.php

Class Profile

Class Overview

This class represents an EAP Profile.

Profiles can inherit attributes from their IdP, if the IdP has some. Otherwise, one can set attribute in the Profile directly. If there is a conflict between IdP-wide and Profile-wide attributes, the more specific ones (i.e. Profile) win.

Located in /core/IdP.php [line 310]



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

Properties

Methods

[ Top ]
Property Summary
mixed   $identifier  
mixed   $institution  
mixed   $name  

[ Top ]
Method Summary
Profile   __construct()  
void   addAttribute()  
void   addSupportedEapMethod()   register new supported EAP method for this profile
void   destroy()   deletes the profile from database and uninstantiates itself
void   flushAttributes()  
void   flushSupportedEapMethods()   removes all supported EAP methods
void   getAnonymousIDSupport()   returns FALSE if anonymous outer ID support if disabled, or the realm if it is enabled
array   getAttributes()   getAttibutes() returnes an array of attributes, including options (as an array) if no argument is given, only the profile-wide options are returned
void   getCAs()  
void   getCollapsedAttributes()  
void   getEapMethodsinOrderOfPreference()  
void   isEapTypeDefinitionComplete()  
void   setAnonymousIDSupport()   toggle anonID support
void   setName()  

[ Top ]
Properties
mixed   $identifier [line 612]
API Tags:
Access:  public


[ Top ]
mixed   $institution [line 614]
API Tags:
Access:  public


[ Top ]
mixed   $name [line 613]
API Tags:
Access:  public


[ Top ]
Methods
Constructor __construct  [line 312]

  Profile __construct( $p_id  )

Parameters:
   $p_id: 

API Tags:
Access:  public


[ Top ]
addAttribute  [line 330]

  void addAttribute( $attr_name, $attr_value, $eap_type  )

Parameters:
   $attr_name: 
   $attr_value: 
   $eap_type: 

API Tags:
Access:  public


[ Top ]
addSupportedEapMethod  [line 352]

  void addSupportedEapMethod( string $type, int $preference  )

register new supported EAP method for this profile

Parameters:
string   $type:  Display name of EAP Type (e.g. "TTLS-PAP")
int   $preference:  preference of this EAP Type. If a preference value is re-used, the order of EAP types of the same preference level is undefined.

API Tags:
Access:  public


[ Top ]
destroy  [line 373]

  void destroy( )

deletes the profile from database and uninstantiates itself


API Tags:
Access:  public


[ Top ]
flushAttributes  [line 325]

  void flushAttributes( $eap_type  )

Parameters:
   $eap_type: 

API Tags:
Access:  public


[ Top ]
flushSupportedEapMethods  [line 387]

  void flushSupportedEapMethods( )

removes all supported EAP methods


API Tags:
Access:  public


[ Top ]
getAnonymousIDSupport  [line 413]

  void getAnonymousIDSupport( )

returns FALSE if anonymous outer ID support if disabled, or the realm if it is enabled


API Tags:
Access:  public


[ Top ]
getAttributes  [line 444]

  array getAttributes( )

getAttibutes() returnes an array of attributes, including options (as an array) if no argument is given, only the profile-wide options are returned


API Tags:
Access:  public


[ Top ]
getCAs  [line 605]

  void getCAs( $certs  )

Parameters:
   $certs: 

API Tags:
Access:  public


[ Top ]
getCollapsedAttributes  [line 550]

  void getCollapsedAttributes( )


API Tags:
Access:  public


[ Top ]
getEapMethodsinOrderOfPreference  [line 424]

  void getEapMethodsinOrderOfPreference( )


API Tags:
Access:  public


[ Top ]
isEapTypeDefinitionComplete  [line 524]

  void isEapTypeDefinitionComplete( $eaptype  )

Parameters:
   $eaptype: 

API Tags:
Access:  public


[ Top ]
setAnonymousIDSupport  [line 399]

  void setAnonymousIDSupport( boolean $shallwe, string $realm  )

toggle anonID support

Parameters:
boolean   $shallwe: 
string   $realm: 

API Tags:
Access:  public


[ Top ]
setName  [line 339]

  void setName( $name  )

Parameters:
   $name: 

API Tags:
Access:  public


[ Top ]

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