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

Braces +21 added lines, -36 removed lines

@@ -25,7 +25,8 @@ 
  * @return
  *   Transliterated text.
  */
-function _transliteration_process($string, $unknown = '?', $source_langcode = NULL) {
+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.
@@ -41,23 +42,17 @@ 
     for ($n = 0; $n < 256; $n++) {
       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;
@@ -100,15 +95,13 @@ 
           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;
-            }
-            else {
+            } else {
               // Illegal tail byte; abandon the sequence.
               $result .= $unknown;
               // Back up and reprocess this byte; it may itself be a legal
@@ -123,34 +116,27 @@ 
         $n = ord($head);
         if ($n <= 0xdf) {
           $ord = ($n - 192) * 64 + (ord($sequence[1]) - 128);
-        }
-        elseif ($n <= 0xef) {
+        } elseif ($n <= 0xef) {
           $ord = ($n - 224) * 4096 + (ord($sequence[1]) - 128) * 64 + (ord($sequence[2]) - 128);
-        }
-        elseif ($n <= 0xf7) {
+        } elseif ($n <= 0xf7) {
           $ord = ($n - 240) * 262144 + (ord($sequence[1]) - 128) * 4096 + (ord($sequence[2]) - 128) * 64 + (ord($sequence[3]) - 128);
-        }
-        elseif ($n <= 0xfb) {
+        } 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);
-        }
-        elseif ($n <= 0xfd) {
+        } 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);
         }
         $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;
         }
