Merge commit 'origin/master' into nefformat

[phpfspot.git] / phpfspot.class.php

diff --git a/phpfspot.class.php b/phpfspot.class.php
index b1093fc8fa1281fd2cb6460acb0ad7cd495c15e7..eb2312bf709a9b5ff0302d4538fa18480e6c2a1b 100644 (file)
--- a/phpfspot.class.php
+++ b/phpfspot.class.php
@@ -25,20 +25,79 @@
 require_once "phpfspot_cfg.php";
 require_once "phpfspot_db.php";
 
 require_once "phpfspot_cfg.php";
 require_once "phpfspot_db.php";
 

+/**
+ * PHPFSPOT main class
+ *
+ * this class contains the most functions which will to the major
+ * work for phpfspot.
+ *
+ * @package phpfspot
+ */

 class PHPFSPOT {
 
 class PHPFSPOT {
 

+   /**
+     * phpfspot configuration
+     * @access public
+     * @see PHPFSPOT_CFG()
+     * @var PHPFSPOT_CFG
+     */

    var $cfg;
    var $cfg;

+
+   /**
+     * SQLite database handle to f-spot database
+     * @see PHPFSPOT_DB()
+     * @access public
+     * @var PHPFSPOT_DB
+     */

    var $db;
    var $db;

+
+   /**
+     * SQLite database handle to phpfspot database
+     * @see PHPFSPOT_DB()
+     * @access public
+     * @var PHPFSPOT_DB
+     */

    var $cfg_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;
    var $tmpl;

+
+   /**
+    * full tag - list
+    * @access public
+    * @var array
+    */

    var $tags;
    var $tags;

+
+   /**
+    * list of available, not-selected, tags
+    * @access public
+    * @var array
+    */

    var $avail_tags;
 
    var $avail_tags;
 

+   /**
+    * true if runtime error occued
+    * @access private
+    * @var boolean
+    */

    private $runtime_error = false;
    private $runtime_error = false;

+
+   /**
+    * F-Spot database version
+    * @access private
+    * @var integer
+    */

    private $dbver;
 
    /**
    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,
     *
     * this function will be called on class construct
     * and will check requirements, loads configuration,


@@ -330,6 +389,8 @@ class PHPFSPOT {
     * 
     * retrieve all available details from f-spot's
     * database and return them as object
     * 
     * 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)
    {
     */
    public function get_photo_details($idx)
    {


@@ -386,6 +447,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 (...)
     * 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)
    {
     */
    public function getPhotoName($idx, $limit = 0)
    {


@@ -406,6 +470,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 "..." 
     * 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)
    {
     */
    private function shrink_text($text, $limit)
    {


@@ -423,8 +490,10 @@ 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
     * 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
+    * @return string

     */
     */

-   public function translate_path($path, $width = 0)
+   public function translate_path($path)

    {  
       return str_replace($this->cfg->path_replace_from, $this->cfg->path_replace_to, $path);
 
    {  
       return str_replace($this->cfg->path_replace_from, $this->cfg->path_replace_to, $path);
 


@@ -435,6 +504,7 @@ class PHPFSPOT {
     *
     * this function provides all the necessary information
     * for the single photo template.
     *
     * this function provides all the necessary information
     * for the single photo template.

+    * @param integer photo

     */
    public function showPhoto($photo)
    {
     */
    public function showPhoto($photo)
    {


@@ -654,6 +724,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']
     * 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()
    {
     */
    public function getSelectedTags()
    {


@@ -686,6 +757,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
     * 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)
    {
     */
    public function addTag($tag)
    {


@@ -708,6 +780,8 @@ class PHPFSPOT {
     *
     * this function removes the specified tag from
     * users current tag selection
     *
     * this function removes the specified tag from
     * users current tag selection

+    * @param string $tag
+    * @return string

     */
    public function delTag($tag)
    {
     */
    public function delTag($tag)
    {


@@ -739,6 +813,7 @@ class PHPFSPOT {
 
    /**
     * returns the value for the autocomplet tag-search
 
    /**
     * returns the value for the autocomplet tag-search

+    * @return string

     */
    public function get_xml_tag_list()
    {
     */
    public function get_xml_tag_list()
    {


@@ -847,6 +922,7 @@ class PHPFSPOT {
     * the tag-selection, tag- or date-search.
     * the tag-search also has to take care of AND
     * and OR conjunctions
     * 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()
    {  
     */
    public function getPhotoSelection()
    {  


@@ -1267,6 +1343,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.
     * 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)
    {  
     */
    public function create_thumbnail($orig_image, $thumb_image, $width)
    {  


@@ -1310,115 +1390,141 @@ class PHPFSPOT {
             }
 
             $src_img = @imagecreatefromjpeg($orig_image);
             }
 
             $src_img = @imagecreatefromjpeg($orig_image);

+            $handler = "gd";

             break;
 
          case 'image/png':
 
             $src_img = @imagecreatefrompng($orig_image);
             break;
 
          case 'image/png':
 
             $src_img = @imagecreatefrompng($orig_image);

+            $handler = "gd";

             break;
 
             break;
 

-      }
+         case 'image/tiff':
+
+            $src_img = new Imagick($orig_image);
+            print_r($src_img->queryFormats());
+            
+            $handler = "imagick";
+            exit(1);
+            break;

 
 

-      if(!$src_img) {
-         print "Can't load image from ". $orig_image ."\n";
-         return false;

       }
 
       }
 

-      /* grabs the height and width */
-      $cur_width = imagesx($src_img);
-      $cur_height = imagesy($src_img);

 
 

-      // If requested width is more then the actual image width,
-      // do not generate a thumbnail, instead safe the original
-      // as thumbnail but with lower quality. But if the image
-      // is to heigh too, then we still have to resize it.
-      if($width >= $cur_width && $cur_height < $this->cfg->thumb_height) {
-         $result = imagejpeg($src_img, $thumb_image, 75);
-         imagedestroy($src_img);
-         return true;
-      }
+      switch($handler) {

 
 

-      // If the image will be rotate because EXIF orientation said so
-      // 'virtually rotate' the image for further calculations
-      if($rotate == 90 || $rotate == 270) {
-         $tmp = $cur_width;
-         $cur_width = $cur_height;
-         $cur_height = $tmp;
-      }
+         case 'gd':

 
 

-      /* calculates aspect ratio */
-      $aspect_ratio = $cur_height / $cur_width;
+            if(!isset($src_img) || empty($src_img)) {
+               print "Can't load image from ". $orig_image ."\n";
+               return false;
+            }

 
 

-      /* sets new size */
-      if($aspect_ratio < 1) {
-         $new_w = $width;
-         $new_h = abs($new_w * $aspect_ratio);
-      } else {
-         /* 'virtually' rotate the image and calculate it's ratio */
-         $tmp_w = $cur_height;
-         $tmp_h = $cur_width;
-         /* now get the ratio from the 'rotated' image */
-         $tmp_ratio = $tmp_h/$tmp_w;
-         /* now calculate the new dimensions */
-         $tmp_w = $width;
-         $tmp_h = abs($tmp_w * $tmp_ratio);
-
-         // now that we know, how high they photo should be, if it
-         // gets rotated, use this high to scale the image
-         $new_h = $tmp_h;
-         $new_w = abs($new_h / $aspect_ratio);
-
-         // If the image will be rotate because EXIF orientation said so
-         // now 'virtually rotate' back the image for the image manipulation
-         if($rotate == 90 || $rotate == 270) {
-            $tmp = $new_w;
-            $new_w = $new_h;
-            $new_h = $tmp;
-         }
-      }
+            /* grabs the height and width */
+            $cur_width = imagesx($src_img);
+            $cur_height = imagesy($src_img);
+
+            // If requested width is more then the actual image width,
+            // do not generate a thumbnail, instead safe the original
+            // as thumbnail but with lower quality. But if the image
+            // is to heigh too, then we still have to resize it.
+            if($width >= $cur_width && $cur_height < $this->cfg->thumb_height) {
+               $result = imagejpeg($src_img, $thumb_image, 75);
+               imagedestroy($src_img);
+               return true;
+            }

 
 

-      /* creates new image of that size */
-      $dst_img = imagecreatetruecolor($new_w, $new_h);
+            // If the image will be rotate because EXIF orientation said so
+            // 'virtually rotate' the image for further calculations
+            if($rotate == 90 || $rotate == 270) {
+               $tmp = $cur_width;
+               $cur_width = $cur_height;
+               $cur_height = $tmp;
+            }

 
 

-      imagefill($dst_img, 0, 0, ImageColorAllocate($dst_img, 255, 255, 255));
+            /* calculates aspect ratio */
+            $aspect_ratio = $cur_height / $cur_width;

 
 

-      /* copies resized portion of original image into new image */
-      imagecopyresampled($dst_img, $src_img, 0, 0, 0, 0, $new_w, $new_h, imagesx($src_img), imagesy($src_img));
+            /* sets new size */
+            if($aspect_ratio < 1) {
+               $new_w = $width;
+               $new_h = abs($new_w * $aspect_ratio);
+            } else {
+               /* 'virtually' rotate the image and calculate it's ratio */
+               $tmp_w = $cur_height;
+               $tmp_h = $cur_width;
+               /* now get the ratio from the 'rotated' image */
+               $tmp_ratio = $tmp_h/$tmp_w;
+               /* now calculate the new dimensions */
+               $tmp_w = $width;
+               $tmp_h = abs($tmp_w * $tmp_ratio);
+
+               // now that we know, how high they photo should be, if it
+               // gets rotated, use this high to scale the image
+               $new_h = $tmp_h;
+               $new_w = abs($new_h / $aspect_ratio);
+
+               // If the image will be rotate because EXIF orientation said so
+               // now 'virtually rotate' back the image for the image manipulation
+               if($rotate == 90 || $rotate == 270) {
+                  $tmp = $new_w;
+                  $new_w = $new_h;
+                  $new_h = $tmp;
+               }
+            }

 
 

-      /* needs the image to be flipped horizontal? */
-      if($flip_hori) {
-         $this->_debug("(FLIP)");
-         $dst_img = $this->flipImage($dst_img, 'hori');
-      }
-      /* needs the image to be flipped vertical? */
-      if($flip_vert) {
-         $this->_debug("(FLIP)");
-         $dst_img = $this->flipImage($dst_img, 'vert');
-      }
+            /* creates new image of that size */
+            $dst_img = imagecreatetruecolor($new_w, $new_h);

 
 

-      if($rotate) {
-         $this->_debug("(ROTATE)");
-         $dst_img = $this->rotateImage($dst_img, $rotate);
-      }
+            imagefill($dst_img, 0, 0, ImageColorAllocate($dst_img, 255, 255, 255));

 
 

-      /* write down new generated file */
-      $result = imagejpeg($dst_img, $thumb_image, 75);
+            /* copies resized portion of original image into new image */
+            imagecopyresampled($dst_img, $src_img, 0, 0, 0, 0, $new_w, $new_h, imagesx($src_img), imagesy($src_img));

 
 

-      /* free your mind */
-      imagedestroy($dst_img);
-      imagedestroy($src_img);
+            /* needs the image to be flipped horizontal? */
+            if($flip_hori) {
+               $this->_debug("(FLIP)");
+               $dst_img = $this->flipImage($dst_img, 'hori');
+            }
+            /* needs the image to be flipped vertical? */
+            if($flip_vert) {
+               $this->_debug("(FLIP)");
+               $dst_img = $this->flipImage($dst_img, 'vert');
+            }

 
 

-      if($result === false) {
-         print "Can't write thumbnail ". $thumb_image ."\n";
-         return false;
-      }
+            if($rotate) {
+               $this->_debug("(ROTATE)");
+               $dst_img = $this->rotateImage($dst_img, $rotate);
+            }

 
 

-      return true;
+            /* write down new generated file */
+            $result = imagejpeg($dst_img, $thumb_image, 75);
+
+            /* free your mind */
+            imagedestroy($dst_img);
+            imagedestroy($src_img);
+
+            if($result === false) {
+               print "Can't write thumbnail ". $thumb_image ."\n";
+               return false;
+            }
+
+            return true;
+
+            break;
+
+         case 'imagick':
+
+            break;
+
+      }

 
    } // create_thumbnail()
 
    /**
     * return all exif meta data from the file
 
    } // create_thumbnail()
 
    /**
     * return all exif meta data from the file

+    * @param string $file
+    * @return array

     */
    public function get_meta_informations($file)
    {
     */
    public function get_meta_informations($file)
    {


@@ -1457,6 +1563,9 @@ class PHPFSPOT {
     *    readable
     * 2. Check if the md5sum of the original file has changed
     * 3. Generate the thumbnails if needed
     *    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)
    {
     */
    public function gen_thumb($idx = 0, $force = 0, $overwrite = false)
    {


@@ -1539,6 +1648,8 @@ class PHPFSPOT {
     *
     * this function queries the phpfspot database for a
     * stored MD5 checksum of the specified photo
     *
     * 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)
    {
     */
    public function getMD5($idx)
    {


@@ -1558,6 +1669,8 @@ class PHPFSPOT {
 
    /**
     * set MD5 sum for the specific photo
 
    /**
     * set MD5 sum for the specific photo

+    * @param integer $idx
+    * @param string $md5

     */
    private function setMD5($idx, $md5)
    {
     */
    private function setMD5($idx, $md5)
    {


@@ -1573,6 +1686,8 @@ class PHPFSPOT {
     *
     * this function stores the current tag condition
     * (AND or OR) in the users session variables
     *
     * this function stores the current tag condition
     * (AND or OR) in the users session variables

+    * @param string $mode
+    * @return string

     */
    public function setTagCondition($mode)
    {
     */
    public function setTagCondition($mode)
    {


@@ -1590,6 +1705,7 @@ class PHPFSPOT {
     * it also handles the date search.
     * getPhotoSelection() will then only return the matching
     * photos.
     * it also handles the date search.
     * getPhotoSelection() will then only return the matching
     * photos.

+    * @return string

     */
    public function startSearch()
    {
     */
    public function startSearch()
    {


@@ -1640,6 +1756,8 @@ class PHPFSPOT {
     *
     * this function is invoked by RPC and will sort the requested
     * sort order in the session variable.
     *
     * 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)
    {
     */
    public function updateSortOrder($order)
    {


@@ -1657,6 +1775,9 @@ class PHPFSPOT {
     *
     * this function rotates the image according the
     * specified angel.
     *
     * this function rotates the image according the
     * specified angel.

+    * @param string $img
+    * @param integer $degress
+    * @return image

     */
    private function rotateImage($img, $degrees)
    {
     */
    private function rotateImage($img, $degrees)
    {


@@ -1734,6 +1855,9 @@ class PHPFSPOT {
     *
     * this function will return an either horizontal or
     * vertical flipped truecolor image.
     *
     * 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)
    {
     */
    private function flipImage($image, $mode)
    {


@@ -1760,6 +1884,8 @@ class PHPFSPOT {
 
    /**
     * return all assigned tags for the specified photo
 
    /**
     * return all assigned tags for the specified photo

+    * @param integer $idx
+    * @return array

     */
    private function get_photo_tags($idx)
    {
     */
    private function get_photo_tags($idx)
    {


@@ -1782,6 +1908,11 @@ class PHPFSPOT {
 
    /**
     * create on-the-fly images with text within
 
    /**
     * 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)
    {
     */
    public function showTextImage($txt, $color=000000, $space=4, $font=4, $w=300)
    {


@@ -1811,6 +1942,7 @@ class PHPFSPOT {
 
    /**
     * check if all requirements are met
 
    /**
     * check if all requirements are met

+    * @return boolean

     */
    private function check_requirements()
    {
     */
    private function check_requirements()
    {


@@ -1865,16 +1997,22 @@ class PHPFSPOT {
 
    /**
     * check if specified MIME type is supported
 
    /**
     * check if specified MIME type is supported

+    * @param string $mime
+    * @return boolean

     */
    public function checkifImageSupported($mime)
    {
     */
    public function checkifImageSupported($mime)
    {

-      if(in_array($mime, Array("image/jpeg", "image/png")))
+      if(in_array($mime, Array("image/jpeg", "image/png", "image/tiff")))

          return true;
 
       return false;
 
    } // checkifImageSupported()
 
          return true;
 
       return false;
 
    } // checkifImageSupported()
 

+   /**
+    * output error text
+    * @param string $text
+    */

    public function _error($text)
    {
       switch($this->cfg->logging) {
    public function _error($text)
    {
       switch($this->cfg->logging) {


@@ -1897,6 +2035,8 @@ class PHPFSPOT {
 
    /**
     * output calendard input fields
 
    /**
     * output calendard input fields

+    * @param string $mode
+    * @return string

     */
    private function get_calendar($mode)
    {
     */
    private function get_calendar($mode)
    {


@@ -1923,6 +2063,9 @@ class PHPFSPOT {
 
    /**
     * output calendar matrix
 
    /**
     * output calendar matrix

+    * @param integer $year
+    * @param integer $month
+    * @param integer $day

     */
    public function get_calendar_matrix($year = 0, $month = 0, $day = 0)
    {
     */
    public function get_calendar_matrix($year = 0, $month = 0, $day = 0)
    {


@@ -2001,6 +2144,7 @@ class PHPFSPOT {
 
    /**
     * output export page
 
    /**
     * output export page

+    * @param string $mode

     */
    public function getExport($mode)
    {
     */
    public function getExport($mode)
    {


@@ -2116,6 +2260,7 @@ class PHPFSPOT {
  
    /**
     * return all selected tags as one string
  
    /**
     * return all selected tags as one string

+    * @return array

     */
    private function getCurrentTags()
    {
     */
    private function getCurrentTags()
    {


@@ -2147,6 +2292,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
     * 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()
    {
     */
    public function whatToDo()
    {


@@ -2166,6 +2312,7 @@ class PHPFSPOT {
 
    /**
     * return the current process-user
 
    /**
     * return the current process-user

+    * @return string

     */
    private function getuid()
    {
     */
    private function getuid()
    {


@@ -2181,6 +2328,9 @@ class PHPFSPOT {
 
    /**
     * returns a select-dropdown box to select photo index sort parameters
 
    /**
     * 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)
    {
     */
    public function smarty_sort_select_list($params, &$smarty)
    {


@@ -2200,6 +2350,7 @@ class PHPFSPOT {
 
    /**
     * returns the currently selected sort order
 
    /**
     * returns the currently selected sort order

+    * @return string

     */ 
    private function get_sort_order()
    {
     */ 
    private function get_sort_order()
    {


@@ -2236,12 +2387,13 @@ class PHPFSPOT {
 
    } // get_sort_order()
 
 
    } // 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();
    public function getNextSlideShowImage()
    {
       $all_photos = $this->getPhotoSelection();


@@ -2255,12 +2407,13 @@ class PHPFSPOT {
 
    } // getNextSlideShowImage()
 
 
    } // 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();
    public function getPrevSlideShowImage()
    {
       $all_photos = $this->getPhotoSelection();


@@ -2281,16 +2434,17 @@ class PHPFSPOT {
 
    } // resetSlideShow()
    
 
    } // 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();
    public function get_random_photo()
    {
       $all = Array();


@@ -2314,6 +2468,8 @@ class PHPFSPOT {
     * this function validates if the provided date
     * contains a valid date and will return true 
     * if it is.
     * 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)
    {
     */
    public function isValidDate($date_str)
    {


@@ -2328,15 +2484,22 @@ class PHPFSPOT {
 
    /**
     * timestamp to string conversion
 
    /**
     * timestamp to string conversion

+    * @param integer $timestamp
+    * @return string

     */
    private function ts2str($timestamp)
    {
       return strftime("%Y-%m-%d", $timestamp);
    } // ts2str()
 
     */
    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)
    {
    private function extractTags($tags_str)
    {

-      $not_validated = split(',', $_GET['tags']);
+      $not_validated = split(',', $tags_str);

       $validated = array();
 
       foreach($not_validated as $tag) {
       $validated = array();
 
       foreach($not_validated as $tag) {


@@ -2350,6 +2513,9 @@ class PHPFSPOT {
 
    /**
     * returns the full path to a thumbnail
 
    /**
     * returns the full path to a thumbnail

+    * @param integer $width
+    * @param integer $photo
+    * @return string

     */
    public function get_thumb_path($width, $photo)
    {
     */
    public function get_thumb_path($width, $photo)
    {


@@ -2367,6 +2533,7 @@ class PHPFSPOT {
 
    /**
     * returns server's virtual host name
 
    /**
     * returns server's virtual host name

+    * @return string

     */
    private function get_server_name()
    {
     */
    private function get_server_name()
    {


@@ -2374,8 +2541,8 @@ class PHPFSPOT {
    } // get_server_name()
 
    /**
    } // 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()
    {
     */
    private function get_web_protocol()
    {


@@ -2387,6 +2554,7 @@ class PHPFSPOT {
 
    /**
     * return url to this phpfspot installation
 
    /**
     * return url to this phpfspot installation

+    * @return string

     */
    private function get_phpfspot_url()
    {
     */
    private function get_phpfspot_url()
    {


@@ -2395,6 +2563,8 @@ class PHPFSPOT {
 
    /**
     * returns the number of photos which are tagged with $tag_id
 
    /**
     * returns the number of photos which are tagged with $tag_id

+    * @param integer $tag_id
+    * @return integer

     */
    public function get_num_photos($tag_id)
    {
     */
    public function get_num_photos($tag_id)
    {


@@ -2418,6 +2588,9 @@ class PHPFSPOT {
     * returns true, if everything is ok, otherwise false
     * if $silent is not set, this function will output and
     * error message
     * 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
+    * @return boolean

     */
    private function check_readable($file, $silent = null)
    {
     */
    private function check_readable($file, $silent = null)
    {


@@ -2462,6 +2635,7 @@ class PHPFSPOT {
     *
     * this function will return the F-Spot database version number
     * It is stored within the sqlite3 database in the table meta
     *
     * 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()
    {
     */
    public function getFspotDBVersion()
    {


@@ -2478,8 +2652,10 @@ class PHPFSPOT {
    } // getFspotDBVersion()
 
    /**
    } // 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)
    {
     */
    public function parse_uri($uri, $mode)
    {


@@ -2507,6 +2683,7 @@ class PHPFSPOT {
     *
     * this function checks if all necessary configuration options are
     * specified and set.
     *
     * this function checks if all necessary configuration options are
     * specified and set.

+    * @return boolean

     */
    private function check_config_options()
    {
     */
    private function check_config_options()
    {


@@ -2626,6 +2803,9 @@ class PHPFSPOT {
     * current page, in which the $current photo lies. this is
     * used to display the correct photo, when calling showPhotoIndex()
     * from showImage()
     * 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)
    {
     */
    private function getCurrentPage($current, $max)
    {