RFC 3676 says there can't be more in the signature delimiter line than this
[squirrelmail.git] / class / mime / Disposition.class.php
index 10da4015049323e1d7f4a3a7ba70ac6c7d8832f0..0b600dc21963b233c72af49d096a99c6f59a0ca5 100644 (file)
@@ -3,25 +3,40 @@
 /**
  * Disposition.class.php
  *
- * Copyright (c) 2003 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
+ * This file contains functions needed to handle content disposition headers 
+ * in mime messages. See RFC 2183.
  *
- * This contains functions needed to handle mime messages.
- *
- * $Id$
+ * @copyright 2003-2010 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
  * @package squirrelmail
+ * @subpackage mime
+ * @since 1.3.2
  */
 
 /**
- * Undocumented class
+ * Class that handles content disposition header
  * @package squirrelmail
+ * @subpackage mime
+ * @since 1.3.0
+ * @todo FIXME: do we have to declare vars ($name and $properties)?
  */
 class Disposition {
+    /**
+     * Constructor function
+     * @param string $name
+     */
     function Disposition($name) {
        $this->name = $name;
        $this->properties = array();
     }
 
+    /**
+     * Returns value of content disposition property
+     * @param string $par content disposition property name
+     * @return string
+     * @since 1.3.1
+     */
     function getProperty($par) {
         $value = strtolower($par);
         if (isset($this->properties[$par])) {
@@ -30,5 +45,3 @@ class Disposition {
         return '';
     }
 }
-
-?>