seblucas / cops

lib/Data.php

Doc Comments +10 added lines

@@ -152,6 +152,9 @@ 
         return new Link ($href, $this->getMimeType (), Link::OPDS_ACQUISITION_TYPE, $title);
     }
 
+    /**
+     * @param Book $book
+     */
     public static function getDataByBook ($book) {
         $out = array ();
         $result = parent::getDb ()->prepare('select id, format, name
@@ -165,6 +168,9 @@ 
         return $out;
     }
 
+    /**
+     * @param string $urlParam
+     */
     public static function handleThumbnailLink ($urlParam, $height) {
         global $config;
 
@@ -184,6 +190,10 @@ 
         return $urlParam;
     }
 
+    /**
+     * @param string $type
+     * @param string $filename
+     */
     public static function getLink ($book, $type, $mime, $rel, $filename, $idData, $title = NULL, $height = NULL, $view = false)
     {
         global $config;

lib/Book.php

Doc Comments +17 added lines, -1 removed lines

@@ -208,6 +208,9 @@ 
         return 'index.php' . $urlParam;
     }
 
+    /**
+     * @return string
+     */
     public function getTitle () {
         return $this->title;
     }
@@ -395,6 +398,9 @@ 
         return reset($reduced);
     }
 
+    /**
+     * @param string $extension
+     */
     public function getFilePath($extension, $idData = NULL, $relative = false)
     {
         /*if ($extension == 'jpg')
@@ -562,6 +568,9 @@ 
             $this->getLinkArray(), $this);
     }
 
+    /**
+     * @param integer $database
+     */
     public static function getBookCount($database = NULL) {
         return parent::executeQuerySingle('select count(*) from books', $database);
     }
@@ -610,7 +619,7 @@ 
     }
 
     /**
-     * @param $customColumn CustomColumn
+     * @param CustomColumn $customColumn CustomColumn
      * @param $id integer
      * @param $n integer
      * @return array
@@ -650,6 +659,10 @@ 
         return NULL;
     }
 
+    /**
+     * @param integer $database
+     * @param integer $numberPerPage
+     */
     public static function getBooksByQuery($query, $n, $database = NULL, $numberPerPage = NULL) {
         $i = 0;
         $critArray = array();
@@ -697,6 +710,9 @@ 
         return $entryArray;
     }
 
+    /**
+     * @param integer $numberPerPage
+     */
     public static function getBooksByStartingLetter($letter, $n, $database = NULL, $numberPerPage = NULL) {
         return self::getEntryArray(self::SQL_BOOKS_BY_FIRST_LETTER, array($letter . '%'), $n, $database, $numberPerPage);
     }

lib/Tag.php

Doc Comments +4 added lines

@@ -54,6 +54,10 @@
         return Base::getEntryArrayWithBookNumber ($sql, self::TAG_COLUMNS, array (), "Tag");
     }
 
+    /**
+     * @param string $query
+     * @param integer $numberPerPage
+     */
     public static function getAllTagsByQuery($query, $n, $database = NULL, $numberPerPage = NULL) {
         $columns  = "tags.id as id, tags.name as name, (select count(*) from books_tags_link where tags.id = tag) as count";
         $sql = 'select {0} from tags where upper (tags.name) like ? {1} order by tags.name';