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/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;
 

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 parent::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);
     }

Indentation +10 added lines, -10 removed lines

@@ -473,15 +473,15 @@ 
         $nBooks = parent::executeQuerySingle('select count(*) from books');
         $result = array();
         $entry = new Entry(localize('allbooks.title'),
-                          self::ALL_BOOKS_ID,
-                          str_format(localize('allbooks.alphabetical', $nBooks), $nBooks), 'text',
-                          array(new LinkNavigation('?page='.parent::PAGE_ALL_BOOKS)), '', $nBooks);
+                            self::ALL_BOOKS_ID,
+                            str_format(localize('allbooks.alphabetical', $nBooks), $nBooks), 'text',
+                            array(new LinkNavigation('?page='.parent::PAGE_ALL_BOOKS)), '', $nBooks);
         array_push($result, $entry);
         if ($config['cops_recentbooks_limit'] > 0) {
             $entry = new Entry(localize('recent.title'),
-                              self::ALL_RECENT_BOOKS_ID,
-                              str_format(localize('recent.list'), $config['cops_recentbooks_limit']), 'text',
-                              array ( new LinkNavigation ('?page='.parent::PAGE_ALL_RECENT_BOOKS)), '', $config['cops_recentbooks_limit']);
+                                self::ALL_RECENT_BOOKS_ID,
+                                str_format(localize('recent.list'), $config['cops_recentbooks_limit']), 'text',
+                                array ( new LinkNavigation ('?page='.parent::PAGE_ALL_RECENT_BOOKS)), '', $config['cops_recentbooks_limit']);
             array_push($result, $entry);
         }
         return $result;
