[Phpfreechat-svn] SF.net SVN: phpfreechat: [514] trunk/src/containers/file.class.php

[<ke...@us...>]

Revision: 514
Author:   kerphi
Date:     2006-05-28 04:50:35 -0700 (Sun, 28 May 2006)
ViewCVS:  http://svn.sourceforge.net/phpfreechat/?rev=514&view=rev

Log Message:
-----------
add few comments

Modified Paths:
--------------
    trunk/src/containers/file.class.php
Modified: trunk/src/containers/file.class.php
===================================================================
--- trunk/src/containers/file.class.php	2006-05-27 19:11:04 UTC (rev 513)
+++ trunk/src/containers/file.class.php	2006-05-28 11:50:35 UTC (rev 514)
@@ -509,7 +509,7 @@
    * @param $key is the index which identify a metadata
    * @param $type is used to "group" some metadata
    * @param $subtype is used to "group" precisely some metadata, use NULL to ignore it
-   * @return mixed the value assigned to the key
+   * @return mixed the value assigned to the key, NULL if not found
    */
   function getMeta($key, $type, $subtype = NULL)
   {
@@ -538,6 +538,7 @@
    * @param $value is the value associated to the key
    * @param $type is used to "group" some metadata
    * @param $subtype is used to "group" precisely some metadata, use NULL to ignore it
+   * @return true on success, false on error
    */
   function setMeta($value, $key, $type, $subtype = NULL)
   {
@@ -568,6 +569,7 @@
    * @param $key is the key to delete, use NULL to delete all the metadata
    * @param $type is used to "group" some metadata
    * @param $subtype is used to "group" precisely some metadata, use NULL to ignore it
+   * @return true on success, false on error
    */
   function rmMeta($key, $type, $subtype = NULL)
   {
@@ -612,6 +614,7 @@
   /**
    * Return a unique id. Each time this function is called, the last id is incremented.
    * used internaly
+   * @private
    */ 
   function _requestMsgId($chan)
   {
@@ -647,12 +650,20 @@
 
     return $msg_id;
   }
-  
+
+  /**
+   * Used to encode UTF8 strings to ASCII filenames
+   * @private
+   */  
   function _encode($str)
   {
     return base64_encode(urlencode($str));
   }
   
+  /**
+   * Used to decode ASCII filenames to UTF8 strings
+   * @private
+   */  
   function _decode($str)
   {
     return urldecode(base64_decode($str));


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.