documenting some class params

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@9445 7612ce4b-ef26-0410-bec9-ea0150e637f0

diff --git a/class/mime/Message.class.php b/class/mime/Message.class.php
index de6530f43b97dc6abdabbb36c36cdffac2917444..c314abc02bcdfe747998c3cf7ed54963c873a9d7 100644 (file)
--- a/class/mime/Message.class.php
+++ b/class/mime/Message.class.php
@@ -6,7 +6,7 @@
  * Copyright (c) 2003-2005 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
- * This contains functions needed to handle mime messages.
+ * This file contains functions needed to handle mime messages.
  *
  * @version $Id$
  * @package squirrelmail
@@ -26,32 +26,117 @@
  * @since 1.3.0
  */
 class Message {
-    var $rfc822_header = '',
-        $mime_header = '',
-        $flags = '',
-        $type0='',
-        $type1='',
-        $entities = array(),
-        $entity_id = '',
-        $parent_ent, $entity,
-        $parent = '', $decoded_body='',
-        $is_seen = 0, $is_answered = 0, $is_deleted = 0, $is_flagged = 0,
-        $is_mdnsent = 0,
-        $body_part = '',
-        $offset = 0,  /* for fetching body parts out of raw messages */
-        $length = 0,  /* for fetching body parts out of raw messages */
-        $att_local_name = ''; /* location where the tempory attachment
-                             is stored. For future usage in smtp.php */
-
-    /**
-     * @param mixed $ent entity id
+    /**
+     * rfc822header object
+     * @var object
+     */
+    var $rfc822_header = '';
+    /**
+     * MessageHeader object
+     * @var object
+     */
+    var $mime_header = '';
+    /**
+     * @var mixed
+     */
+    var $flags = '';
+    /**
+     * Media type
+     * @var string
+     */
+    var $type0='';
+    /**
+     * Media subtype
+     * @var string
+     */
+    var $type1='';
+    /**
+     * Nested mime parts
+     * @var array
+     */
+    var $entities = array();
+    /**
+     * Message part id
+     * @var string
+     */
+    var $entity_id = '';
+    /**
+     * Parent message part id
+     * @var string
+     */
+    var $parent_ent;
+    /**
+     * @var mixed
+     */
+    var $entity;
+    /**
+     * @var mixed
+     */
+    var $parent = '';
+    /**
+     * @var string
+     */
+    var $decoded_body='';
+    /**
+     * Message \seen status
+     * @var boolean
+     */
+    var $is_seen = 0;
+    /**
+     * Message \answered status
+     * @var boolean
+     */
+    var $is_answered = 0;
+    /**
+     * Message \deleted status
+     * @var boolean
+     */
+    var $is_deleted = 0;
+    /**
+     * Message \flagged status
+     * @var boolean
+     */
+    var $is_flagged = 0;
+    /**
+     * Message mdn status
+     * @var boolean
+     */
+    var $is_mdnsent = 0;
+    /**
+     * Message text body
+     * @var string
+     */
+    var $body_part = '';
+    /**
+     * Message part offset
+     * for fetching body parts out of raw messages
+     * @var integer
+     */
+    var $offset = 0;
+    /**
+     * Message part length
+     * for fetching body parts out of raw messages
+     * @var integer
+     */
+    var $length = 0;
+    /**
+     * Local attachment filename
+     * location where the tempory attachment
+     * is stored. For use in delivery class.
+     * @var string
+     */
+    var $att_local_name = '';
+
+    /**
+     * @param string $ent entity id
      */
     function setEnt($ent) {
         $this->entity_id= $ent;
     }
 
     /**
-     * @param mixed $msg
+     * Add nested message part
+     * @param object $msg
      */
     function addEntity ($msg) {
         $this->entities[] = $msg;
@@ -113,6 +198,7 @@ class Message {
 
     /**
      * @param string $ent
+     * @return mixed (object or string?)
      */
     function getEntity($ent) {
         $cur_ent = $this->entity_id;
@@ -655,7 +741,6 @@ class Message {
                 $disp->properties = $arg_a[1];
             }
         }
-
         return (is_object($disp) ? $disp : '');
     }
 
@@ -683,7 +768,6 @@ class Message {
                 $lang->properties = $arg_a[1];
             }
         }
-
         return (is_object($lang) ? $lang : '');
     }
 
@@ -712,7 +796,7 @@ class Message {
      * @param string $read
      * @param string $type0 message part type
      * @param string $type1 message part subtype
-     * @return string
+     * @return string (only when type0 is not message or multipart)
      */
     function parseMessage($read, $type0, $type1) {
         switch ($type0) {
@@ -884,7 +968,6 @@ class Message {
                 }
             }
         }
-
         return $entity;
     }
 

