seblucas / cops

lib/Data.php

Doc Comments +10 added lines

@@ -152,6 +152,9 @@ 
         return new Link ($href, $this->getMimeType (), Link::OPDS_ACQUISITION_TYPE, $title);
     }
 
+    /**
+     * @param Book $book
+     */
     public static function getDataByBook ($book) {
         global $config;
 
@@ -176,6 +179,9 @@ 
         return $out;
     }
 
+    /**
+     * @param string $urlParam
+     */
     public static function handleThumbnailLink ($urlParam, $height) {
         global $config;
 
@@ -195,6 +201,10 @@ 
         return $urlParam;
     }
 
+    /**
+     * @param string $type
+     * @param string $filename
+     */
     public static function getLink ($book, $type, $mime, $rel, $filename, $idData, $title = NULL, $height = NULL, $view = false)
     {
         global $config;

Spacing +44 added lines, -44 removed lines

@@ -59,25 +59,25 @@ 
         $this->id = $post->id;
         $this->name = $post->name;
         $this->format = $post->format;
-        $this->realFormat = str_replace ("ORIGINAL_", "", $post->format);
-        $this->extension = strtolower ($this->realFormat);
+        $this->realFormat = str_replace("ORIGINAL_", "", $post->format);
+        $this->extension = strtolower($this->realFormat);
         $this->book = $book;
     }
 