-      }
-      else {
+      } else {
         // Miscellaneous freaks.
         $result .= $unknown;
         $head = '';
@@ -175,7 +161,8 @@ 
  * @return
  *   ASCII replacement character.
  */
-function _transliteration_replace($ord, $unknown = '?', $langcode = NULL) {
+function _transliteration_replace($ord, $unknown = '?', $langcode = NULL)
+{
   static $map = array();
 
   //GL: set language later
@@ -195,12 +182,10 @@ 
       if ($langcode != 'en' && isset($variant[$langcode])) {
         // Merge in language specific mappings.
         $map[$bank][$langcode] = $variant[$langcode] + $base;
-      }
-      else {
+      } else {
         $map[$bank][$langcode] = $base;
       }
-    }
-    else {
+    } else {
       $map[$bank][$langcode] = array();
     }
   }

sendtomail.php

Braces +13 added lines, -5 removed lines

@@ -2,7 +2,8 @@ 
 
 require_once ("config.php");
 
-function checkConfiguration () {
+function checkConfiguration ()
+{
     global $config;
 
     if (is_null ($config['cops_mail_configuration']) ||
@@ -14,7 +15,8 @@ 
     return False;
 }
 
-function checkRequest ($idData, $emailDest) {
+function checkRequest ($idData, $emailDest)
+{
     if (empty ($idData)) {
         return 'No data sent.';
     }
@@ -58,9 +60,15 @@ 
     $mail->Port = 465;
 }
 $mail->SMTPAuth = !empty ($config['cops_mail_configuration']["smtp.username"]);
-if (!empty ($config['cops_mail_configuration']["smtp.username"])) $mail->Username = $config['cops_mail_configuration']["smtp.username"];
-if (!empty ($config['cops_mail_configuration']["smtp.password"])) $mail->Password = $config['cops_mail_configuration']["smtp.password"];
-if (!empty ($config['cops_mail_configuration']["smtp.secure"])) $mail->SMTPSecure = $config['cops_mail_configuration']["smtp.secure"];
+if (!empty ($config['cops_mail_configuration']["smtp.username"])) {
+    $mail->Username = $config['cops_mail_configuration']["smtp.username"];
+}
+if (!empty ($config['cops_mail_configuration']["smtp.password"])) {
+    $mail->Password = $config['cops_mail_configuration']["smtp.password"];
+}
+if (!empty ($config['cops_mail_configuration']["smtp.secure"])) {
+    $mail->SMTPSecure = $config['cops_mail_configuration']["smtp.secure"];
+}
 
 $mail->From = $config['cops_mail_configuration']["address.from"];
 $mail->FromName = $config['cops_title_default'];

config.php

Braces +2 added lines, -4 removed lines

@@ -21,13 +21,11 @@
 }
 
 if(!is_null($config['cops_basic_authentication']) &&
-    is_array($config['cops_basic_authentication']))
-{
+    is_array($config['cops_basic_authentication'])) {
     if (!isset($_SERVER['PHP_AUTH_USER']) ||
         (isset($_SERVER['PHP_AUTH_USER']) &&
         ($_SERVER['PHP_AUTH_USER']!=$config['cops_basic_authentication']['username'] ||
-        $_SERVER['PHP_AUTH_PW'] != $config['cops_basic_authentication']['password'])))
-    {
+        $_SERVER['PHP_AUTH_PW'] != $config['cops_basic_authentication']['password']))) {
         header('WWW-Authenticate: Basic realm="COPS Authentication"');
         header('HTTP/1.0 401 Unauthorized');
         echo 'This site is password protected';

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

Braces +19 added lines, -11 removed lines

@@ -149,7 +149,9 @@ 
     $errors = libxml_get_errors();
 
     foreach ($errors as $error) {
-        if ($error->code == 801) return false;
+        if ($error->code == 801) {
+            return false;
+        }
     }
     return true;
 }
@@ -175,7 +177,9 @@ 
     }
     */
 
-    if (!are_libxml_errors_ok ()) $output = 'HTML code not valid.';
+    if (!are_libxml_errors_ok ()) {
+        $output = 'HTML code not valid.';
+    }
 
     libxml_use_internal_errors(false);
     return $output;
@@ -235,7 +239,9 @@ 
 
             // set default to 1 for any without q factor
             foreach ($langs as $lang => $val) {
-                if ($val === '') $langs[$lang] = 1;
+                if ($val === '') {
+                    $langs[$lang] = 1;
+                }
             }
 
             // sort list based on value
@@ -257,8 +263,7 @@ 
     $lang = 'en';
     if (!empty($config['cops_language'])) {
         $lang = $config['cops_language'];
-    }
-    elseif (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
+    } elseif (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
         $langs = getAcceptLanguages();
     }
     //echo var_dump($langs);
@@ -284,12 +289,15 @@ 
 function localize($phrase, $count=-1, $reset=false)
 {
     global $config;
-    if ($count == 0)
-        $phrase .= '.none';
-    if ($count == 1)
-        $phrase .= '.one';
-    if ($count > 1)
-        $phrase .= '.many';
+    if ($count == 0) {
+            $phrase .= '.none';
+    }
+    if ($count == 1) {
+            $phrase .= '.one';
+    }
+    if ($count > 1) {
+            $phrase .= '.many';
+    }
 
     /* Static keyword is used to ensure the file is loaded only once */
     static $translations = NULL;

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

Braces +25 added lines, -14 removed lines

@@ -19,37 +19,42 @@ 
     public $name;
     public $sort;
 
-    public function __construct($post) {
+    public function __construct($post)
+    {
         $this->id = $post->id;
         $this->name = str_replace("|", ",", $post->name);
         $this->sort = $post->sort;
     }
 
-    public function getUri () {
+    public function getUri ()
+    {
         return "?page=".parent::PAGE_AUTHOR_DETAIL."&id=$this->id";
     }
 
-    public function getEntryId () {
+    public function getEntryId ()
+    {
         return self::ALL_AUTHORS_ID.":".$this->id;
     }
 
-    public static function getEntryIdByLetter ($startingLetter) {
+    public static function getEntryIdByLetter ($startingLetter)
+    {
         return self::ALL_AUTHORS_ID.":letter:".$startingLetter;
     }
 
-    public static function getCount() {
+    public static function getCount()
+    {
         // str_format (localize("authors.alphabetical", count(array))
         return parent::getCountGeneric ("authors", self::ALL_AUTHORS_ID, parent::PAGE_ALL_AUTHORS);
     }
 
-    public static function getAllAuthorsByFirstLetter() {
+    public static function getAllAuthorsByFirstLetter()
+    {
         list (, $result) = parent::executeQuery ("select {0}
 from authors
 group by substr (upper (sort), 1, 1)
 order by substr (upper (sort), 1, 1)", "substr (upper (sort), 1, 1) as title, count(*) as count", "", array (), -1);
         $entryArray = array();
-        while ($post = $result->fetchObject ())
-        {
+        while ($post = $result->fetchObject ()) {
             array_push ($entryArray, new Entry ($post->title, Author::getEntryIdByLetter ($post->title),
                 str_format (localize("authorword", $post->count), $post->count), "text",
                 array ( new LinkNavigation ("?page=".parent::PAGE_AUTHORS_FIRST_LETTER."&id=". rawurlencode ($post->title))), "", $post->count));
@@ -57,30 +62,36 @@ 
         return $entryArray;
     }
 
-    public static function getAuthorsByStartingLetter($letter) {
+    public static function getAuthorsByStartingLetter($letter)
+    {
         return self::getEntryArray (self::SQL_AUTHORS_BY_FIRST_LETTER, array ($letter . "%"));
     }
 
-    public static function getAuthorsForSearch($query) {
+    public static function getAuthorsForSearch($query)
+    {
         return self::getEntryArray (self::SQL_AUTHORS_FOR_SEARCH, array ($query . "%", $query . "%"));
     }
 
-    public static function getAllAuthors() {
+    public static function getAllAuthors()
+    {
         return self::getEntryArray (self::SQL_ALL_AUTHORS, array ());
     }
 
-    public static function getEntryArray ($query, $params) {
+    public static function getEntryArray ($query, $params)
+    {
         return Base::getEntryArrayWithBookNumber ($query, self::AUTHOR_COLUMNS, $params, "Author");
     }
 
-    public static function getAuthorById ($authorId) {
+    public static function getAuthorById ($authorId)
+    {
         $result = parent::getDb ()->prepare('select ' . self::AUTHOR_COLUMNS . ' from authors where id = ?');
         $result->execute (array ($authorId));
         $post = $result->fetchObject ();
         return new Author ($post);
     }
 
-    public static function getAuthorByBookId ($bookId) {
+    public static function getAuthorByBookId ($bookId)
+    {
         $result = parent::getDb ()->prepare('select authors.id as id, authors.name as name, authors.sort as sort from authors, books_authors_link
 where author = authors.id
 and book = ?');

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;
 

Braces +43 added lines, -23 removed lines

@@ -37,23 +37,27 @@ 
 
     private static $db = NULL;
 
-    public static function isMultipleDatabaseEnabled () {
+    public static function isMultipleDatabaseEnabled ()
+    {
         global $config;
         return is_array ($config['calibre_directory']);
     }
 
-    public static function useAbsolutePath () {
+    public static function useAbsolutePath ()
+    {
         global $config;
         $path = self::getDbDirectory();
         return preg_match ('/^\//', $path) || // Linux /
                preg_match ('/^\w\:/', $path); // Windows X:
     }
 
-    public static function noDatabaseSelected () {
+    public static function noDatabaseSelected ()
+    {
         return self::isMultipleDatabaseEnabled () && is_null (GetUrlParam (DB));
     }
 
-    public static function getDbList () {
+    public static function getDbList ()
+    {
         global $config;
         if (self::isMultipleDatabaseEnabled ()) {
             return $config['calibre_directory'];
@@ -62,7 +66,8 @@ 
         }
     }
 
-    public static function getDbNameList () {
+    public static function getDbNameList ()
+    {
         global $config;
         if (self::isMultipleDatabaseEnabled ()) {
             return array_keys ($config['calibre_directory']);
@@ -71,10 +76,13 @@ 
         }
     }
 
-    public static function getDbName ($database = NULL) {
+    public static function getDbName ($database = NULL)
+    {
         global $config;
         if (self::isMultipleDatabaseEnabled ()) {
-            if (is_null ($database)) $database = GetUrlParam (DB, 0);
+            if (is_null ($database)) {
+                $database = GetUrlParam (DB, 0);
+            }
             if (!is_null($database) && !preg_match('/^\d+$/', $database)) {
                 return self::error ($database);
             }
@@ -84,10 +92,13 @@ 
         return "";
     }
 
-    public static function getDbDirectory ($database = NULL) {
+    public static function getDbDirectory ($database = NULL)
+    {
         global $config;
         if (self::isMultipleDatabaseEnabled ()) {
-            if (is_null ($database)) $database = GetUrlParam (DB, 0);
+            if (is_null ($database)) {
+                $database = GetUrlParam (DB, 0);
+            }
             if (!is_null($database) && !preg_match('/^\d+$/', $database)) {
                 return self::error ($database);
             }
@@ -98,18 +109,21 @@ 
     }
 
 
-    public static function getDbFileName ($database = NULL) {
+    public static function getDbFileName ($database = NULL)
+    {
         return self::getDbDirectory ($database) .'metadata.db';
     }
 
-    private static function error ($database) {
+    private static function error ($database)
+    {
         if (php_sapi_name() != "cli") {
             header("location: checkconfig.php?err=1");
         }
         throw new Exception("Database <{$database}> not found.");
     }
 
-    public static function getDb ($database = NULL) {
+    public static function getDb ($database = NULL)
+    {
         if (is_null (self::$db)) {
             try {
                 if (is_readable (self::getDbFileName ($database))) {
@@ -127,7 +141,8 @@ 
         return self::$db;
     }
 
-    public static function checkDatabaseAvailability () {
+    public static function checkDatabaseAvailability ()
+    {
         if (self::noDatabaseSelected ()) {
             for ($i = 0; $i < count (self::getDbList ()); $i++) {
                 self::getDb ($i);
@@ -139,31 +154,36 @@ 
         return true;
     }
 
-    public static function clearDb () {
+    public static function clearDb ()
+    {
         self::$db = NULL;
     }
 
-    public static function executeQuerySingle ($query, $database = NULL) {
+    public static function executeQuerySingle ($query, $database = NULL)
+    {
         return self::getDb ($database)->query($query)->fetchColumn();
     }
 
-    public static function getCountGeneric($table, $id, $pageId, $numberOfString = NULL) {
+    public static function getCountGeneric($table, $id, $pageId, $numberOfString = NULL)
+    {
         if (!$numberOfString) {
             $numberOfString = $table . ".alphabetical";
         }
         $count = self::executeQuerySingle ('select count(*) from ' . $table);
-        if ($count == 0) return NULL;
+        if ($count == 0) {
+            return NULL;
+        }
         $entry = new Entry (localize($table . ".title"), $id,
             str_format (localize($numberOfString, $count), $count), "text",
             array ( new LinkNavigation ("?page=".$pageId)), "", $count);
         return $entry;
     }
 
-    public static function getEntryArrayWithBookNumber ($query, $columns, $params, $category) {
+    public static function getEntryArrayWithBookNumber ($query, $columns, $params, $category)
+    {
         list (, $result) = self::executeQuery ($query, $columns, "", $params, -1);
         $entryArray = array();
-        while ($post = $result->fetchObject ())
-        {
+        while ($post = $result->fetchObject ()) {
             $instance = new $category ($post);
             if (property_exists($post, "sort")) {
                 $title = $post->sort;
@@ -177,7 +197,8 @@ 
         return $entryArray;
     }
 
-    public static function executeQuery($query, $columns, $filter, $params, $n, $database = NULL, $numberPerPage = NULL) {
+    public static function executeQuery($query, $columns, $filter, $params, $n, $database = NULL, $numberPerPage = NULL)
+    {
         $totalResult = -1;
 
         if (useNormAndUp ()) {
@@ -189,8 +210,7 @@ 
             $numberPerPage = getCurrentOption ("max_item_per_page");
         }
 
-        if ($numberPerPage != -1 && $n != -1)
-        {
+        if ($numberPerPage != -1 && $n != -1) {
             // First check total number of results
             $result = self::getDb ($database)->prepare (str_format ($query, "count(*)", $filter));
             $result->execute ($params);

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

Braces +103 added lines, -81 removed lines

@@ -80,7 +80,8 @@ 
     public $format = array ();
 
 
-    public function __construct($line) {
+    public function __construct($line)
+    {
         $this->id = $line->id;
         $this->title = $line->title;
         $this->timestamp = strtotime ($line->timestamp);
@@ -98,60 +99,73 @@ 
         $this->rating = $line->rating;
     }
 
-    public function getEntryId () {
+    public function getEntryId ()
+    {
         return self::ALL_BOOKS_UUID.":".$this->uuid;
     }
 
-    public static function getEntryIdByLetter ($startingLetter) {
+    public static function getEntryIdByLetter ($startingLetter)
+    {
         return self::ALL_BOOKS_ID.":letter:".$startingLetter;
     }
 
-    public function getUri () {
+    public function getUri ()
+    {
         return "?page=".parent::PAGE_BOOK_DETAIL."&id=$this->id";
     }
 
-    public function getDetailUrl () {
+    public function getDetailUrl ()
+    {
         $urlParam = $this->getUri ();
-        if (!is_null (GetUrlParam (DB))) $urlParam = addURLParameter ($urlParam, DB, GetUrlParam (DB));
+        if (!is_null (GetUrlParam (DB))) {
+            $urlParam = addURLParameter ($urlParam, DB, GetUrlParam (DB));
+        }
         return 'index.php' . $urlParam;
     }
 
-    public function getTitle () {
+    public function getTitle ()
+    {
         return $this->title;
     }
 
     /* Other class (author, series, tag, ...) initialization and accessors */
 
-    public function getAuthors () {
+    public function getAuthors ()
+    {
         if (is_null ($this->authors)) {
             $this->authors = Author::getAuthorByBookId ($this->id);
         }
         return $this->authors;
     }
 
-    public function getAuthorsName () {
+    public function getAuthorsName ()
+    {
         return implode (", ", array_map (function ($author) { return $author->name; }, $this->getAuthors ()));
     }
 
-    public function getAuthorsSort () {
+    public function getAuthorsSort ()
+    {
         return implode (", ", array_map (function ($author) { return $author->sort; }, $this->getAuthors ()));
     }
 
-    public function getPublisher () {
+    public function getPublisher ()
+    {
         if (is_null ($this->publisher)) {
             $this->publisher = Publisher::getPublisherByBookId ($this->id);
         }
         return $this->publisher;
     }
 
-    public function getSerie () {
+    public function getSerie ()
+    {
         if (is_null ($this->serie)) {
             $this->serie = Serie::getSerieByBookId ($this->id);
         }
         return $this->serie;
     }
 
-    public function getLanguages () {
+    public function getLanguages ()
+    {
         $lang = array ();
         $result = parent::getDb ()->prepare('select languages.lang_code
                 from books_languages_link, languages
@@ -159,14 +173,14 @@ 
                 and book = ?
                 order by item_order');
         $result->execute (array ($this->id));
-        while ($post = $result->fetchObject ())
-        {
+        while ($post = $result->fetchObject ()) {
             array_push ($lang, Language::getLanguageString($post->lang_code));
         }
         return implode (", ", $lang);
     }
 
-    public function getTags () {
+    public function getTags ()
+    {
         if (is_null ($this->tags)) {
             $this->tags = array ();
 
@@ -176,15 +190,15 @@ 
                 and book = ?
                 order by name');
             $result->execute (array ($this->id));
-            while ($post = $result->fetchObject ())
-            {
+            while ($post = $result->fetchObject ()) {
                 array_push ($this->tags, new Tag ($post));
             }
         }
         return $this->tags;
     }
 
-    public function getTagsName () {
+    public function getTagsName ()
+    {
         return implode (", ", array_map (function ($tag) { return $tag->name; }, $this->getTags ()));
     }
 
@@ -198,9 +212,12 @@ 
 
     /* End of other class (author, series, tag, ...) initialization and accessors */
 
-    public static function getFilterString () {
+    public static function getFilterString ()
+    {
         $filter = getURLParam ("tag", NULL);
-        if (empty ($filter)) return "";
+        if (empty ($filter)) {
+            return "";
+        }
 
         $exists = true;
         if (preg_match ("/^!(.*)$/", $filter, $matches)) {
@@ -240,7 +257,8 @@ 
         return reset ($reduced);
     }
 
-    public function getRating () {
+    public function getRating ()
+    {
         if (is_null ($this->rating) || $this->rating == 0) {
             return "";
         }
@@ -254,7 +272,8 @@ 
         return $retour;
     }
 
-    public function getPubDate () {
+    public function getPubDate ()
+    {
         if (empty ($this->pubdate)) {
             return "";
         }
@@ -265,23 +284,22 @@ 
         return "";
     }
 
-    public function getComment ($withSerie = true) {
+    public function getComment ($withSerie = true)
+    {
         $addition = "";
         $se = $this->getSerie ();
         if (!is_null ($se) && $withSerie) {
             $addition = $addition . "<strong>" . localize("content.series") . "</strong>" . str_format (localize ("content.series.data"), $this->seriesIndex, htmlspecialchars ($se->name)) . "<br />\n";
         }
-        if (preg_match ("/<\/(div|p|a|span)>/", $this->comment))
-        {
+        if (preg_match ("/<\/(div|p|a|span)>/", $this->comment)) {
             return $addition . html2xhtml ($this->comment);
-        }
-        else
-        {
+        } else {
             return $addition . htmlspecialchars ($this->comment);
         }
     }
 
-    public function getDataFormat ($format) {
+    public function getDataFormat ($format)
+    {
         $reduced = array_filter ($this->getDatas (), function ($data) use ($format) {
             return $data->format == $format;
         });
@@ -290,23 +308,19 @@ 
 
     public function getFilePath ($extension, $idData = NULL, $relative = false)
     {
-        if ($extension == "jpg")
-        {
+        if ($extension == "jpg") {
             $file = "cover.jpg";
-        }
-        else
-        {
+        } else {
             $data = $this->getDataById ($idData);
-            if (!$data) return NULL;
+            if (!$data) {
+                return NULL;
+            }
             $file = $data->name . "." . strtolower ($data->format);
         }
 
-        if ($relative)
-        {
+        if ($relative) {
             return $this->relativePath."/".$file;
-        }
-        else
-        {
+        } else {
             return $this->path."/".$file;
         }
     }
@@ -316,8 +330,7 @@ 
         global $config;
         $data = $this->getDataById ($idData);
 
-        try
-        {
+        try {
             $epub = new EPub ($data->getLocalPath ());
 
             $epub->Title ($this->title);
@@ -340,14 +353,13 @@ 
                 $epub->updateForKepub ();
             }
             $epub->download ($data->getUpdatedFilenameEpub ());
-        }
-        catch (Exception $e)
-        {
+        } catch (Exception $e) {
             echo "Exception : " . $e->getMessage();
         }
     }
 
-    public function getThumbnail ($width, $height, $outputfile = NULL) {
+    public function getThumbnail ($width, $height, $outputfile = NULL)
+    {
         if (is_null ($width) && is_null ($height)) {
             return false;
         }
@@ -386,17 +398,14 @@ 
     {
         $linkArray = array();
 
-        if ($this->hasCover)
-        {
+        if ($this->hasCover) {
             array_push ($linkArray, Data::getLink ($this, "jpg", "image/jpeg", Link::OPDS_IMAGE_TYPE, "cover.jpg", NULL));
 
             array_push ($linkArray, Data::getLink ($this, "jpg", "image/jpeg", Link::OPDS_THUMBNAIL_TYPE, "cover.jpg", NULL));
         }
 
-        foreach ($this->getDatas () as $data)
-        {
-            if ($data->isKnownType ())
-            {
+        foreach ($this->getDatas () as $data) {
+            if ($data->isKnownType ()) {
                 array_push ($linkArray, $data->getDataLink (Link::OPDS_ACQUISITION_TYPE, $data->format));
             }
         }
@@ -414,17 +423,20 @@ 
     }
 
 
-    public function getEntry () {
+    public function getEntry ()
+    {
         return new EntryBook ($this->getTitle (), $this->getEntryId (),
             $this->getComment (), "text/html",
             $this->getLinkArray (), $this);
     }
 
-    public static function getBookCount($database = NULL) {
+    public static function getBookCount($database = NULL)
+    {
         return parent::executeQuerySingle ('select count(*) from books', $database);
     }
 
-    public static function getCount() {
+    public static function getCount()
+    {
         global $config;
         $nBooks = parent::executeQuerySingle ('select count(*) from books');
         $result = array();
@@ -443,55 +455,62 @@ 
         return $result;
     }
 
-    public static function getBooksByAuthor($authorId, $n) {
+    public static function getBooksByAuthor($authorId, $n)
+    {
         return self::getEntryArray (self::SQL_BOOKS_BY_AUTHOR, array ($authorId), $n);
     }
 
-    public static function getBooksByRating($ratingId, $n) {
+    public static function getBooksByRating($ratingId, $n)
+    {
         return self::getEntryArray (self::SQL_BOOKS_BY_RATING, array ($ratingId), $n);
     }
 
-    public static function getBooksByPublisher($publisherId, $n) {
+    public static function getBooksByPublisher($publisherId, $n)
+    {
         return self::getEntryArray (self::SQL_BOOKS_BY_PUBLISHER, array ($publisherId), $n);
     }
 
-    public static function getBooksBySeries($serieId, $n) {
+    public static function getBooksBySeries($serieId, $n)
+    {
         return self::getEntryArray (self::SQL_BOOKS_BY_SERIE, array ($serieId), $n);
     }
 
-    public static function getBooksByTag($tagId, $n) {
+    public static function getBooksByTag($tagId, $n)
+    {
         return self::getEntryArray (self::SQL_BOOKS_BY_TAG, array ($tagId), $n);
     }
 
-    public static function getBooksByLanguage($languageId, $n) {
+    public static function getBooksByLanguage($languageId, $n)
+    {
         return self::getEntryArray (self::SQL_BOOKS_BY_LANGUAGE, array ($languageId), $n);
     }
 
-    public static function getBooksByCustom($customId, $id, $n) {
+    public static function getBooksByCustom($customId, $id, $n)
+    {
         $query = str_format (self::SQL_BOOKS_BY_CUSTOM, "{0}", "{1}", CustomColumn::getTableLinkName ($customId), CustomColumn::getTableLinkColumn ($customId));
         return self::getEntryArray ($query, array ($id), $n);
     }
 
-    public static function getBookById($bookId) {
+    public static function getBookById($bookId)
+    {
         $result = parent::getDb ()->prepare('select ' . self::BOOK_COLUMNS . '
 from books ' . self::SQL_BOOKS_LEFT_JOIN . '
 where books.id = ?');
         $result->execute (array ($bookId));
-        while ($post = $result->fetchObject ())
-        {
+        while ($post = $result->fetchObject ()) {
             $book = new Book ($post);
             return $book;
         }
         return NULL;
     }
 
-    public static function getBookByDataId($dataId) {
+    public static function getBookByDataId($dataId)
+    {
         $result = parent::getDb ()->prepare('select ' . self::BOOK_COLUMNS . ', data.name, data.format
 from data, books ' . self::SQL_BOOKS_LEFT_JOIN . '
 where data.book = books.id and data.id = ?');
         $result->execute (array ($dataId));
-        while ($post = $result->fetchObject ())
-        {
+        while ($post = $result->fetchObject ()) {
             $book = new Book ($post);
             $data = new Data ($post, $book);
             $data->id = $dataId;
@@ -501,7 +520,8 @@ 
         return NULL;
     }
 
-    public static function getBooksByQuery($query, $n, $database = NULL, $numberPerPage = NULL) {
+    public static function getBooksByQuery($query, $n, $database = NULL, $numberPerPage = NULL)
+    {
         $i = 0;
         $critArray = array ();
         foreach (array (PageQueryResult::SCOPE_AUTHOR,
@@ -512,8 +532,7 @@ 
             if (in_array($key, getCurrentOption ('ignored_categories')) ||
                 (!array_key_exists ($key, $query) && !array_key_exists ("all", $query))) {
                 $critArray [$i] = self::BAD_SEARCH;
-            }
-            else {
+            } else {
                 if (array_key_exists ($key, $query)) {
                     $critArray [$i] = $query [$key];
                 } else {
@@ -525,19 +544,20 @@ 
         return self::getEntryArray (self::SQL_BOOKS_QUERY, $critArray, $n, $database, $numberPerPage);
     }
 
-    public static function getBooks($n) {
+    public static function getBooks($n)
+    {
         list ($entryArray, $totalNumber) = self::getEntryArray (self::SQL_BOOKS_ALL , array (), $n);
         return array ($entryArray, $totalNumber);
     }
 
-    public static function getAllBooks() {
+    public static function getAllBooks()
+    {
         list (, $result) = parent::executeQuery ("select {0}
 from books
 group by substr (upper (sort), 1, 1)
 order by substr (upper (sort), 1, 1)", "substr (upper (sort), 1, 1) as title, count(*) as count", self::getFilterString (), array (), -1);
         $entryArray = array();
-        while ($post = $result->fetchObject ())
-        {
+        while ($post = $result->fetchObject ()) {
             array_push ($entryArray, new Entry ($post->title, Book::getEntryIdByLetter ($post->title),
                 str_format (localize("bookword", $post->count), $post->count), "text",
                 array ( new LinkNavigation ("?page=".parent::PAGE_ALL_BOOKS_LETTER."&id=". rawurlencode ($post->title))), "", $post->count));
@@ -545,15 +565,16 @@ 
         return $entryArray;
     }
 
-    public static function getBooksByStartingLetter($letter, $n, $database = NULL, $numberPerPage = NULL) {
+    public static function getBooksByStartingLetter($letter, $n, $database = NULL, $numberPerPage = NULL)
+    {
         return self::getEntryArray (self::SQL_BOOKS_BY_FIRST_LETTER, array ($letter . "%"), $n, $database, $numberPerPage);
     }
 
-    public static function getEntryArray ($query, $params, $n, $database = NULL, $numberPerPage = NULL) {
+    public static function getEntryArray ($query, $params, $n, $database = NULL, $numberPerPage = NULL)
+    {
         list ($totalNumber, $result) = parent::executeQuery ($query, self::BOOK_COLUMNS, self::getFilterString (), $params, $n, $database, $numberPerPage);
         $entryArray = array();
-        while ($post = $result->fetchObject ())
-        {
+        while ($post = $result->fetchObject ()) {
             $book = new Book ($post);
             array_push ($entryArray, $book->getEntry ());
         }
@@ -561,7 +582,8 @@ 
     }
 
 
-    public static function getAllRecentBooks() {
+    public static function getAllRecentBooks()
+    {
         global $config;
         list ($entryArray, ) = self::getEntryArray (self::SQL_BOOKS_RECENT . $config['cops_recentbooks_limit'], array (), -1);
         return $entryArray;

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;

Braces +42 added lines, -29 removed lines

@@ -55,7 +55,8 @@ 
         'zip'   => 'application/zip'
     );
 
-    public function __construct($post, $book = null) {
+    public function __construct($post, $book = null)
+    {
         $this->id = $post->id;
         $this->name = $post->name;
         $this->format = $post->format;
@@ -64,19 +65,20 @@ 
         $this->book = $book;
     }
 
-    public function isKnownType () {
+    public function isKnownType ()
+    {
         return array_key_exists ($this->extension, self::$mimetypes);
     }
 
-    public function getMimeType () {
+    public function getMimeType ()
+    {
         $result = "application/octet-stream";
         if ($this->isKnownType ()) {
             return self::$mimetypes [$this->extension];
         } elseif (function_exists('finfo_open') === true) {
             $finfo = finfo_open(FILEINFO_MIME_TYPE);
 
-            if (is_resource($finfo) === true)
-            {
+            if (is_resource($finfo) === true) {
                 $result = finfo_file($finfo, $this->getLocalPath ());
             }
 
@@ -86,27 +88,33 @@ 
         return $result;
     }
 
-    public function isEpubValidOnKobo () {
+    public function isEpubValidOnKobo ()
+    {
         return $this->format == "EPUB" || $this->format == "KEPUB";
     }
 
-    public function getFilename () {
+    public function getFilename ()
+    {
         return $this->name . "." . strtolower ($this->format);
     }
 
-    public function getUpdatedFilename () {
+    public function getUpdatedFilename ()
+    {
         return $this->book->getAuthorsSort () . " - " . $this->book->title;
     }
 
-    public function getUpdatedFilenameEpub () {
+    public function getUpdatedFilenameEpub ()
+    {
         return $this->getUpdatedFilename () . ".epub";
     }
 
-    public function getUpdatedFilenameKepub () {
+    public function getUpdatedFilenameKepub ()
+    {
         return $this->getUpdatedFilename () . ".kepub.epub";
     }
 
-    public function getDataLink ($rel, $title = NULL) {
+    public function getDataLink ($rel, $title = NULL)
+    {
         global $config;
 
         if ($rel == Link::OPDS_ACQUISITION_TYPE && $config['cops_use_url_rewriting'] == "1") {
@@ -116,19 +124,24 @@ 
         return self::getLink ($this->book, $this->extension, $this->getMimeType (), $rel, $this->getFilename (), $this->id, $title);
     }
 
-    public function getHtmlLink () {
+    public function getHtmlLink ()
+    {
         return $this->getDataLink(Link::OPDS_ACQUISITION_TYPE)->href;
     }
 
-    public function getLocalPath () {
+    public function getLocalPath ()
+    {
         return $this->book->path . "/" . $this->getFilename ();
     }
 
-    public function getHtmlLinkWithRewriting ($title = NULL) {
+    public function getHtmlLinkWithRewriting ($title = NULL)
+    {
         global $config;
 
         $database = "";
-        if (!is_null (GetUrlParam (DB))) $database = GetUrlParam (DB) . "/";
+        if (!is_null (GetUrlParam (DB))) {
+            $database = GetUrlParam (DB) . "/";
+        }
 
         $href = "download/" . $this->id . "/" . $database;
 
@@ -142,28 +155,27 @@ 
         return new Link ($href, $this->getMimeType (), Link::OPDS_ACQUISITION_TYPE, $title);
     }
 
-    public static function getDataByBook ($book) {
+    public static function getDataByBook ($book)
+    {
         $out = array ();
         $result = parent::getDb ()->prepare('select id, format, name
                                              from data where book = ?');
         $result->execute (array ($book->id));
 
-        while ($post = $result->fetchObject ())
-        {
+        while ($post = $result->fetchObject ()) {
             array_push ($out, new Data ($post, $book));
         }
         return $out;
     }
 
-    public static function handleThumbnailLink ($urlParam, $height) {
+    public static function handleThumbnailLink ($urlParam, $height)
+    {
         global $config;
 
         if (is_null ($height)) {
             if (preg_match ('/feed.php/', $_SERVER["SCRIPT_NAME"])) {
                 $height = $config['cops_opds_thumbnail_height'];
-            }
-            else
-            {
+            } else {
                 $height = $config['cops_html_thumbnail_height'];
             }
         }
@@ -182,14 +194,17 @@ 
 
         if (Base::useAbsolutePath () ||
             $rel == Link::OPDS_THUMBNAIL_TYPE ||
-            ($type == "epub" && $config['cops_update_epub-metadata']))
-        {
-            if ($type != "jpg") $urlParam = addURLParameter($urlParam, "type", $type);
+            ($type == "epub" && $config['cops_update_epub-metadata'])) {
+            if ($type != "jpg") {
+                $urlParam = addURLParameter($urlParam, "type", $type);
+            }
             if ($rel == Link::OPDS_THUMBNAIL_TYPE) {
                 $urlParam = self::handleThumbnailLink($urlParam, $height);
             }
             $urlParam = addURLParameter($urlParam, "id", $book->id);
-            if (!is_null (GetUrlParam (DB))) $urlParam = addURLParameter ($urlParam, DB, GetUrlParam (DB));
+            if (!is_null (GetUrlParam (DB))) {
+                $urlParam = addURLParameter ($urlParam, DB, GetUrlParam (DB));
+            }
             if ($config['cops_thumbnail_handling'] != "1" &&
                 !empty ($config['cops_thumbnail_handling']) &&
                 $rel == Link::OPDS_THUMBNAIL_TYPE) {
@@ -197,9 +212,7 @@ 
             } else {
                 return new Link ("fetch.php?" . $urlParam, $mime, $rel, $title);
             }
-        }
-        else
-        {
+        } else {
             return new Link (str_replace('%2F','/',rawurlencode ($book->path."/".$filename)), $mime, $rel, $title);
         }
     }

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

Braces +5 added lines, -2 removed lines

@@ -8,9 +8,12 @@
 
 class LinkFacet extends Link
 {
-    public function __construct($phref, $ptitle = NULL, $pfacetGroup = NULL, $pactiveFacet = FALSE) {
+    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));
+        if (!is_null (GetUrlParam (DB))) {
+            $this->href = addURLParameter ($this->href, DB, GetUrlParam (DB));
+        }
         $this->href = parent::getScriptName() . $this->href;
     }
 }