mbirth / cops

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 +27 added lines, -15 removed lines

@@ -6,7 +6,8 @@ 
  * @author     Sébastien Lucas <sebastien@slucas.fr>
  */
 
-class Author extends Base {
+class Author extends Base
+{
     const ALL_AUTHORS_ID = "cops:authors";
 
     const AUTHOR_COLUMNS = "authors.id as id, authors.name as name, authors.sort as sort, count(*) as count";
@@ -18,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));
@@ -56,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 = ?');

base.php

Doc Comments +50 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 = "";
@@ -369,6 +380,9 @@ 
         return $this->href;
     }
 
+    /**
+     * @return string
+     */
     public function getScriptName() {
         $parts = explode('/', $_SERVER["SCRIPT_NAME"]);
         return $parts[count($parts) - 1];
@@ -377,6 +391,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));
@@ -391,6 +408,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));
@@ -471,6 +491,12 @@ 
 {
     public $book;
 
+    /**
+     * @param string $pid
+     * @param string $pcontent
+     * @param string $pcontentType
+     * @param Book $pbook
+     */
     public function __construct($ptitle, $pid, $pcontent, $pcontentType, $plinkArray, $pbook) {
         parent::__construct ($ptitle, $pid, $pcontent, $pcontentType, $plinkArray);
         $this->book = $pbook;
@@ -1044,6 +1070,9 @@ 
 
 class PageCustomize extends Page
 {
+    /**
+     * @param string $key
+     */
     private function isChecked ($key, $testedValue = 1) {
         $value = getCurrentOption ($key);
         if (is_array ($value)) {
@@ -1058,6 +1087,9 @@ 
         return "";
     }
 
+    /**
+     * @param string $key
+     */
     private function isSelected ($key, $value) {
         if (getCurrentOption ($key) == $value) {
             return "selected='selected'";
@@ -1214,6 +1246,9 @@ 
         return "";
     }
 
+    /**
+     * @return string
+     */
     public static function getDbDirectory ($database = NULL) {
         global $config;
         if (self::isMultipleDatabaseEnabled ()) {
@@ -1273,10 +1308,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";
@@ -1289,6 +1332,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();
@@ -1307,6 +1354,9 @@ 
         return $entryArray;
     }
 
+    /**
+     * @param string $filter
+     */
     public static function executeQuery($query, $columns, $filter, $params, $n, $database = NULL, $numberPerPage = NULL) {
         $totalResult = -1;
 

Braces +186 added lines, -99 removed lines

@@ -13,12 +13,14 @@ 
 date_default_timezone_set($config['default_timezone']);
 
 
-function useServerSideRendering () {
+function useServerSideRendering ()
+{
     global $config;
     return preg_match("/" . $config['cops_server_side_render'] . "/", $_SERVER['HTTP_USER_AGENT']);
 }
 
-function serverSideRender ($data) {
+function serverSideRender ($data)
+{
     // Get the templates
     $theme = getCurrentTemplate ();
     $header = file_get_contents('templates/' . $theme . '/header.html');
@@ -46,28 +48,32 @@ 
     return NULL;
 }
 
-function getQueryString () {
+function getQueryString ()
+{
     if ( isset($_SERVER['QUERY_STRING']) ) {
         return $_SERVER['QUERY_STRING'];
     }
     return "";
 }
 
-function notFound () {
+function notFound ()
+{
     header($_SERVER["SERVER_PROTOCOL"]." 404 Not Found");
     header("Status: 404 Not Found");
 
     $_SERVER['REDIRECT_STATUS'] = 404;
 }
 
-function getURLParam ($name, $default = NULL) {
+function getURLParam ($name, $default = NULL)
+{
     if (!empty ($_GET) && isset($_GET[$name]) && $_GET[$name] != "") {
         return $_GET[$name];
     }
     return $default;
 }
 
-function getCurrentOption ($option) {
+function getCurrentOption ($option)
+{
     global $config;
     if (isset($_COOKIE[$option])) {
         if (isset($config ["cops_" . $option]) && is_array ($config ["cops_" . $option])) {
@@ -83,19 +89,23 @@ 
     return "";
 }
 
-function getCurrentCss () {
+function getCurrentCss ()
+{
     return "templates/" . getCurrentTemplate () . "/styles/style-" . getCurrentOption ("style") . ".css";
 }
 
-function getCurrentTemplate () {
+function getCurrentTemplate ()
+{
     return getCurrentOption ("template");
 }
 
-function getUrlWithVersion ($url) {
+function getUrlWithVersion ($url)
+{
     return $url . "?v=" . VERSION;
 }
 
-function xml2xhtml($xml) {
+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");
         return in_array($m[1], $xhtml_tags) ? "<$m[1]$m[2] />" : "<$m[1]$m[2]></$m[1]>";
@@ -135,12 +145,15 @@ 
     $errors = libxml_get_errors();
 
     foreach ($errors as $error) {
-        if ($error->code == 801) return false;
+        if ($error->code == 801) {
+            return false;
+        }
     }
     return true;
 }
 
-function html2xhtml ($html) {
+function html2xhtml ($html)
+{
     $doc = new DOMDocument();
     libxml_use_internal_errors(true);
 
@@ -160,7 +173,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;
@@ -170,7 +185,8 @@ 
  * This method is a direct copy-paste from
  * http://tmont.com/blargh/2010/1/string-format-in-php
  */
-function str_format($format) {
+function str_format($format)
+{
     $args = func_get_args();
     $format = array_shift($args);
 
@@ -190,7 +206,8 @@ 
  * languages id are normalized : fr-fr -> fr_FR
  * @return array of languages
  */
-function getAcceptLanguages() {
+function getAcceptLanguages()
+{
     $langs = array();
 
     if (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
@@ -218,7 +235,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
@@ -233,14 +252,14 @@ 
  * Find the best translation file possible based on the accepted languages
  * @return array of language and language file
  */
-function getLangAndTranslationFile() {
+function getLangAndTranslationFile()
+{
     global $config;
     $langs = array();
     $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);
@@ -263,14 +282,18 @@ 
  * 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)
-        $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;
@@ -295,8 +318,7 @@ 
                 unset ($translations [$key]);
             }
         }
-        if ($lang_file_en)
-        {
+        if ($lang_file_en) {
             $lang_file_content = file_get_contents($lang_file_en);
             $translations_en = json_decode($lang_file_content, true);
             $translations = array_merge ($translations_en, $translations);
@@ -308,7 +330,8 @@ 
     return $phrase;
 }
 
-function addURLParameter($urlParams, $paramName, $paramValue) {
+function addURLParameter($urlParams, $paramName, $paramValue)
+{
     if (empty ($urlParams)) {
         $urlParams = "";
     }
@@ -327,17 +350,20 @@ 
     return $start . http_build_query($params);
 }
 
-function useNormAndUp () {
+function useNormAndUp ()
+{
     global $config;
     return $config ['cops_normalized_search'] == "1";
 }
 
-function normalizeUtf8String( $s) {
+function normalizeUtf8String( $s)
+{
     include_once 'transliteration.php';
     return _transliteration_process($s);
 }
 
-function normAndUp ($s) {
+function normAndUp ($s)
+{
     return mb_strtoupper (normalizeUtf8String($s), 'UTF-8');
 }
 
@@ -356,7 +382,8 @@ 
     public $facetGroup;
     public $activeFacet;
 
-    public function __construct($phref, $ptype, $prel = NULL, $ptitle = NULL, $pfacetGroup = NULL, $pactiveFacet = FALSE) {
+    public function __construct($phref, $ptype, $prel = NULL, $ptitle = NULL, $pfacetGroup = NULL, $pactiveFacet = FALSE)
+    {
         $this->href = $phref;
         $this->type = $ptype;
         $this->rel = $prel;
@@ -365,11 +392,13 @@ 
         $this->activeFacet = $pactiveFacet;
     }
 
-    public function hrefXhtml () {
+    public function hrefXhtml ()
+    {
         return $this->href;
     }
 
-    public function getScriptName() {
+    public function getScriptName()
+    {
         $parts = explode('/', $_SERVER["SCRIPT_NAME"]);
         return $parts[count($parts) - 1];
     }
@@ -377,10 +406,15 @@ 
 
 class LinkNavigation extends Link
 {
-    public function __construct($phref, $prel = NULL, $ptitle = NULL) {
+    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 (!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 {
@@ -391,9 +425,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;
     }
 }
@@ -423,7 +460,8 @@ 
         Publisher::ALL_PUBLISHERS_ID => 'images/publisher.png'
     );
 
-    public function getUpdatedTime () {
+    public function getUpdatedTime ()
+    {
         if (!is_null ($this->localUpdated)) {
             return date (DATE_ATOM, $this->localUpdated);
         }
@@ -433,7 +471,8 @@ 
         return date (DATE_ATOM, self::$updated);
     }
 
-    public function getNavLink () {
+    public function getNavLink ()
+    {
         foreach ($this->linkArray as $link) {
             if ($link->type != Link::OPDS_NAVIGATION_TYPE) { continue; }
 
@@ -442,7 +481,8 @@ 
         return "#";
     }
 
-    public function __construct($ptitle, $pid, $pcontent, $pcontentType, $plinkArray, $pclass = "", $pcount = 0) {
+    public function __construct($ptitle, $pid, $pcontent, $pcontentType, $plinkArray, $pclass = "", $pcount = 0)
+    {
         global $config;
         $this->title = $ptitle;
         $this->id = $pid;
@@ -452,10 +492,8 @@ 
         $this->className = $pclass;
         $this->numberOfElement = $pcount;
 
-        if ($config['cops_show_icons'] == 1)
-        {
-            foreach (self::$icons as $reg => $image)
-            {
+        if ($config['cops_show_icons'] == 1) {
+            foreach (self::$icons as $reg => $image) {
                 if (preg_match ("/" . $reg . "/", $pid)) {
                     array_push ($this->linkArray, new Link (getUrlWithVersion ($image), "image/png", Link::OPDS_THUMBNAIL_TYPE));
                     break;
@@ -463,7 +501,9 @@ 
             }
         }
 
-        if (!is_null (GetUrlParam (DB))) $this->id = str_replace ("cops:", "cops:" . GetUrlParam (DB) . ":", $this->id);
+        if (!is_null (GetUrlParam (DB))) {
+            $this->id = str_replace ("cops:", "cops:" . GetUrlParam (DB) . ":", $this->id);
+        }
     }
 }
 
@@ -471,24 +511,29 @@ 
 {
     public $book;
 
-    public function __construct($ptitle, $pid, $pcontent, $pcontentType, $plinkArray, $pbook) {
+    public function __construct($ptitle, $pid, $pcontent, $pcontentType, $plinkArray, $pbook)
+    {
         parent::__construct ($ptitle, $pid, $pcontent, $pcontentType, $plinkArray);
         $this->book = $pbook;
         $this->localUpdated = $pbook->timestamp;
     }
 
-    public function getCoverThumbnail () {
+    public function getCoverThumbnail ()
+    {
         foreach ($this->linkArray as $link) {
-            if ($link->rel == Link::OPDS_THUMBNAIL_TYPE)
-                return $link->hrefXhtml ();
+            if ($link->rel == Link::OPDS_THUMBNAIL_TYPE) {
+                            return $link->hrefXhtml ();
+            }
         }
         return null;
     }
 
-    public function getCover () {
+    public function getCover ()
+    {
         foreach ($this->linkArray as $link) {
-            if ($link->rel == Link::OPDS_IMAGE_TYPE)
-                return $link->hrefXhtml ();
+            if ($link->rel == Link::OPDS_IMAGE_TYPE) {
+                            return $link->hrefXhtml ();
+            }
         }
         return null;
     }
@@ -564,7 +609,8 @@ 
         }
     }
 
-    public function __construct($pid, $pquery, $pn) {
+    public function __construct($pid, $pquery, $pn)
+    {
         global $config;
 
         $this->idGet = $pid;
@@ -597,23 +643,33 @@ 
             }
             if (!in_array (PageQueryResult::SCOPE_SERIES, getCurrentOption ('ignored_categories'))) {
                 $series = Serie::getCount();
-                if (!is_null ($series)) array_push ($this->entryArray, $series);
+                if (!is_null ($series)) {
+                    array_push ($this->entryArray, $series);
+                }
             }
             if (!in_array (PageQueryResult::SCOPE_PUBLISHER, getCurrentOption ('ignored_categories'))) {
                 $publisher = Publisher::getCount();
-                if (!is_null ($publisher)) array_push ($this->entryArray, $publisher);
+                if (!is_null ($publisher)) {
+                    array_push ($this->entryArray, $publisher);
+                }
             }
             if (!in_array (PageQueryResult::SCOPE_TAG, getCurrentOption ('ignored_categories'))) {
                 $tags = Tag::getCount();
-                if (!is_null ($tags)) array_push ($this->entryArray, $tags);
+                if (!is_null ($tags)) {
+                    array_push ($this->entryArray, $tags);
+                }
             }
             if (!in_array (PageQueryResult::SCOPE_RATING, getCurrentOption ('ignored_categories'))) {
                 $rating = Rating::getCount();
-                if (!is_null ($rating)) array_push ($this->entryArray, $rating);
+                if (!is_null ($rating)) {
+                    array_push ($this->entryArray, $rating);
+                }
             }
             if (!in_array ("language", getCurrentOption ('ignored_categories'))) {
                 $languages = Language::getCount();
-                if (!is_null ($languages)) array_push ($this->entryArray, $languages);
+                if (!is_null ($languages)) {
+                    array_push ($this->entryArray, $languages);
+                }
             }
             foreach ($config['cops_calibre_custom_column'] as $lookup) {
                 $customId = CustomColumn::getCustomId ($lookup);
@@ -623,7 +679,9 @@ 
             }
             $this->entryArray = array_merge ($this->entryArray, Book::getCount());
 
-            if (Base::isMultipleDatabaseEnabled ()) $this->title =  Base::getDbName ();
+            if (Base::isMultipleDatabaseEnabled ()) {
+                $this->title =  Base::getDbName ();
+            }
         }
     }
 
@@ -659,8 +717,12 @@ 
 
     public function containsBook ()
     {
-        if (count ($this->entryArray) == 0) return false;
-        if (get_class ($this->entryArray [0]) == "EntryBook") return true;
+        if (count ($this->entryArray) == 0) {
+            return false;
+        }
+        if (get_class ($this->entryArray [0]) == "EntryBook") {
+            return true;
+        }
         return false;
     }
 }
@@ -672,8 +734,7 @@ 
         $this->title = localize("authors.title");
         if (getCurrentOption ("author_split_first_letter") == 1) {
             $this->entryArray = Author::getAllAuthorsByFirstLetter();
-        }
-        else {
+        } else {
             $this->entryArray = Author::getAllAuthors();
         }
         $this->idPage = Author::ALL_AUTHORS_ID;
@@ -836,8 +897,7 @@ 
         $this->title = localize ("allbooks.title");
         if (getCurrentOption ("titles_split_first_letter") == 1) {
             $this->entryArray = Book::getAllBooks();
-        }
-        else {
+        } else {
             list ($this->entryArray, $this->totalNumber) = Book::getBooks ($this->n);
         }
         $this->idPage = Book::ALL_BOOKS_ID;
@@ -852,8 +912,9 @@ 
         $this->idPage = Book::getEntryIdByLetter ($this->idGet);
 
         $count = $this->totalNumber;
-        if ($count == -1)
-            $count = count ($this->entryArray);
+        if ($count == -1) {
+                    $count = count ($this->entryArray);
+        }
 
         $this->title = str_format (localize ("splitByLetter.letter"), str_format (localize ("bookword", $count), $count), $this->idGet);
     }
@@ -878,11 +939,13 @@ 
     const SCOPE_BOOK = "book";
     const SCOPE_PUBLISHER = "publisher";
 
-    private function useTypeahead () {
+    private function useTypeahead ()
+    {
         return !is_null (getURLParam ("search"));
     }
 
-    private function searchByScope ($scope, $limit = FALSE) {
+    private function searchByScope ($scope, $limit = FALSE)
+    {
         $n = $this->n;
         $numberPerPage = NULL;
         $queryNormedAndUp = $this->query;
@@ -917,7 +980,8 @@ 
         return $array;
     }
 
-    public function doSearchByCategory () {
+    public function doSearchByCategory ()
+    {
         $database = GetUrlParam (DB);
         $out = array ();
         $pagequery = Base::PAGE_OPENSEARCH_QUERY;
@@ -1044,7 +1108,8 @@ 
 
 class PageCustomize extends Page
 {
-    private function isChecked ($key, $testedValue = 1) {
+    private function isChecked ($key, $testedValue = 1)
+    {
         $value = getCurrentOption ($key);
         if (is_array ($value)) {
             if (in_array ($testedValue, $value)) {
@@ -1058,14 +1123,16 @@ 
         return "";
     }
 
-    private function isSelected ($key, $value) {
+    private function isSelected ($key, $value)
+    {
         if (getCurrentOption ($key) == $value) {
             return "selected='selected'";
         }
         return "";
     }
 
-    private function getStyleList () {
+    private function getStyleList ()
+    {
         $result = array ();
         foreach (glob ("templates/" . getCurrentTemplate () . "/styles/style-*.css") as $filename) {
             if (preg_match ('/styles\/style-(.*?)\.css/', $filename, $m)) {
@@ -1167,23 +1234,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'];
@@ -1192,7 +1263,8 @@ 
         }
     }
 
-    public static function getDbNameList () {
+    public static function getDbNameList ()
+    {
         global $config;
         if (self::isMultipleDatabaseEnabled ()) {
             return array_keys ($config['calibre_directory']);
@@ -1201,10 +1273,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);
             }
@@ -1214,10 +1289,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);
             }
@@ -1228,18 +1306,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))) {
@@ -1257,7 +1338,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);
@@ -1269,31 +1351,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;
@@ -1307,7 +1394,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 ()) {
@@ -1319,8 +1407,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);

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 +105 added lines, -82 removed lines

@@ -38,7 +38,8 @@ 
 define ('SQL_BOOKS_BY_RATING', "select {0} from books " . SQL_BOOKS_LEFT_JOIN . "
                                                     where books_ratings_link.book = books.id and ratings.id = ? {1} order by sort");
 
-class Book extends Base {
+class Book extends Base
+{
     const ALL_BOOKS_UUID = "urn:uuid";
     const ALL_BOOKS_ID = "cops:books";
     const ALL_RECENT_BOOKS_ID = "cops:recentbooks";
@@ -79,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);
@@ -97,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
@@ -158,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 ();
 
@@ -175,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 ()));
     }
 
@@ -197,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)) {
@@ -239,7 +257,8 @@ 
         return reset ($reduced);
     }
 
-    public function getRating () {
+    public function getRating ()
+    {
         if (is_null ($this->rating) || $this->rating == 0) {
             return "";
         }
@@ -253,7 +272,8 @@ 
         return $retour;
     }
 
-    public function getPubDate () {
+    public function getPubDate ()
+    {
         if (empty ($this->pubdate)) {
             return "";
         }
@@ -264,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;
         });
@@ -289,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;
         }
     }
@@ -315,8 +330,7 @@ 
         global $config;
         $data = $this->getDataById ($idData);
 
-        try
-        {
+        try {
             $epub = new EPub ($data->getLocalPath ());
 
             $epub->Title ($this->title);
@@ -339,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;
         }
@@ -385,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));
             }
         }
@@ -413,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();
@@ -442,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;
@@ -500,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,
@@ -511,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 {
@@ -524,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));
@@ -544,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 ());
         }
@@ -560,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;

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 +44 added lines, -30 removed lines

@@ -6,7 +6,8 @@ 
  * @author     Sébastien Lucas <sebastien@slucas.fr>
  */
 
-class Data extends Base {
+class Data extends Base
+{
     public $id;
     public $name;
     public $format;
@@ -54,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;
@@ -63,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 ());
             }
 
@@ -85,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") {
@@ -115,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;
 
@@ -141,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'];
             }
         }
@@ -181,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) {
@@ -196,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);
         }
     }

rating.php

Doc Comments +3 added lines

@@ -36,6 +36,9 @@
         return self::getEntryArray (self::SQL_ALL_RATINGS, array ());
     }
 
+    /**
+     * @param string $query
+     */
     public static function getEntryArray ($query, $params) {
         list (, $result) = parent::executeQuery ($query, self::RATING_COLUMNS, "", $params, -1);
         $entryArray = array();

Braces +17 added lines, -10 removed lines

@@ -6,7 +6,8 @@ 
  * @author     Michael Pfitzner
  */
 
-class Rating extends Base {
+class Rating extends Base
+{
     const ALL_RATING_ID = "cops:rating";
 
     const RATING_COLUMNS = "ratings.id as id, ratings.rating as rating, count(*) as count";
@@ -14,33 +15,38 @@ 
     public $id;
     public $name;
 
-    public function __construct($pid, $pname) {
+    public function __construct($pid, $pname)
+    {
         $this->id = $pid;
         $this->name = $pname;
     }
 
-    public function getUri () {
+    public function getUri ()
+    {
         return "?page=".parent::PAGE_RATING_DETAIL."&id=$this->id";
     }
 
-    public function getEntryId () {
+    public function getEntryId ()
+    {
         return self::ALL_RATING_ID.":".$this->id;
     }
 
-    public static function getCount() {
+    public static function getCount()
+    {
         // str_format (localize("ratings", count(array))
         return parent::getCountGeneric ("ratings", self::ALL_RATING_ID, parent::PAGE_ALL_RATINGS, "ratings");
     }
 
-    public static function getAllRatings() {
+    public static function getAllRatings()
+    {
         return self::getEntryArray (self::SQL_ALL_RATINGS, array ());
     }
 
-    public static function getEntryArray ($query, $params) {
+    public static function getEntryArray ($query, $params)
+    {
         list (, $result) = parent::executeQuery ($query, self::RATING_COLUMNS, "", $params, -1);
         $entryArray = array();
-        while ($post = $result->fetchObject ())
-        {
+        while ($post = $result->fetchObject ()) {
             $ratingObj = new Rating ($post->id, $post->rating);
             $rating=$post->rating/2;
             $rating = str_format (localize("ratingword", $rating), $rating);
@@ -51,7 +57,8 @@ 
         return $entryArray;
     }
 
-    public static function getRatingById ($ratingId) {
+    public static function getRatingById ($ratingId)
+    {
         $result = parent::getDb ()->prepare('select rating from ratings where id = ?');
         $result->execute (array ($ratingId));
         return new Rating ($ratingId, $result->fetchColumn ());

tag.php

Doc Comments +3 added lines

@@ -45,6 +45,9 @@
         return Base::getEntryArrayWithBookNumber (self::SQL_ALL_TAGS, self::TAG_COLUMNS, array (), "Tag");
     }
 
+    /**
+     * @param integer $numberPerPage
+     */
     public static function getAllTagsByQuery($query, $n, $database = NULL, $numberPerPage = NULL) {
         $columns  = "tags.id as id, tags.name as name, (select count(*) from books_tags_link where tags.id = tag) as count";
         $sql = 'select {0} from tags where upper (tags.name) like ? {1} order by tags.name';

Braces +17 added lines, -10 removed lines

@@ -6,7 +6,8 @@ 
  * @author     Sébastien Lucas <sebastien@slucas.fr>
  */
 
-class Tag extends Base {
+class Tag extends Base
+{
     const ALL_TAGS_ID = "cops:tags";
     const TAG_COLUMNS = "tags.id as id, tags.name as name, count(*) as count";
     const SQL_ALL_TAGS = "select {0} from tags, books_tags_link where tags.id = tag group by tags.id, tags.name order by tags.name";
@@ -14,25 +15,30 @@ 
     public $id;
     public $name;
 
-    public function __construct($post) {
+    public function __construct($post)
+    {
         $this->id = $post->id;
         $this->name = $post->name;
     }
 
-    public function getUri () {
+    public function getUri ()
+    {
         return "?page=".parent::PAGE_TAG_DETAIL."&id=$this->id";
     }
 
-    public function getEntryId () {
+    public function getEntryId ()
+    {
         return self::ALL_TAGS_ID.":".$this->id;
     }
 
-    public static function getCount() {
+    public static function getCount()
+    {
         // str_format (localize("tags.alphabetical", count(array))
         return parent::getCountGeneric ("tags", self::ALL_TAGS_ID, parent::PAGE_ALL_TAGS);
     }
 
-    public static function getTagById ($tagId) {
+    public static function getTagById ($tagId)
+    {
         $result = parent::getDb ()->prepare('select id, name  from tags where id = ?');
         $result->execute (array ($tagId));
         if ($post = $result->fetchObject ()) {
@@ -41,17 +47,18 @@ 
         return NULL;
     }
 
-    public static function getAllTags() {
+    public static function getAllTags()
+    {
         return Base::getEntryArrayWithBookNumber (self::SQL_ALL_TAGS, self::TAG_COLUMNS, array (), "Tag");
     }
 
-    public static function getAllTagsByQuery($query, $n, $database = NULL, $numberPerPage = NULL) {
+    public static function getAllTagsByQuery($query, $n, $database = NULL, $numberPerPage = NULL)
+    {
         $columns  = "tags.id as id, tags.name as name, (select count(*) from books_tags_link where tags.id = tag) as count";
         $sql = 'select {0} from tags where upper (tags.name) like ? {1} order by tags.name';
         list ($totalNumber, $result) = parent::executeQuery ($sql, $columns, "", array ('%' . $query . '%'), $n, $database, $numberPerPage);
         $entryArray = array();
-        while ($post = $result->fetchObject ())
-        {
+        while ($post = $result->fetchObject ()) {
             $tag = new Tag ($post);
             array_push ($entryArray, new Entry ($tag->name, $tag->getEntryId (),
                 str_format (localize("bookword", $post->count), $post->count), "text",

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

serie.php

Braces +18 added lines, -9 removed lines

@@ -6,7 +6,8 @@ 
  * @author     Sébastien Lucas <sebastien@slucas.fr>
  */
 
-class Serie extends Base {
+class Serie extends Base
+{
     const ALL_SERIES_ID = "cops:series";
     const SERIES_COLUMNS = "series.id as id, series.name as name, series.sort as sort, count(*) as count";
     const SQL_ALL_SERIES = "select {0} from series, books_series_link where series.id = series group by series.id, series.name, series.sort order by series.sort";
@@ -15,25 +16,30 @@ 
     public $id;
     public $name;
 
-    public function __construct($post) {
+    public function __construct($post)
+    {
         $this->id = $post->id;
         $this->name = $post->name;
     }
 
-    public function getUri () {
+    public function getUri ()
+    {
         return "?page=".parent::PAGE_SERIE_DETAIL."&id=$this->id";
     }
 
-    public function getEntryId () {
+    public function getEntryId ()
+    {
         return self::ALL_SERIES_ID.":".$this->id;
     }
 
-    public static function getCount() {
+    public static function getCount()
+    {
         // str_format (localize("series.alphabetical", count(array))
         return parent::getCountGeneric ("series", self::ALL_SERIES_ID, parent::PAGE_ALL_SERIES);
     }
 
-    public static function getSerieByBookId ($bookId) {
+    public static function getSerieByBookId ($bookId)
+    {
         $result = parent::getDb ()->prepare('select  series.id as id, name
 from books_series_link, series
 where series.id = series and book = ?');
@@ -44,7 +50,8 @@ 
         return NULL;
     }
 
-    public static function getSerieById ($serieId) {
+    public static function getSerieById ($serieId)
+    {
         $result = parent::getDb ()->prepare('select id, name  from series where id = ?');
         $result->execute (array ($serieId));
         if ($post = $result->fetchObject ()) {
@@ -53,11 +60,13 @@ 
         return NULL;
     }
 
-    public static function getAllSeries() {
+    public static function getAllSeries()
+    {
         return Base::getEntryArrayWithBookNumber (self::SQL_ALL_SERIES, self::SERIES_COLUMNS, array (), "Serie");
     }
 
-    public static function getAllSeriesByQuery($query) {
+    public static function getAllSeriesByQuery($query)
+    {
         return Base::getEntryArrayWithBookNumber (self::SQL_SERIES_FOR_SEARCH, self::SERIES_COLUMNS, array ('%' . $query . '%'), "Serie");
     }
 }

fetch.php

Braces +7 added lines, -15 removed lines

@@ -25,12 +25,9 @@ 
     $bookId = getURLParam ("id", NULL);
     $type = getURLParam ("type", "jpg");
     $idData = getURLParam ("data", NULL);
-    if (is_null ($bookId))
-    {
+    if (is_null ($bookId)) {
         $book = Book::getBookByDataId($idData);
-    }
-    else
-    {
+    } else {
         $book = Book::getBookById($bookId);
     }
 
@@ -51,8 +48,7 @@ 
         }
     }
 
-    switch ($type)
-    {
+    switch ($type) {
         case "jpg":
             header("Content-Type: image/jpeg");
             //by default, we don't cache
@@ -69,8 +65,7 @@ 
                     //we name the thumbnail from the book's uuid and it's dimensions (width and/or height)
                     $thumbnailCacheName = substr($book->uuid, 3) . '-' . getURLParam ("width") . 'x' . getURLParam ("height") . '.jpg';
                     $thumbnailCacheFullpath = $thumbnailCacheFullpath . $thumbnailCacheName;
-                }
-                else {
+                } else {
                     //error creating the folder, so we don't cache
                     $thumbnailCacheFullpath = null;
                 }
@@ -87,8 +82,7 @@ 
                 if ( $thumbnailCacheFullpath === null ) {
                     // The cover had to be resized
                     return;
-                }
-                else {
+                } else {
                     //return the just cached thumbnail
                     readfile( $thumbnailCacheFullpath );
                     return;
@@ -101,8 +95,7 @@ 
             break;
     }
     $file = $book->getFilePath ($type, $idData, true);
-    if ($type == "epub" && $config['cops_update_epub-metadata'])
-    {
+    if ($type == "epub" && $config['cops_update_epub-metadata']) {
         $book->getUpdatedEpub ($idData);
         return;
     }
@@ -122,7 +115,6 @@ 
         $fp = fopen($filename, 'rb');
         header("Content-Length: " . filesize($filename));
         fpassthru($fp);
-    }
-    else {
+    } else {
         header ($config['cops_x_accel_redirect'] . ": " . $dir . $file);
     }