From: Michael M Slusarz Date: Wed, 10 Nov 2010 17:38:03 +0000 (-0700) Subject: phpdoc X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=1c6cd92106e90786562e0ae72c49c1b0fe7dccc3;p=horde.git phpdoc --- diff --git a/imp/lib/Mailbox/List.php b/imp/lib/Mailbox/List.php index b4062d780..6570a4d96 100644 --- a/imp/lib/Mailbox/List.php +++ b/imp/lib/Mailbox/List.php @@ -93,34 +93,30 @@ class IMP_Mailbox_List implements Countable, Serializable * If 2, forces addition of preview info. * DEFAULT: No preview information. * 'structure' - (boolean) Get structure information from server. - * Contained in the 'strucutre' entry. + * Contained in the 'structure' entry. * DEFAULT: false * * * @return array An array with the following keys: * 
-     * 'overview' - (array) The overview information. Contains the following:
-     *              'envelope' - (array) Envelope information returned from
-     *                           the IMAP server. See
-     *                           Horde_Imap_Client::fetch() for format.
-     *              'flags' - (array) The list of IMAP flags returned from
-     *                        the server. See Horde_Imap_Client::fetch() for
-     *                        the format.
-     *              'headers' - (array) Any headers requested in
-     *                          $options['headers']. Horde_Mime_Headers objects
-     *                          are returned.  See Horde_Imap_Client::fetch()
-     *                          for the format.
-     *              'mailbox' - (string) The mailbox containing the message.
-     *              'preview' - (string) If requested in $options['preview'],
-     *                          the preview text.
-     *              'previewcut'- (boolean) Has the preview text been cut?
-     *              'size' - (integer) The size of the message in bytes.
-     *              'structure'- (array) The structure of the message. Only
-     *                           set if $options['structure'] is true. See
-     *                           Horde_Imap_Client::fetch() for format.
-     *              'uid' - (string) The unique ID of the message.
-     *
-     * 'uids' - (IMP_Indices) An indices object.
+     * overview - (array) The overview information. Contains the following:
+     *     envelope - (array) Envelope information returned from the IMAP
+     *                server. See Horde_Imap_Client::fetch() for format.
+     *     flags - (array) The list of IMAP flags returned from the server.
+     *             See Horde_Imap_Client::fetch() for the format.
+     *     headers - (array) Any headers requested in $options['headers'].
+     *               Horde_Mime_Headers objects are returned.  See
+     *               Horde_Imap_Client::fetch() for the format.
+     *     mailbox - (string) The mailbox containing the message.
+     *     preview - (string) If requested in $options['preview'], the preview
+     *               text.
+     *     previewcut - (boolean) Has the preview text been cut?
+     *     size - (integer) The size of the message in bytes.
+     *     structure - (array) The structure of the message. Only set if
+     *                 $options['structure'] is true. See
+     *                 Horde_Imap_Client::fetch() for format.
+     *     uid - (string) The unique ID of the message.
+     * uids - (IMP_Indices) An indices object.
      *
