phpPoA2
[ class tree: phpPoA2 ] [ index: phpPoA2 ] [ all elements ]

Class: GenericConfigurator

Source Location: /lib/GenericConfigurator.php

Class Overview


Generic configuration class.


Author(s):

Variables

Methods


Child classes:

OpenIDConfigurator
Configurator class for the OpenID Authentication Engine.
PAPIConfigurator
Configurator class for the PAPI Authentication Engine.
AuthorizationConfigurator
PoAConfigurator
Main configurator for the phpPoA.

Class Details

[line 31]
Generic configuration class.



Tags:

abstract:  


[ Top ]


Class Variables

$cfg = array()

[line 33]



Tags:

access:  protected

Type:   mixed


[ Top ]

$mandatory_options = array()

[line 34]



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 42]

GenericConfigurator __construct( file $file, site $site)

Main constructor.



Tags:

throws:  PoAException if any error occurs.
access:  public


Overridden in child classes as:

PoAConfigurator::__construct()

Parameters:

file   $file   The file which stores the configuration.
site   $site   The section of the configuration that applies for the current site.

[ Top ]

method configure [line 59]

void configure( file $file, site $site)

Read the configuration from the specified file and section.



Tags:

throws:  PoAException if any error occurs.
access:  protected


Parameters:

file   $file   The file which stores the configuration.
site   $site   The section of the configuration that applies for the current site.

[ Top ]

method validate [line 84]

boolean validate( [mandatory $mandatory = null])

Check all mandatory attributes are set.



Tags:

return:  true if success.
throws:  PoAException if any error occurs.
access:  public


Parameters:

mandatory   $mandatory   Optional. An array of mandatory attributes that should be searched within the current configuration.

[ Top ]


Documentation generated on Tue, 14 Jun 2011 12:22:07 +0200 by phpDocumentor 1.4.3