lib/modules/pykotaPrinter.inc
Properties
author
package
Description Manages PyKota printers.
Classes
pykotaPrinter
Properties
Extends
Implements
package
Abstract No
Final No
Description
Manages PyKota printers. 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 ,
cnExists ,
display_html_attributes ,
display_html_members ,
getPrinterGroups ,
get_metaData ,
get_pdfEntries ,
loadPrinterNameCache ,
load_Messages ,
process_attributes ,
process_members ,
__construct(
string
$scope,
)
:
n/a
Description
Creates a new pykotaPrinter 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
cnExists(
String
$cn,
)
:
boolean
Description
Returns if the given cn already exists. Arguments
Name
Type
Description
Default
$cn
String
cn attribute value
Return value
Type
Description
boolean
cn exists
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_members(
)
:
\htmlElement
Description
This function will create the meta HTML code to show a page to add members. Return value
Type
Description
\htmlElement
HTML meta data
getPrinterGroups(
)
:
array
Description
Returns the printer group memberships. Return value
Type
Description
array
DNs of parent groups
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(
)
:
n/a
Description
Returns a list of PDF entries Return value
loadPrinterNameCache(
)
:
n/a
Description
Loads the list of printer names into the cache. Return value
load_Messages(
)
:
n/a
Description
This function fills the $messages variable with output messages from this module. 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_members(
)
:
array
Description
Processes user input of the members 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
Properties
$groupCache ,
$passThroughOptions ,
$printerCache ,
private
$groupCache
=
null
printer group cache
private
$passThroughOptions
=
list of pass through options: label => value
private
$printerCache
=
null
cache for existing printers (array(dn => array(cn => . .., description => ...)))