]> CyberLeo.Net >> Repos - SourceForge/phpwiki.git/blob - pgsrc/Help%2FLdapSearchPlugin
Harmonize documentation
[SourceForge/phpwiki.git] / pgsrc / Help%2FLdapSearchPlugin
1 Date: Wed, 28 May 2008 19:08:00 +0200
2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
3 Content-Type: application/x-phpwiki;
4   pagename=Help%2FLdapSearchPlugin;
5   flags="";
6   markup=2;
7   charset=iso-8859-1
8 Content-Transfer-Encoding: binary
9
10 [WikiPlugin|Help:WikiPlugin] which displays a LDAP query as table.
11
12 !!! Usage
13 <verbatim>
14   <?plugin LdapSearch ?>
15   <?plugin LdapSearch
16            host="localhost"
17            port=389
18            basedn=""
19            filter="(cn=*)"
20            attributes=""
21   ?>
22   <?plugin LdapSearch host=ldap.example.com filter="(ou=web-team)"
23                       attributes="sn cn telephonenumber" ?>
24   <?plugin LdapSearch host="ldap.itd.umich.edu" basedn="" filter="(sn=jensen)" attributes="cn drink" ?>
25   <?plugin LdapSearch host=ldap.example.com attributes="cn sn telephonenumber" ?>
26   <?plugin LdapSearch host=bugs.debian.org port=10101 basedn="dc=current,dc=bugs,dc=debian,dc=org"
27                       filter="(debbugsPackage=phpwiki)"
28                       attributes="debbugsSeverity debbugsState debbugsTitle" ?>
29 </verbatim>
30
31 !!! Arguments
32
33 host _(default: from LDAP_AUTH_HOST or localhost)_:
34         hostname or ip or ldap:// uri to connect to.
35
36 port _(default: from LDAP_AUTH_HOST or 389)_:
37         portnumber to connect to.
38
39 basedn _(default: LDAP_BASE_DN)_:
40         connect string: "ou=Users,o=Development,dc=mycompany.com"
41
42 filter _(default: "(cn=*)")_:
43         Optional ldap_search() filter argument
44
45 attributes _(default: empty)_ :
46         space seperated fields to return as table columns: "cn sn"
47
48 options:
49         ldap_set_option(). Default: LDAP_SET_OPTION if host == LDAP_AUTH_HOST
50         Column seperated name=value pairs. Esp. needed for Windows Active directory:
51         "LDAP_OPT_PROTOCOL_VERSION=3:LDAP_OPT_REFERRALS=0"
52 user:
53         Default: LDAP_AUTH_USER if host == LDAP_AUTH_HOST
54 password:
55         Default: LDAP_AUTH_PASSWORD if host == LDAP_AUTH_HOST
56         user and password are required for Windows Active directory.
57
58 !!! Examples
59
60 <?plugin WikiFormRich action=LdapSearch
61         editbox[] name=host value=bugs.debian.org size=80
62         editbox[] name=port value=10101 size=80
63         editbox[] name=basedn value="dc=current,dc=bugs,dc=debian,dc=org" size=80
64         editbox[] name=filter value="(debbugsPackage=phpwiki)" size=80
65         editbox[] name=attributes value="debbugsSeverity debbugsState debbugsTitle" size=80
66         submit[] reset[]
67 ?>
68
69 !!! Author
70 [John Lines|PhpWiki:JohnLines]
71
72 !!! See Also
73
74 ----
75 [PhpWikiDocumentation] [WikiPlugin|Help:WikiPlugin]