Remove a bunch of @todo
authorMichael J. Rubinsky <mrubinsk@horde.org>
Sat, 10 Apr 2010 14:02:22 +0000 (10:02 -0400)
committerMichael J. Rubinsky <mrubinsk@horde.org>
Sat, 10 Apr 2010 14:02:22 +0000 (10:02 -0400)
framework/ActiveSync/lib/Horde/ActiveSync/Driver/Base.php
framework/ActiveSync/lib/Horde/ActiveSync/Driver/Horde.php

index 8764821..e7c5393 100644 (file)
@@ -312,9 +312,6 @@ abstract class Horde_ActiveSync_Driver_Base
     /**
      * Return the helper for importing hierarchy changes from the PIM.
      *
-     * @TODO: Probably not functional, as methods were missing from original
-     * codebase.
-     *
      * @return Horde_ActiveSync_DiffState_ImportHierarchy
      */
     public function GetHierarchyImporter()
@@ -398,8 +395,6 @@ abstract class Horde_ActiveSync_Driver_Base
     /**
      * Obtain a message from the backend.
      *
-     * @TODO: Not sure why we have this *and* GetMessage()??
-     *
      * @param string $folderid
      * @param string $id
      * @param ?? $mimesupport  (Not sure what this was supposed to do)
@@ -423,18 +418,16 @@ abstract class Horde_ActiveSync_Driver_Base
     }
 
     /**
-     * @TODO
-     * 
-     * @param $rfc822
-     * @param $forward
-     * @param $reply
-     * @param $parent
-     * @return unknown_type
+     * Sends the email represented by the rfc822 string received by the PIM.
+     *
+     * @param string $rfc822    The rfc822 mime message
+     * @param boolean $forward  Is this a message forward?
+     * @param boolean $reply    Is this a reply?
+     * @param boolean $parent   Parent message in thread.
+     *
+     * @return boolean
      */
-    public function sendMail($rfc822, $forward = false, $reply = false, $parent = false)
-    {
-        return true;
-    }
+    abstract function sendMail($rfc822, $forward = false, $reply = false, $parent = false);
 
     /**
      * @return unknown_type
@@ -445,11 +438,13 @@ abstract class Horde_ActiveSync_Driver_Base
     }
 
     /**
-     * @TODO: Missing method from Z-Push
+     * Delete a folder on the server.
      *
-     * @param $parent
-     * @param $id
-     * @return unknown_type
+     * @param string $parent  The parent folder.
+     * @param string $id      The folder to delete.
+     *
+     * @return boolean
+     * @throws Horde_ActiveSync_Exception
      */
     public function DeleteFolder($parent, $id)
     {
@@ -469,13 +464,14 @@ abstract class Horde_ActiveSync_Driver_Base
     }
 
     /**
-     * @TODO: This method was missing from Z-Push
+     * Change the name and/or type of a folder.
      *
-     * @param unknown_type $parent
-     * @param unknown_type $id
-     * @param unknown_type $displayname
-     * @param unknown_type $type
-     * @return unknown_type
+     * @param string $parent
+     * @param string $id
+     * @param string $displayname
+     * @param string $type
+     * 
+     * @return boolean
      */
     public function changeFolder($parent, $id, $displayname, $type)
     {
index 77bf4df..48040ca 100644 (file)
@@ -21,7 +21,6 @@
 ************************************************/
 class Horde_ActiveSync_Driver_Horde extends Horde_ActiveSync_Driver_Base
 {
-
     /** Constants **/
     const APPOINTMENTS_FOLDER = 'Calendar';
     const CONTACTS_FOLDER = 'Contacts';
@@ -122,15 +121,12 @@ class Horde_ActiveSync_Driver_Horde extends Horde_ActiveSync_Driver_Base
     /**
      * Return a list of available folders
      *
-     * @TODO: only return those folders we configure horde to serve
      * @return array  An array of folder stats
      */
     public function getFolderList()
     {
         $this->_logger->debug('Horde::getFolderList()');
         $folders = array();
-
-        // @TODO: Be able to configure the folders to sync/not sync
         $folders[] = $this->StatFolder(self::APPOINTMENTS_FOLDER);
         $folders[] = $this->StatFolder(self::CONTACTS_FOLDER);
         $folders[] = $this->StatFolder(self::TASKS_FOLDER);
@@ -267,8 +263,7 @@ class Horde_ActiveSync_Driver_Horde extends Horde_ActiveSync_Driver_Base
 
     /**
      * Get a message from the backend
-     *
-     * @TODO: Default value for truncsize? Do we need it?
+     * 
      * @see framework/ActiveSync/lib/Horde/ActiveSync/Driver/Horde_ActiveSync_Driver_Base#GetMessage($folderid, $id, $truncsize, $mimesupport)
      */
     public function GetMessage($folderid, $id, $truncsize, $mimesupport = 0)