seblucas / cops

base.php

Doc Comments +11 added lines

@@ -64,6 +64,9 @@ 
     $_SERVER['REDIRECT_STATUS'] = 404;
 }
 
+/**
+ * @param string $name
+ */
 function getURLParam($name, $default = NULL)
 {
     if (!empty ($_GET) && isset($_GET[$name]) && $_GET[$name] != '') {
@@ -104,6 +107,11 @@ 
     return $url . '?v=' . VERSION;
 }
 
+/**
+ * @param string $xml
+ *
+ * @return string
+ */
 function xml2xhtml($xml)
 {
     return preg_replace_callback('#<(\w+)([^>]*)\s*/>#s', function($m) {
@@ -326,6 +334,9 @@ 
     return $phrase;
 }
 
+/**
+ * @param string $paramName
+ */
 function addURLParameter($urlParams, $paramName, $paramValue)
 {
     if (empty ($urlParams)) {

Braces +19 added lines, -11 removed lines

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

lib/Author.php

Doc Comments +6 added lines

@@ -62,6 +62,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 . "%"));
     }
@@ -70,6 +73,9 @@ 
         return self::getEntryArray (self::SQL_ALL_AUTHORS, array ());
     }
 
+    /**
+     * @param string $query
+     */
     public static function getEntryArray ($query, $params) {
         return Base::getEntryArrayWithBookNumber ($query, self::AUTHOR_COLUMNS, $params, "Author");
     }

Braces +25 added lines, -14 removed lines

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

lib/Base.php

Doc Comments +18 added lines

@@ -84,6 +84,9 @@ 
         return "";
     }
 
