mbirth / cops

lib/LinkFacet.php

Doc Comments +3 added lines

@@ -8,6 +8,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));

lib/LinkNavigation.php

Doc Comments +3 added lines

@@ -8,6 +8,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));

lib/PageCustomize.php

Doc Comments +6 added lines

@@ -8,6 +8,9 @@ 
 
 class PageCustomize extends Page
 {
+    /**
+     * @param string $key
+     */
     private function isChecked ($key, $testedValue = 1) {
         $value = getCurrentOption ($key);
         if (is_array ($value)) {
@@ -22,6 +25,9 @@ 
         return "";
     }
 
+    /**
+     * @param string $key
+     */
     private function isSelected ($key, $value) {
         if (getCurrentOption ($key) == $value) {
             return "selected='selected'";

base.php

Doc Comments +11 added lines

@@ -64,6 +64,9 @@ 
     $_SERVER['REDIRECT_STATUS'] = 404;
 }
 
+/**
+ * @param string $name
+ */
 function getURLParam($name, $default = NULL)
 {
     if (!empty ($_GET) && isset($_GET[$name]) && $_GET[$name] != '') {
@@ -104,6 +107,11 @@ 
     return $url . '?v=' . VERSION;
 }
 
+/**
+ * @param string $xml
+ *
+ * @return string
+ */
 function xml2xhtml($xml)
 {
     return preg_replace_callback('#<(\w+)([^>]*)\s*/>#s', function($m) {
@@ -326,6 +334,9 @@ 
     return $phrase;
 }
 
+/**
+ * @param string $paramName
+ */
 function addURLParameter($urlParams, $paramName, $paramValue)
 {
     if (empty ($urlParams)) {

lib/Base.php

Doc Comments +18 added lines

@@ -90,6 +90,9 @@ 
         return '';
     }
 
+    /**
+     * @return string
+     */
     public static function getDbDirectory($database = NULL)
     {
         global $config;
@@ -154,11 +157,19 @@ 
         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) {
@@ -174,6 +185,10 @@ 
         return $entry;
     }
 
+    /**
+     * @param string $columns
+     * @param string $category
+     */
     public static function getEntryArrayWithBookNumber($query, $columns, $params, $category)
     {
         /* @var $result PDOStatement */
@@ -197,6 +212,9 @@ 
         return $entryArray;
     }
 
+    /**
+     * @param string $filter
+     */
     public static function executeQuery($query, $columns, $filter, $params, $n, $database = NULL, $numberPerPage = NULL)
     {
         $totalResult = -1;

lib/Book.php

Doc Comments +17 added lines, -1 removed lines

@@ -144,6 +144,9 @@ 
         return 'index.php' . $urlParam;
     }
 
+    /**
+     * @return string
+     */
     public function getTitle () {
         return $this->title;
     }
@@ -331,6 +334,9 @@ 
         return reset($reduced);
     }
 
+    /**
+     * @param string $extension
+     */
     public function getFilePath($extension, $idData = NULL, $relative = false)
     {
         if ($extension == 'jpg')
@@ -464,6 +470,9 @@ 
             $this->getLinkArray(), $this);
     }
 
+    /**
+     * @param integer $database
+     */
     public static function getBookCount($database = NULL) {
         return Base::executeQuerySingle('select count(*) from books', $database);
     }
@@ -512,7 +521,7 @@ 
     }
 
     /**
-     * @param $customColumn CustomColumn
+     * @param CustomColumn $customColumn CustomColumn
      * @param $id integer
      * @param $n integer
      * @return array
@@ -552,6 +561,10 @@ 
         return NULL;
     }
 
+    /**
+     * @param integer $database
+     * @param integer $numberPerPage
+     */
     public static function getBooksByQuery($query, $n, $database = NULL, $numberPerPage = NULL) {
         $i = 0;
         $critArray = array();
@@ -599,6 +612,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);
     }