lib/modules/freeRadius.inc
Properties
author
package
Description Manages FreeRadius accounts.
Classes
freeRadius
Properties
Extends
Implements
package
Abstract No
Final No
Description
Manages FreeRadius accounts. It implements the complete module interface and uses meta-data
provided by the account modules for its functions.
Location and naming of modules
All LAM modules are placed in lib/modules/ and are named "
.inc".
E.g. if you create a new module and its class name is "qmail" then the filename would be "qmail.inc".
The class name of a module must contain only a-z, A-Z, 0-9, -, and _.
You can avoid to override many functions by using {@link get_metaData()}.
All module classes should extend the baseModule class.
Methods
__construct ,
build_uploadAccounts ,
check_profileOptions ,
display_html_attributes ,
display_html_expiration ,
formatExpirationDate ,
get_metaData ,
get_pdfEntries ,
load_Messages ,
load_profile ,
process_attributes ,
process_expiration ,
__construct(
string
$scope,
)
:
n/a
Description
Creates a new freeRadius object. Arguments
Name
Type
Description
Default
$scope
string
account type (user, group, host)
Return value
build_uploadAccounts(
array
$rawAccounts,
array
$ids,
array
$partialAccounts,
array
$selectedModules,
)
:
array
Description
In this function the LDAP account is built up. Arguments
Name
Type
Description
Default
$rawAccounts
array
list of hash arrays (name => value) from user input
$ids
array
list of IDs for column position (e.g. "posixAccount_uid" => 5)
$partialAccounts
array
list of hash arrays (name => value) which are later added to LDAP
$selectedModules
array
list of selected account modules
Return value
Type
Description
array
list of error messages if any
check_profileOptions(
array
$options,
)
:
array
Description
Checks input values of account profiles. Arguments
Name
Type
Description
Default
$options
array
a hash array (name => value) containing the options
Return value
Type
Description
array
list of error messages (array(type, title, text)) to generate StatusMessages, if any
display_html_attributes(
)
:
\htmlElement
Description
Returns the HTML meta data for the main account page. Return value
Type
Description
\htmlElement
HTML meta data
display_html_expiration(
)
:
\htmlElement
Description
This function will create the meta HTML code to show a page to change the expiration date. Return value
Type
Description
\htmlElement
meta HTML code
formatExpirationDate(
String
$date,
)
:
n/a
Description
Formats the expiration date attribute. Arguments
Name
Type
Description
Default
$date
String
date value
Return value
get_metaData(
)
:
array
Description
Returns meta data that is interpreted by parent class Return value
Type
Description
array
array with meta data
Tags
get_pdfEntries(
)
:
array
Description
Returns the PDF entries for this module. Return value
Type
Description
array
list of possible PDF entries
load_Messages(
)
:
n/a
Description
This function fills the error message array with messages Return value
load_profile(
array
$profile,
)
:
n/a
Description
Loads the values of an account profile into internal variables. Arguments
Name
Type
Description
Default
$profile
array
hash array with profile values (identifier => value)
Return value
process_attributes(
)
:
array
Description
Processes user input of the primary module page. It checks if all input values are correct and updates the associated LDAP attributes. Return value
Type
Description
array
list of info/error messages
process_expiration(
)
:
array
Description
Processes user input of the time selection page. Return value
Type
Description
array
list of info/error messages
Properties
$monthList ,
private
static $monthList
=
array('01' => 'Jan', '02' => 'Feb', '03' => 'Mar', '04' => 'Apr', '05' => 'May', '06' => 'Jun', '07' => 'Jul', '08' => 'Aug', '09' => 'Sep', '10' => 'Oct', '11' => 'Nov', '12' => 'Dec')
list of possible months