From 2094b6f5e8eab40033300c1c7f8cf5945ccb3123 Mon Sep 17 00:00:00 2001
From: Benjamin Renard <brenard@easter-eggs.com>
Date: Thu, 15 Jun 2017 17:23:37 +0200
Subject: [PATCH] Rename LSattr_ldap :: postalAddress to LSattr_ldap ::
 postaladdress and add doc on this type of html & ldap attribute

---
 doc/conf/LSattribute/LSattr_html.docbook      |  1 +
 .../LSattr_html/LSattr_html.entities.xml      |  1 +
 .../LSattr_html_postaladdress.docbook         | 39 +++++++++++++++++++
 doc/conf/LSattribute/LSattr_ldap.docbook      |  1 +
 .../LSattr_ldap/LSattr_ldap.entities.xml      |  1 +
 .../LSattr_ldap_postaladdress.docbook         | 14 +++++++
 ...hp => class.LSattr_ldap_postaladdress.php} |  4 +-
 7 files changed, 59 insertions(+), 2 deletions(-)
 create mode 100644 doc/conf/LSattribute/LSattr_html/LSattr_html_postaladdress.docbook
 create mode 100644 doc/conf/LSattribute/LSattr_ldap/LSattr_ldap_postaladdress.docbook
 rename public_html/includes/class/{class.LSattr_ldap_postalAddress.php => class.LSattr_ldap_postaladdress.php} (94%)

diff --git a/doc/conf/LSattribute/LSattr_html.docbook b/doc/conf/LSattribute/LSattr_html.docbook
index 59fdd074..4a9df3c0 100644
--- a/doc/conf/LSattribute/LSattr_html.docbook
+++ b/doc/conf/LSattribute/LSattr_html.docbook
@@ -11,6 +11,7 @@
   &conf-LSattr_html_maildir;
   &conf-LSattr_html_mailQuota;
   &conf-LSattr_html_password;
+  &conf-LSattr_html_postaladdress;
   &conf-LSattr_html_rss;
   &conf-LSattr_html_select_box;
   &conf-LSattr_html_select_list;
diff --git a/doc/conf/LSattribute/LSattr_html/LSattr_html.entities.xml b/doc/conf/LSattribute/LSattr_html/LSattr_html.entities.xml
index 3e342b14..e29c60a3 100644
--- a/doc/conf/LSattribute/LSattr_html/LSattr_html.entities.xml
+++ b/doc/conf/LSattribute/LSattr_html/LSattr_html.entities.xml
@@ -7,6 +7,7 @@
 <!ENTITY conf-LSattr_html_maildir SYSTEM "LSattr_html_maildir.docbook">
 <!ENTITY conf-LSattr_html_mailQuota SYSTEM "LSattr_html_mailQuota.docbook">
 <!ENTITY conf-LSattr_html_password SYSTEM "LSattr_html_password.docbook">
+<!ENTITY conf-LSattr_html_postaladdress SYSTEM "LSattr_html_postaladdress.docbook">
 <!ENTITY conf-LSattr_html_rss SYSTEM "LSattr_html_rss.docbook">
 <!ENTITY conf-LSattr_html_select_box SYSTEM "LSattr_html_select_box.docbook">
 <!ENTITY conf-LSattr_html_select_list SYSTEM "LSattr_html_select_list.docbook">
diff --git a/doc/conf/LSattribute/LSattr_html/LSattr_html_postaladdress.docbook b/doc/conf/LSattribute/LSattr_html/LSattr_html_postaladdress.docbook
new file mode 100644
index 00000000..9e74b8fe
--- /dev/null
+++ b/doc/conf/LSattribute/LSattr_html/LSattr_html_postaladdress.docbook
@@ -0,0 +1,39 @@
+<sect4 id="config-LSattr_html_postaladdress">
+  <title>LSattr_html_postaladdress</title>
+  <para>Ce type est utilisé pour la gestion des attributs du type de l'attribut
+  standard <emphasis>postalAddress</emphasis>. Ce type d'attribut permet d'afficher,
+  en plus de l'adresse, un lien composé à partir d'informations de l'objet permettant
+  par exemple d'afficher un lien vers une carte géocalisant l'adresse postale.</para>
+
+<programlisting linenumbering="unnumbered">
+<citetitle>Structure</citetitle>...
+<![CDATA['html_options' => array(
+  'map_url_pattern_format' => '[LSformat]',
+  'map_url_format' => '[LSformat]',
+),]]>
+...
+</programlisting>
+
+<variablelist>
+<title>Paramètres de configuration</title>
+
+<varlistentry>
+  <term>map_url_pattern_format</term>
+  <listitem>
+    <simpara>Ce &LSformat; doit permettre de générer la valeur de l'adresse postale
+    qui sera insérée dans l'URL du lien ajouté dans l'interface.</simpara>
+  </listitem>
+</varlistentry>
+
+<varlistentry>
+  <term>map_url_format</term>
+  <listitem>
+    <simpara>Ce &LSformat; doit permettre de générer l'URL du lien ajouté dans
+    l'interface à partir de la valeur de l'adresse postale générée via le paramètre
+    <literal>map_url_pattern_format</literal>.</simpara>
+  </listitem>
+</varlistentry>
+
+</variablelist>
+
+</sect4>
diff --git a/doc/conf/LSattribute/LSattr_ldap.docbook b/doc/conf/LSattribute/LSattr_ldap.docbook
index 948656d1..d7d563a1 100644
--- a/doc/conf/LSattribute/LSattr_ldap.docbook
+++ b/doc/conf/LSattribute/LSattr_ldap.docbook
@@ -9,4 +9,5 @@
   &conf-LSattr_ldap_image;
   &conf-LSattr_ldap_numeric;
   &conf-LSattr_ldap_password;
