Rename LSattr_ldap :: postalAddress to LSattr_ldap :: postaladdress and add doc on...
authorBenjamin Renard <brenard@easter-eggs.com>
Thu, 15 Jun 2017 15:23:37 +0000 (17:23 +0200)
committerBenjamin Renard <brenard@easter-eggs.com>
Thu, 15 Jun 2017 15:23:37 +0000 (17:23 +0200)
doc/conf/LSattribute/LSattr_html.docbook
doc/conf/LSattribute/LSattr_html/LSattr_html.entities.xml
doc/conf/LSattribute/LSattr_html/LSattr_html_postaladdress.docbook [new file with mode: 0644]
doc/conf/LSattribute/LSattr_ldap.docbook
doc/conf/LSattribute/LSattr_ldap/LSattr_ldap.entities.xml
doc/conf/LSattribute/LSattr_ldap/LSattr_ldap_postaladdress.docbook [new file with mode: 0644]
public_html/includes/class/class.LSattr_ldap_postalAddress.php [deleted file]
public_html/includes/class/class.LSattr_ldap_postaladdress.php [new file with mode: 0644]

index 59fdd07..4a9df3c 100644 (file)
@@ -11,6 +11,7 @@
   &conf-LSattr_html_maildir;
   &conf-LSattr_html_mailQuota;
   &conf-LSattr_html_password;
   &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;
   &conf-LSattr_html_rss;
   &conf-LSattr_html_select_box;
   &conf-LSattr_html_select_list;
index 3e342b1..e29c60a 100644 (file)
@@ -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_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">
 <!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 (file)
index 0000000..9e74b8f
--- /dev/null
@@ -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>
index 948656d..d7d563a 100644 (file)
@@ -9,4 +9,5 @@
   &conf-LSattr_ldap_image;
   &conf-LSattr_ldap_numeric;
   &conf-LSattr_ldap_password;
   &conf-LSattr_ldap_image;
   &conf-LSattr_ldap_numeric;
   &conf-LSattr_ldap_password;
+  &conf-LSattr_ldap_postaladdress;
 </sect3>
 </sect3>
index 95bb528..9cf9b70 100644 (file)
@@ -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_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 (file)
index 0000000..409ed9d
--- /dev/null
@@ -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
deleted file mode 100644 (file)
index 229a2f1..0000000
+++ /dev/null
@@ -1,52 +0,0 @@
-<?php
-/*******************************************************************************
- * Copyright (C) 2007 Easter-eggs
- * http://ldapsaisie.labs.libre-entreprise.org
- *
- * Author: See AUTHORS file in top-level directory.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License version 2
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-
-******************************************************************************/
-
-/**
- * Type d'attribut Ldap postalAddress
- * RFC4519 : les retours a la ligne sont remplace par des '$'
- */
-class LSattr_ldap_postalAddress extends LSattr_ldap {
-
-  /**
-   * Retourne la valeur d'affichage de l'attribut après traitement lié à son type ldap
-   *
-   * @param[in] $data mixed La valeur de l'attribut
-   *
-   * @retval mixed La valeur d'affichage de l'attribut
-   */
-  function getDisplayValue($data) {
-    return str_replace("$","\n",$data);
-  }
-
-  /**
-   * Retourne la valeur de l'attribut après traitement lié à son type ldap
-   *
-   * @param[in] $data mixed La valeur de l'attribut
-   *
-   * @retval mixed La valeur traitée de l'attribut
-   */
-  function getUpdateData($data) {
-    return str_replace("\n","$",$data);
-  }
-}
-
-?>
diff --git a/public_html/includes/class/class.LSattr_ldap_postaladdress.php b/public_html/includes/class/class.LSattr_ldap_postaladdress.php
new file mode 100644 (file)
index 0000000..f10d557
--- /dev/null
@@ -0,0 +1,52 @@
+<?php
+/*******************************************************************************
+ * Copyright (C) 2007 Easter-eggs
+ * http://ldapsaisie.labs.libre-entreprise.org
+ *
+ * Author: See AUTHORS file in top-level directory.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License version 2
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+******************************************************************************/
+
+/**
+ * Type d'attribut Ldap postaladdress
+ * RFC4519 : les retours a la ligne sont remplace par des '$'
+ */
+class LSattr_ldap_postaladdress extends LSattr_ldap {
+
+  /**
+   * Retourne la valeur d'affichage de l'attribut après traitement lié à son type ldap
+   *
+   * @param[in] $data mixed La valeur de l'attribut
+   *
+   * @retval mixed La valeur d'affichage de l'attribut
+   */
+  function getDisplayValue($data) {
+    return str_replace("$","\n",$data);
+  }
+
+  /**
+   * Retourne la valeur de l'attribut après traitement lié à son type ldap
+   *
+   * @param[in] $data mixed La valeur de l'attribut
+   *
+   * @retval mixed La valeur traitée de l'attribut
+   */
+  function getUpdateData($data) {
+    return str_replace("\n","$",$data);
+  }
+}
+
+?>