added phpDocumentor tags to parts of the code

Signed-off-by: Andreas Unterkircher <unki@netshadow.at>

3 files changed, 194 insertions, 28 deletions

diff --git a/phpfspot.class.php b/phpfspot.class.php
index b1093fc..12e14fa 100644
--- a/phpfspot.class.php
+++ b/phpfspot.class.php
@@ -25,20 +25,76 @@
 require_once "phpfspot_cfg.php";
 require_once "phpfspot_db.php";
 
+/**
+ * PHPFSPOT main class
+ *
+ * @package phpfspot
+ */
 class PHPFSPOT {
 
+   /**
+     * phpfspot configuration
+     * @access public
+     * @see PHPFSPOT_CFG()
+     * @var PHPFSPOT_CFG
+     */
    var $cfg;
+
+   /**
+     * SQLite database handle to f-spot database
+     * @see PHPFSPOT_DB()
+     * @access public
+     * @var PHPFSPOT_DB
+     */
    var $db;
+
+   /**
+     * SQLite database handle to phpfspot database
+     * @see PHPFSPOT_DB()
+     * @access public
+     * @var PHPFSPOT_DB
+     */
    var $cfg_db;
+
+   /**
+    * Smarty template engine
+    * @link http://smarty.php.net smarty.php.net
+    * @see PHPFSPOT_TMPL()
+    * @access public
+    * @var PHPFSPOT_TMPL
+    */
    var $tmpl;
+
+   /**
+    * full tag - list
+    * @access public
+    * @var array
+    */
    var $tags;
+
+   /**
+    * list of available, not-selected, tags
+    * @access public
+    * @var array
+    */
    var $avail_tags;
 
+   /**
+    * true if runtime error occued
+    * @access private
+    * @var boolean
+    */
    private $runtime_error = false;
+
+   /**
+    * F-Spot database version
+    * @access private
+    * @var integer
+    */
    private $dbver;
 
    /**
-    * class constructor
+    * class constructor ($cfg, $db, $cfg_db, $tmpl, $db_ver)
     *
     * this function will be called on class construct
     * and will check requirements, loads configuration,
@@ -330,6 +386,8 @@ class PHPFSPOT {
     * 
     * retrieve all available details from f-spot's
     * database and return them as object
+    * @param integer $idx
+    * @return object|null
     */
    public function get_photo_details($idx)
    {
@@ -386,6 +444,9 @@ class PHPFSPOT {
     * this function returns aligned (length) names for
     * an specific photo. If the length of the name exceeds
     * $limit the name will be shrinked (...)
+    * @param integer $idx
+    * @param integer $limit
+    * @return string|null
     */
    public function getPhotoName($idx, $limit = 0)
    {
@@ -406,6 +467,9 @@ class PHPFSPOT {
     * If the length of the name exceeds $limit the
     * text will be shortend and some content in between
     * will be replaced with "..." 
+    * @param string $ext
+    * @param integer $limit
+    * @return string
     */
    private function shrink_text($text, $limit)
    {
@@ -423,6 +487,9 @@ class PHPFSPOT {
     * as the full-qualified path recorded in the f-spot database
     * is usally not the same as on the webserver, this function
     * will replace the path with that one specified in the cfg
+    * @param string $path
+    * @param integer $width
+    * @return string
     */
    public function translate_path($path, $width = 0)
    {  
@@ -435,6 +502,7 @@ class PHPFSPOT {
     *
     * this function provides all the necessary information
     * for the single photo template.
+    * @param integer photo
     */
    public function showPhoto($photo)
    {
@@ -654,6 +722,7 @@ class PHPFSPOT {
     * this function output all tags which have been selected
     * by the user. the selected tags are stored in the 
     * session-variable $_SESSION['selected_tags']
+    * @return string
     */
    public function getSelectedTags()
    {
@@ -686,6 +755,7 @@ class PHPFSPOT {
     * this function will add the specified to users current
     * tag selection. if a date search has been made before
     * it will be now cleared
+    * @return string
     */
    public function addTag($tag)
    {
@@ -708,6 +778,8 @@ class PHPFSPOT {
     *
     * this function removes the specified tag from
     * users current tag selection
+    * @param string $tag
+    * @return string
     */
    public function delTag($tag)
    {
@@ -739,6 +811,7 @@ class PHPFSPOT {
 
    /**
     * returns the value for the autocomplet tag-search
+    * @return string
     */
    public function get_xml_tag_list()
    {
@@ -847,6 +920,7 @@ class PHPFSPOT {
     * the tag-selection, tag- or date-search.
     * the tag-search also has to take care of AND
     * and OR conjunctions
+    * @return array
     */
    public function getPhotoSelection()
    {  
@@ -1267,6 +1341,10 @@ class PHPFSPOT {
     * stored as $thumb_image. It will check if the image is
     * in a supported format, if necessary rotate the image
     * (based on EXIF orientation meta headers) and re-sizing.
+    * @param string $orig_image
+    * @param string $thumb_image
+    * @param integer $width
+    * @return boolean
     */
    public function create_thumbnail($orig_image, $thumb_image, $width)
    {  
@@ -1419,6 +1497,8 @@ class PHPFSPOT {
 
    /**
     * return all exif meta data from the file
+    * @param string $file
+    * @return array
     */
    public function get_meta_informations($file)
    {
@@ -1457,6 +1537,9 @@ class PHPFSPOT {
     *    readable
     * 2. Check if the md5sum of the original file has changed
     * 3. Generate the thumbnails if needed
+    * @param integer $idx
+    * @param integer $force
+    * @param boolean $overwrite
     */
    public function gen_thumb($idx = 0, $force = 0, $overwrite = false)
    {
@@ -1539,6 +1622,8 @@ class PHPFSPOT {
     *
     * this function queries the phpfspot database for a
     * stored MD5 checksum of the specified photo
+    * @param integer $idx
+    * @return string|null
     */
    public function getMD5($idx)
    {
@@ -1558,6 +1643,8 @@ class PHPFSPOT {
 
    /**
     * set MD5 sum for the specific photo
+    * @param integer $idx
+    * @param string $md5
     */
    private function setMD5($idx, $md5)
    {
@@ -1573,6 +1660,8 @@ class PHPFSPOT {
     *
     * this function stores the current tag condition
     * (AND or OR) in the users session variables
+    * @param string $mode
+    * @return string
     */
    public function setTagCondition($mode)
    {
@@ -1590,6 +1679,7 @@ class PHPFSPOT {
     * it also handles the date search.
     * getPhotoSelection() will then only return the matching
     * photos.
+    * @return string
     */
    public function startSearch()
    {
@@ -1640,6 +1730,8 @@ class PHPFSPOT {
     *
     * this function is invoked by RPC and will sort the requested
     * sort order in the session variable.
+    * @param string $sort_order
+    * @return string
     */
    public function updateSortOrder($order)
    {
@@ -1657,6 +1749,9 @@ class PHPFSPOT {
     *
     * this function rotates the image according the
     * specified angel.
+    * @param string $img
+    * @param integer $degress
+    * @return image
     */
    private function rotateImage($img, $degrees)
    {
@@ -1734,6 +1829,9 @@ class PHPFSPOT {
     *
     * this function will return an either horizontal or
     * vertical flipped truecolor image.
+    * @param string $image
+    * @param string $mode 
+    * @return image
     */
    private function flipImage($image, $mode)
    {
@@ -1760,6 +1858,8 @@ class PHPFSPOT {
 
    /**
     * return all assigned tags for the specified photo
+    * @param integer $idx
+    * @return array
     */
    private function get_photo_tags($idx)
    {
@@ -1782,6 +1882,11 @@ class PHPFSPOT {
 
    /**
     * create on-the-fly images with text within
+    * @param string $txt
+    * @param string $color
+    * @param integer $space
+    * @param integer $font
+    * @param integer $w
     */
    public function showTextImage($txt, $color=000000, $space=4, $font=4, $w=300)
    {
@@ -1811,6 +1916,7 @@ class PHPFSPOT {
 
    /**
     * check if all requirements are met
+    * @return boolean
     */
    private function check_requirements()
    {
@@ -1865,6 +1971,8 @@ class PHPFSPOT {
 
    /**
     * check if specified MIME type is supported
+    * @param string $mime
+    * @return boolean
     */
    public function checkifImageSupported($mime)
    {
@@ -1875,6 +1983,10 @@ class PHPFSPOT {
 
    } // checkifImageSupported()
 
+   /**
+    * output error text
+    * @param string $text
+    */
    public function _error($text)
    {
       switch($this->cfg->logging) {
@@ -1897,6 +2009,8 @@ class PHPFSPOT {
 
    /**
     * output calendard input fields
+    * @param string $mode
+    * @return string
     */
    private function get_calendar($mode)
    {
@@ -1923,6 +2037,9 @@ class PHPFSPOT {
 
    /**
     * output calendar matrix
+    * @param integer $year
+    * @param integer $month
+    * @param integer $day
     */
    public function get_calendar_matrix($year = 0, $month = 0, $day = 0)
    {
@@ -2001,6 +2118,7 @@ class PHPFSPOT {
 
    /**
     * output export page
+    * @param string $mode
     */
    public function getExport($mode)
    {
@@ -2116,6 +2234,7 @@ class PHPFSPOT {
  
    /**
     * return all selected tags as one string
+    * @return array
     */
    private function getCurrentTags()
    {
@@ -2147,6 +2266,7 @@ class PHPFSPOT {
     * to do next. This is necessary for directly jumping
     * into photo index or single photo view when the are
     * requested with specific URLs
+    * @return string
     */
    public function whatToDo()
    {
@@ -2166,6 +2286,7 @@ class PHPFSPOT {
 
    /**
     * return the current process-user
+    * @return string
     */
    private function getuid()
    {
@@ -2181,6 +2302,9 @@ class PHPFSPOT {
 
    /**
     * returns a select-dropdown box to select photo index sort parameters
+    * @param array $params
+    * @param smarty $smarty
+    * @return string
     */
    public function smarty_sort_select_list($params, &$smarty)
    {
@@ -2200,6 +2324,7 @@ class PHPFSPOT {
 
    /**
     * returns the currently selected sort order
+    * @return string
     */ 
    private function get_sort_order()
    {
@@ -2236,12 +2361,13 @@ class PHPFSPOT {
 
    } // get_sort_order()
 
-   /***
-     * return the next to be shown slide show image
-     *
-     * this function returns the URL of the next image
-     * in the slideshow sequence.
-     */
+   /**
+    * return the next to be shown slide show image
+    *
+    * this function returns the URL of the next image
+    * in the slideshow sequence.
+    * @return string
+    */
    public function getNextSlideShowImage()
    {
       $all_photos = $this->getPhotoSelection();
@@ -2255,12 +2381,13 @@ class PHPFSPOT {
 
    } // getNextSlideShowImage()
 
-   /***
-     * return the previous to be shown slide show image
-     *
-     * this function returns the URL of the previous image
-     * in the slideshow sequence.
-     */
+   /**
+    * return the previous to be shown slide show image
+    *
+    * this function returns the URL of the previous image
+    * in the slideshow sequence.
+    * @return string
+    */
    public function getPrevSlideShowImage()
    {
       $all_photos = $this->getPhotoSelection();
@@ -2281,16 +2408,17 @@ class PHPFSPOT {
 
    } // resetSlideShow()
    
-   /***
-     * get random photo
-     *
-     * this function will get all photos from the fspot
-     * database and randomly return ONE entry
-     *
-     * saddly there is yet no sqlite3 function which returns
-     * the bulk result in array, so we have to fill up our
-     * own here.
-     */ 
+   /**
+    * get random photo
+    *
+    * this function will get all photos from the fspot
+    * database and randomly return ONE entry
+    *
+    * saddly there is yet no sqlite3 function which returns
+    * the bulk result in array, so we have to fill up our
+    * own here.
+    * @return array
+    */
    public function get_random_photo()
    {
       $all = Array();
@@ -2314,6 +2442,8 @@ class PHPFSPOT {
     * this function validates if the provided date
     * contains a valid date and will return true 
     * if it is.
+    * @param string $date_str
+    * @return boolean
     */
    public function isValidDate($date_str)
    {
@@ -2328,15 +2458,22 @@ class PHPFSPOT {
 
    /**
     * timestamp to string conversion
+    * @param integer $timestamp
+    * @return string
     */
    private function ts2str($timestamp)
    {
       return strftime("%Y-%m-%d", $timestamp);
    } // ts2str()
 
+   /**
+    * extract tag-names from $_GET['tags']
+    * @param string $tags_str
+    * @return string
+    */
    private function extractTags($tags_str)
    {
-      $not_validated = split(',', $_GET['tags']);
+      $not_validated = split(',', $tags_str);
       $validated = array();
 
       foreach($not_validated as $tag) {
@@ -2350,6 +2487,9 @@ class PHPFSPOT {
 
    /**
     * returns the full path to a thumbnail
+    * @param integer $width
+    * @param integer $photo
+    * @return string
     */
    public function get_thumb_path($width, $photo)
    {
@@ -2367,6 +2507,7 @@ class PHPFSPOT {
 
    /**
     * returns server's virtual host name
+    * @return string
     */
    private function get_server_name()
    {
@@ -2374,8 +2515,8 @@ class PHPFSPOT {
    } // get_server_name()
 
    /**
-    * returns type of webprotocol which is
-    * currently used
+    * returns type of webprotocol which is currently used
+    * @return string
     */
    private function get_web_protocol()
    {
@@ -2387,6 +2528,7 @@ class PHPFSPOT {
 
    /**
     * return url to this phpfspot installation
+    * @return string
     */
    private function get_phpfspot_url()
    {
@@ -2395,6 +2537,8 @@ class PHPFSPOT {
 
    /**
     * returns the number of photos which are tagged with $tag_id
+    * @param integer $tag_id
+    * @return integer
     */
    public function get_num_photos($tag_id)
    {
@@ -2418,6 +2562,9 @@ class PHPFSPOT {
     * returns true, if everything is ok, otherwise false
     * if $silent is not set, this function will output and
     * error message
+    * @param string $file
+    * @param boolean $silent
+    * @retrun boolean
     */
    private function check_readable($file, $silent = null)
    {
@@ -2462,6 +2609,7 @@ class PHPFSPOT {
     *
     * this function will return the F-Spot database version number
     * It is stored within the sqlite3 database in the table meta
+    * @return string|null
     */
    public function getFspotDBVersion()
    {
@@ -2478,8 +2626,10 @@ class PHPFSPOT {
    } // getFspotDBVersion()
 
    /**
-    * parse the provided URI and will returned the
-    * requested chunk
+    * parse the provided URI and will returned the requested chunk
+    * @param string $uri
+    * @param string $mode
+    * @return string
     */
    public function parse_uri($uri, $mode)
    {
@@ -2507,6 +2657,7 @@ class PHPFSPOT {
     *
     * this function checks if all necessary configuration options are
     * specified and set.
+    * @return boolean
     */
    private function check_config_options()
    {
@@ -2626,6 +2777,9 @@ class PHPFSPOT {
     * current page, in which the $current photo lies. this is
     * used to display the correct photo, when calling showPhotoIndex()
     * from showImage()
+    * @param integer $current
+    * @param integer $max
+    * @return integer
     */
    private function getCurrentPage($current, $max)
    {
diff --git a/phpfspot_db.php b/phpfspot_db.php
index e5f1f0b..83376ad 100644
--- a/phpfspot_db.php
+++ b/phpfspot_db.php
@@ -22,6 +22,10 @@
  *
  ***************************************************************************/
 
+/**
+ * PHPFSPOT_DB class
+ * @package phpfspot
+ */
 class PHPFSPOT_DB {
 
    private $db;
diff --git a/phpfspot_img.php b/phpfspot_img.php
index 43107ac..8379b83 100644
--- a/phpfspot_img.php
+++ b/phpfspot_img.php
@@ -24,6 +24,14 @@
 
 require_once "phpfspot.class.php";
 
+/**
+ * PHPFSPOT_IMG class
+ *
+ * handles phpfspot's photos. It will output either the photo binaries
+ * or can also show error messages as a on-the-fly generated picture.
+ *
+ * @package phpfspot
+ */
 class PHPFSPOT_IMG {
    
    var $db;