Cleaning comments

removes french comments and adds a few new comments in english

Author: dremecker

runInstallModule.php

@@ -11,8 +11,6 @@
 $db_initscript = 'bfwmailer_init_db.php';
 $process_q_script = 'bfwmailer_process_q.php';
 
-
-//$result .= "\033[0m\n";
 echo "\n".'     > Copy script '."\033[0;36m".$process_q_script."\033[0m into /src/cli/";
 
 // We check that our destination file does not exist

src/classes/QueueHandler.php

@@ -59,11 +59,11 @@ public function __construct(MailerOptions $options)
      */
     public function enqueue (\PHPMailer &$email, SendindStatus &$sendingStatus) 
     {   
-        // Nous traitons notre contenu
+        // processing email content and retreiving content database id
         $cont_id = $this->process_content($email);
 
-        // Si nous avons un id, nous construisons le données de l'outbox et nous 
-        // les poussons dans la table prévue à cet effet
+        // if content processing going well, add email metadata into outbox and
+        // update the sending status of the whole email
         if ($cont_id !== false) {
 
             $out_id = $this->db_outbox->add( 
@@ -95,32 +95,34 @@ public function enqueue (\PHPMailer &$email, SendindStatus &$sendingStatus)
      */
     public function dequeue (\PHPMailer &$email, SendindStatus &$sendingStatus, $max_sendingAttempts) 
     {
-        // we refresh our scheduled elements before going further
+        // refreshing our scheduled elements before going further
         $this->db_outbox->refresh_scheduled(time());
 
         // get the next email to send from the queue
         $out_id = $this->db_outbox->get_nextPending($max_sendingAttempts);
 
         if ($out_id !== false) {
 
+            // retrieving outbox and content data
             $outbox = $this->db_outbox->retrieve($out_id);
             $content = $this->db_content->retrieve($outbox[modeles\Outbox::DB_CONT_ID]);
 
-            // Nous construisons notre contenu pour injection dans la base
+            // making email sending status
             $sendingStatus->priority      = $outbox[modeles\Outbox::DB_PRIORITY];
             $sendingStatus->state         = $outbox[modeles\Outbox::DB_STATE];
             $sendingStatus->error         = $outbox[modeles\Outbox::DB_ERROR];
             $sendingStatus->attempts      = $outbox[modeles\Outbox::DB_ATTEMPTS];
             $sendingStatus->lastAction_ts = $outbox[modeles\Outbox::DB_LAST_ACT];
 
+            // making email metadata
             $this->add_emailAttr($email, $outbox[modeles\Outbox::DB_FROM], 'From');
             $this->add_emailAttr($email, $outbox[modeles\Outbox::DB_REPLY], 'ReplyTo');
             $this->add_emailAttr($email, $outbox[modeles\Outbox::DB_TO], 'Address');
             $this->add_emailAttr($email, $outbox[modeles\Outbox::DB_CC], 'CC');
             $this->add_emailAttr($email, $outbox[modeles\Outbox::DB_BCC], 'BCC');
 
+            // constructing email content
             if ($content !== false) {
-
                 $email->Subject = $content[modeles\Content::DB_SUBJECT];
                 $email->Body    = $content[modeles\Content::DB_BODY];
                 $email->AltBody = $content[modeles\Content::DB_ALT_BODY];
@@ -145,7 +147,6 @@ public function dequeue (\PHPMailer &$email, SendindStatus &$sendingStatus, $max
 
         // flushing old sent emails and old failed emails
         $this->clean_db(time() - $this->sent_ttl);
-
         return false;
     }
 
@@ -161,11 +162,12 @@ public function dequeue (\PHPMailer &$email, SendindStatus &$sendingStatus, $max
      */
     public function archive (\PHPMailer &$email, $outbox_id = null) 
     {   
-        // Nous traitons notre contenu
+        // processing email content and retreiving content database id
         $cont_id = $this->process_content($email);
 
-        // Si nous avons un id, nous construisons le données de l'outbox et nous 
-        // les poussons dans la table prévue à cet effet
+        // if content processing going well, add email metadata into sentbox,
+        // update the last action timestamp of the whole email 
+        // and remove the email metadata from the outbox
         if ($cont_id !== false) {
 
             $send_id = $this->db_sentbox->add( 

src/classes/modeles/AbstrMailBox.php

@@ -94,7 +94,6 @@ public function is_content_used($cont_id)
      * @param string  $cc       : cc field
      * @param string  $bcc      : bcc field
      * @param integer $cont_id  : content id
-     * @param integer $email_id : email id, default = null
      * @return mixed : mailbox id corresponding to the added email, or false in case of fail
      */
     public function add($from, $reply, $to, $cc, $bcc, $cont_id)

src/classes/modeles/Outbox.php

@@ -90,19 +90,19 @@ public function add($from, $reply, $to, $cc, $bcc, $cont_id, $prio = \BfwMailer\
      */
     public function get_nextPending($max_sendingAttempts)
     {
-        // Nous construisons nos données pour le test sur l'outbox
-        $outbox_test = array(
+        // creating our database outbox conditions for the fetch
+        $outbox_cond = array(
             ':pending'     => \BfwMailer\SendindStatus::STATE_PENDING, 
             ':failed'      => \BfwMailer\SendindStatus::STATE_FAILED, 
             ':maxAttempts' => $max_sendingAttempts,
             ':actualTime'  => time());
 
-        // Connexion à la bdd pour récupérer l'email actif avec la plus petite priorité (type)
+        // retrieving active email with the lower priority
         $req = $this->select()->from($this->tableName)
                 ->where('('.self::DB_STATE.    '=:pending OR '
                         .self::DB_STATE.       '=:failed) AND '
                         .self::DB_ATTEMPTS.'<:maxAttempts AND '
-                        .self::DB_LAST_ACT.    '<=:actualTime', $outbox_test)
+                        .self::DB_LAST_ACT.    '<=:actualTime', $outbox_cond)
                 ->order(self::DB_PRIORITY.' ASC')
                 ->limit(1);
         $outbox = $this->fetch_sql($req, 'fetchRow');

src/classes/modeles/Sentbox.php

@@ -13,7 +13,7 @@ class Sentbox extends AbstrMailBox
     /**
      * @var string $tableName : table name
      */
-    protected $tableName = 'bfwmailer_sendbox';
+    protected $tableName = 'bfwmailer_sentbox';