seblucas / cops

author.php

Doc Comments +6 added lines

@@ -62,6 +62,9 @@ 
         return self::getEntryArray (self::SQL_AUTHORS_BY_FIRST_LETTER, array ($letter . "%"));
     }
 
+    /**
+     * @param string $query
+     */
     public static function getAuthorsForSearch($query) {
         return self::getEntryArray (self::SQL_AUTHORS_FOR_SEARCH, array ($query . "%", $query . "%"));
     }
@@ -70,6 +73,9 @@ 
         return self::getEntryArray (self::SQL_ALL_AUTHORS, array ());
     }
 
+    /**
+     * @param string $query
+     */
     public static function getEntryArray ($query, $params) {
         return Base::getEntryArrayWithBookNumber ($query, self::AUTHOR_COLUMNS, $params, "Author");
     }

data.php

Doc Comments +10 added lines

@@ -139,6 +139,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
@@ -152,6 +155,9 @@ 
         return $out;
     }
 
+    /**
+     * @param string $urlParam
+     */
     public static function handleThumbnailLink ($urlParam, $height) {
         global $config;
 
@@ -171,6 +177,10 @@ 
         return $urlParam;
     }
 
+    /**
+     * @param string $type
+     * @param string $filename
+     */
     public static function getLink ($book, $type, $mime, $rel, $filename, $idData, $title = NULL, $height = NULL)
     {
         global $config;

rating.php

Doc Comments +3 added lines

@@ -38,6 +38,9 @@
         return self::getEntryArray (self::SQL_ALL_RATINGS, array ());
     }
 
+    /**
+     * @param string $query
+     */
     public static function getEntryArray ($query, $params) {
         list (, $result) = parent::executeQuery ($query, self::RATING_COLUMNS, "", $params, -1);
         $entryArray = array();

test/OPDSTest.php

Doc Comments +6 added lines

@@ -26,6 +26,9 @@ 
         unlink (TEST_FEED);
     }
 
+    /**
+     * @param string $relax
+     */
     function jingValidateSchema($feed, $relax = OPDS_RELAX_NG) {
         $path = "";
         if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
@@ -57,6 +60,9 @@ 
             return true;
     }
 
+    /**
+     * @param string $feed
+     */
     function opdsCompleteValidation ($feed) {
         return $this->jingValidateSchema($feed) && $this->opdsValidator($feed);
     }

test/Sauce.php

Doc Comments +4 added lines

@@ -189,6 +189,10 @@
         $this->assertEquals (14, count($filtered));
     }
 
+    /**
+     * @param string $src
+     * @param string $out
+     */
     public function normalSearch ($src, $out)
     {
         $driver = $this;

transliteration.php

Doc Comments +1 added lines, -1 removed lines

@@ -163,7 +163,7 @@
 /**
  * Replaces a Unicode character using the transliteration database.
  *
- * @param $ord
+ * @param integer $ord
  *   An ordinal Unicode character code.
  * @param $unknown
  *   Replacement string for characters that do not have a suitable ASCII

base.php

Doc Comments +50 added lines

@@ -60,6 +60,9 @@ 
     $_SERVER['REDIRECT_STATUS'] = 404;
 }
 
+/**
+ * @param string $name
+ */
 function getURLParam ($name, $default = NULL) {
     if (!empty ($_GET) && isset($_GET[$name]) && $_GET[$name] != "") {
         return $_GET[$name];
@@ -99,6 +102,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");
@@ -312,6 +320,9 @@ 
     return $phrase;
 }
 
+/**
+ * @param string $paramName
+ */
 function addURLParameter($urlParams, $paramName, $paramValue) {
     if (empty ($urlParams)) {
         $urlParams = "";
@@ -373,6 +384,9 @@ 
         return $this->href;
     }
 
+    /**
+     * @return string
+     */
     public function getScriptName() {
         $parts = explode('/', $_SERVER["SCRIPT_NAME"]);
         return $parts[count($parts) - 1];
@@ -381,6 +395,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))) $this->href = addURLParameter ($this->href, DB, GetUrlParam (DB));
@@ -395,6 +412,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))) $this->href = addURLParameter ($this->href, DB, GetUrlParam (DB));
@@ -448,6 +468,9 @@ 
         return "#";
     }
 
