seblucas / cops

book.php

Doc Comments +27 added lines

@@ -294,6 +294,11 @@ 
         }
     }
 
+    /**
+     * @param string $format
+     *
+     * @return boolean
+     */
     public function getDataFormat ($format) {
         $reduced = array_filter ($this->getDatas (), function ($data) use ($format) {
             return $data->format == $format;
@@ -301,6 +306,10 @@ 
         return reset ($reduced);
     }
 
+    /**
+     * @param string $extension
+     * @param integer $idData
+     */
     public function getFilePath ($extension, $idData = NULL, $relative = false)
     {
         if ($extension == "jpg")
@@ -360,6 +369,9 @@ 
         }
     }
 
+    /**
+     * @param string $outputfile
+     */
     public function getThumbnail ($width, $height, $outputfile = NULL) {
         if (is_null ($width) && is_null ($height)) {
             return false;
@@ -433,6 +445,10 @@ 
             $this->getLinkArray (), $this);
     }
 
+    /**
+     * @param integer $database
+     * @param integer $virtualLib
+     */
     public static function getBookCount($database = NULL, $virtualLib = NULL) {
         return parent::executeFilteredQuerySingle('select count(*) from ({0}) as filter', $database, $virtualLib);
     }
@@ -498,6 +514,9 @@ 
         return NULL;
     }
 
