JLDAP/1.5

From Joomla! Documentation
< JLDAP(Difference between revisions)
Jump to: navigation, search
(Bulk upload by Doxiki2)
 
(Layout updates)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
=={{JVer|1.5}} 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/1.5|Client]]
 
−
===Extends===
 
−
[[JObject/1.5|JObject]]
 
−
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
 +
|public
 
|[[JLDAP::__construct/1.5|__construct]]
 
|[[JLDAP::__construct/1.5|__construct]]
 
|Constructor.  
 
|Constructor.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::add/1.5|add]]
 
|[[JLDAP::add/1.5|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
 
|[[JLDAP::anonymous_bind/1.5|anonymous_bind]]
 
|[[JLDAP::anonymous_bind/1.5|anonymous_bind]]
 
|Anonymously Binds to LDAP Directory.  
 
|Anonymously Binds to LDAP Directory.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::bind/1.5|bind]]
 
|[[JLDAP::bind/1.5|bind]]
 
|Binds to the LDAP directory.  
 
|Binds to the LDAP directory.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::close/1.5|close]]
 
|[[JLDAP::close/1.5|close]]
 
|Close the connection  public.  
 
|Close the connection  public.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::compare/1.5|compare]]
 
|[[JLDAP::compare/1.5|compare]]
 
|Compare an entry and return a true or false result.  
 
|Compare an entry and return a true or false result.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::connect/1.5|connect]]
 
|[[JLDAP::connect/1.5|connect]]
 
|Connect to server.  
 
|Connect to server.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::create/1.5|create]]
 
|[[JLDAP::create/1.5|create]]
 
|Create a new DN.  
 
|Create a new DN.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::delete/1.5|delete]]
 
|[[JLDAP::delete/1.5|delete]]
 
|Deletes a given DN from the tree.  
 
|Deletes a given DN from the tree.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::generatePassword/1.5|generatePassword]]
 
|[[JLDAP::generatePassword/1.5|generatePassword]]
 
|Generates a LDAP compatible password.  
 
|Generates a LDAP compatible password.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::getDN/1.5|getDN]]
 
|[[JLDAP::getDN/1.5|getDN]]
 
|
 
|
 
|-
 
|-
 +
|public
 
|[[JLDAP::getErrorMsg/1.5|getErrorMsg]]
 
|[[JLDAP::getErrorMsg/1.5|getErrorMsg]]
 
|Returns the error message.  
 
|Returns the error message.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::ipToNetAddress/1.5|ipToNetAddress]]
 
|[[JLDAP::ipToNetAddress/1.5|ipToNetAddress]]
 
|Converts a dot notation IP address to net address (e.g.  
 
|Converts a dot notation IP address to net address (e.g.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::LDAPNetAddr/1.5|LDAPNetAddr]]
 
|[[JLDAP::LDAPNetAddr/1.5|LDAPNetAddr]]
 
|extract readable network address from the LDAP encoded networkAddress attribute.  
 
|extract readable network address from the LDAP encoded networkAddress attribute.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::modify/1.5|modify]]
 
|[[JLDAP::modify/1.5|modify]]
 
|Modifies an entry and return a true or false result.  
 
|Modifies an entry and return a true or false result.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::read/1.5|read]]
 
|[[JLDAP::read/1.5|read]]
 
|Read all or specified attributes of given dn.  
 
|Read all or specified attributes of given dn.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::remove/1.5|remove]]
 
|[[JLDAP::remove/1.5|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
 
|[[JLDAP::rename/1.5|rename]]
 
|[[JLDAP::rename/1.5|rename]]
 
|Rename the entry.  
 
|Rename the entry.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::replace/1.5|replace]]
 
|[[JLDAP::replace/1.5|replace]]
 
|Replace an entry and return a true or false result.  
 
|Replace an entry and return a true or false result.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::search/1.5|search]]
 
|[[JLDAP::search/1.5|search]]
 
|Perform an LDAP search.  
 
|Perform an LDAP search.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::setDN/1.5|setDN]]
 
|[[JLDAP::setDN/1.5|setDN]]
 
|Sets the DN with some template replacements.  
 
|Sets the DN with some template replacements.  
 
|-
 
|-
 +
|public
 
|[[JLDAP::simple_search/1.5|simple_search]]
 
|[[JLDAP::simple_search/1.5|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''' [[JObject/1.5|JObject]]
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.client.ldap' );</source>
 
<source lang="php">jimport( 'joomla.client.ldap' );</source>
 
===See also===
 
===See also===
 +
* {{JVer|1.5}} '''JLDAP''' on [http://api.joomla.org/Joomla-Framework/Client/JLDAP.html api.joomla.org]
 +
* {{JVer|1.5}} '''JLDAP source code''' on [[jframework15:client/ldap.php|JoomlaCode]]
 +
* {{JVer|1.5}} Subpackage [[Subpackage Client/1.5|Client]]
 +
* [[JLDAP|Other versions of 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>
−
{{SeeAlso:JLDAP}}
+
===User contributed notes===
−
* [[JLDAP|Other versions of this class]]
+
−
* [http://api.joomla.org/Joomla-Framework/Client/JLDAP.html JLDAP on api.joomla.org]
+
−
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 101: Line 123:
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:Framework]][[Category:Framework 1.5]][[Category:JLDAP]]</noinclude>
 
<noinclude>[[Category:Framework]][[Category:Framework 1.5]][[Category:JLDAP]]</noinclude>

Revision as of 18:10, 25 April 2011

Joomla 1.5 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.
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 />


Retrieved from "http://docs.joomla.org/index.php?title=JLDAP/1.5&oldid=51085"
Personal tools
Namespaces

Variants
Actions
Navigation
Joomla! Sites
Toolbox