+  &conf-LSattr_ldap_postaladdress;
 </sect3>
diff --git a/doc/conf/LSattribute/LSattr_ldap/LSattr_ldap.entities.xml b/doc/conf/LSattribute/LSattr_ldap/LSattr_ldap.entities.xml
index 95bb5288..9cf9b70a 100644
--- a/doc/conf/LSattribute/LSattr_ldap/LSattr_ldap.entities.xml
+++ b/doc/conf/LSattribute/LSattr_ldap/LSattr_ldap.entities.xml
@@ -5,3 +5,4 @@
 <!ENTITY conf-LSattr_ldap_image SYSTEM "LSattr_ldap_image.docbook">
 <!ENTITY conf-LSattr_ldap_numeric SYSTEM "LSattr_ldap_numeric.docbook">
 <!ENTITY conf-LSattr_ldap_password SYSTEM "LSattr_ldap_password.docbook">
+<!ENTITY conf-LSattr_ldap_postaladdress SYSTEM "LSattr_ldap_postaladdress.docbook">
diff --git a/doc/conf/LSattribute/LSattr_ldap/LSattr_ldap_postaladdress.docbook b/doc/conf/LSattribute/LSattr_ldap/LSattr_ldap_postaladdress.docbook
new file mode 100644
index 00000000..409ed9d7
--- /dev/null
+++ b/doc/conf/LSattribute/LSattr_ldap/LSattr_ldap_postaladdress.docbook
@@ -0,0 +1,14 @@
+<sect4 id="config-LSattr_ldap_postaladdress">
+  <title>LSattr_ldap_postaladdress</title>
+  <para>Ce type est utilisé pour la gestion des attributs dont la valeur est construite
+  sur le modèle de l'attribut standard <emphasis>postalAddress</emphasis>, c'est à dire
+  dont les lignes sont séparées à l'aide du caractère de délimiteur <literal>$</literal>.
+  </para>
+
+  <para>Lors de la lecture des valeurs de ce type d'attribut dans l'annuaire, les
+  caractères <literal>$</literal> seront remplacés par des caractères <literal>\n</literal>
+  et, à l'inverse, lors de l'écriture des valeurs de ce type d'attribut dans l'annuaire,
+  les caractères <literal>\n</literal> seront remplacés par des caractères
+  <literal>$</literal>.</para>
+  
+</sect4>
diff --git a/public_html/includes/class/class.LSattr_ldap_postalAddress.php b/public_html/includes/class/class.LSattr_ldap_postaladdress.php
similarity index 94%
rename from public_html/includes/class/class.LSattr_ldap_postalAddress.php
rename to public_html/includes/class/class.LSattr_ldap_postaladdress.php
index 229a2f1a..f10d5574 100644
--- a/public_html/includes/class/class.LSattr_ldap_postalAddress.php
+++ b/public_html/includes/class/class.LSattr_ldap_postaladdress.php
@@ -21,10 +21,10 @@
 ******************************************************************************/
 
 /**
- * Type d'attribut Ldap postalAddress
+ * Type d'attribut Ldap postaladdress
  * RFC4519 : les retours a la ligne sont remplace par des '$'
  */
-class LSattr_ldap_postalAddress extends LSattr_ldap {
+class LSattr_ldap_postaladdress extends LSattr_ldap {
 
   /**
    * Retourne la valeur d'affichage de l'attribut après traitement lié à son type ldap