diff --git a/class/mime/MessageHeader.class.php b/class/mime/MessageHeader.class.php
index 51000744ea48c3603ba21932bee9dcf93c9119e3..8a843bb17cc26f0cf628e329d45bbad5ae7a0bf0 100644 (file)
--- a/class/mime/MessageHeader.class.php
+++ b/class/mime/MessageHeader.class.php
@@ -22,19 +22,52 @@
  * @package squirrelmail
  * @subpackage mime
  * @since 1.3.2
- * @todo document vars
  */
 class MessageHeader {
-    var $type0 = '',
-        $type1 = '',
-        $parameters = array(),
-        $id = 0,
-        $description = '',
-        $encoding='',
-        $size = 0,
-        $md5='',
-        $disposition = '',
-        $language='';
+    /**
+     * Media type
+     * @var string
+     */
+    var $type0 = '';
+    /**
+     * Media subtype
+     * @var string
+     */
+    var $type1 = '';
+    /**
+     * Content type parameters
+     * @var array
+     */
+    var $parameters = array();
+    /**
+     * @var mixed
+     */
+    var $id = 0;
+    /**
+     * @var string
+     */
+    var $description = '';
+    /**
+     * @var string
+     */
+    var $encoding='';
+    /**
+     * Message size
+     * @var integer
+     */
+    var $size = 0;
+    /**
+     * @var string
+     */
+    var $md5='';
+    /**
+     * @var mixed
+     */
+    var $disposition = '';
+    /**
+     * @var mixed
+     */
+    var $language='';
 
     /**
      * Sets header variable

diff --git a/class/mime/Rfc822Header.class.php b/class/mime/Rfc822Header.class.php
index 750734989240a973bde625ebfd2fe8da516547bf..9f05a715cd8a4fb68bae27a380cca00b2e93c49f 100644 (file)
--- a/class/mime/Rfc822Header.class.php
+++ b/class/mime/Rfc822Header.class.php
@@ -25,30 +25,114 @@
  * @since 1.3.0
  */
 class Rfc822Header {
-    var $date = -1,
-        $subject = '',
-        $from = array(),
-        $sender = '',
-        $reply_to = array(),
-        $mail_followup_to = array(),
-        $to = array(),
-        $cc = array(),
-        $bcc = array(),
-        $in_reply_to = '',
-        $message_id = '',
-        $references = '',
-        $mime = false,
-        $content_type = '',
-        $disposition = '',
-        $xmailer = '',
-        $priority = 3,
-        $dnt = '',
-        $encoding = '',
-        $content_id = '',
-        $content_desc = '',
-        $mlist = array(),
-        $more_headers = array(); /* only needed for constructing headers
-                                    in smtp.php */
+    /**
+     * Date header
+     * @var mixed
+     */
+    var $date = -1;
+    /**
+     * Subject header
+     * @var string
+     */
+    var $subject = '';
+    /**
+     * From header
+     * @var array
+     */
+    var $from = array();
+    /**
+     * @var mixed
+     */
+    var $sender = '';
+    /**
+     * Reply-To header
+     * @var array
+     */
+    var $reply_to = array();
+    /**
+     * Mail-Followup-To header
+     * @var array
+     */
+    var $mail_followup_to = array();
+    /**
+     * To header
+     * @var array
+     */
+    var $to = array();
+    /**
+     * Cc header
+     * @var array
+     */
+    var $cc = array();
+    /**
+     * Bcc header
+     * @var array
+     */
+    var $bcc = array();
+    /**
+     * In-reply-to header
+     * @var string
+     */
+    var $in_reply_to = '';
+    /**
+     * Message-ID header
+     * @var string
+     */
+    var $message_id = '';
+    /**
+     * References header
+     * @var string
+     */
+    var $references = '';
+    /**
+     * @var mixed
+     */
+    var $mime = false;
+    /**
+     * @var mixed
+     */
+    var $content_type = '';
+    /**
+     * @var mixed
+     */
+    var $disposition = '';
+    /**
+     * X-Mailer header
+     * @var string
+     */
+    var $xmailer = '';
+    /**
+     * Priority header
+     * @var integer
+     */
+    var $priority = 3;
+    /**
+     * @var mixed
+     */
+    var $dnt = '';
+    /**
+     * @var mixed
+     */
+    var $encoding = '';
+    /**
+     * @var mixed
+     */
+    var $content_id = '';
+    /**
+     * @var mixed
+     */
+    var $content_desc = '';
+    /**
+     * @var mixed
+     */
+    var $mlist = array();
+    /**
+     * Extra header
+     * only needed for constructing headers in delivery class
+     * @var array
+     */
+    var $more_headers = array();
+
     /**
      * @param mixed $hdr string or array with message headers
      */