seblucas / cops

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)) {

Indentation +6 added lines, -6 removed lines

@@ -32,9 +32,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) {
@@ -125,7 +125,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:
@@ -134,8 +134,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/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");
     }

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) {
         /* @var $result PDOStatement */
 
@@ -181,6 +196,9 @@ 
         return $entryArray;
     }
 
+    /**
+     * @param string $filter
+     */
     public static function executeQuery($query, $columns, $filter, $params, $n, $database = NULL, $numberPerPage = NULL) {
         $totalResult = -1;
 

Indentation +7 added lines, -7 removed lines

@@ -99,13 +99,13 @@
 
     // -DC- Add image directory
     public static function getImgDirectory ($database = NULL) {
-    	global $config;
-    	if (self::isMultipleDatabaseEnabled ()) {
-    		if (is_null ($database)) $database = GetUrlParam (DB, 0);
-    		$array = array_values ($config['image_directory']);
-    		return  $array[$database];
-    	}
-    	return $config['image_directory'];
+        global $config;
+        if (self::isMultipleDatabaseEnabled ()) {
+            if (is_null ($database)) $database = GetUrlParam (DB, 0);
+            $array = array_values ($config['image_directory']);
+            return  $array[$database];
+        }
+        return $config['image_directory'];
     }
 
     public static function getDbFileName ($database = NULL) {

lib/CustomColumnType.php

Doc Comments +5 added lines, -2 removed lines

@@ -39,6 +39,9 @@ 
     /** @var null|Entry[] */
     private $customValues = NULL;
 
+    /**
+     * @param string $pdatatype
+     */
     protected function __construct($pcustomId, $pdatatype)
     {
         $this->columnTitle = self::getTitleByCustomID($pcustomId);
@@ -147,7 +150,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)
@@ -277,7 +280,7 @@ 
     /**
      * Get a CustomColumn for a specified (by ID) value
      *
-     * @param string|integer $id the id of the searched value
+     * @param integer $id the id of the searched value
      * @return CustomColumn
      */
     abstract public function getCustom($id);

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", "",

lib/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();

index.php

Indentation +8 added lines, -8 removed lines

@@ -37,14 +37,14 @@
     header('Content-Type:text/html;charset=utf-8');
 
     $data = array('title'                 => $config['cops_title_default'],
-                  'version'               => VERSION,
-                  'opds_url'              => $config['cops_full_url'] . 'feed.php',
-                  'customHeader'          => '',
-                  'template'              => getCurrentTemplate(),
-                  'server_side_rendering' => useServerSideRendering(),
-                  'current_css'           => getCurrentCss(),
-                  'favico'                => $config['cops_icon'],
-                  'getjson_url'           => 'getJSON.php?' . addURLParameter(getQueryString(), 'complete', 1));
+                    'version'               => VERSION,
+                    'opds_url'              => $config['cops_full_url'] . 'feed.php',
+                    'customHeader'          => '',
+                    'template'              => getCurrentTemplate(),
+                    'server_side_rendering' => useServerSideRendering(),
+                    'current_css'           => getCurrentCss(),
+                    'favico'                => $config['cops_icon'],
+                    'getjson_url'           => 'getJSON.php?' . addURLParameter(getQueryString(), 'complete', 1));
     if (preg_match('/Kindle/', $_SERVER['HTTP_USER_AGENT'])) {
         $data['customHeader'] = '<style media="screen" type="text/css"> html { font-size: 75%; -webkit-text-size-adjust: 75%; -ms-text-size-adjust: 75%; }</style>';
     }