From c5316826af7ad58d3ae18cdbf6b4798d6440401f Mon Sep 17 00:00:00 2001 From: Dominique Fournier Date: Mon, 7 Sep 2020 14:08:26 +0000 Subject: [PATCH] Header update on all the files git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@6095 bf3deb0d-5f1a-0410-827f-c0cc1f45334c --- authhtpasswd.php | 5 +++-- authimap.php | 5 +++-- authorization.php | 5 +++-- authorizationdb.php | 5 +++-- authshibboleth.php | 5 +++-- authsql.php | 5 +++-- authsympa.php | 5 +++-- authzgroups.php | 5 +++-- backtrace.php | 4 ++++ cacheoutput.php | 16 +++++++++++----- certificationauthority.php | 4 ++-- cli.php | 5 +++-- color.php | 5 +++-- config.php | 5 +++-- convert.php | 5 +++-- daemon.php | 5 +++++ dbjson.php | 9 ++++++--- dblayer.php | 5 +++-- dblayerauthzgroups.php | 8 +++++--- dblayeroo.php | 5 ++--- file.php | 5 +++-- graph.php | 5 +++-- imap.php | 5 +++-- inifile.php | 5 +++-- ipaddresses.php | 5 +++-- language.php | 3 ++- lockfile.php | 8 +++++--- logger.php | 8 +++++--- mail.php | 8 +++++--- markdown.php | 8 +++++--- module.php | 8 +++++--- output.php | 8 +++++--- outputcsv.php | 9 ++++++--- outputhtml.php | 3 ++- outputjson.php | 6 ++++-- outputrest.php | 6 ++++-- outputtxt.php | 9 ++++++--- outputxml.php | 9 ++++++--- password.php | 5 +++++ queue.php | 5 +++++ queuefile.php | 4 ++++ ratelimit.php | 8 +++++--- ratelimitfile.php | 8 +++++--- renderer.php | 8 +++++--- route.php | 8 +++++--- routeSQL.php | 10 +++++----- rss.php | 5 +++-- smtp.php | 8 +++++--- users.php | 5 +++++ userssql.php | 8 +++++--- verify.php | 8 +++++--- version.php | 19 ++++++++++--------- 52 files changed, 221 insertions(+), 122 deletions(-) diff --git a/authhtpasswd.php b/authhtpasswd.php index 5a03dc1..a1c624e 100644 --- a/authhtpasswd.php +++ b/authhtpasswd.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ require_once ("domframework/auth.php"); diff --git a/authimap.php b/authimap.php index 2e288c3..367c151 100644 --- a/authimap.php +++ b/authimap.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ require_once ("domframework/auth.php"); require_once ("domframework/imap.php"); diff --git a/authorization.php b/authorization.php index 5ef1e4f..0a00a49 100644 --- a/authorization.php +++ b/authorization.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ /** All the needed functions to authorize or deny access to an authenticated user */ diff --git a/authorizationdb.php b/authorizationdb.php index 0045255..febee85 100644 --- a/authorizationdb.php +++ b/authorizationdb.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ error_reporting (E_ALL); require_once ("domframework/dblayer.php"); diff --git a/authshibboleth.php b/authshibboleth.php index a972e3b..e892352 100644 --- a/authshibboleth.php +++ b/authshibboleth.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ require_once ("domframework/auth.php"); diff --git a/authsql.php b/authsql.php index 58a8a5c..37ae51a 100644 --- a/authsql.php +++ b/authsql.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ require_once ("domframework/dblayer.php"); require_once ("domframework/auth.php"); diff --git a/authsympa.php b/authsympa.php index b51a021..dc23fea 100644 --- a/authsympa.php +++ b/authsympa.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ require_once ("domframework/auth.php"); diff --git a/authzgroups.php b/authzgroups.php index 0e2289a..7b41925 100644 --- a/authzgroups.php +++ b/authzgroups.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ require_once ("domframework/dblayer.php"); diff --git a/backtrace.php b/backtrace.php index c2dd8ec..34555e0 100644 --- a/backtrace.php +++ b/backtrace.php @@ -1,4 +1,8 @@ + */ /** Display the backtrace in HTML with clicks to display the content */ diff --git a/cacheoutput.php b/cacheoutput.php index 93bd150..3fae3ca 100644 --- a/cacheoutput.php +++ b/cacheoutput.php @@ -1,10 +1,16 @@ + */ + /** 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 */ diff --git a/certificationauthority.php b/certificationauthority.php index 67c18c6..b9ea053 100644 --- a/certificationauthority.php +++ b/certificationauthority.php @@ -1,6 +1,6 @@ */ diff --git a/cli.php b/cli.php index afdddfc..d8be54e 100644 --- a/cli.php +++ b/cli.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ /** Allow to interract with controllers and models from the CLI */ class cli diff --git a/color.php b/color.php index 6692a91..b68bec4 100644 --- a/color.php +++ b/color.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ /** Convert the name of colors to RGB */ diff --git a/config.php b/config.php index df9f744..3f8243b 100644 --- a/config.php +++ b/config.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ /** Manage the configurations of the module done by administrator in a config * file diff --git a/convert.php b/convert.php index a0a101c..d75dac0 100644 --- a/convert.php +++ b/convert.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ /** Convert a format to another one */ diff --git a/daemon.php b/daemon.php index 377ca66..3f4497e 100644 --- a/daemon.php +++ b/daemon.php @@ -1,4 +1,9 @@ + */ + require_once ("domframework/fork.php"); require_once ("domframework/file.php"); diff --git a/dbjson.php b/dbjson.php index 3b353d6..5bb44e6 100644 --- a/dbjson.php +++ b/dbjson.php @@ -1,6 +1,11 @@ + */ -/** 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 */ diff --git a/dblayer.php b/dblayer.php index 7f72a10..eff720d 100644 --- a/dblayer.php +++ b/dblayer.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ // dblayer.php diff --git a/dblayerauthzgroups.php b/dblayerauthzgroups.php index 2d3d402..46702c0 100644 --- a/dblayerauthzgroups.php +++ b/dblayerauthzgroups.php @@ -1,12 +1,14 @@ */ + * @package domframework + * @author Dominique Fournier + */ 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 */ diff --git a/dblayeroo.php b/dblayeroo.php index 61d47c8..915d6ef 100644 --- a/dblayeroo.php +++ b/dblayeroo.php @@ -4,9 +4,8 @@ * @author Dominique Fournier */ -// 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 diff --git a/file.php b/file.php index 1247aa8..1542ae1 100644 --- a/file.php +++ b/file.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ /** The file method allow to manage files like PHP with a working chroot on all * plateforms, and a right management compatible with database diff --git a/graph.php b/graph.php index 5c74448..609e712 100644 --- a/graph.php +++ b/graph.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ require_once ("domframework/color.php"); diff --git a/imap.php b/imap.php index 6a063c8..647c3f8 100644 --- a/imap.php +++ b/imap.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ /** IMAP connection abstraction In the IMAP terminology, "mailbox" is a folder in the mailbox of the user */ diff --git a/inifile.php b/inifile.php index da8d125..e46072c 100644 --- a/inifile.php +++ b/inifile.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ /** Manage .ini files like in php.ini Support the sections (or not) */ diff --git a/ipaddresses.php b/ipaddresses.php index 9482f24..05a8a06 100644 --- a/ipaddresses.php +++ b/ipaddresses.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ /** Manage the IP addresses conversions */ class ipaddresses diff --git a/language.php b/language.php index bf4ef2f..ce63ec0 100644 --- a/language.php +++ b/language.php @@ -4,7 +4,8 @@ * @author Dominique Fournier */ -/** Language class : change the messages */ +/** Language class : change the messages + */ class language { // Language.php diff --git a/lockfile.php b/lockfile.php index fce51ce..51cfa80 100644 --- a/lockfile.php +++ b/lockfile.php @@ -1,9 +1,11 @@ */ + * @package domframework + * @author Dominique Fournier + */ -/** The lock management of files */ +/** The lock management of files + */ class lockfile { /** The Exclusive lock file */ diff --git a/logger.php b/logger.php index d4cc5fc..94e1f39 100644 --- a/logger.php +++ b/logger.php @@ -1,10 +1,12 @@ */ + * @package domframework + * @author Dominique Fournier + */ /** 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 : diff --git a/mail.php b/mail.php index 2a28c19..1ee505c 100644 --- a/mail.php +++ b/mail.php @@ -1,9 +1,11 @@ */ + * @package domframework + * @author Dominique Fournier + */ -/** 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 { diff --git a/markdown.php b/markdown.php index afb8b05..cf342dc 100644 --- a/markdown.php +++ b/markdown.php @@ -1,9 +1,11 @@ */ + * @package domframework + * @author Dominique Fournier + */ -/** Convert the Markdown text to html format */ +/** Convert the Markdown text to html format + */ class markdown { /** To debug the markdown analyzer, activate the option */ diff --git a/module.php b/module.php index ce6e74e..2127cd3 100644 --- a/module.php +++ b/module.php @@ -1,9 +1,11 @@ */ + * @package domframework + * @author Dominique Fournier + */ -/** Module management */ +/** Module management + */ class module { /** The modules are not allowed if $toplevel=0 diff --git a/output.php b/output.php index 0d725ec..c55f6f1 100644 --- a/output.php +++ b/output.php @@ -1,9 +1,11 @@ */ + * @package domframework + * @author Dominique Fournier + */ -/** Class used to display data */ +/** Class used to display data + */ class output { /** Class used to display data diff --git a/outputcsv.php b/outputcsv.php index dbd8886..c91ef69 100644 --- a/outputcsv.php +++ b/outputcsv.php @@ -1,10 +1,13 @@ */ + * @package domframework + * @author Dominique Fournier + */ 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 */ diff --git a/outputhtml.php b/outputhtml.php index fc7bdc3..7083db5 100644 --- a/outputhtml.php +++ b/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 diff --git a/outputjson.php b/outputjson.php index 502c967..bddb938 100644 --- a/outputjson.php +++ b/outputjson.php @@ -1,9 +1,11 @@ */ + * @package domframework + * @author Dominique Fournier + */ require_once ("domframework/output.php"); + /** Display in JSON the data provided * The data must NOT be binary ! */ diff --git a/outputrest.php b/outputrest.php index db7c60f..b12f116 100644 --- a/outputrest.php +++ b/outputrest.php @@ -1,10 +1,12 @@ */ + * @package domframework + * @author Dominique Fournier + */ require_once ("domframework/output.php"); require_once ("domframework/rest.php"); + /** Display in REST the data provided. * Allow all the output types : JSON, XML, TXT... */ diff --git a/outputtxt.php b/outputtxt.php index a508209..9f2edc2 100644 --- a/outputtxt.php +++ b/outputtxt.php @@ -1,10 +1,13 @@ */ + * @package domframework + * @author Dominique Fournier + */ 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) */ diff --git a/outputxml.php b/outputxml.php index b228c70..36d8fdb 100644 --- a/outputxml.php +++ b/outputxml.php @@ -1,10 +1,13 @@ */ + * @package domframework + * @author Dominique Fournier + */ 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 diff --git a/password.php b/password.php index bf35ae3..d1aa508 100644 --- a/password.php +++ b/password.php @@ -1,4 +1,9 @@ + */ + /** A class to manage the password hashing, password generation */ class password diff --git a/queue.php b/queue.php index 6c12d12..8ad0667 100644 --- a/queue.php +++ b/queue.php @@ -1,4 +1,9 @@ + */ + /** 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 diff --git a/queuefile.php b/queuefile.php index c24e686..13406b6 100644 --- a/queuefile.php +++ b/queuefile.php @@ -1,4 +1,8 @@ + */ require_once ("domframework/queue.php"); require_once ("domframework/file.php"); diff --git a/ratelimit.php b/ratelimit.php index 363833a..f1772aa 100644 --- a/ratelimit.php +++ b/ratelimit.php @@ -1,9 +1,11 @@ */ + * @package domframework + * @author Dominique Fournier + */ -/** The rate limit abstract class */ +/** The rate limit abstract class + */ class ratelimit { /** The maximum number of entries by specified unit time */ diff --git a/ratelimitfile.php b/ratelimitfile.php index ff3fd6a..5d1edf4 100644 --- a/ratelimitfile.php +++ b/ratelimitfile.php @@ -1,12 +1,14 @@ */ + * @package domframework + * @author Dominique Fournier + */ 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 */ diff --git a/renderer.php b/renderer.php index d6ed3b0..1b7a189 100644 --- a/renderer.php +++ b/renderer.php @@ -1,9 +1,11 @@ */ + * @package domframework + * @author Dominique Fournier + */ -/** 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 */ diff --git a/route.php b/route.php index ab13de1..fd8d688 100644 --- a/route.php +++ b/route.php @@ -1,12 +1,14 @@ */ + * @package domframework + * @author Dominique Fournier + */ 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 */ diff --git a/routeSQL.php b/routeSQL.php index 606d37a..9752b83 100644 --- a/routeSQL.php +++ b/routeSQL.php @@ -1,16 +1,16 @@ */ + * @package domframework + * @author Dominique Fournier + */ 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 */ diff --git a/rss.php b/rss.php index 4a75796..da88441 100644 --- a/rss.php +++ b/rss.php @@ -1,7 +1,8 @@ */ + * @package domframework + * @author Dominique Fournier + */ require_once ("domframework/verify.php"); require_once ("domframework/convert.php"); diff --git a/smtp.php b/smtp.php index 45b64d2..aecc467 100644 --- a/smtp.php +++ b/smtp.php @@ -1,9 +1,11 @@ */ + * @package domframework + * @author Dominique Fournier + */ -/** Allow to send mails by smtp */ +/** Allow to send mails by smtp + */ class smtp { /** Debug mode diff --git a/users.php b/users.php index b3427a0..e27cca4 100644 --- a/users.php +++ b/users.php @@ -1,4 +1,9 @@ + */ + /** 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 diff --git a/userssql.php b/userssql.php index 1932c07..cc26345 100644 --- a/userssql.php +++ b/userssql.php @@ -1,13 +1,15 @@ */ + * @package domframework + * @author Dominique Fournier + */ 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 */ diff --git a/verify.php b/verify.php index 9b4ef75..e8ac75c 100644 --- a/verify.php +++ b/verify.php @@ -1,9 +1,11 @@ */ + * @package domframework + * @author Dominique Fournier + */ -/** Permit to check the validity of fields */ +/** Permit to check the validity of fields + */ class verify { ///////////////// diff --git a/version.php b/version.php index c6d2ec9..0144c03 100644 --- a/version.php +++ b/version.php @@ -1,14 +1,15 @@ */ - + * @package domframework + * @author Dominique Fournier + */ /** 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");