From: Jan Schneider <jan@horde.org>
Date: Thu, 6 May 2010 09:42:29 +0000 (+0200)
Subject: Add typehints.
X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=289212da97a7029adabb84bcb664256bc5b9508d;p=horde.git

Add typehints.
---

diff --git a/framework/Alarm/lib/Horde/Alarm.php b/framework/Alarm/lib/Horde/Alarm.php
index c10c5d90c..083d6ac00 100644
--- a/framework/Alarm/lib/Horde/Alarm.php
+++ b/framework/Alarm/lib/Horde/Alarm.php
@@ -46,12 +46,8 @@ abstract class Horde_Alarm
      * @return Horde_Alarm  The newly created concrete instance.
      * @throws Horde_Alarm_Exception
      */
-    static public function factory($driver = null, $params = array())
+    static public function factory($driver, array $params = array())
     {
-        if (empty($driver)) {
-            return new Horde_Alarm($params);
-        }
-
         $driver = ucfirst(basename($driver));
         $class = __CLASS__ . '_' . $driver;
 
@@ -75,7 +71,7 @@ abstract class Horde_Alarm
      * 'ttl' - (integer) Time to live value, in seconds.
      * </pre>
      */
-    public function __construct($params = array())
+    public function __construct(array $params = array())
     {
         if (isset($params['logger'])) {
             $this->_logger = $params['logger'];
@@ -157,8 +153,8 @@ abstract class Horde_Alarm
      * @return array  A list of alarm hashes.
      * @throws Horde_Alarm_Exception
      */
-    public function listAlarms($user = null, $time = null, $load = false,
-                               $preload = true)
+    public function listAlarms($user = null, Horde_Date $time = null,
+                               $load = false, $preload = true)
     {
         if (empty($time)) {
             $time = new Horde_Date(time());
@@ -187,7 +183,7 @@ abstract class Horde_Alarm
      * @return array  A list of alarm hashes.
      * @throws Horde_Alarm_Exception
      */
-    abstract protected function _list($user, $time);
+    abstract protected function _list($user, Horde_Date $time);
 
     /**
      * Returns an alarm hash from the backend.
@@ -242,7 +238,7 @@ abstract class Horde_Alarm
      *
      * @throws Horde_Alarm_Exception
      */
-    public function set($alarm, $keepsnooze = false)
+    public function set(array $alarm, $keepsnooze = false)
     {
         if (isset($alarm['mail']['body'])) {
             $alarm['mail']['body'] = $this->_toDriver($alarm['mail']['body']);
@@ -262,7 +258,7 @@ abstract class Horde_Alarm
      *
      * @throws Horde_Alarm_Exception
      */
-    abstract protected function _add($alarm);
+    abstract protected function _add(array $alarm);
 
     /**
      * Updates an alarm hash in the backend.
@@ -272,7 +268,7 @@ abstract class Horde_Alarm
      *
      * @throws Horde_Alarm_Exception
      */
-    abstract protected function _update($alarm, $keepsnooze = false);
+    abstract protected function _update(array $alarm, $keepsnooze = false);
 
     /**
      * Updates internal alarm properties, i.e. properties not determined by
@@ -284,7 +280,7 @@ abstract class Horde_Alarm
      *
      * @throws Horde_Alarm_Exception
      */
-    abstract protected function _internal($id, $user, $internal);
+    abstract protected function _internal($id, $user, array $internal);
 
     /**
      * Returns whether an alarm with the given id exists already.
@@ -353,7 +349,7 @@ abstract class Horde_Alarm
      *
      * @throws Horde_Alarm_Exception
      */
-    abstract protected function _snooze($id, $user, $snooze);
+    abstract protected function _snooze($id, $user, Horde_Date $snooze);
 
     /**
      * Returns whether an alarm is snoozed.
@@ -367,7 +363,7 @@ abstract class Horde_Alarm
      *
      * @throws Horde_Alarm_Exception
      */
-    public function isSnoozed($id, $user, $time = null)
+    public function isSnoozed($id, $user, Horde_Date $time = null)
     {
         if (is_null($time)) {
             $time = new Horde_Date(time());
@@ -385,7 +381,7 @@ abstract class Horde_Alarm
      * @return boolean  True if the alarm is snoozed.
      * @throws Horde_Alarm_Exception
      */
-    abstract protected function _isSnoozed($id, $user, $time);
+    abstract protected function _isSnoozed($id, $user, Horde_Date $time);
 
     /**
      * Dismisses an alarm.
@@ -433,7 +429,7 @@ abstract class Horde_Alarm
      * @throws Horde_Alarm_Exception
      */
     public function notify($user = null, $load = true, $preload = true,
-                           $exclude = array())
+                           array $exclude = array())
     {
         try {
             $alarms = $this->listAlarms($user, null, $load, $preload);
@@ -470,7 +466,7 @@ abstract class Horde_Alarm
      *
      * @param array $alarm  An alarm hash.
      */
-    protected function _notify($alarm)
+    protected function _notify(array $alarm)
     {
         static $sound_played;
 
@@ -491,7 +487,7 @@ abstract class Horde_Alarm
      * @throws Horde_Mime_Exception
      * @throws Horde_Alarm_Exception
      */
-    protected function _mail($alarm)
+    protected function _mail(array $alarm)
     {
         if (!empty($alarm['internal']['mail']['sent'])) {
             return;
@@ -527,7 +523,7 @@ abstract class Horde_Alarm
      *
      * @param array $alarm  An alarm hash.
      */
-    protected function _sms($alarm)
+    protected function _sms(array $alarm)
     {
     }
 
diff --git a/framework/Alarm/lib/Horde/Alarm/Sql.php b/framework/Alarm/lib/Horde/Alarm/Sql.php
index 4c38c1903..4f540ba8f 100644
--- a/framework/Alarm/lib/Horde/Alarm/Sql.php
+++ b/framework/Alarm/lib/Horde/Alarm/Sql.php
@@ -62,7 +62,7 @@ class Horde_Alarm_Sql extends Horde_Alarm
      * @return array  A list of alarm hashes.
      * @throws Horde_Alarm_Exception
      */
-    protected function _list($user, $time)
+    protected function _list($user, Horde_Date $time)
     {
         $query = sprintf('SELECT alarm_id, alarm_uid, alarm_start, alarm_end, alarm_methods, alarm_params, alarm_title, alarm_text, alarm_snooze, alarm_internal FROM %s WHERE alarm_dismissed = 0 AND ((alarm_snooze IS NULL AND alarm_start <= ?) OR alarm_snooze <= ?) AND (alarm_end IS NULL OR alarm_end >= ?)%s ORDER BY alarm_start, alarm_end',
                          $this->_params['table'],
@@ -103,7 +103,7 @@ class Horde_Alarm_Sql extends Horde_Alarm
 
     /**
      */
-    protected function _getHash($alarm)
+    protected function _getHash(array $alarm)
     {
         return array(
             'id' => $alarm['alarm_id'],
@@ -160,7 +160,7 @@ class Horde_Alarm_Sql extends Horde_Alarm
      *
      * @throws Horde_Alarm_Exception
      */
-    protected function _add($alarm)
+    protected function _add(array $alarm)
     {
         $query = sprintf('INSERT INTO %s (alarm_id, alarm_uid, alarm_start, alarm_end, alarm_methods, alarm_params, alarm_title, alarm_text, alarm_snooze) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)', $this->_params['table']);
         $values = array(
@@ -195,7 +195,7 @@ class Horde_Alarm_Sql extends Horde_Alarm
      *
      * @throws Horde_Alarm_Exception
      */
-    protected function _update($alarm, $keepsnooze = false)
+    protected function _update(array $alarm, $keepsnooze = false)
     {
         $query = sprintf('UPDATE %s set alarm_start = ?, alarm_end = ?, alarm_methods = ?, alarm_params = ?, alarm_title = ?, alarm_text = ?%s WHERE alarm_id = ? AND %s',
                          $this->_params['table'],
@@ -235,7 +235,7 @@ class Horde_Alarm_Sql extends Horde_Alarm
      *
      * @throws Horde_Alarm_Exception
      */
-    protected function _internal($id, $user, $internal)
+    protected function _internal($id, $user, array $internal)
     {
         $query = sprintf('UPDATE %s set alarm_internal = ? WHERE alarm_id = ? AND %s',
                          $this->_params['table'],
@@ -294,7 +294,7 @@ class Horde_Alarm_Sql extends Horde_Alarm
      *
      * @throws Horde_Alarm_Exception
      */
-    protected function _snooze($id, $user, $snooze)
+    protected function _snooze($id, $user, Horde_Date $snooze)
     {
         $query = sprintf('UPDATE %s set alarm_snooze = ? WHERE alarm_id = ? AND %s',
                          $this->_params['table'],
@@ -324,7 +324,7 @@ class Horde_Alarm_Sql extends Horde_Alarm
      * @return boolean  True if the alarm is snoozed.
      * @throws Horde_Alarm_Exception
      */
-    protected function _isSnoozed($id, $user, $time)
+    protected function _isSnoozed($id, $user, Horde_Date $time)
     {
         $query = sprintf('SELECT 1 FROM %s WHERE alarm_id = ? AND %s AND (alarm_dismissed = 1 OR (alarm_snooze IS NOT NULL AND alarm_snooze >= ?))',
                          $this->_params['table'],
@@ -481,7 +481,7 @@ class Horde_Alarm_Sql extends Horde_Alarm
 
     /**
      */
-    protected function _initConn($db)
+    protected function _initConn(DB_common $db)
     {
         // Set DB portability options.
         switch ($db->phptype) {