Changes:

- added type-hints
- added documentation
- changed double-quotes to single

diff --git a/src/Model/Post/Media.php b/src/Model/Post/Media.php
index 78f27b7a099252380b09821bc3c170d9f2dd17a3..2b17614e89b1ce54ae4c425433d049138c8be149 100644 (file)
--- a/src/Model/Post/Media.php
+++ b/src/Model/Post/Media.php
@@ -109,7 +109,7 @@ class Media
         * @param array $media
         * @return array cleaned media array
         */
-       private static function unsetEmptyFields(array $media)
+       private static function unsetEmptyFields(array $media): array
        {
                $fields = ['mimetype', 'height', 'width', 'size', 'preview', 'preview-height', 'preview-width', 'description'];
                foreach ($fields as $field) {
@@ -145,7 +145,7 @@ class Media
         * @param string $title
         * @return string "[attach]" element
         */
-       public static function getAttachElement(string $href, int $length, string $type, string $title = '')
+       public static function getAttachElement(string $href, int $length, string $type, string $title = ''): string
        {
                $media = self::fetchAdditionalData(['type' => self::DOCUMENT, 'url' => $href,
                        'size' => $length, 'mimetype' => $type, 'description' => $title]);
@@ -160,7 +160,7 @@ class Media
         * @param array $media
         * @return array media array with additional data
         */
-       public static function fetchAdditionalData(array $media)
+       public static function fetchAdditionalData(array $media): array
        {
                if (Network::isLocalLink($media['url'])) {
                        $media = self::fetchLocalData($media);
@@ -235,7 +235,7 @@ class Media
         * @param array $media
         * @return array media with added data
         */
-       private static function fetchLocalData(array $media)
+       private static function fetchLocalData(array $media): array
        {
                if (!preg_match('|.*?/photo/(.*[a-fA-F0-9])\-(.*[0-9])\..*[\w]|', $media['url'] ?? '', $matches)) {
                        return $media;
@@ -266,7 +266,7 @@ class Media
         * @param array $data
         * @return array data array with the detected type
         */
-       public static function addType(array $data)
+       public static function addType(array $data): array
        {
                if (empty($data['mimetype'])) {
                        Logger::info('No MimeType provided', ['media' => $data]);
@@ -318,7 +318,7 @@ class Media
         * @param string $preview Preview picture
         * @return boolean
         */
-       private static function isPictureLink(string $page, string $preview)
+       private static function isPictureLink(string $page, string $preview): bool
        {
                return preg_match('#/photos/.*/image/#ism', $page) && preg_match('#/photo/.*-1\.#ism', $preview);
        }
@@ -330,7 +330,7 @@ class Media
         * @param string $body
         * @return string Body without media links
         */
-       public static function insertFromBody(int $uriid, string $body)
+       public static function insertFromBody(int $uriid, string $body): string
        {
                // Simplify image codes
                $unshared_body = $body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $body);
@@ -413,6 +413,7 @@ class Media
         *
         * @param integer $uriid
         * @param string $body
+        * @return void
         */
        public static function insertFromRelevantUrl(int $uriid, string $body)
        {
@@ -448,6 +449,7 @@ class Media
         *
         * @param integer $uriid
         * @param string $body
+        * @return void
         */
        public static function insertFromAttachmentData(int $uriid, string $body)
        {
@@ -506,9 +508,9 @@ class Media
        /**
         * Retrieves the media attachments associated with the provided item ID.
         *
-        * @param int $uri_id
-        * @param array $types
-        * @return array
+        * @param int $uri_id URI id
+        * @param array $types Media types
+        * @return array|bool Array on success, false on error
         * @throws \Exception
         */
        public static function getByURIId(int $uri_id, array $types = [])
@@ -525,12 +527,12 @@ class Media
        /**
         * Checks if media attachments are associated with the provided item ID.
         *
-        * @param int $uri_id
-        * @param array $types
-        * @return array
+        * @param int $uri_id URI id
+        * @param array $types Media types
+        * @return bool Whether media attachment exists
         * @throws \Exception
         */
-       public static function existsByURIId(int $uri_id, array $types = [])
+       public static function existsByURIId(int $uri_id, array $types = []): bool
        {
                $condition = ['uri-id' => $uri_id];
 
@@ -544,13 +546,13 @@ class Media
        /**
         * Split the attachment media in the three segments "visual", "link" and "additional"
         *
-        * @param int    $uri_id
-        * @param string $guid
+        * @param int    $uri_id URI id
+        * @param string $guid GUID
         * @param array  $links list of links that shouldn't be added
         * @param bool   $has_media
         * @return array attachments
         */
-       public static function splitAttachments(int $uri_id, string $guid = '', array $links = [], bool $has_media = true)
+       public static function splitAttachments(int $uri_id, string $guid = '', array $links = [], bool $has_media = true): array
        {
                $attachments = ['visual' => [], 'link' => [], 'additional' => []];
 
@@ -648,7 +650,7 @@ class Media
         * @param string $body
         * @return string body
         */
-       public static function addAttachmentsToBody(int $uriid, string $body = '')
+       public static function addAttachmentsToBody(int $uriid, string $body = ''): string
        {
                if (empty($body)) {
                        $item = Post::selectFirst(['body'], ['uri-id' => $uriid]);
@@ -701,7 +703,7 @@ class Media
         * @param string  $size One of the Proxy::SIZE_* constants
         * @return string preview link
         */
-       public static function getPreviewUrlForId(int $id, string $size = ''):string
+       public static function getPreviewUrlForId(int $id, string $size = ''): string
        {
                $url = DI::baseUrl() . '/photo/preview/';
                switch ($size) {
@@ -731,7 +733,7 @@ class Media
         * @param string  $size One of the Proxy::SIZE_* constants
         * @return string media link
         */
-       public static function getUrlForId(int $id, string $size = ''):string
+       public static function getUrlForId(int $id, string $size = ''): string
        {
                $url = DI::baseUrl() . '/photo/media/';
                switch ($size) {

diff --git a/src/Module/Photo.php b/src/Module/Photo.php
index 86c737aa4e092208932ee4c8e3fc9717cd98c5f6..bedc216fb20ab827d61568385c0e5e1721e38cf2 100644 (file)
--- a/src/Module/Photo.php
+++ b/src/Module/Photo.php
@@ -128,7 +128,7 @@ class Photo extends BaseModule
                                throw new HTTPException\NotFoundException(DI::l10n()->t('The Photo is not available.'));
                        }
 
-                       $photo = self::getPhotoByid($id, $this->parameters['type'], $customsize ?: Proxy::PIXEL_SMALL);
+                       $photo = self::getPhotoById($id, $this->parameters['type'], $customsize ?: Proxy::PIXEL_SMALL);
                } else {
                        $photoid = pathinfo($this->parameters['name'], PATHINFO_FILENAME);
                        $scale = 0;
@@ -228,10 +228,18 @@ class Photo extends BaseModule
                System::exit();
        }
 
-       private static function getPhotoByid(int $id, $type, $customsize)
+       /**
+        * Fetches photo record by given id number, type and custom size
+        *
+        * @param int $id Photo id
+        * @param string $type Photo type
+        * @param int $customsize Custom size (?)
+        * @return array|bool Array on success, false on error
+        */
+       private static function getPhotoById(int $id, string $type, int $customsize)
        {
                switch($type) {
-                       case "preview":
+                       case 'preview':
                                $media = DBA::selectFirst('post-media', ['preview', 'url', 'mimetype', 'type', 'uri-id'], ['id' => $id]);
                                if (empty($media)) {
                                        return false;
@@ -251,7 +259,7 @@ class Photo extends BaseModule
                                }
 
                                return MPhoto::createPhotoForExternalResource($url, (int)local_user(), $media['mimetype']);
-                       case "media":
+                       case 'media':
                                $media = DBA::selectFirst('post-media', ['url', 'mimetype', 'uri-id'], ['id' => $id, 'type' => Post\Media::IMAGE]);
                                if (empty($media)) {
                                        return false;
@@ -262,14 +270,14 @@ class Photo extends BaseModule
                                }
 
                                return MPhoto::createPhotoForExternalResource($media['url'], (int)local_user(), $media['mimetype']);
-                       case "link":
+                       case 'link':
                                $link = DBA::selectFirst('post-link', ['url', 'mimetype'], ['id' => $id]);
                                if (empty($link)) {
                                        return false;
                                }
 
                                return MPhoto::createPhotoForExternalResource($link['url'], (int)local_user(), $link['mimetype']);
-                       case "contact":
+                       case 'contact':
                                $fields = ['uid', 'uri-id', 'url', 'nurl', 'avatar', 'photo', 'xmpp', 'addr', 'network', 'failed', 'updated'];
                                $contact = Contact::getById($id, $fields);
                                if (empty($contact)) {
@@ -287,7 +295,7 @@ class Photo extends BaseModule
                                                } else {
                                                        $scale = 4;
                                                }
-                                               $photo = MPhoto::selectFirst([], ["scale" => $scale, "uid" => $contact['uid'], "profile" => 1]);
+                                               $photo = MPhoto::selectFirst([], ['scale' => $scale, 'uid' => $contact['uid'], 'profile' => 1]);
                                                if (!empty($photo)) {
                                                        return $photo;
                                                }
@@ -330,7 +338,7 @@ class Photo extends BaseModule
                                                }
                                                if ($update) {
                                                        Logger::info('Invalid file, contact update initiated', ['cid' => $id, 'url' => $contact['url'], 'avatar' => $url]);
-                                                       Worker::add(PRIORITY_LOW, "UpdateContact", $id);
+                                                       Worker::add(PRIORITY_LOW, 'UpdateContact', $id);
                                                } else {
                                                        Logger::info('Invalid file', ['cid' => $id, 'url' => $contact['url'], 'avatar' => $url]);
                                                }
@@ -352,7 +360,7 @@ class Photo extends BaseModule
                                        }
                                }
                                return MPhoto::createPhotoForExternalResource($url, 0, $mimetext);
-                       case "header":
+                       case 'header':
                                $fields = ['uid', 'url', 'header', 'network', 'gsid'];
                                $contact = Contact::getById($id, $fields);
                                if (empty($contact)) {
@@ -367,37 +375,37 @@ class Photo extends BaseModule
                                        $url = Contact::getDefaultHeader($contact);
                                }
                                return MPhoto::createPhotoForExternalResource($url);
-                       case "banner":
-                               $photo = MPhoto::selectFirst([], ["scale" => 3, 'uid' => $id, 'photo-type' => MPhoto::USER_BANNER]);
+                       case 'banner':
+                               $photo = MPhoto::selectFirst([], ['scale' => 3, 'uid' => $id, 'photo-type' => MPhoto::USER_BANNER]);
                                if (!empty($photo)) {
                                        return $photo;
                                }
                                return MPhoto::createPhotoForExternalResource(DI::baseUrl() . '/images/friendica-banner.jpg');
-                       case "profile":
-                       case "custom":
+                       case 'profile':
+                       case 'custom':
                                $scale = 4;
                                break;
-                       case "micro":
+                       case 'micro':
                                $scale = 6;
                                break;
-                       case "avatar":
+                       case 'avatar':
                        default:
                                $scale = 5;
                }
 
-               $photo = MPhoto::selectFirst([], ["scale" => $scale, "uid" => $id, "profile" => 1]);
+               $photo = MPhoto::selectFirst([], ['scale' => $scale, 'uid' => $id, 'profile' => 1]);
                if (empty($photo)) {
                        $contact = DBA::selectFirst('contact', [], ['uid' => $id, 'self' => true]) ?: [];
 
                        switch($type) {
-                               case "profile":
-                               case "custom":
+                               case 'profile':
+                               case 'custom':
                                        $default = Contact::getDefaultAvatar($contact, Proxy::SIZE_SMALL);
                                        break;
-                               case "micro":
+                               case 'micro':
                                        $default = Contact::getDefaultAvatar($contact, Proxy::SIZE_MICRO);
                                        break;
-                               case "avatar":
+                               case 'avatar':
                                default:
                                        $default = Contact::getDefaultAvatar($contact, Proxy::SIZE_THUMB);
                        }