LSaddon::phpldapadmin : Added icon and give an use case example in documentation
[ldapsaisie.git] / doc / conf / LSaddon / LSaddon_phpldapadmin.docbook
1 <sect2 id="config-LSaddon_phpldapadmin">
2   <title>LSaddon_phpldapadmin</title>
3   <para>Cet &LSaddon; est utilisé pour permettre un lien facile entre le logiciel
4   &PhpLdapAdmin; et LdapSaisie. Il sera possible ainsi à partir d'un objet dans
5   LdapSaisie de voir ce même objet dans &PhpLdapAdmin;.</para>
6
7   <para>Il est necessaire de configurer l'URL de votre installation de &PhpLdapAdmin; dans
8   le fichier de configuration <literal>config.LSaddons.phpldapadmin.php</literal>.</para>
9   
10   <programlisting linenumbering="unnumbered">
11   <citetitle>Structure du fichier</citetitle>
12 <![CDATA[// PhpLdapAdmin View Object URL format
13 define('LS_PHPLDAPADMIN_VIEW_OBJECT_URL_FORMAT','//'.$_SERVER['SERVER_NAME'].'/phpldapadmin/cmd.php?cmd=template_engine&server_id=0&dn=%{dn}');]]>
14 </programlisting>
15
16 <para>Cet &LSaddon; offre la possibilité d'utilisé la fonction &php;
17 <function>redirectToPhpLdapAdmin()</function> comme &customActions;.
18 <funcsynopsis>
19 <funcprototype>
20   <funcdef>bool <function>redirectToPhpLdapAdmin</function></funcdef>
21     <paramdef>LSldapObject <parameter>$ldapObject</parameter></paramdef>
22 </funcprototype>
23 </funcsynopsis>
24 </para>
25 <programlisting linenumbering="unnumbered">
26 <citetitle>Exemple d'utilisation</citetitle><![CDATA[$GLOBALS['LSobjects']['LSpeople'] = array (
27         [...]
28         'customActions' => array (
29                 'redirectPhpLdapAdmin' => array (
30                         'function' => 'redirectToPhpLdapAdmin',
31                         'label' => 'See in PhpLdapAdmin',
32                         'hideLabel' => True,
33                         'noConfirmation' => true,
34                         'disableOnSuccessMsg' => true,
35                         'icon' => 'phpldapadmin',
36                         'rights' => array (
37                                 'admin'
38                         )
39                 ),
40         ),
41         [...]
42 );]]>
43 </programlisting>
44 </sect2>