@@ -556,10 +556,10 @@ 
         $i = 0;
         $critArray = array();
         foreach (array(PageQueryResult::SCOPE_AUTHOR,
-                       PageQueryResult::SCOPE_TAG,
-                       PageQueryResult::SCOPE_SERIES,
-                       PageQueryResult::SCOPE_PUBLISHER,
-                       PageQueryResult::SCOPE_BOOK) as $key) {
+                        PageQueryResult::SCOPE_TAG,
+                        PageQueryResult::SCOPE_SERIES,
+                        PageQueryResult::SCOPE_PUBLISHER,
+                        PageQueryResult::SCOPE_BOOK) as $key) {
             if (in_array($key, getCurrentOption('ignored_categories')) ||
                 (!array_key_exists($key, $query) && !array_key_exists('all', $query))) {
                 $critArray[$i] = self::BAD_SEARCH;

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

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

transliteration.php

Indentation +80 added lines, -80 removed lines

@@ -26,56 +26,56 @@ 
  *   Transliterated text.
  */
 function _transliteration_process($string, $unknown = '?', $source_langcode = NULL) {
-  // ASCII is always valid NFC! If we're only ever given plain ASCII, we can
-  // avoid the overhead of initializing the decomposition tables by skipping
-  // out early.
-  if (!preg_match('/[\x80-\xff]/', $string)) {
+    // ASCII is always valid NFC! If we're only ever given plain ASCII, we can
+    // avoid the overhead of initializing the decomposition tables by skipping
+    // out early.
+    if (!preg_match('/[\x80-\xff]/', $string)) {
     return $string;
-  }
+    }
 
-  static $tail_bytes;
+    static $tail_bytes;
 
-  if (!isset($tail_bytes)) {
+    if (!isset($tail_bytes)) {
     // Each UTF-8 head byte is followed by a certain number of tail bytes.
     $tail_bytes = array();
     for ($n = 0; $n < 256; $n++) {
-      if ($n < 0xc0) {
+        if ($n < 0xc0) {
         $remaining = 0;
-      }
-      elseif ($n < 0xe0) {
+        }
+        elseif ($n < 0xe0) {
         $remaining = 1;
-      }
-      elseif ($n < 0xf0) {
+        }
+        elseif ($n < 0xf0) {
         $remaining = 2;
-      }
-      elseif ($n < 0xf8) {
+        }
+        elseif ($n < 0xf8) {
         $remaining = 3;
-      }
-      elseif ($n < 0xfc) {
+        }
+        elseif ($n < 0xfc) {
         $remaining = 4;
-      }
-      elseif ($n < 0xfe) {
+        }
+        elseif ($n < 0xfe) {
         $remaining = 5;
-      }
-      else {
+        }
+        else {
         $remaining = 0;
-      }
-      $tail_bytes[chr($n)] = $remaining;
+        }
+        $tail_bytes[chr($n)] = $remaining;
+    }
     }
-  }
 
-  // Chop the text into pure-ASCII and non-ASCII areas; large ASCII parts can
-  // be handled much more quickly. Don't chop up Unicode areas for punctuation,
-  // though, that wastes energy.
-  preg_match_all('/[\x00-\x7f]+|[\x80-\xff][\x00-\x40\x5b-\x5f\x7b-\xff]*/', $string, $matches);
+    // Chop the text into pure-ASCII and non-ASCII areas; large ASCII parts can
+    // be handled much more quickly. Don't chop up Unicode areas for punctuation,
+    // though, that wastes energy.
+    preg_match_all('/[\x00-\x7f]+|[\x80-\xff][\x00-\x40\x5b-\x5f\x7b-\xff]*/', $string, $matches);
 
-  $result = '';
-  foreach ($matches[0] as $str) {
+    $result = '';
+    foreach ($matches[0] as $str) {
     if ($str[0] < "\x80") {
-      // ASCII chunk: guaranteed to be valid UTF-8 and in normal form C, so
-      // skip over it.
-      $result .= $str;
-      continue;
+        // ASCII chunk: guaranteed to be valid UTF-8 and in normal form C, so
+        // skip over it.
+        $result .= $str;
+        continue;
     }
 
     // We'll have to examine the chunk byte by byte to ensure that it consists
@@ -91,72 +91,72 @@ 
     $len = $chunk + 1;
 
     for ($i = -1; --$len; ) {
-      $c = $str[++$i];
-      if ($remaining = $tail_bytes[$c]) {
+        $c = $str[++$i];
+        if ($remaining = $tail_bytes[$c]) {
         // UTF-8 head byte!
         $sequence = $head = $c;
         do {
-          // Look for the defined number of tail bytes...
-          if (--$len && ($c = $str[++$i]) >= "\x80" && $c < "\xc0") {
+            // Look for the defined number of tail bytes...
+            if (--$len && ($c = $str[++$i]) >= "\x80" && $c < "\xc0") {
             // Legal tail bytes are nice.
             $sequence .= $c;
-          }
-          else {
+            }
+            else {
             if ($len == 0) {
-              // Premature end of string! Drop a replacement character into
-              // output to represent the invalid UTF-8 sequence.
-              $result .= $unknown;
-              break 2;
+                // Premature end of string! Drop a replacement character into
+                // output to represent the invalid UTF-8 sequence.
+                $result .= $unknown;
+                break 2;
             }
             else {
-              // Illegal tail byte; abandon the sequence.
-              $result .= $unknown;
-              // Back up and reprocess this byte; it may itself be a legal
-              // ASCII or UTF-8 sequence head.
-              --$i;
-              ++$len;
-              continue 2;
+                // Illegal tail byte; abandon the sequence.
+                $result .= $unknown;
+                // Back up and reprocess this byte; it may itself be a legal
+                // ASCII or UTF-8 sequence head.
+                --$i;
+                ++$len;
+                continue 2;
+            }
             }
-          }
         } while (--$remaining);
 
         $n = ord($head);
         if ($n <= 0xdf) {
-          $ord = ($n - 192) * 64 + (ord($sequence[1]) - 128);
+            $ord = ($n - 192) * 64 + (ord($sequence[1]) - 128);
         }
         elseif ($n <= 0xef) {
-          $ord = ($n - 224) * 4096 + (ord($sequence[1]) - 128) * 64 + (ord($sequence[2]) - 128);
+            $ord = ($n - 224) * 4096 + (ord($sequence[1]) - 128) * 64 + (ord($sequence[2]) - 128);
         }
         elseif ($n <= 0xf7) {
-          $ord = ($n - 240) * 262144 + (ord($sequence[1]) - 128) * 4096 + (ord($sequence[2]) - 128) * 64 + (ord($sequence[3]) - 128);
+            $ord = ($n - 240) * 262144 + (ord($sequence[1]) - 128) * 4096 + (ord($sequence[2]) - 128) * 64 + (ord($sequence[3]) - 128);
         }
         elseif ($n <= 0xfb) {
-          $ord = ($n - 248) * 16777216 + (ord($sequence[1]) - 128) * 262144 + (ord($sequence[2]) - 128) * 4096 + (ord($sequence[3]) - 128) * 64 + (ord($sequence[4]) - 128);
+            $ord = ($n - 248) * 16777216 + (ord($sequence[1]) - 128) * 262144 + (ord($sequence[2]) - 128) * 4096 + (ord($sequence[3]) - 128) * 64 + (ord($sequence[4]) - 128);
         }
         elseif ($n <= 0xfd) {
-          $ord = ($n - 252) * 1073741824 + (ord($sequence[1]) - 128) * 16777216 + (ord($sequence[2]) - 128) * 262144 + (ord($sequence[3]) - 128) * 4096 + (ord($sequence[4]) - 128) * 64 + (ord($sequence[5]) - 128);
+            $ord = ($n - 252) * 1073741824 + (ord($sequence[1]) - 128) * 16777216 + (ord($sequence[2]) - 128) * 262144 + (ord($sequence[3]) - 128) * 4096 + (ord($sequence[4]) - 128) * 64 + (ord($sequence[5]) - 128);
         } else {
-          $ord = $n;
+            $ord = $n;
         }
         $result .= _transliteration_replace($ord, $unknown, $source_langcode);
         $head = '';
-      } elseif ($c < "\x80") {
+        } elseif ($c < "\x80") {
         // ASCII byte.
         $result .= $c;
         $head = '';
-      } elseif ($c < "\xc0") {
+        } elseif ($c < "\xc0") {
         // Illegal tail bytes.
         if ($head == '') {
-          $result .= $unknown;
+            $result .= $unknown;
         }
-      } else {
+        } else {
         // Miscellaneous freaks.
         $result .= $unknown;
         $head = '';
-      }
+        }
     }
-  }
-  return $result;
+    }
+    return $result;
 }
 
 /**
@@ -175,38 +175,38 @@ 
  *   ASCII replacement character.
  */
 function _transliteration_replace($ord, $unknown = '?', $langcode = NULL) {
-  static $map = array();
+    static $map = array();
 
-  //GL: set language later
-  /*
+    //GL: set language later
+    /*
   if (!isset($langcode)) {
     global $language;
     $langcode = $language->language;
   }
   */
 
-  $bank = $ord >> 8;
+    $bank = $ord >> 8;
 
-  if (!isset($map[$bank][$langcode])) {
+    if (!isset($map[$bank][$langcode])) {
     $file = './resources/transliteration-data/' . sprintf('x%02x', $bank) . '.php';  
     if (file_exists($file)) {
-      $base = array();
-      $variant = array();
-      include $file;
-      if ($langcode != 'en' && isset($variant[$langcode])) {
+        $base = array();
+        $variant = array();
+        include $file;
+        if ($langcode != 'en' && isset($variant[$langcode])) {
         // Merge in language specific mappings.
         $map[$bank][$langcode] = $variant[$langcode] + $base;
-      }
-      else {
+        }
+        else {
         $map[$bank][$langcode] = $base;
-      }
+        }
     }
     else {
-      $map[$bank][$langcode] = array();
+        $map[$bank][$langcode] = array();
+    }
     }
-  }
 
-  $ord = $ord & 255;
+    $ord = $ord & 255;
 
-  return isset($map[$bank][$langcode][$ord]) ? $map[$bank][$langcode][$ord] : $unknown;
+    return isset($map[$bank][$langcode][$ord]) ? $map[$bank][$langcode][$ord] : $unknown;
 }