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

Spacing +2 added lines, -2 removed lines

@@ -90,7 +90,7 @@ 
     // Counting down is faster. I'm *so* sorry.
     $len = $chunk + 1;
 
-    for ($i = -1; --$len; ) {
+    for ($i = -1; --$len;) {
       $c = $str[++$i];
       if ($remaining = $tail_bytes[$c]) {
         // UTF-8 head byte!
@@ -207,5 +207,5 @@ 
 
   $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

Spacing +14 added lines, -14 removed lines

@@ -2,11 +2,11 @@ 
 
 require_once ("config.php");
 
-function checkConfiguration () {
+function checkConfiguration() {
     global $config;
 
-    if (is_null ($config['cops_mail_configuration']) ||
-        !is_array ($config['cops_mail_configuration']) ||
+    if (is_null($config['cops_mail_configuration']) ||
+        !is_array($config['cops_mail_configuration']) ||
         empty ($config['cops_mail_configuration']["smtp.host"]) ||
         empty ($config['cops_mail_configuration']["address.from"])) {
         return "NOK. bad configuration.";
@@ -14,7 +14,7 @@ 
     return False;
 }
 
-function checkRequest ($idData, $emailDest) {
+function checkRequest($idData, $emailDest) {
     if (empty ($idData)) {
         return 'No data sent.';
     }
@@ -28,22 +28,22 @@ 
 
 global $config;
 
-if ($error = checkConfiguration ()) {
+if ($error = checkConfiguration()) {
     echo $error;
     exit;
 }
 
 $idData = $_REQUEST["data"];
 $emailDest = $_REQUEST["email"];
-if ($error = checkRequest ($idData, $emailDest)) {
+if ($error = checkRequest($idData, $emailDest)) {
     echo $error;
     exit;
 }
 
 $book = Book::getBookByDataId($idData);
-$data = $book->getDataById ($idData);
+$data = $book->getDataById($idData);
 
-if (filesize ($data->getLocalPath ()) > 10 * 1024 * 1024) {
+if (filesize($data->getLocalPath()) > 10 * 1024 * 1024) {
     echo 'Attachment too big';
     exit;
 }
@@ -65,23 +65,23 @@ 
 $mail->From = $config['cops_mail_configuration']["address.from"];
 $mail->FromName = $config['cops_title_default'];
 
-foreach (explode (";", $emailDest) as $emailAddress) {
+foreach (explode(";", $emailDest) as $emailAddress) {
     if (empty ($emailAddress)) { continue; }
     $mail->AddAddress($emailAddress);
 }
 
-$mail->AddAttachment($data->getLocalPath ());
+$mail->AddAttachment($data->getLocalPath());
 
 $mail->IsHTML(true);
-$mail->Subject = 'Sent by COPS : ' . $data->getUpdatedFilename ();
-$mail->Body    = "<h1>" . $book->title . "</h1><h2>" . $book->getAuthorsName () . "</h2>" . $book->getComment ();
+$mail->Subject = 'Sent by COPS : ' . $data->getUpdatedFilename();
+$mail->Body    = "<h1>" . $book->title . "</h1><h2>" . $book->getAuthorsName() . "</h2>" . $book->getComment();
 $mail->AltBody = "Sent by COPS";
 
 if (!$mail->Send()) {
-   echo localize ("mail.messagenotsent");
+   echo localize("mail.messagenotsent");
    echo 'Mailer Error: ' . $mail->ErrorInfo;
    exit;
 }
 
-echo localize ("mail.messagesent");
+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 = "";

Spacing +23 added lines, -23 removed lines

@@ -8,8 +8,8 @@ 
 
 require_once 'config.php';
 
-define ('VERSION', '1.0.0RC4');
-define ('DB', 'db');
+define('VERSION', '1.0.0RC4');
+define('DB', 'db');
 date_default_timezone_set($config['default_timezone']);
 
 
@@ -22,7 +22,7 @@ 
 function serverSideRender($data)
 {
     // Get the templates
-    $theme = getCurrentTemplate ();
+    $theme = getCurrentTemplate();
     $header = file_get_contents('templates/' . $theme . '/header.html');
     $footer = file_get_contents('templates/' . $theme . '/footer.html');
     $main = file_get_contents('templates/' . $theme . '/main.html');
@@ -30,8 +30,8 @@ 
     $page = file_get_contents('templates/' . $theme . '/page.html');
 
     // Generate the function for the template
-    $template = new doT ();
-    $dot = $template->template ($page, array ('bookdetail' => $bookdetail,
+    $template = new doT();
+    $dot = $template->template($page, array('bookdetail' => $bookdetail,
                                               'header' => $header,
                                               'footer' => $footer,
                                               'main' => $main));
@@ -42,7 +42,7 @@ 
     }
     // Execute the template
     if (!empty ($data)) {
-        return $dot ($data);
+        return $dot($data);
     }
 
     return NULL;
@@ -58,7 +58,7 @@ 
 
 function notFound()
 {
-    header($_SERVER['SERVER_PROTOCOL'].' 404 Not Found');
+    header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');
     header('Status: 404 Not Found');
 
     $_SERVER['REDIRECT_STATUS'] = 404;
@@ -76,8 +76,8 @@ 
 {
     global $config;
     if (isset($_COOKIE[$option])) {
-        if (isset($config ['cops_' . $option]) && is_array ($config ['cops_' . $option])) {
-            return explode (',', $_COOKIE[$option]);
+        if (isset($config ['cops_' . $option]) && is_array($config ['cops_' . $option])) {
+            return explode(',', $_COOKIE[$option]);
         } else {
             return $_COOKIE[$option];
         }
@@ -91,12 +91,12 @@ 
 
 function getCurrentCss()
 {
-    return 'templates/' . getCurrentTemplate () . '/styles/style-' . getCurrentOption('style') . '.css';
+    return 'templates/' . getCurrentTemplate() . '/styles/style-' . getCurrentOption('style') . '.css';
 }
 
 function getCurrentTemplate()
 {
-    return getCurrentOption ('template');
+    return getCurrentOption('template');
 }
 
 function getUrlWithVersion($url)
@@ -160,10 +160,10 @@ 
     libxml_use_internal_errors(true);
 
     $doc->loadHTML('<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></head><body>' .
-                        $html  . '</body></html>'); // Load the HTML
+                        $html . '</body></html>'); // Load the HTML
     $output = $doc->saveXML($doc->documentElement); // Transform to an Ansi xml stream
     $output = xml2xhtml($output);
-    if (preg_match ('#<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></meta></head><body>(.*)</body></html>#ms', $output, $matches)) {
+    if (preg_match('#<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"></meta></head><body>(.*)</body></html>#ms', $output, $matches)) {
         $output = $matches [1]; // Remove <html><body>
     }
     /*
@@ -175,7 +175,7 @@ 
     }
     */
 
-    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;
@@ -264,7 +264,7 @@ 
     //echo var_dump($langs);
     $lang_file = NULL;
     foreach ($langs as $language => $val) {
-        $temp_file = dirname(__FILE__). '/lang/Localization_' . $language . '.json';
+        $temp_file = dirname(__FILE__) . '/lang/Localization_' . $language . '.json';
         if (file_exists($temp_file)) {
             $lang = $language;
             $lang_file = $temp_file;
@@ -272,7 +272,7 @@ 
         }
     }
     if (empty ($lang_file)) {
-        $lang_file = dirname(__FILE__). '/lang/Localization_' . $lang . '.json';
+        $lang_file = dirname(__FILE__) . '/lang/Localization_' . $lang . '.json';
     }
     return array($lang, $lang_file);
 }
@@ -281,7 +281,7 @@ 
  * This method is based on this page
  * http://www.mind-it.info/2010/02/22/a-simple-approach-to-localization-in-php/
  */
-function localize($phrase, $count=-1, $reset=false)
+function localize($phrase, $count = -1, $reset = false)
 {
     global $config;
     if ($count == 0)
@@ -301,7 +301,7 @@ 
         $lang_file_en = NULL;
         list ($lang, $lang_file) = getLangAndTranslationFile();
         if ($lang != 'en') {
-            $lang_file_en = dirname(__FILE__). '/lang/' . 'Localization_en.json';
+            $lang_file_en = dirname(__FILE__) . '/lang/' . 'Localization_en.json';
         }
 
         $lang_file_content = file_get_contents($lang_file);
@@ -309,8 +309,8 @@ 
         $translations = json_decode($lang_file_content, true);
 
         /* Clean the array of all unfinished translations */
-        foreach (array_keys ($translations) as $key) {
-            if (preg_match ('/^##TODO##/', $key)) {
+        foreach (array_keys($translations) as $key) {
+            if (preg_match('/^##TODO##/', $key)) {
                 unset ($translations [$key]);
             }
         }
@@ -318,10 +318,10 @@ 
         {
             $lang_file_content = file_get_contents($lang_file_en);
             $translations_en = json_decode($lang_file_content, true);
-            $translations = array_merge ($translations_en, $translations);
+            $translations = array_merge($translations_en, $translations);
         }
     }
-    if (array_key_exists ($phrase, $translations)) {
+    if (array_key_exists($phrase, $translations)) {
         return $translations[$phrase];
     }
     return $phrase;
@@ -333,7 +333,7 @@ 
         $urlParams = '';
     }
     $start = '';
-    if (preg_match ('#^\?(.*)#', $urlParams, $matches)) {
+    if (preg_match('#^\?(.*)#', $urlParams, $matches)) {
         $start = '?';
         $urlParams = $matches[1];
     }

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

Spacing +29 added lines, -29 removed lines

@@ -24,69 +24,69 @@
         $this->sort = $post->sort;
     }
 
-    public function getUri () {
-        return "?page=".parent::PAGE_AUTHOR_DETAIL."&id=$this->id";
+    public function getUri() {
+        return "?page=" . parent::PAGE_AUTHOR_DETAIL . "&id=$this->id";
     }
 
-    public function getEntryId () {
-        return self::ALL_AUTHORS_ID.":".$this->id;
+    public function getEntryId() {
+        return self::ALL_AUTHORS_ID . ":" . $this->id;
     }
 
-    public static function getEntryIdByLetter ($startingLetter) {
-        return self::ALL_AUTHORS_ID.":letter:".$startingLetter;
+    public static function getEntryIdByLetter($startingLetter) {
+        return self::ALL_AUTHORS_ID . ":letter:" . $startingLetter;
     }
 
     public static function getCount() {
         // str_format (localize("authors.alphabetical", count(array))
-        return parent::getCountGeneric ("authors", self::ALL_AUTHORS_ID, parent::PAGE_ALL_AUTHORS);
+        return parent::getCountGeneric("authors", self::ALL_AUTHORS_ID, parent::PAGE_ALL_AUTHORS);
     }
 
     public static function getAllAuthorsByFirstLetter() {
-        list (, $result) = parent::executeQuery ("select {0}
+        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);
+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));
+            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));
         }
         return $entryArray;
     }
 
     public static function getAuthorsByStartingLetter($letter) {
-        return self::getEntryArray (self::SQL_AUTHORS_BY_FIRST_LETTER, array ($letter . "%"));
+        return self::getEntryArray(self::SQL_AUTHORS_BY_FIRST_LETTER, array($letter . "%"));
     }
 
     public static function getAuthorsForSearch($query) {
-        return self::getEntryArray (self::SQL_AUTHORS_FOR_SEARCH, array ($query . "%", $query . "%"));
+        return self::getEntryArray(self::SQL_AUTHORS_FOR_SEARCH, array($query . "%", $query . "%"));
     }
 
     public static function getAllAuthors() {
-        return self::getEntryArray (self::SQL_ALL_AUTHORS, array ());
+        return self::getEntryArray(self::SQL_ALL_AUTHORS, array());
     }
 
-    public static function getEntryArray ($query, $params) {
-        return Base::getEntryArrayWithBookNumber ($query, self::AUTHOR_COLUMNS, $params, "Author");
+    public static function getEntryArray($query, $params) {
+        return Base::getEntryArrayWithBookNumber($query, self::AUTHOR_COLUMNS, $params, "Author");
     }
 
-    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 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) {
-        $result = parent::getDb ()->prepare('select authors.id as id, authors.name as name, authors.sort as sort from authors, books_authors_link
+    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 = ?');
-        $result->execute (array ($bookId));
-        $authorArray = array ();
-        while ($post = $result->fetchObject ()) {
-            array_push ($authorArray, new Author ($post));
+        $result->execute(array($bookId));
+        $authorArray = array();
+        while ($post = $result->fetchObject()) {
+            array_push($authorArray, new Author($post));
         }
         return $authorArray;
     }

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;
 

Spacing +65 added lines, -65 removed lines

@@ -37,146 +37,146 @@ 
 
     private static $db = NULL;
 
-    public static function isMultipleDatabaseEnabled () {
+    public static function isMultipleDatabaseEnabled() {
         global $config;
-        return is_array ($config['calibre_directory']);
+        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:
+        return preg_match('/^\//', $path) || // Linux /
+               preg_match('/^\w\:/', $path); // Windows X:
     }
 
-    public static function noDatabaseSelected () {
-        return self::isMultipleDatabaseEnabled () && is_null (GetUrlParam (DB));
+    public static function noDatabaseSelected() {
+        return self::isMultipleDatabaseEnabled() && is_null(GetUrlParam(DB));
     }
 
-    public static function getDbList () {
+    public static function getDbList() {
         global $config;
-        if (self::isMultipleDatabaseEnabled ()) {
+        if (self::isMultipleDatabaseEnabled()) {
             return $config['calibre_directory'];
         } else {
-            return array ("" => $config['calibre_directory']);
+            return array("" => $config['calibre_directory']);
         }
     }
 
-    public static function getDbNameList () {
+    public static function getDbNameList() {
         global $config;
-        if (self::isMultipleDatabaseEnabled ()) {
-            return array_keys ($config['calibre_directory']);
+        if (self::isMultipleDatabaseEnabled()) {
+            return array_keys($config['calibre_directory']);
         } else {
-            return array ("");
+            return array("");
         }
     }
 
-    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 (self::isMultipleDatabaseEnabled()) {
+            if (is_null($database)) $database = GetUrlParam(DB, 0);
             if (!is_null($database) && !preg_match('/^\d+$/', $database)) {
-                self::error ($database);
+                self::error($database);
             }
-            $array = array_keys ($config['calibre_directory']);
+            $array = array_keys($config['calibre_directory']);
             return  $array[$database];
         }
         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 (self::isMultipleDatabaseEnabled()) {
+            if (is_null($database)) $database = GetUrlParam(DB, 0);
             if (!is_null($database) && !preg_match('/^\d+$/', $database)) {
-                self::error ($database);
+                self::error($database);
             }
-            $array = array_values ($config['calibre_directory']);
+            $array = array_values($config['calibre_directory']);
             return  $array[$database];
         }
         return $config['calibre_directory'];
     }
 
 
-    public static function getDbFileName ($database = NULL) {
-        return self::getDbDirectory ($database) .'metadata.db';
+    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) {
-        if (is_null (self::$db)) {
+    public static function getDb($database = NULL) {
+        if (is_null(self::$db)) {
             try {
-                if (is_readable (self::getDbFileName ($database))) {
-                    self::$db = new PDO('sqlite:'. self::getDbFileName ($database));
-                    if (useNormAndUp ()) {
-                        self::$db->sqliteCreateFunction ('normAndUp', 'normAndUp', 1);
+                if (is_readable(self::getDbFileName($database))) {
+                    self::$db = new PDO('sqlite:' . self::getDbFileName($database));
+                    if (useNormAndUp()) {
+                        self::$db->sqliteCreateFunction('normAndUp', 'normAndUp', 1);
                     }
                 } else {
-                    self::error ($database);
+                    self::error($database);
                 }
             } catch (Exception $e) {
-                self::error ($database);
+                self::error($database);
             }
         }
         return self::$db;
     }
 
-    public static function checkDatabaseAvailability () {
-        if (self::noDatabaseSelected ()) {
-            for ($i = 0; $i < count (self::getDbList ()); $i++) {
-                self::getDb ($i);
-                self::clearDb ();
+    public static function checkDatabaseAvailability() {
+        if (self::noDatabaseSelected()) {
+            for ($i = 0; $i < count(self::getDbList()); $i++) {
+                self::getDb($i);
+                self::clearDb();
             }
         } else {
-            self::getDb ();
+            self::getDb();
         }
         return true;
     }
 
-    public static function clearDb () {
+    public static function clearDb() {
         self::$db = NULL;
     }
 
-    public static function executeQuerySingle ($query, $database = NULL) {
-        return self::getDb ($database)->query($query)->fetchColumn();
+    public static function executeQuerySingle($query, $database = NULL) {
+        return self::getDb($database)->query($query)->fetchColumn();
     }
 
     public static function getCountGeneric($table, $id, $pageId, $numberOfString = NULL) {
         if (!$numberOfString) {
             $numberOfString = $table . ".alphabetical";
         }
-        $count = self::executeQuerySingle ('select count(*) from ' . $table);
+        $count = self::executeQuerySingle('select count(*) from ' . $table);
         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);
+        $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) {
         /* @var $result PDOStatement */
 
-        list (, $result) = self::executeQuery ($query, $columns, "", $params, -1);
+        list (, $result) = self::executeQuery($query, $columns, "", $params, -1);
         $entryArray = array();
-        while ($post = $result->fetchObject ())
+        while ($post = $result->fetchObject())
         {
             /* @var $instance Author|Tag|Serie|Publisher */
 
-            $instance = new $category ($post);
+            $instance = new $category($post);
             if (property_exists($post, "sort")) {
                 $title = $post->sort;
             } else {
                 $title = $post->name;
             }
-            array_push ($entryArray, new Entry ($title, $instance->getEntryId (),
-                str_format (localize("bookword", $post->count), $post->count), "text",
-                array ( new LinkNavigation ($instance->getUri ())), "", $post->count));
+            array_push($entryArray, new Entry($title, $instance->getEntryId(),
+                str_format(localize("bookword", $post->count), $post->count), "text",
+                array(new LinkNavigation($instance->getUri())), "", $post->count));
         }
         return $entryArray;
     }
@@ -184,30 +184,30 @@ 
     public static function executeQuery($query, $columns, $filter, $params, $n, $database = NULL, $numberPerPage = NULL) {
         $totalResult = -1;
 
-        if (useNormAndUp ()) {
+        if (useNormAndUp()) {
             $query = preg_replace("/upper/", "normAndUp", $query);
             $columns = preg_replace("/upper/", "normAndUp", $columns);
         }
 
-        if (is_null ($numberPerPage)) {
-            $numberPerPage = getCurrentOption ("max_item_per_page");
+        if (is_null($numberPerPage)) {
+            $numberPerPage = getCurrentOption("max_item_per_page");
         }
 
         if ($numberPerPage != -1 && $n != -1)
         {
             // First check total number of results
-            $result = self::getDb ($database)->prepare (str_format ($query, "count(*)", $filter));
-            $result->execute ($params);
-            $totalResult = $result->fetchColumn ();
+            $result = self::getDb($database)->prepare(str_format($query, "count(*)", $filter));
+            $result->execute($params);
+            $totalResult = $result->fetchColumn();
 
             // Next modify the query and params
             $query .= " limit ?, ?";
-            array_push ($params, ($n - 1) * $numberPerPage, $numberPerPage);
+            array_push($params, ($n - 1) * $numberPerPage, $numberPerPage);
         }
 
-        $result = self::getDb ($database)->prepare(str_format ($query, $columns, $filter));
-        $result->execute ($params);
-        return array ($totalResult, $result);
+        $result = self::getDb($database)->prepare(str_format($query, $columns, $filter));
+        $result->execute($params);
+        return array($totalResult, $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;

Spacing +43 added lines, -43 removed lines

@@ -59,25 +59,25 @@ 
         $this->id = $post->id;
         $this->name = $post->name;
         $this->format = $post->format;
-        $this->realFormat = str_replace ("ORIGINAL_", "", $post->format);
-        $this->extension = strtolower ($this->realFormat);
+        $this->realFormat = str_replace("ORIGINAL_", "", $post->format);
+        $this->extension = strtolower($this->realFormat);
         $this->book = $book;
     }
 
-    public function isKnownType () {
-        return array_key_exists ($this->extension, self::$mimetypes);
+    public function isKnownType() {
+        return array_key_exists($this->extension, self::$mimetypes);
     }
 
-    public function getMimeType () {
+    public function getMimeType() {
         $result = "application/octet-stream";
-        if ($this->isKnownType ()) {
+        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)
             {
-                $result = finfo_file($finfo, $this->getLocalPath ());
+                $result = finfo_file($finfo, $this->getLocalPath());
             }
 
             finfo_close($finfo);
@@ -86,82 +86,82 @@ 
         return $result;
     }
 
-    public function isEpubValidOnKobo () {
+    public function isEpubValidOnKobo() {
         return $this->format == "EPUB" || $this->format == "KEPUB";
     }
 
-    public function getFilename () {
-        return $this->name . "." . strtolower ($this->format);
+    public function getFilename() {
+        return $this->name . "." . strtolower($this->format);
     }
 
-    public function getUpdatedFilename () {
-        return $this->book->getAuthorsSort () . " - " . $this->book->title;
+    public function getUpdatedFilename() {
+        return $this->book->getAuthorsSort() . " - " . $this->book->title;
     }
 
-    public function getUpdatedFilenameEpub () {
-        return $this->getUpdatedFilename () . ".epub";
+    public function getUpdatedFilenameEpub() {
+        return $this->getUpdatedFilename() . ".epub";
     }
 
-    public function getUpdatedFilenameKepub () {
-        $str = $this->getUpdatedFilename () . ".kepub.epub";
+    public function getUpdatedFilenameKepub() {
+        $str = $this->getUpdatedFilename() . ".kepub.epub";
         return str_replace(array(':', '#', '&'),
-                           array('-', '-', ' '), $str );
+                           array('-', '-', ' '), $str);
     }
 
-    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") {
             return $this->getHtmlLinkWithRewriting($title);
         }
 
-        return self::getLink ($this->book, $this->extension, $this->getMimeType (), $rel, $this->getFilename (), $this->id, $title);
+        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 () {
-        return $this->book->path . "/" . $this->getFilename ();
+    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;
 
         if ($config['cops_provide_kepub'] == "1" &&
-            $this->isEpubValidOnKobo () &&
+            $this->isEpubValidOnKobo() &&
             preg_match("/Kobo/", $_SERVER['HTTP_USER_AGENT'])) {
-            $href .= rawurlencode ($this->getUpdatedFilenameKepub ());
+            $href .= rawurlencode($this->getUpdatedFilenameKepub());
         } else {
-            $href .= rawurlencode ($this->getFilename ());
+            $href .= rawurlencode($this->getFilename());
         }
-        return new Link ($href, $this->getMimeType (), Link::OPDS_ACQUISITION_TYPE, $title);
+        return new Link($href, $this->getMimeType(), Link::OPDS_ACQUISITION_TYPE, $title);
     }
 
-    public static function getDataByBook ($book) {
-        $out = array ();
-        $result = parent::getDb ()->prepare('select id, format, name
+    public static function getDataByBook($book) {
+        $out = array();
+        $result = parent::getDb()->prepare('select id, format, name
                                              from data where book = ?');
-        $result->execute (array ($book->id));
+        $result->execute(array($book->id));
 
-        while ($post = $result->fetchObject ())
+        while ($post = $result->fetchObject())
         {
-            array_push ($out, new Data ($post, $book));
+            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"])) {
+        if (is_null($height)) {
+            if (preg_match('/feed.php/', $_SERVER["SCRIPT_NAME"])) {
                 $height = $config['cops_opds_thumbnail_height'];
             }
             else
@@ -176,13 +176,13 @@ 
         return $urlParam;
     }
 
-    public static function getLink ($book, $type, $mime, $rel, $filename, $idData, $title = NULL, $height = NULL)
+    public static function getLink($book, $type, $mime, $rel, $filename, $idData, $title = NULL, $height = NULL)
     {
         global $config;
 
         $urlParam = addURLParameter("", "data", $idData);
 
-        if (Base::useAbsolutePath () ||
+        if (Base::useAbsolutePath() ||
             $rel == Link::OPDS_THUMBNAIL_TYPE ||
             ($type == "epub" && $config['cops_update_epub-metadata']))
         {
@@ -191,18 +191,18 @@ 
                 $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) {
-                return new Link ($config['cops_thumbnail_handling'], $mime, $rel, $title);
+                return new Link($config['cops_thumbnail_handling'], $mime, $rel, $title);
             } else {
-                return new Link ("fetch.php?" . $urlParam, $mime, $rel, $title);
+                return new Link("fetch.php?" . $urlParam, $mime, $rel, $title);
             }
         }
         else
         {
-            return new Link (str_replace('%2F','/',rawurlencode ($book->path."/".$filename)), $mime, $rel, $title);
+            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));

Spacing +2 added lines, -2 removed lines

@@ -9,8 +9,8 @@
 class LinkFacet extends Link
 {
     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));
+        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));
         $this->href = parent::getScriptName() . $this->href;
     }
 }

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

Spacing +4 added lines, -4 removed lines

@@ -9,10 +9,10 @@
 class LinkNavigation extends Link
 {
     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));
-        if (!preg_match ("#^\?(.*)#", $this->href) && !empty ($this->href)) $this->href = "?" . $this->href;
-        if (preg_match ("/(bookdetail|getJSON).php/", parent::getScriptName())) {
+        parent::__construct($phref, Link::OPDS_NAVIGATION_TYPE, $prel, $ptitle);
+        if (!is_null(GetUrlParam(DB))) $this->href = addURLParameter($this->href, DB, GetUrlParam(DB));
+        if (!preg_match("#^\?(.*)#", $this->href) && !empty ($this->href)) $this->href = "?" . $this->href;
+        if (preg_match("/(bookdetail|getJSON).php/", parent::getScriptName())) {
             $this->href = "index.php" . $this->href;
         } else {
             $this->href = parent::getScriptName() . $this->href;

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

Spacing +40 added lines, -40 removed lines

@@ -8,10 +8,10 @@ 
 
 class PageCustomize extends Page
 {
-    private function isChecked ($key, $testedValue = 1) {
-        $value = getCurrentOption ($key);
-        if (is_array ($value)) {
-            if (in_array ($testedValue, $value)) {
+    private function isChecked($key, $testedValue = 1) {
+        $value = getCurrentOption($key);
+        if (is_array($value)) {
+            if (in_array($testedValue, $value)) {
                 return "checked='checked'";
             }
         } else {
@@ -22,29 +22,29 @@ 
         return "";
     }
 
-    private function isSelected ($key, $value) {
-        if (getCurrentOption ($key) == $value) {
+    private function isSelected($key, $value) {
+        if (getCurrentOption($key) == $value) {
             return "selected='selected'";
         }
         return "";
     }
 
-    private function getStyleList () {
-        $result = array ();
-        foreach (glob ("templates/" . getCurrentTemplate () . "/styles/style-*.css") as $filename) {
-            if (preg_match ('/styles\/style-(.*?)\.css/', $filename, $m)) {
-                array_push ($result, $m [1]);
+    private function getStyleList() {
+        $result = array();
+        foreach (glob("templates/" . getCurrentTemplate() . "/styles/style-*.css") as $filename) {
+            if (preg_match('/styles\/style-(.*?)\.css/', $filename, $m)) {
+                array_push($result, $m [1]);
             }
         }
         return $result;
     }
 
-    public function InitializeContent ()
+    public function InitializeContent()
     {
-        $this->title = localize ("customize.title");
-        $this->entryArray = array ();
+        $this->title = localize("customize.title");
+        $this->entryArray = array();
 
-        $ignoredBaseArray = array (PageQueryResult::SCOPE_AUTHOR,
+        $ignoredBaseArray = array(PageQueryResult::SCOPE_AUTHOR,
                                    PageQueryResult::SCOPE_TAG,
                                    PageQueryResult::SCOPE_SERIES,
                                    PageQueryResult::SCOPE_PUBLISHER,
@@ -52,49 +52,49 @@ 
                                    "language");
 
         $content = "";
-        array_push ($this->entryArray, new Entry ("Template", "",
+        array_push($this->entryArray, new Entry("Template", "",
                                         "<span style='cursor: pointer;' onclick='$.cookie(\"template\", \"bootstrap\", { expires: 365 });window.location=$(\".headleft\").attr(\"href\");'>Click to switch to Bootstrap</span>", "text",
-                                        array ()));
+                                        array()));
         if (!preg_match("/(Kobo|Kindle\/3.0|EBRD1101)/", $_SERVER['HTTP_USER_AGENT'])) {
             $content .= '<select id="style" onchange="updateCookie (this);">';
-            foreach ($this-> getStyleList () as $filename) {
-                $content .= "<option value='{$filename}' " . $this->isSelected ("style", $filename) . ">{$filename}</option>";
+            foreach ($this-> getStyleList() as $filename) {
+                $content .= "<option value='{$filename}' " . $this->isSelected("style", $filename) . ">{$filename}</option>";
             }
             $content .= '</select>';
         } else {
-            foreach ($this-> getStyleList () as $filename) {
-                $content .= "<input type='radio' onchange='updateCookieFromCheckbox (this);' id='style-{$filename}' name='style' value='{$filename}' " . $this->isChecked ("style", $filename) . " /><label for='style-{$filename}'> {$filename} </label>";
+            foreach ($this-> getStyleList() as $filename) {
+                $content .= "<input type='radio' onchange='updateCookieFromCheckbox (this);' id='style-{$filename}' name='style' value='{$filename}' " . $this->isChecked("style", $filename) . " /><label for='style-{$filename}'> {$filename} </label>";
             }
         }
-        array_push ($this->entryArray, new Entry (localize ("customize.style"), "",
+        array_push($this->entryArray, new Entry(localize("customize.style"), "",
                                         $content, "text",
-                                        array ()));
-        if (!useServerSideRendering ()) {
-            $content = '<input type="checkbox" onchange="updateCookieFromCheckbox (this);" id="use_fancyapps" ' . $this->isChecked ("use_fancyapps") . ' />';
-            array_push ($this->entryArray, new Entry (localize ("customize.fancybox"), "",
+                                        array()));
+        if (!useServerSideRendering()) {
+            $content = '<input type="checkbox" onchange="updateCookieFromCheckbox (this);" id="use_fancyapps" ' . $this->isChecked("use_fancyapps") . ' />';
+            array_push($this->entryArray, new Entry(localize("customize.fancybox"), "",
                                             $content, "text",
-                                            array ()));
+                                            array()));
         }
-        $content = '<input type="number" onchange="updateCookie (this);" id="max_item_per_page" value="' . getCurrentOption ("max_item_per_page") . '" min="-1" max="1200" pattern="^[-+]?[0-9]+$" />';
-        array_push ($this->entryArray, new Entry (localize ("customize.paging"), "",
+        $content = '<input type="number" onchange="updateCookie (this);" id="max_item_per_page" value="' . getCurrentOption("max_item_per_page") . '" min="-1" max="1200" pattern="^[-+]?[0-9]+$" />';
+        array_push($this->entryArray, new Entry(localize("customize.paging"), "",
                                         $content, "text",
-                                        array ()));
-        $content = '<input type="text" onchange="updateCookie (this);" id="email" value="' . getCurrentOption ("email") . '" />';
-        array_push ($this->entryArray, new Entry (localize ("customize.email"), "",
+                                        array()));
+        $content = '<input type="text" onchange="updateCookie (this);" id="email" value="' . getCurrentOption("email") . '" />';
+        array_push($this->entryArray, new Entry(localize("customize.email"), "",
                                         $content, "text",
-                                        array ()));
-        $content = '<input type="checkbox" onchange="updateCookieFromCheckbox (this);" id="html_tag_filter" ' . $this->isChecked ("html_tag_filter") . ' />';
-        array_push ($this->entryArray, new Entry (localize ("customize.filter"), "",
+                                        array()));
+        $content = '<input type="checkbox" onchange="updateCookieFromCheckbox (this);" id="html_tag_filter" ' . $this->isChecked("html_tag_filter") . ' />';
+        array_push($this->entryArray, new Entry(localize("customize.filter"), "",
                                         $content, "text",
-                                        array ()));
+                                        array()));
         $content = "";
         foreach ($ignoredBaseArray as $key) {
-            $keyPlural = preg_replace ('/(ss)$/', 's', $key . "s");
-            $content .=  '<input type="checkbox" name="ignored_categories[]" onchange="updateCookieFromCheckboxGroup (this);" id="ignored_categories_' . $key . '" ' . $this->isChecked ("ignored_categories", $key) . ' > ' . localize ("{$keyPlural}.title") . '</input> ';
+            $keyPlural = preg_replace('/(ss)$/', 's', $key . "s");
+            $content .= '<input type="checkbox" name="ignored_categories[]" onchange="updateCookieFromCheckboxGroup (this);" id="ignored_categories_' . $key . '" ' . $this->isChecked("ignored_categories", $key) . ' > ' . localize("{$keyPlural}.title") . '</input> ';
         }
 
-        array_push ($this->entryArray, new Entry (localize ("customize.ignored"), "",
+        array_push($this->entryArray, new Entry(localize("customize.ignored"), "",
                                         $content, "text",
-                                        array ()));
+                                        array()));
     }
 }