*/ public function getMailboxArray($msgnum, $options = array()) diff --git a/imp/lib/Search/Element/Bulk.php b/imp/lib/Search/Element/Bulk.php index d913c3b45..b51d7eb46 100644 --- a/imp/lib/Search/Element/Bulk.php +++ b/imp/lib/Search/Element/Bulk.php @@ -30,11 +30,6 @@ class IMP_Search_Element_Bulk extends IMP_Search_Element } /** - * Adds the current query item to the query object. - * - * @param Horde_Imap_Client_Search_Query The query object. - * - * @return Horde_Imap_Client_Search_Query The query object. */ public function createQuery($queryob) { @@ -44,9 +39,6 @@ class IMP_Search_Element_Bulk extends IMP_Search_Element } /** - * Return search query text representation. - * - * @return array The textual description of this search element. */ public function queryText() { diff --git a/imp/lib/Search/Element/Date.php b/imp/lib/Search/Element/Date.php index a9e74bf99..ab3b0e00f 100644 --- a/imp/lib/Search/Element/Date.php +++ b/imp/lib/Search/Element/Date.php @@ -41,11 +41,6 @@ class IMP_Search_Element_Date extends IMP_Search_Element } /** - * Adds the current query item to the query object. - * - * @param Horde_Imap_Client_Search_Query The query object. - * - * @return Horde_Imap_Client_Search_Query The query object. */ public function createQuery($queryob) { @@ -56,9 +51,6 @@ class IMP_Search_Element_Date extends IMP_Search_Element } /** - * Return search query text representation. - * - * @return array The textual description of this search element. */ public function queryText() { diff --git a/imp/lib/Search/Element/Flag.php b/imp/lib/Search/Element/Flag.php index f2454ef3a..0be7a427e 100644 --- a/imp/lib/Search/Element/Flag.php +++ b/imp/lib/Search/Element/Flag.php @@ -40,11 +40,6 @@ class IMP_Search_Element_Flag extends IMP_Search_Element } /** - * Adds the current query item to the query object. - * - * @param Horde_Imap_Client_Search_Query The query object. - * - * @return Horde_Imap_Client_Search_Query The query object. */ public function createQuery($queryob) { @@ -54,9 +49,6 @@ class IMP_Search_Element_Flag extends IMP_Search_Element } /** - * Return search query text representation. - * - * @return array The textual description of this search element. */ public function queryText() { diff --git a/imp/lib/Search/Element/Header.php b/imp/lib/Search/Element/Header.php index 33d9b8a29..e796b2934 100644 --- a/imp/lib/Search/Element/Header.php +++ b/imp/lib/Search/Element/Header.php @@ -34,11 +34,6 @@ class IMP_Search_Element_Header extends IMP_Search_Element } /** - * Adds the current query item to the query object. - * - * @param Horde_Imap_Client_Search_Query The query object. - * - * @return Horde_Imap_Client_Search_Query The query object. */ public function createQuery($queryob) { @@ -48,9 +43,6 @@ class IMP_Search_Element_Header extends IMP_Search_Element } /** - * Return search query text representation. - * - * @return array The textual description of this search element. */ public function queryText() { diff --git a/imp/lib/Search/Element/Mailinglist.php b/imp/lib/Search/Element/Mailinglist.php index f205b6eb0..e58f343b2 100644 --- a/imp/lib/Search/Element/Mailinglist.php +++ b/imp/lib/Search/Element/Mailinglist.php @@ -29,11 +29,6 @@ class IMP_Search_Element_Mailinglist extends IMP_Search_Element } /** - * Adds the current query item to the query object. - * - * @param Horde_Imap_Client_Search_Query The query object. - * - * @return Horde_Imap_Client_Search_Query The query object. */ public function createQuery($queryob) { @@ -43,9 +38,6 @@ class IMP_Search_Element_Mailinglist extends IMP_Search_Element } /** - * Return search query text representation. - * - * @return array The textual description of this search element. */ public function queryText() { diff --git a/imp/lib/Search/Element/Or.php b/imp/lib/Search/Element/Or.php index bd17ad2fb..3ded706ac 100644 --- a/imp/lib/Search/Element/Or.php +++ b/imp/lib/Search/Element/Or.php @@ -15,12 +15,6 @@ class IMP_Search_Element_Or extends IMP_Search_Element { /** - * Adds the current query item to the query object. - * - * @param Horde_Imap_Client_Search_Query The query object. - * - * @return Horde_Imap_Client_Search_Query The query object. - * */ public function createQuery($queryob) { @@ -31,9 +25,6 @@ class IMP_Search_Element_Or extends IMP_Search_Element } /** - * Return search query text representation. - * - * @return array The textual description of this search element. */ public function queryText() { diff --git a/imp/lib/Search/Element/Personal.php b/imp/lib/Search/Element/Personal.php index 62c6c9fc2..ba0c6c966 100644 --- a/imp/lib/Search/Element/Personal.php +++ b/imp/lib/Search/Element/Personal.php @@ -29,11 +29,6 @@ class IMP_Search_Element_Personal extends IMP_Search_Element } /** - * Adds the current query item to the query object. - * - * @param Horde_Imap_Client_Search_Query The query object. - * - * @return Horde_Imap_Client_Search_Query The query object. */ public function createQuery($queryob) { @@ -60,9 +55,6 @@ class IMP_Search_Element_Personal extends IMP_Search_Element } /** - * Return search query text representation. - * - * @return array The textual description of this search element. */ public function queryText() { diff --git a/imp/lib/Search/Element/Recipient.php b/imp/lib/Search/Element/Recipient.php index 7f1132c94..219a089fa 100644 --- a/imp/lib/Search/Element/Recipient.php +++ b/imp/lib/Search/Element/Recipient.php @@ -31,11 +31,6 @@ class IMP_Search_Element_Recipient extends IMP_Search_Element } /** - * Adds the current query item to the query object. - * - * @param Horde_Imap_Client_Search_Query The query object. - * - * @return Horde_Imap_Client_Search_Query The query object. */ public function createQuery($queryob) { @@ -59,9 +54,6 @@ class IMP_Search_Element_Recipient extends IMP_Search_Element } /** - * Return search query text representation. - * - * @return array The textual description of this search element. */ public function queryText() { diff --git a/imp/lib/Search/Element/Size.php b/imp/lib/Search/Element/Size.php index 41f67f503..9023dfa8e 100644 --- a/imp/lib/Search/Element/Size.php +++ b/imp/lib/Search/Element/Size.php @@ -38,11 +38,6 @@ class IMP_Search_Element_Size extends IMP_Search_Element } /** - * Adds the current query item to the query object. - * - * @param Horde_Imap_Client_Search_Query The query object. - * - * @return Horde_Imap_Client_Search_Query The query object. */ public function createQuery($queryob) { @@ -52,9 +47,6 @@ class IMP_Search_Element_Size extends IMP_Search_Element } /** - * Return search query text representation. - * - * @return array The textual description of this search element. */ public function queryText() { diff --git a/imp/lib/Search/Element/Text.php b/imp/lib/Search/Element/Text.php index 58b9e46b1..d93ad6328 100644 --- a/imp/lib/Search/Element/Text.php +++ b/imp/lib/Search/Element/Text.php @@ -35,11 +35,6 @@ class IMP_Search_Element_Text extends IMP_Search_Element } /** - * Adds the current query item to the query object. - * - * @param Horde_Imap_Client_Search_Query The query object. - * - * @return Horde_Imap_Client_Search_Query The query object. */ public function createQuery($queryob) { @@ -49,9 +44,6 @@ class IMP_Search_Element_Text extends IMP_Search_Element } /** - * Return search query text representation. - * - * @return array The textual description of this search element. */ public function queryText() { diff --git a/imp/lib/Search/Element/Within.php b/imp/lib/Search/Element/Within.php index 771efaaa6..2986eb3f5 100644 --- a/imp/lib/Search/Element/Within.php +++ b/imp/lib/Search/Element/Within.php @@ -44,11 +44,6 @@ class IMP_Search_Element_Within extends IMP_Search_Element } /** - * Adds the current query item to the query object. - * - * @param Horde_Imap_Client_Search_Query The query object. - * - * @return Horde_Imap_Client_Search_Query The query object. */ public function createQuery($queryob) { @@ -71,9 +66,6 @@ class IMP_Search_Element_Within extends IMP_Search_Element } /** - * Return search query text representation. - * - * @return array The textual description of this search element. */ public function queryText() { diff --git a/imp/lib/Search/Filter.php b/imp/lib/Search/Filter.php index c8a5b93a4..81a032bce 100644 --- a/imp/lib/Search/Filter.php +++ b/imp/lib/Search/Filter.php @@ -15,9 +15,6 @@ class IMP_Search_Filter extends IMP_Search_Query { /** - * Get object properties. - * - * @see __get() */ public function __get($name) { diff --git a/imp/lib/Search/Filter/Builtin.php b/imp/lib/Search/Filter/Builtin.php index 4cb799bcf..1a56933ab 100644 --- a/imp/lib/Search/Filter/Builtin.php +++ b/imp/lib/Search/Filter/Builtin.php @@ -15,16 +15,10 @@ abstract class IMP_Search_Filter_Builtin extends IMP_Search_Filter { /** - * Can this query be edited? - * - * @var boolean */ protected $_canEdit = false; /** - * List of serialize entries not to save. - * - * @var array */ protected $_nosave = array('c', 'i', 'l'); @@ -43,16 +37,10 @@ abstract class IMP_Search_Filter_Builtin extends IMP_Search_Filter } /** - * Initialization tasks. */ abstract protected function _init(); /** - * Unserialization. - * - * @param string $data Serialized data. - * - * @throws Exception */ public function unserialize($data) { diff --git a/imp/lib/Search/Filter/Bulk.php b/imp/lib/Search/Filter/Bulk.php index 098b89038..6c29b93d6 100644 --- a/imp/lib/Search/Filter/Bulk.php +++ b/imp/lib/Search/Filter/Bulk.php @@ -15,7 +15,6 @@ class IMP_Search_Filter_Bulk extends IMP_Search_Filter_Builtin { /** - * Initialization tasks. */ protected function _init() { diff --git a/imp/lib/Search/Filter/Mailinglist.php b/imp/lib/Search/Filter/Mailinglist.php index 3fc936ab7..942204ade 100644 --- a/imp/lib/Search/Filter/Mailinglist.php +++ b/imp/lib/Search/Filter/Mailinglist.php @@ -15,7 +15,6 @@ class IMP_Search_Filter_Mailinglist extends IMP_Search_Filter_Builtin { /** - * Initialization tasks. */ protected function _init() { diff --git a/imp/lib/Search/Filter/Personal.php b/imp/lib/Search/Filter/Personal.php index 6549b9c5c..2dca38060 100644 --- a/imp/lib/Search/Filter/Personal.php +++ b/imp/lib/Search/Filter/Personal.php @@ -15,7 +15,6 @@ class IMP_Search_Filter_Personal extends IMP_Search_Filter_Builtin { /** - * Initialization tasks. */ protected function _init() { diff --git a/imp/lib/Search/Query.php b/imp/lib/Search/Query.php index d36c0add7..3f4f12c33 100644 --- a/imp/lib/Search/Query.php +++ b/imp/lib/Search/Query.php @@ -111,13 +111,13 @@ class IMP_Search_Query implements Serializable * * @param string $name Available properties: * 
-     * 'canEdit' - (boolean)
-     * 'id' - (string)
-     * 'label' - (string)
-     * 'mboxes' - (array)
-     * 'mid' - (string)
-     * 'query' - (Horde_Imap_Client_Search_Query)
-     * 'querytext' - (string)
+     * 'canEdit' - (boolean) Can this query be edited?
+     * 'id' - (string) The query ID.
+     * 'label' - (string) The query label.
+     * 'mboxes' - (array) The list of mailboxes to query.
+     * 'mid' - (string) The query ID with the search mailbox prefix.
+     * 'query' - (Horde_Imap_Client_Search_Query) The IMAP query object.
+     * 'querytext' - (string) The textual representation of the query.
      *
* * @return mixed Property value.