Difference between revisions of "JLDAP"
From Joomla! Documentation
m (→User contributed notes: moving preparation) |
m (moving preparation) |
||
Line 14: | Line 14: | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::__construct | + | |[[API17:JLDAP::__construct|__construct]] |
|Constructor. | |Constructor. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::add | + | |[[API17:JLDAP::add|add]] |
|Add an attribute to the given DN Note: DN has to exist already. | |Add an attribute to the given DN Note: DN has to exist already. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::anonymous_bind | + | |[[API17:JLDAP::anonymous_bind|anonymous_bind]] |
|Anonymously binds to LDAP directory. | |Anonymously binds to LDAP directory. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::bind | + | |[[API17:JLDAP::bind|bind]] |
|Binds to the LDAP directory. | |Binds to the LDAP directory. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::close | + | |[[API17:JLDAP::close|close]] |
|Close the connection. | |Close the connection. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::compare | + | |[[API17:JLDAP::compare|compare]] |
|Compare an entry and return a true or false result. | |Compare an entry and return a true or false result. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::connect | + | |[[API17:JLDAP::connect|connect]] |
|Connect to server. | |Connect to server. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::create | + | |[[API17:JLDAP::create|create]] |
|Create a new DN. | |Create a new DN. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::delete | + | |[[API17:JLDAP::delete|delete]] |
|Deletes a given DN from the tree. | |Deletes a given DN from the tree. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::generatePassword | + | |[[API17:JLDAP::generatePassword|generatePassword]] |
|Generates a LDAP compatible password. | |Generates a LDAP compatible password. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::getDN | + | |[[API17:JLDAP::getDN|getDN]] |
| | | | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::getErrorMsg | + | |[[API17:JLDAP::getErrorMsg|getErrorMsg]] |
|Returns the error message. | |Returns the error message. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::ipToNetAddress | + | |[[API17:JLDAP::ipToNetAddress|ipToNetAddress]] |
|Converts a dot notation IP address to net address (e.g. | |Converts a dot notation IP address to net address (e.g. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::LDAPNetAddr | + | |[[API17:JLDAP::LDAPNetAddr|LDAPNetAddr]] |
|extract readable network address from the LDAP encoded networkAddress attribute. | |extract readable network address from the LDAP encoded networkAddress attribute. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::modify | + | |[[API17:JLDAP::modify|modify]] |
|Modifies an entry and return a true or false result. | |Modifies an entry and return a true or false result. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::read | + | |[[API17:JLDAP::read|read]] |
|Read all or specified attributes of given dn. | |Read all or specified attributes of given dn. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::remove | + | |[[API17:JLDAP::remove|remove]] |
|Removes attribute value from given dn and return a true or false result. | |Removes attribute value from given dn and return a true or false result. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::rename | + | |[[API17:JLDAP::rename|rename]] |
|Rename the entry. | |Rename the entry. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::replace | + | |[[API17:JLDAP::replace|replace]] |
|Replace an entry and return a true or false result. | |Replace an entry and return a true or false result. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::search | + | |[[API17:JLDAP::search|search]] |
|Perform an LDAP search. | |Perform an LDAP search. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::setDN | + | |[[API17:JLDAP::setDN|setDN]] |
|Sets the DN with some template replacements. | |Sets the DN with some template replacements. | ||
|- | |- | ||
|public | |public | ||
− | |[[JLDAP::simple_search | + | |[[API17:JLDAP::simple_search|simple_search]] |
|Perform an LDAP search using comma seperated search strings. | |Perform an LDAP search using comma seperated search strings. | ||
|- | |- | ||
|} | |} | ||
* '''Defined in''' libraries/joomla/client/ldap.php | * '''Defined in''' libraries/joomla/client/ldap.php | ||
− | * '''Extends''' [[JObject | + | * '''Extends''' [[API17:JObject|JObject]] |
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.client.ldap' );</source> | <source lang="php">jimport( 'joomla.client.ldap' );</source> | ||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JLDAP source code''' on [[jplatform:client/ldap.php|BitBucket]] | * {{JVer|11.1}} '''JLDAP source code''' on [[jplatform:client/ldap.php|BitBucket]] | ||
− | * {{JVer|11.1}} Subpackage [[Subpackage Client | + | * {{JVer|11.1}} Subpackage [[API17:Subpackage Client|Client]] |
− | * [[JLDAP|Other versions of JLDAP]] | + | * [[API17:JLDAP|Other versions of JLDAP]] |
{{SeeAlso:JLDAP}} | {{SeeAlso:JLDAP}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> |
Revision as of 21:04, 11 May 2013
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JLDAP[edit]
Description[edit]
Template:Description:JLDAP [Edit Descripton]
Methods[edit]
Visibility | Method name | Description |
---|---|---|
public | __construct | Constructor. |
public | add | Add an attribute to the given DN Note: DN has to exist already. |
public | anonymous_bind | Anonymously binds to LDAP directory. |
public | bind | Binds to the LDAP directory. |
public | close | Close the connection. |
public | compare | Compare an entry and return a true or false result. |
public | connect | Connect to server. |
public | create | Create a new DN. |
public | delete | Deletes a given DN from the tree. |
public | generatePassword | Generates a LDAP compatible password. |
public | getDN | |
public | getErrorMsg | Returns the error message. |
public | ipToNetAddress | Converts a dot notation IP address to net address (e.g. |
public | LDAPNetAddr | extract readable network address from the LDAP encoded networkAddress attribute. |
public | modify | Modifies an entry and return a true or false result. |
public | read | Read all or specified attributes of given dn. |
public | remove | Removes attribute value from given dn and return a true or false result. |
public | rename | Rename the entry. |
public | replace | Replace an entry and return a true or false result. |
public | search | Perform an LDAP search. |
public | setDN | Sets the DN with some template replacements. |
public | simple_search | Perform an LDAP search using comma seperated search strings. |
- Defined in libraries/joomla/client/ldap.php
- Extends JObject
Importing[edit]
jimport( 'joomla.client.ldap' );
See also[edit]
- JLDAP source code on BitBucket
- Subpackage Client
- Other versions of JLDAP
Template:SeeAlso:JLDAP [Edit See Also]
User contributed notes[edit]
<CodeExamplesForm />