-    public function isKnownType () {
-        return array_key_exists ($this->extension, self::$mimetypes);
+    public function isKnownType() {
+        return array_key_exists($this->extension, self::$mimetypes);
     }
 
-    public function getMimeType () {
+    public function getMimeType() {
         $result = "application/octet-stream";
-        if ($this->isKnownType ()) {
+        if ($this->isKnownType()) {
             return self::$mimetypes [$this->extension];
         } elseif (function_exists('finfo_open') === true) {
             $finfo = finfo_open(FILEINFO_MIME_TYPE);
 
             if (is_resource($finfo) === true)
             {
-                $result = finfo_file($finfo, $this->getLocalPath ());
+                $result = finfo_file($finfo, $this->getLocalPath());
             }
 
             finfo_close($finfo);
@@ -86,55 +86,55 @@ 
         return $result;
     }
 
-    public function isEpubValidOnKobo () {
+    public function isEpubValidOnKobo() {
         return $this->format == "EPUB" || $this->format == "KEPUB";
     }
 
-    public function getFilename () {
-        return $this->name . "." . strtolower ($this->format);
+    public function getFilename() {
+        return $this->name . "." . strtolower($this->format);
     }
 
-    public function getUpdatedFilename () {
-        return $this->book->getAuthorsSort () . " - " . $this->book->title;
+    public function getUpdatedFilename() {
+        return $this->book->getAuthorsSort() . " - " . $this->book->title;
     }
 
-    public function getUpdatedFilenameEpub () {
-        return $this->getUpdatedFilename () . ".epub";
+    public function getUpdatedFilenameEpub() {
+        return $this->getUpdatedFilename() . ".epub";
     }
 
-    public function getUpdatedFilenameKepub () {
-        $str = $this->getUpdatedFilename () . ".kepub.epub";
+    public function getUpdatedFilenameKepub() {
+        $str = $this->getUpdatedFilename() . ".kepub.epub";
         return str_replace(array(':', '#', '&'),
-                           array('-', '-', ' '), $str );
+                           array('-', '-', ' '), $str);
     }
 
-    public function getDataLink ($rel, $title = NULL, $view = false) {
+    public function getDataLink($rel, $title = NULL, $view = false) {
         global $config;
 
         if ($rel == Link::OPDS_ACQUISITION_TYPE && $config['cops_use_url_rewriting'] == "1") {
             return $this->getHtmlLinkWithRewriting($title, $view);
         }
 
-        return self::getLink ($this->book, $this->extension, $this->getMimeType (), $rel, $this->getFilename (), $this->id, $title, NULL, $view);
+        return self::getLink($this->book, $this->extension, $this->getMimeType(), $rel, $this->getFilename(), $this->id, $title, NULL, $view);
     }
 
-    public function getHtmlLink () {
+    public function getHtmlLink() {
         return $this->getDataLink(Link::OPDS_ACQUISITION_TYPE)->href;
     }
 
-    public function getViewHtmlLink () {
+    public function getViewHtmlLink() {
         return $this->getDataLink(Link::OPDS_ACQUISITION_TYPE, NULL, true)->href;
     }
 
-    public function getLocalPath () {
-        return $this->book->path . "/" . $this->getFilename ();
+    public function getLocalPath() {
+        return $this->book->path . "/" . $this->getFilename();
     }
 
-    public function getHtmlLinkWithRewriting ($title = NULL, $view = false) {
+    public function getHtmlLinkWithRewriting($title = NULL, $view = false) {
         global $config;
 
         $database = "";
-        if (!is_null (GetUrlParam (DB))) $database = GetUrlParam (DB) . "/";
+        if (!is_null(GetUrlParam(DB))) $database = GetUrlParam(DB) . "/";
 
         $prefix = "download";
         if ($view) {
@@ -143,19 +143,19 @@ 
         $href = $prefix . "/" . $this->id . "/" . $database;
 
         if ($config['cops_provide_kepub'] == "1" &&
-            $this->isEpubValidOnKobo () &&
+            $this->isEpubValidOnKobo() &&
             preg_match("/Kobo/", $_SERVER['HTTP_USER_AGENT'])) {
-            $href .= rawurlencode ($this->getUpdatedFilenameKepub ());
+            $href .= rawurlencode($this->getUpdatedFilenameKepub());
         } else {
-            $href .= rawurlencode ($this->getFilename ());
+            $href .= rawurlencode($this->getFilename());
         }
-        return new Link ($href, $this->getMimeType (), Link::OPDS_ACQUISITION_TYPE, $title);
+        return new Link($href, $this->getMimeType(), Link::OPDS_ACQUISITION_TYPE, $title);
     }
 
-    public static function getDataByBook ($book) {
+    public static function getDataByBook($book) {
         global $config;
 
-        $out = array ();
+        $out = array();
 
         $sql = 'select id, format, name from data where book = ?';
         
@@ -166,21 +166,21 @@ 
             . "')";
         }
 
-        $result = parent::getDb ()->prepare($sql);
-        $result->execute (array ($book->id));
+        $result = parent::getDb()->prepare($sql);
+        $result->execute(array($book->id));
 
-        while ($post = $result->fetchObject ())
+        while ($post = $result->fetchObject())
         {
-            array_push ($out, new Data ($post, $book));
+            array_push($out, new Data($post, $book));
         }
         return $out;
     }
 
-    public static function handleThumbnailLink ($urlParam, $height) {
+    public static function handleThumbnailLink($urlParam, $height) {
         global $config;
 
-        if (is_null ($height)) {
-            if (preg_match ('/feed.php/', $_SERVER["SCRIPT_NAME"])) {
+        if (is_null($height)) {
+            if (preg_match('/feed.php/', $_SERVER["SCRIPT_NAME"])) {
                 $height = $config['cops_opds_thumbnail_height'];
             }
             else
@@ -195,14 +195,14 @@ 
         return $urlParam;
     }
 
-    public static function getLink ($book, $type, $mime, $rel, $filename, $idData, $title = NULL, $height = NULL, $view = false)
+    public static function getLink($book, $type, $mime, $rel, $filename, $idData, $title = NULL, $height = NULL, $view = false)
     {
         global $config;
 
         $urlParam = addURLParameter("", "data", $idData);
         if ($view) $urlParam = addURLParameter($urlParam, "view", 1);
 
-        if (Base::useAbsolutePath () ||
+        if (Base::useAbsolutePath() ||
             $rel == Link::OPDS_THUMBNAIL_TYPE ||
             ($type == "epub" && $config['cops_update_epub-metadata']))
         {
@@ -211,18 +211,18 @@ 
                 $urlParam = self::handleThumbnailLink($urlParam, $height);
             }
             $urlParam = addURLParameter($urlParam, "id", $book->id);
-            if (!is_null (GetUrlParam (DB))) $urlParam = addURLParameter ($urlParam, DB, GetUrlParam (DB));
+            if (!is_null(GetUrlParam(DB))) $urlParam = addURLParameter($urlParam, DB, GetUrlParam(DB));
             if ($config['cops_thumbnail_handling'] != "1" &&
                 !empty ($config['cops_thumbnail_handling']) &&
                 $rel == Link::OPDS_THUMBNAIL_TYPE) {
-                return new Link ($config['cops_thumbnail_handling'], $mime, $rel, $title);
+                return new Link($config['cops_thumbnail_handling'], $mime, $rel, $title);
             } else {
-                return new Link ("fetch.php?" . $urlParam, $mime, $rel, $title);
+                return new Link("fetch.php?" . $urlParam, $mime, $rel, $title);
             }
         }
         else
         {
-            return new Link (str_replace('%2F','/',rawurlencode ($book->path."/".$filename)), $mime, $rel, $title);
+            return new Link(str_replace('%2F', '/', rawurlencode($book->path . "/" . $filename)), $mime, $rel, $title);
         }
     }
 }

Braces +47 added lines, -31 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, $view = false) {
+    public function getDataLink ($rel, $title = NULL, $view = false)
+    {
         global $config;
 
         if ($rel == Link::OPDS_ACQUISITION_TYPE && $config['cops_use_url_rewriting'] == "1") {
@@ -118,23 +126,29 @@ 
         return self::getLink ($this->book, $this->extension, $this->getMimeType (), $rel, $this->getFilename (), $this->id, $title, NULL, $view);
     }
 
-    public function getHtmlLink () {
+    public function getHtmlLink ()
+    {
         return $this->getDataLink(Link::OPDS_ACQUISITION_TYPE)->href;
     }
 
-    public function getViewHtmlLink () {
+    public function getViewHtmlLink ()
+    {
         return $this->getDataLink(Link::OPDS_ACQUISITION_TYPE, NULL, true)->href;
     }
 
-    public function getLocalPath () {
+    public function getLocalPath ()
+    {
         return $this->book->path . "/" . $this->getFilename ();
     }
 
-    public function getHtmlLinkWithRewriting ($title = NULL, $view = false) {
+    public function getHtmlLinkWithRewriting ($title = NULL, $view = false)
+    {
         global $config;
 
         $database = "";
-        if (!is_null (GetUrlParam (DB))) $database = GetUrlParam (DB) . "/";
+        if (!is_null (GetUrlParam (DB))) {
+            $database = GetUrlParam (DB) . "/";
+        }
 
         $prefix = "download";
         if ($view) {
@@ -152,7 +166,8 @@ 
         return new Link ($href, $this->getMimeType (), Link::OPDS_ACQUISITION_TYPE, $title);
     }
 
-    public static function getDataByBook ($book) {
+    public static function getDataByBook ($book)
+    {
         global $config;
 
         $out = array ();
@@ -169,22 +184,20 @@ 
         $result = parent::getDb ()->prepare($sql);
         $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'];
             }
         }
@@ -200,18 +213,23 @@ 
         global $config;
 
         $urlParam = addURLParameter("", "data", $idData);
-        if ($view) $urlParam = addURLParameter($urlParam, "view", 1);
+        if ($view) {
+            $urlParam = addURLParameter($urlParam, "view", 1);
+        }
 
         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) {
@@ -219,9 +237,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);
         }
     }