+    /**
+     * @param integer $dataId
+     */
     public static function getBookByDataId($dataId) {
         $result = parent::getDb ()->prepare('select ' . self::BOOK_COLUMNS . ', data.name, data.format
 from data, books ' . self::SQL_BOOKS_LEFT_JOIN . '
@@ -514,6 +533,11 @@ 
         return NULL;
     }
 
+    /**
+     * @param integer $database
+     * @param integer $virtualLib
+     * @param integer $numberPerPage
+     */
     public static function getBooksByQuery($query, $n, $database = NULL, $virtualLib = NULL, $numberPerPage = NULL) {
         $i = 0;
         $critArray = array ();
@@ -558,6 +582,9 @@ 
         return $entryArray;
     }
 
+    /**
+     * @param integer $numberPerPage
+     */
     public static function getBooksByStartingLetter($letter, $n, $database = NULL, $virtualLib = NULL, $numberPerPage = NULL) {
         return self::getEntryArray (self::SQL_BOOKS_BY_FIRST_LETTER, array ($letter . "%"), $n, $database, $virtualLib, $numberPerPage);
     }

virtuallib.php

Doc Comments +3 added lines, -3 removed lines

@@ -43,7 +43,7 @@ 
 	/**
 	 * Includes the booke filter (see $config['cops_books_filter'])
 	 * @param Filter $filter
-	 * @return string
+	 * @return Filter
 	 */
 	private static function includeBookFilter($filter) {
 		$bookFilter = getURLParam ("tag", NULL);
@@ -206,7 +206,7 @@ 
 	 * 
 	 * Some attributes can be used in plural (e.g. languages) and singular (e.g. language). This function appends a missing s and puts everything to lower case
 	 * @param string $attr the attribute, like it was used in calibre
-	 * @return the normalized attribute name
+	 * @return string normalized attribute name
 	 */
 	public static function normalizeAttribute($attr) {
 		$attr = strtolower($attr);
@@ -414,7 +414,7 @@ 
 
 	/**
 	 * Constructor that combines multiple filters to one filter
-	 * @param array $parts An array of Filter objects
+	 * @param Filter[] $parts An array of Filter objects
 	 * @param string $op The operator for combining. Either "and" or "or" (case insensitive).
 	 */
 	public function __construct($parts, $op = "and") {

JSON_renderer.php

Doc Comments +3 added lines

@@ -106,6 +106,9 @@
         return array ( "title" => $entry->title, "content" => $entry->content, "navlink" => $entry->getNavLink (), "number" => $entry->numberOfElement );
     }
 
+    /**
+     * @param Page $page
+     */
     public static function getContentArrayTypeahead ($page) {
         $out = array ();
         foreach ($page->entryArray as $entry) {

base.php

Doc Comments +55 added lines

@@ -61,6 +61,9 @@ 
     $_SERVER['REDIRECT_STATUS'] = 404;
 }
 
+/**
+ * @param string $name
+ */
 function getURLParam ($name, $default = NULL) {
     if (!empty ($_GET) && isset($_GET[$name]) && $_GET[$name] != "") {
         return $_GET[$name];
@@ -100,6 +103,11 @@ 
     return $url . "?v=" . VERSION;
 }
 
+/**
+ * @param string $xml
+ *
+ * @return string
+ */
 function xml2xhtml($xml) {
     return preg_replace_callback('#<(\w+)([^>]*)\s*/>#s', create_function('$m', '
         $xhtml_tags = array("br", "hr", "input", "frame", "img", "area", "link", "col", "base", "basefont", "param");
@@ -339,6 +347,9 @@ 
     return $phrase;
 }
 
+/**
+ * @param string $paramName
+ */
 function addURLParameter($urlParams, $paramName, $paramValue) {
     if (empty ($urlParams)) {
         $urlParams = "";
@@ -400,6 +411,9 @@ 
         return $this->href;
     }
 
+    /**
+     * @return string
+     */
     public function getScriptName() {
         $parts = explode('/', $_SERVER["SCRIPT_NAME"]);
         return $parts[count($parts) - 1];
@@ -408,6 +422,9 @@ 
 
 class LinkNavigation extends Link
 {
+    /**
+     * @param string $prel
+     */
     public function __construct($phref, $prel = NULL, $ptitle = NULL) {
         parent::__construct ($phref, Link::OPDS_NAVIGATION_TYPE, $prel, $ptitle);
         if (!is_null (GetUrlParam (DB))) {
@@ -425,6 +442,9 @@ 
 
 class LinkFacet extends Link
 {
+    /**
+     * @param string $phref
+     */
     public function __construct($phref, $ptitle = NULL, $pfacetGroup = NULL, $pactiveFacet = FALSE) {
         parent::__construct ($phref, Link::OPDS_PAGING_TYPE, "http://opds-spec.org/facet", $ptitle, $pfacetGroup, $pactiveFacet);
         if (!is_null (GetUrlParam (DB))) {
@@ -508,6 +528,12 @@ 
 {
     public $book;
 
+    /**
+     * @param string $pid
+     * @param string $pcontent
+     * @param string $pcontentType
+     * @param Book $pbook
+     */
     public function __construct($ptitle, $pid, $pcontent, $pcontentType, $plinkArray, $pbook) {
         parent::__construct ($ptitle, $pid, $pcontent, $pcontentType, $plinkArray);
         $this->book = $pbook;
@@ -1110,6 +1136,9 @@ 
 
 class PageCustomize extends Page
 {
+    /**
+     * @param string $key
+     */
     private function isChecked ($key, $testedValue = 1) {
         $value = getCurrentOption ($key);
         if (is_array ($value)) {
@@ -1124,6 +1153,9 @@ 
         return "";
     }
 
+    /**
+     * @param string $key
+     */
     private function isSelected ($key, $value) {
         if (getCurrentOption ($key) == $value) {
             return "selected='selected'";
@@ -1273,6 +1305,9 @@ 
         }
     }
 
+    /**
+     * @param integer $database
+     */
     public static function getDbName ($database = NULL) {
         global $config;
         if (self::isDatabaseArray ()) {
@@ -1286,6 +1321,9 @@ 
         return "";
     }
 
+    /**
+     * @return string
+     */
     public static function getDbDirectory ($database = NULL) {
         global $config;
         if (self::isDatabaseArray ()) {
@@ -1345,6 +1383,9 @@ 
         self::$db = NULL;
     }
 
+    /**
+     * @param integer $database
+     */
     public static function executeQuerySingle ($query, $database = NULL) {
         return self::getDb ($database)->query($query)->fetchColumn();
     }
@@ -1362,6 +1403,11 @@ 
     	return self::getDb ($database)->query($query)->fetchColumn();
     }
 
+    /**
+     * @param string $table
+     * @param string $id
+     * @param string $numberOfString
+     */
     public static function getCountGeneric($table, $id, $pageId, $numberOfString = NULL) {
         if (!$numberOfString) {
             $numberOfString = $table . ".alphabetical";
@@ -1374,6 +1420,9 @@ 
         return $entry;
     }
 
+    /**
+     * @param string $category
+     */
     public static function getEntryArrayWithBookNumber ($query, $params, $category) {
         list (, $result) = self::executeFilteredQuery($query, $params, -1);
         $entryArray = array();
@@ -1433,6 +1482,12 @@ 
     	return array ($totalResult, $result);
     }
 
+    /**
+     * @param string $query
+     * @param string $columns
+     * @param string $filter
+     * @param integer $n
+     */
     public static function executeQuery($query, $columns, $filter, $params, $n, $database = NULL, $numberPerPage = NULL) {
         $totalResult = -1;