+    /**
+     * @param string $pcontentType
+     */
     public function __construct($ptitle, $pid, $pcontent, $pcontentType, $plinkArray, $pclass = "", $pcount = 0) {
         global $config;
         $this->title = $ptitle;
@@ -1067,6 +1090,9 @@ 
 
 class PageCustomize extends Page
 {
+    /**
+     * @param string $key
+     */
     private function isChecked ($key, $testedValue = 1) {
         $value = getCurrentOption ($key);
         if (is_array ($value)) {
@@ -1081,6 +1107,9 @@ 
         return "";
     }
 
+    /**
+     * @param string $key
+     */
     private function isSelected ($key, $value) {
         if (getCurrentOption ($key) == $value) {
             return "selected='selected'";
@@ -1223,6 +1252,9 @@ 
         }
     }
 
+    /**
+     * @param integer $database
+     */
     public static function getDbName ($database = NULL) {
         global $config;
         if (self::isMultipleDatabaseEnabled ()) {
@@ -1236,6 +1268,9 @@ 
         return "";
     }
 
+    /**
+     * @return string
+     */
     public static function getDbDirectory ($database = NULL) {
         global $config;
         if (self::isMultipleDatabaseEnabled ()) {
@@ -1295,10 +1330,18 @@ 
         self::$db = NULL;
     }
 
+    /**
+     * @param string $query
+     */
     public static function executeQuerySingle ($query, $database = NULL) {
         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";
@@ -1311,6 +1354,10 @@ 
         return $entry;
     }
 
+    /**
+     * @param string $columns
+     * @param string $category
+     */
     public static function getEntryArrayWithBookNumber ($query, $columns, $params, $category) {
         /* @var $result PDOStatement */
 
@@ -1333,6 +1380,9 @@ 
         return $entryArray;
     }
 
+    /**
+     * @param string $filter
+     */
     public static function executeQuery($query, $columns, $filter, $params, $n, $database = NULL, $numberPerPage = NULL) {
         $totalResult = -1;
 

customcolumn.php

Doc Comments +35 added lines, -5 removed lines

@@ -128,6 +128,9 @@ 
     /** @var Entry[] */
     private $customValues = NULL;
 
+    /**
+     * @param string $pdatatype
+     */
     protected function __construct($pcustomId, $pdatatype)
     {
         $this->columnTitle = self::getTitleByCustomID($pcustomId);
@@ -236,7 +239,7 @@ 
     /**
      * Encode a value of this column ready to be displayed in an HTML document
      *
-     * @param integer|string $value
+     * @param string $value
      * @return string
      */
     public function encodeHTMLValue($value)
@@ -404,6 +407,9 @@ 
 
 class CustomColumnTypeText extends CustomColumnType
 {
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_TEXT);
@@ -433,7 +439,7 @@ 
     /**
      * Get the name of the linking column in the linktable
      *
-     * @return string|null
+     * @return string
      */
     private function getTableLinkColumn()
     {
@@ -501,6 +507,9 @@ 
 
 class CustomColumnTypeSeries extends CustomColumnType
 {
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_SERIES);
@@ -530,7 +539,7 @@ 
     /**
      * Get the name of the linking column in the linktable
      *
-     * @return string|null
+     * @return string
      */
     private function getTableLinkColumn()
     {
@@ -596,6 +605,9 @@ 
 
 class CustomColumnTypeEnumeration extends CustomColumnType
 {
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_ENUM);
@@ -625,7 +637,7 @@ 
     /**
      * Get the name of the linking column in the linktable
      *
-     * @return string|null
+     * @return string
      */
     private function getTableLinkColumn()
     {
@@ -691,6 +703,9 @@ 
 
 class CustomColumnTypeDate extends CustomColumnType
 {
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_DATE);
@@ -771,6 +786,9 @@ 
 
 class CustomColumnTypeRating extends CustomColumnType
 {
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_RATING);
@@ -800,7 +818,7 @@ 
     /**
      * Get the name of the linking column in the linktable
      *
-     * @return string|null
+     * @return string
      */
     private function getTableLinkColumn()
     {
@@ -881,6 +899,9 @@ 
         +1 => "customcolumn.boolean.yes",     // localize("customcolumn.boolean.yes")
     );
 
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_BOOL);
@@ -961,6 +982,9 @@ 
 
 class CustomColumnTypeInteger extends CustomColumnType
 {
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_INT);
@@ -1032,6 +1056,9 @@ 
 
 class CustomColumnTypeFloat extends CustomColumnType
 {
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_FLOAT);
@@ -1103,6 +1130,9 @@ 
 
 class CustomColumnTypeComment extends CustomColumnType
 {
+    /**
+     * @param integer $pcustomId
+     */
     protected function __construct($pcustomId)
     {
         parent::__construct($pcustomId, self::CUSTOM_TYPE_COMMENT);

book.php

Doc Comments +21 added lines, -1 removed lines

@@ -341,6 +341,10 @@ 
         return reset ($reduced);
     }
 
+    /**
+     * @param string $extension
+     * @param integer $idData
+     */
     public function getFilePath ($extension, $idData = NULL, $relative = false)
     {
         if ($extension == "jpg")
@@ -400,6 +404,9 @@ 
         }
     }
 
+    /**
+     * @param string $outputfile
+     */
     public function getThumbnail ($width, $height, $outputfile = NULL) {
         if (is_null ($width) && is_null ($height)) {
             return false;
@@ -474,6 +481,9 @@ 
             $this->getLinkArray (), $this);
     }
 
+    /**
+     * @param integer $database
+     */
     public static function getBookCount($database = NULL) {
         return parent::executeQuerySingle ('select count(*) from books', $database);
     }
@@ -522,7 +532,7 @@ 
     }
 
     /**
-     * @param $customColumn CustomColumn
+     * @param CustomColumn $customColumn CustomColumn
      * @param $id integer
      * @param $n integer
      * @return array
@@ -546,6 +556,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 . '
@@ -562,6 +575,10 @@ 
         return NULL;
     }
 
+    /**
+     * @param integer $database
+     * @param integer $numberPerPage
+     */
     public static function getBooksByQuery($query, $n, $database = NULL, $numberPerPage = NULL) {
         $i = 0;
         $critArray = array ();
@@ -609,6 +626,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);
     }