WMDE
/
LDAPAccountManager
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated PHPdoc

This commit is contained in:
Roland Gruber 2010-06-11 19:39:19 +00:00
parent 2c16303759
commit 161675c697
1 changed files with 16 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
lam/lib/baseModule.inc
View File

@ -503,15 +503,15 @@ abstract class baseModule {
* *
* Calling this method does not require the existence of an enclosing {@link accountContainer}.<br> * Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
* <br> * <br>
* The return value is an array that contains meta HTML code.<br> * The return value is an object implementing htmlElement.<br>
* The type "fieldset" is not allowed here. The name attributes are used as keywords to load * The field name are used as keywords to load
* and save profiles. We recommend to use the module name as prefix for them * and save profiles. We recommend to use the module name as prefix for them
* (e.g. posixAccount_homeDirectory) to avoid naming conflicts. * (e.g. posixAccount_homeDirectory) to avoid naming conflicts.
* *
* @return array meta HTML code * @return htmlElement meta HTML object
* *
* @see baseModule::get_metaData() * @see baseModule::get_metaData()
* @see parseHtml() * @see htmlElement
*/ */
public function get_profileOptions() { public function get_profileOptions() {
if (isset($this->meta['profile_options'])) return $this->meta['profile_options']; if (isset($this->meta['profile_options'])) return $this->meta['profile_options'];
@ -635,15 +635,15 @@ abstract class baseModule {
* *
* Calling this method does not require the existence of an enclosing {@link accountContainer}.<br> * Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
* <br> * <br>
* The type "fieldset" is not allowed here. The attribute names are used as keywords to load and save settings. * The field names are used as keywords to load and save settings.
* We recommend to use the module name as prefix for them (e.g. posixAccount_homeDirectory) to avoid naming conflicts. * We recommend to use the module name as prefix for them (e.g. posixAccount_homeDirectory) to avoid naming conflicts.
* *
* @param array $scopes account types (user, group, host) * @param array $scopes account types (user, group, host)
* @param array $allScopes list of all active account modules and their scopes (module => array(scopes)) * @param array $allScopes list of all active account modules and their scopes (module => array(scopes))
* @return array meta HTML code * @return mixed htmlElement or array of htmlElement
* *
* @see baseModule::get_metaData() * @see baseModule::get_metaData()
* @see parseHtml() * @see htmlElement
*/ */
public function get_configOptions($scopes, $allScopes) { public function get_configOptions($scopes, $allScopes) {
$return = array(); $return = array();
@ -1091,8 +1091,8 @@ abstract class baseModule {
* This can be used to interact with the user, e.g. should the home directory be deleted? The output * This can be used to interact with the user, e.g. should the home directory be deleted? The output
* of all modules is displayed on a single page. * of all modules is displayed on a single page.
* *
* @return meta HTML code * @return htmlElement meta HTML object
* @see parseHtml() * @see htmlElement
*/ */
public function display_html_delete() { public function display_html_delete() {
return 0; return 0;
@ -1116,9 +1116,9 @@ abstract class baseModule {
* *
* Calling this method requires the existence of an enclosing {@link accountContainer}. * Calling this method requires the existence of an enclosing {@link accountContainer}.
* *
* @return meta HTML * @return htmlElement meta HTML object
* *
* @see parseHtml() * @see htmlElement
*/ */
public abstract function display_html_attributes(); public abstract function display_html_attributes();
@ -1218,14 +1218,13 @@ abstract class baseModule {
* *
* Calling this method does not require the existence of an enclosing {@link accountContainer}.<br> * Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
* <br> * <br>
* <b>Format:</b> array(<field1> => array(<META HTML>), ...)<br>
* It is not possible to display help links. * It is not possible to display help links.
* *
* @param array $fields list of active fields * @param array $fields list of active fields
* @param array $attributes attributes of LDAP account (attribute names in lower case) * @param array $attributes attributes of LDAP account (attribute names in lower case)
* @return array meta HTML * @return htmlElement meta HTML object
* *
* @see parseHtml() * @see htmlElement
*/ */
public function getSelfServiceOptions($fields, $attributes) { public function getSelfServiceOptions($fields, $attributes) {
// this function must be overwritten by subclasses. // this function must be overwritten by subclasses.
@ -1251,14 +1250,14 @@ abstract class baseModule {
* *
* Calling this method does not require the existence of an enclosing {@link accountContainer}.<br> * Calling this method does not require the existence of an enclosing {@link accountContainer}.<br>
* <br> * <br>
* The type "fieldset" is not allowed here. The name attributes are used as keywords to load * The name attributes are used as keywords to load
* and save settings. We recommend to use the module name as prefix for them * and save settings. We recommend to use the module name as prefix for them
* (e.g. posixAccount_homeDirectory) to avoid naming conflicts. * (e.g. posixAccount_homeDirectory) to avoid naming conflicts.
* *
* @return array meta HTML code * @return htmlElement meta HTML object
* *
* @see baseModule::get_metaData() * @see baseModule::get_metaData()
* @see parseHtml() * @see htmlElement
*/ */
public function getSelfServiceSettings() { public function getSelfServiceSettings() {
if (isset($this->meta['selfServiceSettings'])) { if (isset($this->meta['selfServiceSettings'])) {