mbirth / cops

base.php

Doc Comments +11 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];
@@ -95,6 +98,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");
@@ -308,6 +316,9 @@ 
     return $phrase;
 }
 
+/**
+ * @param string $paramName
+ */
 function addURLParameter($urlParams, $paramName, $paramValue) {
     if (empty ($urlParams)) {
         $urlParams = "";

Indentation +6 added lines, -6 removed lines

@@ -30,9 +30,9 @@ 
     // Generate the function for the template
     $template = new doT ();
     $dot = $template->template ($page, array ("bookdetail" => $bookdetail,
-                                              "header" => $header,
-                                              "footer" => $footer,
-                                              "main" => $main));
+                                                "header" => $header,
+                                                "footer" => $footer,
+                                                "main" => $main));
     // If there is a syntax error in the function created
     // $dot will be equal to FALSE
     if (!$dot) {
@@ -111,7 +111,7 @@ 
         case LIBXML_ERR_WARNING:
             $return .= "Warning $error->code: ";
             break;
-         case LIBXML_ERR_ERROR:
+            case LIBXML_ERR_ERROR:
             $return .= "Error $error->code: ";
             break;
         case LIBXML_ERR_FATAL:
@@ -120,8 +120,8 @@ 
     }
 
     $return .= trim($error->message) .
-               "\n  Line: $error->line" .
-               "\n  Column: $error->column";
+                "\n  Line: $error->line" .
+                "\n  Column: $error->column";
 
     if ($error->file) {
         $return .= "\n  File: $error->file";

lib/Base.php

Doc Comments +18 added lines

@@ -84,6 +84,9 @@ 
         return "";
     }
 
+    /**
+     * @return string
+     */
     public static function getDbDirectory ($database = NULL) {
         global $config;
         if (self::isMultipleDatabaseEnabled ()) {
@@ -143,10 +146,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";
@@ -159,6 +170,10 @@ 
         return $entry;
     }
 
+    /**
+     * @param string $columns
+     * @param string $category
+     */
     public static function getEntryArrayWithBookNumber ($query, $columns, $params, $category) {
         list (, $result) = self::executeQuery ($query, $columns, "", $params, -1);
         $entryArray = array();
@@ -177,6 +192,9 @@ 
         return $entryArray;
     }
 
+    /**
+     * @param string $filter
+     */
     public static function executeQuery($query, $columns, $filter, $params, $n, $database = NULL, $numberPerPage = NULL) {
         $totalResult = -1;
 

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'";

Indentation +5 added lines, -5 removed lines

@@ -45,11 +45,11 @@
         $this->entryArray = array ();
 
         $ignoredBaseArray = array (PageQueryResult::SCOPE_AUTHOR,
-                                   PageQueryResult::SCOPE_TAG,
-                                   PageQueryResult::SCOPE_SERIES,
-                                   PageQueryResult::SCOPE_PUBLISHER,
-                                   PageQueryResult::SCOPE_RATING,
-                                   "language");
+                                    PageQueryResult::SCOPE_TAG,
+                                    PageQueryResult::SCOPE_SERIES,
+                                    PageQueryResult::SCOPE_PUBLISHER,
+                                    PageQueryResult::SCOPE_RATING,
+                                    "language");
 
         $content = "";
         array_push ($this->entryArray, new Entry ("Template", "",