mbirth / cops

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

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,73 +91,73 @@ 
     $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);
         }
         $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;
 }
 
 /**
@@ -176,36 +176,36 @@ 
  *   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)) {
-      include $file;
-      if ($langcode != 'en' && isset($variant[$langcode])) {
+        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;
 }

sendtomail.php

Indentation +3 added lines, -3 removed lines

@@ -78,9 +78,9 @@
 $mail->AltBody = "Sent by COPS";
 
 if (!$mail->Send()) {
-   echo localize ("mail.messagenotsent");
-   echo 'Mailer Error: ' . $mail->ErrorInfo;
-   exit;
+    echo localize ("mail.messagenotsent");
+    echo 'Mailer Error: ' . $mail->ErrorInfo;
+    exit;
 }
 
 echo localize ("mail.messagesent");

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

@@ -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

@@ -60,6 +60,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 . "%"));
     }
@@ -68,6 +71,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) {
         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/Book.php

Doc Comments +13 added lines

@@ -287,6 +287,9 @@ 
         return reset ($reduced);
     }
 
+    /**
+     * @param string $extension
+     */
     public function getFilePath ($extension, $idData = NULL, $relative = false)
     {
         if ($extension == "jpg")
@@ -419,6 +422,9 @@ 
             $this->getLinkArray (), $this);
     }
 
+    /**
+     * @param integer $database
+     */
     public static function getBookCount($database = NULL) {
         return parent::executeQuerySingle ('select count(*) from books', $database);
     }
@@ -500,6 +506,10 @@ 
         return NULL;
     }
 
+    /**
+     * @param integer $database
+     * @param integer $numberPerPage
+     */
     public static function getBooksByQuery($query, $n, $database = NULL, $numberPerPage = NULL) {
         $i = 0;
         $critArray = array ();
@@ -544,6 +554,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 +6 added lines, -6 removed lines

@@ -428,15 +428,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;

lib/Data.php

Doc Comments +10 added lines

@@ -141,6 +141,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
@@ -154,6 +157,9 @@ 
         return $out;
     }
 
+    /**
+     * @param string $urlParam
+     */
     public static function handleThumbnailLink ($urlParam, $height) {
         global $config;
 
@@ -173,6 +179,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;

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