Difference between revisions of "JLDAP"

Revision as of 18:05, 27 April 2011

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' );

User contributed notes[edit]

@@ Line 1: / Line 1: @@
 __NOTOC__
+=={{JVer|11.1}} JLDAP==
+===Description===
+{{Description:JLDAP}}
 <span class="editsection" style="font-size:76%;">
 <nowiki>[</nowiki>[[Description:JLDAP|Edit Descripton]]<nowiki>]</nowiki>
 </span>
-{{Description:JLDAP}}
-===Defined in===
-libraries/joomla/client/ldap.php
-* see source code in [[jplatform:client/ldap.php|BitBucket]]
-===Subpackage===
-[[Subpackage Client/11.1|Client]]
-===Extends===
-[[JObject/11.1|JObject]]
-===Extended by===
 ===Methods===
 {| class="wikitable sortable"
 |-
+!Visibility
 !Method name
 !Description
 |-
+|public
 |[[JLDAP::__construct/11.1|__construct]]
 |Constructor.
 |-
+|public
 |[[JLDAP::add/11.1|add]]
 |Add an attribute to the given DN Note: DN has to exist already.
 |-
+|public
 |[[JLDAP::anonymous_bind/11.1|anonymous_bind]]
 |Anonymously binds to LDAP directory.
 |-
+|public
 |[[JLDAP::bind/11.1|bind]]
 |Binds to the LDAP directory.
 |-
+|public
 |[[JLDAP::close/11.1|close]]
 |Close the connection.
 |-
+|public
 |[[JLDAP::compare/11.1|compare]]
 |Compare an entry and return a true or false result.
 |-
+|public
 |[[JLDAP::connect/11.1|connect]]
 |Connect to server.
 |-
+|public
 |[[JLDAP::create/11.1|create]]
 |Create a new DN.
 |-
+|public
 |[[JLDAP::delete/11.1|delete]]
 |Deletes a given DN from the tree.
 |-
+|public
 |[[JLDAP::generatePassword/11.1|generatePassword]]
 |Generates a LDAP compatible password.
 |-
+|public
 |[[JLDAP::getDN/11.1|getDN]]
 |
 |-
+|public
 |[[JLDAP::getErrorMsg/11.1|getErrorMsg]]
 |Returns the error message.
 |-
+|public
 |[[JLDAP::ipToNetAddress/11.1|ipToNetAddress]]
 |Converts a dot notation IP address to net address (e.g.
 |-
+|public
 |[[JLDAP::LDAPNetAddr/11.1|LDAPNetAddr]]
 |extract readable network address from the LDAP encoded networkAddress attribute.
 |-
+|public
 |[[JLDAP::modify/11.1|modify]]
 |Modifies an entry and return a true or false result.
 |-
+|public
 |[[JLDAP::read/11.1|read]]
 |Read all or specified attributes of given dn.
 |-
+|public
 |[[JLDAP::remove/11.1|remove]]
 |Removes attribute value from given dn and return a true or false result.
 |-
+|public
 |[[JLDAP::rename/11.1|rename]]
 |Rename the entry.
 |-
+|public
 |[[JLDAP::replace/11.1|replace]]
 |Replace an entry and return a true or false result.
 |-
+|public
 |[[JLDAP::search/11.1|search]]
 |Perform an LDAP search.
 |-
+|public
 |[[JLDAP::setDN/11.1|setDN]]
 |Sets the DN with some template replacements.
 |-
+|public
 |[[JLDAP::simple_search/11.1|simple_search]]
 |Perform an LDAP search using comma seperated search strings.
 |-
 |}
+* '''Defined in''' libraries/joomla/client/ldap.php
+* '''Extends''' [[JObject/11.1|JObject]]
 ===Importing===
 <source lang="php">jimport( 'joomla.client.ldap' );</source>
 ===See also===
-* JLDAP source code in [[jplatform:client/ldap.php|BitBucket]]
+* {{JVer|11.1}} '''JLDAP source code''' on [[jplatform:client/ldap.php|BitBucket]]
-* [[JLDAP|Other versions of this class]]
+* {{JVer|11.1}} Subpackage [[Subpackage Client/11.1|Client]]
+* [[JLDAP|Other versions of JLDAP]]
 {{SeeAlso:JLDAP}}
 <span class="editsection" style="font-size:76%;">
 <nowiki>[</nowiki>[[SeeAlso:JLDAP|Edit See Also]]<nowiki>]</nowiki>
 </span>
-===Examples===
+===User contributed notes===
 <CodeExamplesForm />
 <dpl>
@@ Line 102: / Line 122: @@
 category=ClassExample
 include=*
+namespace=CodeExample
 format= ,,,
 </dpl>
 <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JLDAP]]</noinclude>

API17