This class is made for easy service creation for editing LDAP attributes. More...
Inheritance diagram for simpleService:
Public Member Functions | |
| __construct ($dn=NULL, $parent=NULL, $attributesInfo=NULL) | |
| constructor More... | |
| render () | |
| This function display the service and return the html code. | |
| getListEntry () | |
| Get service information for servicesManagement plugin. | |
| setStatus ($value) | |
| This function save new status flag. | |
 Public Member Functions inherited from simplePlugin | |
| __construct (string $dn=NULL, $object=NULL, $parent=NULL, bool $mainTab=FALSE, array $attributesInfo=NULL) | |
| constructor More... | |
| setTemplate (bool $bool) | |
| Sets whether the opened objet is a template. More... | |
| getObjectClassFilter () | |
| This function returns an LDAP filter for this plugin object classes. | |
| __get ($name) | |
| This function allows to use the syntax $plugin->attributeName to get attributes values. More... | |
| __set ($name, $value) | |
| This function allows to use the syntax $plugin->attributeName to set attributes values. More... | |
| __isset ($name) | |
| This function allows to use the syntax isset($plugin->attributeName) More... | |
| compute_dn () | |
| This function returns the dn this object should have. | |
| get_allowed_bases () | |
| Returns a list of all available departments for this object. More... | |
| set_acl_category (string $category) | |
| Set acl category. More... | |
| move (string $src_dn, string $dst_dn) | |
| Move ldap entries from one place to another. More... | |
| getRequiredAttributes () | |
| Returns list of required LDAP attributes. More... | |
| readOnly () | |
| Indicates if this object is opened as read-only (because of locks) | |
| update () | |
| Update state and return FALSE if the dialog was closed. | |
| render () | |
| This function display the plugin and return the html code. | |
| show_header (string $buttonHtmlText, string $htmlText, bool $plugin_enabled, bool $button_disabled=FALSE, string $name='modify_state') | |
| Show header message for tab dialogs. More... | |
| isActive () | |
| Test whether a tab is active. | |
| isActivatable () | |
| Test whether a tab can be deactivated. | |
| attrIsReadable ($attr) | |
| Check if logged in user have enough right to read this attribute value. More... | |
| attrIsWriteable ($attr) | |
| Check if logged in user have enough right to write this attribute value. More... | |
| getAclBase (bool $callParent=TRUE) | |
| Get LDAP base to use for ACL checks. | |
| openDialog (FusionDirectoryDialog $dialog) | |
| This function allows you to open a dialog. More... | |
| closeDialog () | |
| This function closes the dialog. | |
| setNeedEditMode (bool $bool) | |
| Sets whether the opened objet has an edit button. More... | |
| acl_is_writeable ($attribute, bool $skipWrite=FALSE) | |
| Can we write the attribute. | |
| acl_is_readable ($attribute) | |
| Can we read the acl. More... | |
| acl_is_createable (string $base=NULL) | |
| Can we create the object. More... | |
| acl_is_removeable (string $base=NULL) | |
| Can we delete the object. More... | |
| acl_is_moveable (string $base=NULL) | |
| Can we move the object. More... | |
| aclHasPermissions () | |
| Test if there are ACLs for this plugin. | |
| aclGetPermissions ($attribute='0', string $base=NULL, bool $skipWrite=FALSE) | |
| Get the acl permissions for an attribute or the plugin itself. | |
| remove (bool $fulldelete=FALSE) | |
| This function removes the object from LDAP. | |
| save_object () | |
| This function handle $_POST informations. | |
| readPost () | |
| This function handle $_POST informations. | |
| cleanup () | |
| Remove attributes, empty arrays, arrays single attributes that do not differ. | |
| save () | |
| This function saves the object in the LDAP. | |
| mergeObjectClasses (array $oc) | |
| Merge in objectClasses needed by this tab. More... | |
| handle_post_events (string $mode, array $addAttrs=[]) | |
| Forward command execution requests to the post hook execution method. | |
| handle_pre_events (string $mode, array $addAttrs=[]) | |
| Forward command execution requests to the pre hook execution method. | |
| fillHookAttrs (array &$addAttrs) | |
| Fill attributes which may be used in hooks. More... | |
| callHook ($cmd, array $addAttrs=[], &$returnOutput=[], &$returnCode=NULL) | |
| Calls external hooks which are defined for this plugin (fusiondirectory.conf) Replaces placeholder by class values of this plugin instance. Allows to a add special replacements. | |
| check () | |
| This function checks the attributes values and yell if something is wrong. | |
| create_unique_dn (string $attribute, string $base) | |
| Create unique DN. More... | |
| adapt_from_template (array $attrs, array $skip=[]) | |
| Adapt from template. More... | |
| resetCopyInfos () | |
| This function is called on the copied object to set its dn to where it will be saved. | |
| deserializeValues (array $values, bool $checkAcl=TRUE) | |
| Deserialize values. More... | |
| showInTemplate (string $attr, array $templateAttrs) | |
| Returns TRUE if this attribute should be asked in the creation by template dialog. More... | |
| is_modal_dialog () | |
| Is there a modal dialog opened. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from simplePlugin | |
| static | plInfo () |
| Return plugin informations for acl handling. More... | |
| static | generatePlProvidedAcls (array $attributesInfo, bool $operationalAttributes=NULL) |
| This function generate the needed ACLs for a given attribtues array. More... | |
| static | mainInc ($classname=NULL, $entry_dn=NULL, $tabs=FALSE, $edit_mode=TRUE, $objectType=FALSE) |
| This function is the needed main.inc for plugins that are not used inside a management class. More... | |
| Data Fields inherited from simplePlugin | |
| $attributesInfo | |
| This attribute store all information about attributes. | |
| $attributesAccess = [] | |
| This attribute store references toward attributes. More... | |
| $is_account = FALSE | |
| Mark plugin as account. More... | |
| $dn = '' | |
| dn of the opened object | |
| $orig_dn = '' | |
| original dn of the opened object | |
| $parent = NULL | |
| Reference to parent object. More... | |
| $is_template = FALSE | |
| Mark plugin as template. More... | |
| $attrs = [] | |
| Represent temporary LDAP data. More... | |
| Protected Member Functions inherited from simplePlugin | |
| post_save () | |
| This function is called after LDAP save to do some post operations and logging. More... | |
| getAuditAttributesListFromConf () | |
| handle_hooks (string $when, string $mode, array $addAttrs=[]) | |
| Forward command execution requests to the pre/post hook execution method. More... | |
| Static Protected Member Functions inherited from simplePlugin | |
| static | passwordProtect (string $hookCommand=NULL) |
| This function protect the clear string password by replacing char. | |
| Protected Attributes inherited from simplePlugin | |
| $objectclasses = [] | |
| The objectClasses set by this tab. | |
| $saved_attributes = [] | |
| The state of the attributes when we opened the object. | |
| $displayHeader = FALSE | |
| Do we want a header allowing to able/disable this plugin. | |
| $mainTab = FALSE | |
| Is this plugin the main tab, the one that handle the object itself. | |
| $needEditMode = FALSE | |
| Are we executed in a edit-mode environment? (this is FALSE if we're called from management, TRUE if we're called from a main.inc) | |
| $preInitAttributes = [] | |
| Attributes that needs to be initialized before the others. | |
| $inheritance = FALSE | |
| FALSE to disable inheritance. Array like array ('objectClass' => 'attribute') to specify oc of the groups it might be inherited from. | |
| $read_only = FALSE | |
| Used when the entry is opened as "readonly" due to locks. | |
| $ldap_error | |
| Last LDAP error (used by logging calls from post_* methods) | |
| $entryCSN = '' | |
| Object entry CSN. More... | |
Detailed Description
This class is made for easy service creation for editing LDAP attributes.
Definition at line 25 of file class_simpleService.inc.
Constructor & Destructor Documentation
◆ __construct()
| __construct | ( | $dn = NULL, |
|
$parent = NULL, |
|||
$attributesInfo = NULL |
|||
| ) |
constructor
- Parameters
-
string $dn The dn of this instance Object $parent The servicesManagement instance array $attributesInfo An attributesInfo array, if NULL, getAttributesInfo will be used.
Definition at line 41 of file class_simpleService.inc.
References simplePlugin\$attributesInfo, simplePlugin\$dn, and simplePlugin\$parent.
The documentation for this class was generated from the following file:
- include/simpleplugin/class_simpleService.inc
