Actions

API17

Difference between revisions of "JLDAP"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
m (moving preparation)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
=={{JVer|11.1}} JLDAP==
 +
===Description===
 +
{{Description:JLDAP}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[Description:JLDAP|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JLDAP|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
{{Description:JLDAP}}
 
===Defined in===
 
libraries/joomla/client/ldap.php
 
===Subpackage===
 
[[Subpackage Client/11.1|Client]]
 
===Extends===
 
[[JObject/11.1|JObject]]
 
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
|[[JLDAP::__construct/11.1|__construct]]
+
|public
 +
|[[API17:JLDAP::__construct|__construct]]
 
|Constructor.  
 
|Constructor.  
 
|-
 
|-
|[[JLDAP::add/11.1|add]]
+
|public
 +
|[[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.  
 
|-
 
|-
|[[JLDAP::anonymous_bind/11.1|anonymous_bind]]
+
|public
 +
|[[API17:JLDAP::anonymous_bind|anonymous_bind]]
 
|Anonymously binds to LDAP directory.  
 
|Anonymously binds to LDAP directory.  
 
|-
 
|-
|[[JLDAP::bind/11.1|bind]]
+
|public
 +
|[[API17:JLDAP::bind|bind]]
 
|Binds to the LDAP directory.  
 
|Binds to the LDAP directory.  
 
|-
 
|-
|[[JLDAP::close/11.1|close]]
+
|public
 +
|[[API17:JLDAP::close|close]]
 
|Close the connection.  
 
|Close the connection.  
 
|-
 
|-
|[[JLDAP::compare/11.1|compare]]
+
|public
 +
|[[API17:JLDAP::compare|compare]]
 
|Compare an entry and return a true or false result.  
 
|Compare an entry and return a true or false result.  
 
|-
 
|-
|[[JLDAP::connect/11.1|connect]]
+
|public
 +
|[[API17:JLDAP::connect|connect]]
 
|Connect to server.  
 
|Connect to server.  
 
|-
 
|-
|[[JLDAP::create/11.1|create]]
+
|public
 +
|[[API17:JLDAP::create|create]]
 
|Create a new DN.  
 
|Create a new DN.  
 
|-
 
|-
|[[JLDAP::delete/11.1|delete]]
+
|public
 +
|[[API17:JLDAP::delete|delete]]
 
|Deletes a given DN from the tree.  
 
|Deletes a given DN from the tree.  
 
|-
 
|-
|[[JLDAP::generatePassword/11.1|generatePassword]]
+
|public
 +
|[[API17:JLDAP::generatePassword|generatePassword]]
 
|Generates a LDAP compatible password.  
 
|Generates a LDAP compatible password.  
 
|-
 
|-
|[[JLDAP::getDN/11.1|getDN]]
+
|public
 +
|[[API17:JLDAP::getDN|getDN]]
 
|
 
|
 
|-
 
|-
|[[JLDAP::getErrorMsg/11.1|getErrorMsg]]
+
|public
 +
|[[API17:JLDAP::getErrorMsg|getErrorMsg]]
 
|Returns the error message.  
 
|Returns the error message.  
 
|-
 
|-
|[[JLDAP::ipToNetAddress/11.1|ipToNetAddress]]
+
|public
 +
|[[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.  
 
|-
 
|-
|[[JLDAP::LDAPNetAddr/11.1|LDAPNetAddr]]
+
|public
 +
|[[API17:JLDAP::LDAPNetAddr|LDAPNetAddr]]
 
|extract readable network address from the LDAP encoded networkAddress attribute.  
 
|extract readable network address from the LDAP encoded networkAddress attribute.  
 
|-
 
|-
|[[JLDAP::modify/11.1|modify]]
+
|public
 +
|[[API17:JLDAP::modify|modify]]
 
|Modifies an entry and return a true or false result.  
 
|Modifies an entry and return a true or false result.  
 
|-
 
|-
|[[JLDAP::read/11.1|read]]
+
|public
 +
|[[API17:JLDAP::read|read]]
 
|Read all or specified attributes of given dn.  
 
|Read all or specified attributes of given dn.  
 
|-
 
|-
|[[JLDAP::remove/11.1|remove]]
+
|public
 +
|[[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.  
 
|-
 
|-
|[[JLDAP::rename/11.1|rename]]
+
|public
 +
|[[API17:JLDAP::rename|rename]]
 
|Rename the entry.  
 
|Rename the entry.  
 
|-
 
|-
|[[JLDAP::replace/11.1|replace]]
+
|public
 +
|[[API17:JLDAP::replace|replace]]
 
|Replace an entry and return a true or false result.  
 
|Replace an entry and return a true or false result.  
 
|-
 
|-
|[[JLDAP::search/11.1|search]]
+
|public
 +
|[[API17:JLDAP::search|search]]
 
|Perform an LDAP search.  
 
|Perform an LDAP search.  
 
|-
 
|-
|[[JLDAP::setDN/11.1|setDN]]
+
|public
 +
|[[API17:JLDAP::setDN|setDN]]
 
|Sets the DN with some template replacements.  
 
|Sets the DN with some template replacements.  
 
|-
 
|-
|[[JLDAP::simple_search/11.1|simple_search]]
+
|public
 +
|[[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
 +
* '''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===
* [[JLDAP|Other versions of this class]]
+
* {{JVer|11.1}} '''JLDAP source code''' on [[jplatform:client/ldap.php|BitBucket]]
 +
* {{JVer|11.1}} Subpackage [[API17:Subpackage Client|Client]]
 +
* [[API17:JLDAP|Other versions of JLDAP]]
 
{{SeeAlso:JLDAP}}
 
{{SeeAlso:JLDAP}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JLDAP|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JLDAP|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Examples===
+
===User contributed notes===
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 100: Line 122:
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JLDAP]]</noinclude>
+
<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

Latest revision as of 21:04, 11 May 2013

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JLDAP

Description

Description:JLDAP [Edit Descripton]

Methods

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

jimport( 'joomla.client.ldap' );

See also

SeeAlso:JLDAP [Edit See Also]

User contributed notes

<CodeExamplesForm />