MULTI_EDIT
Interfaces, Classes, Traits and Enums
- toolMultiEdit
 - Multi edit tool that allows LDAP operations on multiple entries.
 
Table of Contents
- displayStartPage() : void
 - Displays the main page of the multi edit tool.
 - runActions() : void
 - Runs the dry run and change actions.
 - runAjaxActions() : void
 - Performs the modify operations.
 - readLDAPData() : array<string|int, mixed>
 - Reads the LDAP entries from the directory.
 - generateActions() : array<string|int, mixed>
 - Generates the required actions based on the read LDAP data.
 - dryRun() : array<string|int, mixed>
 - Prints the dryRun output.
 - multiEditLdapErrorHandler() : void
 - Error handler
 - doModify() : array<string|int, mixed>
 - Runs the actual modifications.
 - getMessageHTML() : string
 - Returns the HTML code for a htmlStatusMessage
 - extractWildcards() : array<string|int, mixed>
 - Extracts any wildcards from the value field.
 - replaceWildcards() : string
 - Replaces wildcards in the user entered value.
 
Functions
displayStartPage()
Displays the main page of the multi edit tool.
    
                    displayStartPage() : void
    
    
    
        Return values
void —runActions()
Runs the dry run and change actions.
    
                    runActions(htmlResponsiveRow $container) : void
    
        Parameters
- $container : htmlResponsiveRow
 - 
                    
container
 
Return values
void —runAjaxActions()
Performs the modify operations.
    
                    runAjaxActions() : void
    
    
    
        Return values
void —readLDAPData()
Reads the LDAP entries from the directory.
    
                    readLDAPData() : array<string|int, mixed>
    
    
    
        Return values
array<string|int, mixed> —status
generateActions()
Generates the required actions based on the read LDAP data.
    
                    generateActions() : array<string|int, mixed>
    
    
    
        Return values
array<string|int, mixed> —status
dryRun()
Prints the dryRun output.
    
                    dryRun() : array<string|int, mixed>
    
    
    
    Tags
Return values
array<string|int, mixed> —status
multiEditLdapErrorHandler()
Error handler
    
                    multiEditLdapErrorHandler(int $errno, string $errstr, string $errfile, int $errline) : void
    
        Parameters
- $errno : int
 - 
                    
error number
 - $errstr : string
 - 
                    
error message
 - $errfile : string
 - 
                    
error file
 - $errline : int
 - 
                    
error line
 
Return values
void —doModify()
Runs the actual modifications.
    
                    doModify() : array<string|int, mixed>
    
    
    
        Return values
array<string|int, mixed> —status
getMessageHTML()
Returns the HTML code for a htmlStatusMessage
    
                    getMessageHTML(htmlStatusMessage $msg) : string
    
        Parameters
- $msg : htmlStatusMessage
 - 
                    
message
 
Return values
string —HTML code
extractWildcards()
Extracts any wildcards from the value field.
    
                    extractWildcards(string $value) : array<string|int, mixed>
    
        Parameters
- $value : string
 - 
                    
value field
 
Return values
array<string|int, mixed> —wildcard attributes
replaceWildcards()
Replaces wildcards in the user entered value.
    
                    replaceWildcards(string $value, array<string|int, mixed> $entry) : string
    
        Parameters
- $value : string
 - 
                    
user entered value
 - $entry : array<string|int, mixed>
 - 
                    
LDAP entry
 
Return values
string —result