+    /**
+     * @return string
+     */
     public static function getDbDirectory ($database = NULL) {
         global $config;
         if (self::isMultipleDatabaseEnabled ()) {
@@ -143,10 +146,18 @@ 
         self::$db = NULL;
     }
 
+    /**
+     * @param string $query
+     */
     public static function executeQuerySingle ($query, $database = NULL) {
         return self::getDb ($database)->query($query)->fetchColumn();
     }
 
+    /**
+     * @param string $table
+     * @param string $id
+     * @param string $numberOfString
+     */
     public static function getCountGeneric($table, $id, $pageId, $numberOfString = NULL) {
         if (!$numberOfString) {
             $numberOfString = $table . ".alphabetical";
@@ -159,6 +170,10 @@ 
         return $entry;
     }
 
+    /**
+     * @param string $columns
+     * @param string $category
+     */
     public static function getEntryArrayWithBookNumber ($query, $columns, $params, $category) {
         /* @var $result PDOStatement */
 
@@ -181,6 +196,9 @@ 
         return $entryArray;
     }
 
+    /**
+     * @param string $filter
+     */
     public static function executeQuery($query, $columns, $filter, $params, $n, $database = NULL, $numberPerPage = NULL) {
         $totalResult = -1;
 

Braces +43 added lines, -23 removed lines

@@ -37,23 +37,27 @@ 
 
     private static $db = NULL;
 
-    public static function isMultipleDatabaseEnabled () {
+    public static function isMultipleDatabaseEnabled ()
+    {
         global $config;
         return is_array ($config['calibre_directory']);
     }
 
-    public static function useAbsolutePath () {
+    public static function useAbsolutePath ()
+    {
         global $config;
         $path = self::getDbDirectory();
         return preg_match ('/^\//', $path) || // Linux /
                preg_match ('/^\w\:/', $path); // Windows X:
     }
 
-    public static function noDatabaseSelected () {
+    public static function noDatabaseSelected ()
+    {
         return self::isMultipleDatabaseEnabled () && is_null (GetUrlParam (DB));
     }
 
-    public static function getDbList () {
+    public static function getDbList ()
+    {
         global $config;
         if (self::isMultipleDatabaseEnabled ()) {
             return $config['calibre_directory'];
@@ -62,7 +66,8 @@ 
         }
     }
 
-    public static function getDbNameList () {
+    public static function getDbNameList ()
+    {
         global $config;
         if (self::isMultipleDatabaseEnabled ()) {
             return array_keys ($config['calibre_directory']);
@@ -71,10 +76,13 @@ 
         }
     }
 
-    public static function getDbName ($database = NULL) {
+    public static function getDbName ($database = NULL)
+    {
         global $config;
         if (self::isMultipleDatabaseEnabled ()) {
-            if (is_null ($database)) $database = GetUrlParam (DB, 0);
+            if (is_null ($database)) {
+                $database = GetUrlParam (DB, 0);
+            }
             if (!is_null($database) && !preg_match('/^\d+$/', $database)) {
                 self::error ($database);
             }
@@ -84,10 +92,13 @@ 
         return "";
     }
 
-    public static function getDbDirectory ($database = NULL) {
+    public static function getDbDirectory ($database = NULL)
+    {
         global $config;
         if (self::isMultipleDatabaseEnabled ()) {
-            if (is_null ($database)) $database = GetUrlParam (DB, 0);
+            if (is_null ($database)) {
+                $database = GetUrlParam (DB, 0);
+            }
             if (!is_null($database) && !preg_match('/^\d+$/', $database)) {
                 self::error ($database);
             }
@@ -98,18 +109,21 @@ 
     }
 
 
-    public static function getDbFileName ($database = NULL) {
+    public static function getDbFileName ($database = NULL)
+    {
         return self::getDbDirectory ($database) .'metadata.db';
     }
 
-    private static function error ($database) {
+    private static function error ($database)
+    {
         if (php_sapi_name() != "cli") {
             header("location: checkconfig.php?err=1");
         }
         throw new Exception("Database <{$database}> not found.");
     }
 
-    public static function getDb ($database = NULL) {
+    public static function getDb ($database = NULL)
+    {
         if (is_null (self::$db)) {
             try {
                 if (is_readable (self::getDbFileName ($database))) {
@@ -127,7 +141,8 @@ 
         return self::$db;
     }
 
-    public static function checkDatabaseAvailability () {
+    public static function checkDatabaseAvailability ()
+    {
         if (self::noDatabaseSelected ()) {
             for ($i = 0; $i < count (self::getDbList ()); $i++) {
                 self::getDb ($i);
@@ -139,33 +154,38 @@ 
         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)
+    {
         /* @var $result PDOStatement */
 
         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);
@@ -181,7 +201,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 ()) {
@@ -193,8 +214,7 @@ 
             $numberPerPage = getCurrentOption ("max_item_per_page");
         }
 
-        if ($numberPerPage != -1 && $n != -1)
-        {
+        if ($numberPerPage != -1 && $n != -1) {
             // First check total number of results
             $result = self::getDb ($database)->prepare (str_format ($query, "count(*)", $filter));
             $result->execute ($params);

lib/Book.php

Doc Comments +17 added lines, -1 removed lines

@@ -144,6 +144,9 @@ 
         return 'index.php' . $urlParam;
     }
 
+    /**
+     * @return string
+     */
     public function getTitle () {
         return $this->title;
     }
@@ -331,6 +334,9 @@ 
         return reset($reduced);
     }
 
+    /**
+     * @param string $extension
+     */
     public function getFilePath($extension, $idData = NULL, $relative = false)
     {
         if ($extension == 'jpg')
@@ -464,6 +470,9 @@ 
             $this->getLinkArray(), $this);
     }
 
+    /**
+     * @param integer $database
+     */
     public static function getBookCount($database = NULL) {
         return parent::executeQuerySingle('select count(*) from books', $database);
     }
@@ -512,7 +521,7 @@ 
     }
 
     /**
-     * @param $customColumn CustomColumn
+     * @param CustomColumn $customColumn CustomColumn
      * @param $id integer
      * @param $n integer
      * @return array
@@ -552,6 +561,10 @@ 
         return NULL;
     }
 
+    /**
+     * @param integer $database
+     * @param integer $numberPerPage
+     */
     public static function getBooksByQuery($query, $n, $database = NULL, $numberPerPage = NULL) {
         $i = 0;
         $critArray = array();
@@ -599,6 +612,9 @@ 
         return $entryArray;
     }
 
+    /**
+     * @param integer $numberPerPage
+     */
     public static function getBooksByStartingLetter($letter, $n, $database = NULL, $numberPerPage = NULL) {
         return self::getEntryArray(self::SQL_BOOKS_BY_FIRST_LETTER, array($letter . '%'), $n, $database, $numberPerPage);
     }

Braces +105 added lines, -82 removed lines

@@ -108,7 +108,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);
@@ -126,25 +127,32 @@ 
         $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;
     }
 
@@ -153,22 +161,26 @@ 
     /**
      * @return Author[]
      */
-    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);
         }
@@ -178,7 +190,8 @@ 
     /**
      * @return Serie
      */
-    public function getSerie() {
+    public function getSerie()
+    {
         if (is_null($this->serie)) {
             $this->serie = Serie::getSerieByBookId($this->id);
         }
@@ -188,7 +201,8 @@ 
     /**
      * @return string
      */
-    public function getLanguages() {
+    public function getLanguages()
+    {
         $lang = array();
         $result = parent::getDb()->prepare('select languages.lang_code
                 from books_languages_link, languages
@@ -196,8 +210,7 @@ 
                 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);
@@ -206,7 +219,8 @@ 
     /**
      * @return Tag[]
      */
-    public function getTags() {
+    public function getTags()
+    {
         if (is_null ($this->tags)) {
             $this->tags = array();
 
@@ -216,15 +230,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()));
     }
 
@@ -241,9 +255,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)) {
@@ -283,7 +300,8 @@ 
         return reset($reduced);
     }
 
-    public function getRating() {
+    public function getRating()
+    {
         if (is_null($this->rating) || $this->rating == 0) {
             return '';
         }
@@ -297,7 +315,8 @@ 
         return $retour;
     }
 
-    public function getPubDate() {
+    public function getPubDate()
+    {
         if (empty ($this->pubdate)) {
             return '';
         }
@@ -308,23 +327,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;
         });
@@ -333,23 +351,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;
         }
     }
@@ -359,8 +373,7 @@ 
         global $config;
         $data = $this->getDataById($idData);
 
-        try
-        {
+        try {
             $epub = new EPub($data->getLocalPath());
 
             $epub->Title($this->title);
@@ -383,14 +396,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;
         }
@@ -429,17 +441,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));
             }
         }
@@ -458,17 +467,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();
@@ -487,27 +499,33 @@ 
         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);
     }
 
@@ -517,32 +535,33 @@ 
      * @param $n integer
      * @return array
      */
-    public static function getBooksByCustom($customColumn, $id, $n) {
+    public static function getBooksByCustom($customColumn, $id, $n)
+    {
         list($query, $params) = $customColumn->getQuery($id);
 
         return self::getEntryArray($query, $params, $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;
@@ -552,7 +571,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,
@@ -563,8 +583,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 {
@@ -576,12 +595,14 @@ 
         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()
+    {
         /* @var $result PDOStatement */
 
         list (, $result) = parent::executeQuery('select {0}
@@ -590,8 +611,7 @@ 
 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));
@@ -599,25 +619,27 @@ 
         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)
+    {
         /* @var $totalNumber integer */
         /* @var $result PDOStatement */
         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());
         }
         return array($entryArray, $totalNumber);
     }
 
-    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;
@@ -629,7 +651,8 @@ 
      * @param string[] $columns
      * @return CustomColumn[]
      */
-    public function getCustomColumnValues($columns, $asArray = false) {
+    public function getCustomColumnValues($columns, $asArray = false)
+    {
         $result = array();
 
         foreach ($columns as $lookup) {

lib/CustomColumnType.php

Doc Comments +5 added lines, -2 removed lines

@@ -39,6 +39,9 @@ 
     /** @var null|Entry[] */
     private $customValues = NULL;
 
+    /**
+     * @param string $pdatatype
+     */
     protected function __construct($pcustomId, $pdatatype)
     {
         $this->columnTitle = self::getTitleByCustomID($pcustomId);
@@ -147,7 +150,7 @@ 
     /**
      * Encode a value of this column ready to be displayed in an HTML document
      *
-     * @param integer|string $value
+     * @param string $value
      * @return string
      */
     public function encodeHTMLValue($value)
@@ -277,7 +280,7 @@ 
     /**
      * Get a CustomColumn for a specified (by ID) value
      *
-     * @param string|integer $id the id of the searched value
+     * @param integer $id the id of the searched value
      * @return CustomColumn
      */
     abstract public function getCustom($id);

Braces +9 added lines, -6 removed lines

@@ -181,8 +181,9 @@ 
     public static function createByCustomID($customId)
     {
         // Reuse already created CustomColumns for performance
-        if (array_key_exists($customId, self::$customColumnCacheID))
-            return self::$customColumnCacheID[$customId];
+        if (array_key_exists($customId, self::$customColumnCacheID)) {
+                    return self::$customColumnCacheID[$customId];
+        }
 
         $datatype = self::getDatatypeByCustomID($customId);
 
@@ -221,8 +222,9 @@ 
     public static function createByLookup($lookup)
     {
         // Reuse already created CustomColumns for performance
-        if (array_key_exists($lookup, self::$customColumnCacheLookup))
-            return self::$customColumnCacheLookup[$lookup];
+        if (array_key_exists($lookup, self::$customColumnCacheLookup)) {
+                    return self::$customColumnCacheLookup[$lookup];
+        }
 
         $result = parent::getDb()->prepare('SELECT id FROM custom_columns WHERE label = ?');
         $result->execute(array($lookup));
@@ -241,8 +243,9 @@ 
     public function getAllCustomValues()
     {
         // lazy loading
-        if ($this->customValues == NULL)
-            $this->customValues = $this->getAllCustomValuesFromDatabase();
+        if ($this->customValues == NULL) {
+                    $this->customValues = $this->getAllCustomValuesFromDatabase();
+        }
 
         return $this->customValues;
     }

lib/Data.php

Doc Comments +10 added lines

@@ -139,6 +139,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
@@ -152,6 +155,9 @@ 
         return $out;
     }
 
+    /**
+     * @param string $urlParam
+     */
     public static function handleThumbnailLink ($urlParam, $height) {
         global $config;
 
@@ -171,6 +177,10 @@ 
         return $urlParam;
     }
 
+    /**
+     * @param string $type
+     * @param string $filename
+     */
     public static function getLink ($book, $type, $mime, $rel, $filename, $idData, $title = NULL, $height = NULL)
     {
         global $config;

Braces +42 added lines, -29 removed lines

@@ -55,7 +55,8 @@ 
         'zip'   => 'application/zip'
     );
 
-    public function __construct($post, $book = null) {
+    public function __construct($post, $book = null)
+    {
         $this->id = $post->id;
         $this->name = $post->name;
         $this->format = $post->format;
@@ -64,19 +65,20 @@ 
         $this->book = $book;
     }
 
-    public function isKnownType () {
+    public function isKnownType ()
+    {
         return array_key_exists ($this->extension, self::$mimetypes);
     }
 
-    public function getMimeType () {
+    public function getMimeType ()
+    {
         $result = "application/octet-stream";
         if ($this->isKnownType ()) {
             return self::$mimetypes [$this->extension];
         } elseif (function_exists('finfo_open') === true) {
             $finfo = finfo_open(FILEINFO_MIME_TYPE);
 
-            if (is_resource($finfo) === true)
-            {
+            if (is_resource($finfo) === true) {
                 $result = finfo_file($finfo, $this->getLocalPath ());
             }
 
@@ -86,29 +88,35 @@ 
         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 ()
+    {
         $str = $this->getUpdatedFilename () . ".kepub.epub";
         return str_replace(array(':', '#', '&'),
                            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") {
@@ -118,19 +126,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;
 
@@ -144,28 +157,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'];
             }
         }
@@ -184,14 +196,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) {
@@ -199,9 +214,7 @@ 
             } else {
                 return new Link ("fetch.php?" . $urlParam, $mime, $rel, $title);
             }
-        }
-        else
-        {
+        } else {
             return new Link (str_replace('%2F','/',rawurlencode ($book->path."/".$filename)), $mime, $rel, $title);
         }
     }

lib/LinkFacet.php

Doc Comments +3 added lines

@@ -8,6 +8,9 @@
 
 class LinkFacet extends Link
 {
+    /**
+     * @param string $phref
+     */
     public function __construct($phref, $ptitle = NULL, $pfacetGroup = NULL, $pactiveFacet = FALSE) {
         parent::__construct ($phref, Link::OPDS_PAGING_TYPE, "http://opds-spec.org/facet", $ptitle, $pfacetGroup, $pactiveFacet);
         if (!is_null (GetUrlParam (DB))) $this->href = addURLParameter ($this->href, DB, GetUrlParam (DB));

Braces +5 added lines, -2 removed lines

@@ -8,9 +8,12 @@
 
 class LinkFacet extends Link
 {
-    public function __construct($phref, $ptitle = NULL, $pfacetGroup = NULL, $pactiveFacet = FALSE) {
+    public function __construct($phref, $ptitle = NULL, $pfacetGroup = NULL, $pactiveFacet = FALSE)
+    {
         parent::__construct ($phref, Link::OPDS_PAGING_TYPE, "http://opds-spec.org/facet", $ptitle, $pfacetGroup, $pactiveFacet);
-        if (!is_null (GetUrlParam (DB))) $this->href = addURLParameter ($this->href, DB, GetUrlParam (DB));
+        if (!is_null (GetUrlParam (DB))) {
+            $this->href = addURLParameter ($this->href, DB, GetUrlParam (DB));
+        }
         $this->href = parent::getScriptName() . $this->href;
     }
 }

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

Braces +8 added lines, -3 removed lines

@@ -8,10 +8,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 {

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

Braces +6 added lines, -3 removed lines

@@ -8,7 +8,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)) {
@@ -22,14 +23,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)) {