Moving to GitHub.
[platal.git] / include / reminder.inc.php
index cede617..aabd989 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /***************************************************************************
- *  Copyright (C) 2003-2009 Polytechnique.org                              *
+ *  Copyright (C) 2003-2014 Polytechnique.org                              *
  *  http://opensource.polytechnique.org/                                   *
  *                                                                         *
  *  This program is free software; you can redistribute it and/or modify   *
@@ -22,7 +22,7 @@
 // Base class for a reminder; it offers the factory for creating valid reminders
 // tailored for a given user, as well as base methods for reminder impls.
 // Sub-classes should define at least the abstract methods, and the static
-// IsCandidate method (prototype: (User &$user)).
+// IsCandidate method (prototype: (User $user)).
 //
 // Usage:
 //   // Instantiates and returns a valid Reminder object for the user.
@@ -47,7 +47,7 @@ abstract class Reminder
 
     // Constructs the Reminder object from a mandatory User instance, a list of
     // key-value pairs from the `reminder_type` and `reminder` tables.
-    function __construct(User &$user, array $type)
+    function __construct(User $user, array $type)
     {
         $this->user = &$user;
 
@@ -69,12 +69,12 @@ abstract class Reminder
     // Updates (or creates) the reminder line for the pair (|user|, |reminder_id|)
     // using the |status| as status, and the |next_ask| as the delay between now
     // and the next ask (if any).
-    private static function UpdateStatus($user_id, $type_id, $status, $next_ask)
+    private static function UpdateStatus($uid, $type_id, $status, $next_ask)
     {
-        XDB::execute('REPLACE INTO  reminder
-                               SET  uid = {?}, type_id = {?}, status = {?},
-                                    remind_last = NOW(), remind_next = FROM_UNIXTIME({?})',
-                     $user_id, $type_id, $status,
+        XDB::execute('INSERT INTO  reminder (uid, type_id, status, remind_last, remind_next)
+                           VALUES  ({?}, {?}, {?}, NOW(), FROM_UNIXTIME({?}))
+          ON DUPLICATE KEY UPDATE  status = VALUES(status), remind_last = VALUES(remind_last), remind_next = VALUES(remind_next)',
+                     $uid, $type_id, $status,
                      ($next_ask > 0 ? time() + $next_ask * 24 * 60 * 60 : null));
     }
 
@@ -103,18 +103,18 @@ abstract class Reminder
 
     // Displays a reduced version of the reminder and notifies that the action
     // has been taken into account.
-    public function NotifiesAction(&$page)
+    public function NotifiesAction($page)
     {
-        header('Content-Type: text/html; charset=utf-8');
+        pl_content_headers("text/html");
         $page->changeTpl('reminder/notification.tpl', NO_SKIN);
         $page->assign('previous_reminder', $this->title());
     }
 
     // Displays the reminder as a standalone html snippet. It should be used
     // when the reminder is the only output of a page.
-    public function DisplayStandalone(&$page, $previous_reminder = null)
+    public function DisplayStandalone($page, $previous_reminder = null)
     {
-        header('Content-Type: text/html; charset=utf-8');
+        pl_content_headers("text/html");
         $page->changeTpl('reminder/base.tpl', NO_SKIN);
         $this->Prepare($page);
         if ($previous_reminder) {
@@ -123,7 +123,7 @@ abstract class Reminder
     }
 
     // Prepares the display by assigning template variables.
-    public function Prepare(&$page)
+    public function Prepare($page)
     {
         $page->assign_by_ref('reminder', $this);
     }
@@ -153,19 +153,19 @@ abstract class Reminder
 
     // Static status update methods -------------------------------------------
 
-    // Marks the candidate reminder as having been accepted for user |user_id|.
+    // Marks the candidate reminder as having been accepted for user |uid|.
     // It is intended to be used when a reminder box has been bypassed, and when
     // it should behave as if the user had clicked on 'yes'.
-    protected static function MarkCandidateAsAccepted($user_id, $candidate)
+    protected static function MarkCandidateAsAccepted($uid, $candidate)
     {
-        Reminder::UpdateStatus($user_id, $candidate['type_id'],
+        Reminder::UpdateStatus($uid, $candidate['type_id'],
                                'yes', $candidate['remind_delay_yes']);
     }
 
     // Static factories -------------------------------------------------------
 
     // Returns a chosen class using the user data from |user|, and from the database.
-    public static function GetCandidateReminder(User &$user)
+    public static function GetCandidateReminder(User $user)
     {
         $res = XDB::query('SELECT  rt.*, r.status, r.remind_last
                              FROM  reminder_type AS rt
@@ -194,7 +194,7 @@ abstract class Reminder
 
     // Returns an instantiation of the reminder class which name is |name|, using
     // user data from |user|, and from the database.
-    public static function GetByName(User &$user, $name)
+    public static function GetByName(User $user, $name)
     {
         if (!($class = self::GetClassName($name))) {
             return null;
@@ -223,5 +223,5 @@ abstract class Reminder
 }
 
 
-// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
+// vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
 ?>