Header update on all the files

git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@6095 bf3deb0d-5f1a-0410-827f-c0cc1f45334c

authhtpasswd.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/auth.php");
 

authimap.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/auth.php");
 require_once ("domframework/imap.php");

authorization.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 /** All the needed functions to authorize or deny access to an authenticated
     user */

authorizationdb.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 error_reporting (E_ALL);
 require_once ("domframework/dblayer.php");

authshibboleth.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/auth.php");
 

authsql.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/dblayer.php");
 require_once ("domframework/auth.php");

authsympa.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/auth.php");
 

authzgroups.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/dblayer.php");
 

backtrace.php

@@ -1,4 +1,8 @@
 <?php
+/** DomFramework
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 /** Display the backtrace in HTML with clicks to display the content
   */

cacheoutput.php

@@ -1,10 +1,16 @@
 <?php
+/** DomFramework
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
+
 /** This class permit to cache the ouptut of a code. If the cache is already
-    available, use it.
-    It resend the headers as the ouptut send them
-    Use it by :
-       $c = new cacheoutput ("URL");
-    Don't forget to define a variable or the cache saved is always empty */
+  * available, use it.
+  * It resend the headers as the ouptut send them
+  * Use it by :
+  *    $c = new cacheoutput ("URL");
+  * Don't forget to define a variable or the cache saved is always empty
+  */
 class cacheoutput
 {
   /** Record if the saving of pages is on going */

certificationauthority.php

@@ -1,6 +1,6 @@
 <?php
-/** DomFirewall
-  * @package domfirewall
+/** DomFramework
+  * @package domframework
   * @author Dominique Fournier <dominique@fournier38.fr>
   */
 

cli.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 /** Allow to interract with controllers and models from the CLI */
 class cli

color.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 /** Convert the name of colors to RGB
   */

config.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 /** Manage the configurations of the module done by administrator in a config
   * file

convert.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 /** Convert a format to another one
   */

daemon.php

@@ -1,4 +1,9 @@
 <?php
+/** DomFramework
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
+
 require_once ("domframework/fork.php");
 require_once ("domframework/file.php");
 

dbjson.php

@@ -1,6 +1,11 @@
 <?php
+/** DomFramework
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
-/** Documentation
+/** DBJSON  : a NoSQL DB in JSON
+  * Documentation
   * - A filter is an array containing the fields and the values to found
   *   array ("key"=>"val")              <== Look for the key equal val
   *   array ("key=>array ("val", "<=")) <== Look for the key lighter or equal
@@ -13,8 +18,6 @@
   *
   * - The field named _id is the document key
   */
-
-/** DBJSON  : a NoSQL DB in JSON */
 class dbjson
 {
   /** The DSN of the connection */

dblayer.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 // dblayer.php
 

dblayerauthzgroups.php

@@ -1,12 +1,14 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/dblayer.php");
 
 /** DBLayer with authorization
-    All the actions in database are conditionned to the rights in authzgroups */
+  * All the actions in database are conditionned to the rights in authzgroups
+  */
 class dblayerauthzgroups extends dblayer
 {
   /** The authzgroups object, connected to the database */

dblayeroo.php

@@ -4,9 +4,8 @@
   * @author Dominique Fournier <dominique@fournier38.fr>
   */
 
-// dblayeroo.php
-
-/** Permit abstraction on the differents SQL databases available */
+/** Permit abstraction on the differents SQL databases available
+  */
 class dblayeroo
 {
   /** The table name to use

file.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 /** The file method allow to manage files like PHP with a working chroot on all
   * plateforms, and a right management compatible with database

graph.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/color.php");
 

imap.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 /** IMAP connection abstraction
     In the IMAP terminology, "mailbox" is a folder in the mailbox of the user */

inifile.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 /** Manage .ini files like in php.ini
     Support the sections (or not) */

ipaddresses.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 /** Manage the IP addresses conversions */
 class ipaddresses

language.php

@@ -4,7 +4,8 @@
   * @author Dominique Fournier <dominique@fournier38.fr>
   */
 
-/** Language class : change the messages */
+/** Language class : change the messages
+  */
 class language
 {
   // Language.php

lockfile.php

@@ -1,9 +1,11 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
-/** The lock management of files */
+/** The lock management of files
+  */
 class lockfile
 {
   /** The Exclusive lock file */

logger.php

@@ -1,10 +1,12 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 /** The logger class permit to log the information from the soft
-    It allow to debug too */
+  * It allow to debug too
+  */
 class logger
 {
   /* The logger class can be used with :

mail.php

@@ -1,9 +1,11 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
-/** The class to create a complete email. Can read an email from a content */
+/** The class to create a complete email. Can read an email from a content
+  */
 class mail
 {
 

markdown.php

@@ -1,9 +1,11 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
-/** Convert the Markdown text to html format */
+/** Convert the Markdown text to html format
+  */
 class markdown
 {
   /** To debug the markdown analyzer, activate the option */

module.php

@@ -1,9 +1,11 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
-/** Module management */
+/** Module management
+  */
 class module
 {
   /** The modules are not allowed if $toplevel=0

output.php

@@ -1,9 +1,11 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
-/** Class used to display data */
+/** Class used to display data
+  */
 class output
 {
   /** Class used to display data

outputcsv.php

@@ -1,10 +1,13 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/output.php");
-/** Display in CSV the data provided */
+
+/** Display in CSV the data provided
+  */
 class outputcsv extends output
 {
   /** Don't allow to output in CSV if the functions are not available in PHP */

outputhtml.php

@@ -6,7 +6,8 @@
 
 require_once ("domframework/output.php");
 
-/** Display in HTML the data provided, with the layout support */
+/** Display in HTML the data provided, with the layout support
+  */
 class outputhtml extends output
 {
   /** Data is printed by viewClass->viewmethod, in the middle of $layout

outputjson.php

@@ -1,9 +1,11 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/output.php");
+
 /** Display in JSON the data provided
   * The data must NOT be binary !
   */

outputrest.php

@@ -1,10 +1,12 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/output.php");
 require_once ("domframework/rest.php");
+
 /** Display in REST the data provided.
   * Allow all the output types : JSON, XML, TXT...
   */

outputtxt.php

@@ -1,10 +1,13 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/output.php");
-/** Display in Text the data provided */
+
+/** Display in Text the data provided
+  */
 class outputtxt extends output
 {
   /** Display an array on table format (TRUE) or tree format (FALSE) */

outputxml.php

@@ -1,10 +1,13 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/output.php");
-/** Display in XML the data provided */
+
+/** Display in XML the data provided
+  */
 class outputxml extends output
 {
   /** Display in XML the data provided

password.php

@@ -1,4 +1,9 @@
 <?php
+/** DomFramework
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
+
 /** A class to manage the password hashing, password generation
   */
 class password

queue.php

@@ -1,4 +1,9 @@
 <?php
+/** DomFramework
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
+
 /** Manage a queue in multiple storages
   * A process can add entries to the end of a queue
   * A process can get all the entries in a queue

queuefile.php

@@ -1,4 +1,8 @@
 <?php
+/** DomFramework
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/queue.php");
 require_once ("domframework/file.php");

ratelimit.php

@@ -1,9 +1,11 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
-/** The rate limit abstract class */
+/** The rate limit abstract class
+  */
 class ratelimit
 {
   /** The maximum number of entries by specified unit time */

ratelimitfile.php

@@ -1,12 +1,14 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/lockfile.php");
 require_once ("domframework/ratelimit.php");
 
-/** The rate limit with file storage */
+/** The rate limit with file storage
+  */
 class ratelimitfile extends ratelimit
 {
   /** The storage directory */

renderer.php

@@ -1,9 +1,11 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
-/** Display the data in HTML with a FLASH method to display the errors */
+/** Display the data in HTML with a FLASH method to display the errors
+  */
 class renderer
 {
   /** The result in construction */

route.php

@@ -1,12 +1,14 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/http.php");
 require_once ("domframework/ratelimitfile.php");
 
-/** The routing module, base of the DomFramework */
+/** The routing module, base of the DomFramework
+  */
 class route
 {
   /** The baseURL of the site */

routeSQL.php

@@ -1,16 +1,16 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/route.php");
 require_once ("domframework/form.php");
 require_once ("domframework/renderer.php");
 
-error_reporting (E_ALL);
-
 /** Automatic Routing for SQL database
-    Allow to do CRUD on data with only one line in index.php */
+  * Allow to do CRUD on data with only one line in index.php
+  */
 class routeSQL
 {
   /** Activate the debug */

rss.php

@@ -1,7 +1,8 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/verify.php");
 require_once ("domframework/convert.php");

smtp.php

@@ -1,9 +1,11 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
-/** Allow to send mails by smtp */
+/** Allow to send mails by smtp
+  */
 class smtp
 {
   /** Debug mode

users.php

@@ -1,4 +1,9 @@
 <?php
+/** DomFramework
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
+
 /** The abstraction class of the users
   * Allow to manage the users in multiple storages (SQL, HTPasswd, passwd file).
   * CRUD the users and allow to modify the password

userssql.php

@@ -1,13 +1,15 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 require_once ("domframework/dblayer.php");
 require_once ("domframework/users.php");
 
 /** Store the users in SQL database. Manage the creation of the users,
-    modification, delete, password management*/
+  * modification, delete, password management
+  */
 class userssql extends users
 {
   /** The database connector */

verify.php

@@ -1,9 +1,11 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
-/** Permit to check the validity of fields */
+/** Permit to check the validity of fields
+  */
 class verify
 {
   /////////////////

version.php

@@ -1,14 +1,15 @@
 <?php
 /** DomFramework
-    @package domframework
-    @author Dominique Fournier <dominique@fournier38.fr> */
-
+  * @package domframework
+  * @author Dominique Fournier <dominique@fournier38.fr>
+  */
 
 /** This is the version of DomFramework.
-    It can be used to test if the framework is uptodate for the application
-    with :
-    require ("domframework/version.php");
-    if (!defined ("DOMFRAMEWORK_VERSION") ||
-        version_compare (DOMFRAMEWORK_VERSION, "0.6") < 0)
-      die ("Your DomFramework version is too old : 0.6 minimum\n"); */
+  * It can be used to test if the framework is uptodate for the application
+  * with :
+  * require ("domframework/version.php");
+  * if (!defined ("DOMFRAMEWORK_VERSION") ||
+  *     version_compare (DOMFRAMEWORK_VERSION, "0.6") < 0)
+  *   die ("Your DomFramework version is too old : 0.6 minimum\n");
+  */
 define ("DOMFRAMEWORK_VERSION", "0.58");