From dd7579e5a809de9f4c5fe151800bd7ca514af3dc Mon Sep 17 00:00:00 2001
From: Frédéric Guillot <fred@kanboard.net>
Date: Tue, 23 Sep 2014 19:46:05 +0200
Subject: Add phpdoc comments

---
 app/functions.php | 142 ++++++++++++++++++++++++++++++++++++++++--------------
 1 file changed, 106 insertions(+), 36 deletions(-)

(limited to 'app/functions.php')

diff --git a/app/functions.php b/app/functions.php
index dc6431b9..c39eaf98 100644
--- a/app/functions.php
+++ b/app/functions.php
@@ -4,6 +4,11 @@ use Core\Event;
 use Core\Translator;
 use PicoDb\Database;
 
+/**
+ * Send a debug message to the log files
+ *
+ * @param mixed $message Variable or string
+ */
 function debug($message)
 {
     if (! is_string($message)) {
@@ -13,11 +18,21 @@ function debug($message)
     error_log($message.PHP_EOL, 3, 'data/debug.log');
 }
 
+/**
+ * Setup events
+ *
+ * @return Core\Event
+ */
 function setup_events()
 {
     return new Event;
 }
 
+/**
+ * Setup the mailer according to the configuration
+ *
+ * @return Swift_SmtpTransport
+ */
 function setup_mailer()
 {
     require_once __DIR__.'/../vendor/swiftmailer/swift_required.php';
@@ -39,52 +54,30 @@ function setup_mailer()
     return $transport;
 }
 
+/**
+ * Setup the database driver and execute schema migration
+ *
+ * @return PicoDb\Database
+ */
 function setup_db()
 {
     switch (DB_DRIVER) {
         case 'sqlite':
-            require_once __DIR__.'/Schema/Sqlite.php';
-
-            $params = array(
-                'driver' => 'sqlite',
-                'filename' => DB_FILENAME
-            );
-
+            $db = setup_sqlite();
             break;
 
         case 'mysql':
-            require_once __DIR__.'/Schema/Mysql.php';
-
-            $params = array(
-                'driver'   => 'mysql',
-                'hostname' => DB_HOSTNAME,
-                'username' => DB_USERNAME,
-                'password' => DB_PASSWORD,
-                'database' => DB_NAME,
-                'charset'  => 'utf8',
-            );
-
+            $db = setup_mysql();
             break;
 
         case 'postgres':
-            require_once __DIR__.'/Schema/Postgres.php';
-
-            $params = array(
-                'driver'   => 'postgres',
-                'hostname' => DB_HOSTNAME,
-                'username' => DB_USERNAME,
-                'password' => DB_PASSWORD,
-                'database' => DB_NAME,
-            );
-
+            $db = setup_postgres();
             break;
 
         default:
             die('Database driver not supported');
     }
 
-    $db = new Database($params);
-
     if ($db->schema()->check(Schema\VERSION)) {
         return $db;
     }
@@ -94,42 +87,119 @@ function setup_db()
     }
 }
 
-// Get a translation
+/**
+ * Setup the Sqlite database driver
+ *
+ * @return PicoDb\Database
+ */
+function setup_sqlite()
+{
+    require_once __DIR__.'/Schema/Sqlite.php';
+
+    return new Database(array(
+        'driver' => 'sqlite',
+        'filename' => DB_FILENAME
+    ));
+}
+
+/**
+ * Setup the Mysql database driver
+ *
+ * @return PicoDb\Database
+ */
+function setup_mysql()
+{
+    require_once __DIR__.'/Schema/Mysql.php';
+
+    return new Database(array(
+        'driver'   => 'mysql',
+        'hostname' => DB_HOSTNAME,
+        'username' => DB_USERNAME,
+        'password' => DB_PASSWORD,
+        'database' => DB_NAME,
+        'charset'  => 'utf8',
+    ));
+}
+
+/**
+ * Setup the Postgres database driver
+ *
+ * @return PicoDb\Database
+ */
+function setup_postgres()
+{
+    require_once __DIR__.'/Schema/Postgres.php';
+
+    return new Database(array(
+        'driver'   => 'postgres',
+        'hostname' => DB_HOSTNAME,
+        'username' => DB_USERNAME,
+        'password' => DB_PASSWORD,
+        'database' => DB_NAME,
+    ));
+}
+
+/**
+ * Translate a string
+ *
+ * @return string
+ */
 function t()
 {
     $t = new Translator;
     return call_user_func_array(array($t, 'translate'), func_get_args());
 }
 
-// translate with no html escaping
+/**
+ * Translate a string with no HTML escaping
+ *
+ * @return string
+ */
 function e()
 {
     $t = new Translator;
     return call_user_func_array(array($t, 'translateNoEscaping'), func_get_args());
 }
 
-// Get a locale currency
+/**
+ * Translate a currency
+ *
+ * @return string
+ */
 function c($value)
 {
     $t = new Translator;
     return $t->currency($value);
 }
 
-// Get a formatted number
+/**
+ * Translate a number
+ *
+ * @return string
+ */
 function n($value)
 {
     $t = new Translator;
     return $t->number($value);
 }
 
-// Get a locale date
+/**
+ * Translate a date
+ *
+ * @return string
+ */
 function dt($format, $timestamp)
 {
     $t = new Translator;
     return $t->datetime($format, $timestamp);
 }
 
-// Plurals, return $t2 if $value > 1
+/**
+ * Handle plurals, return $t2 if $value > 1
+ *
+ * @todo   Improve this function
+ * @return mixed
+ */
 function p($value, $t1, $t2) {
     return $value > 1 ? $t2 : $t1;
 }
-- 
cgit v1.2.3