Fix errors psalm found scanning at level 7

app/Http/Controllers/MicropubController.php

@@ -6,13 +6,12 @@ namespace App\Http\Controllers;
 
 use App\Exceptions\InvalidTokenException;
 use App\Jobs\ProcessMedia;
-use App\Models\{Like, Media, Note, Place};
+use Exception;
+use Illuminate\Contracts\Container\BindingResolutionException;
+use App\Models\{Media, Place};
 use App\Services\Micropub\{HCardService, HEntryService, UpdateService};
 use App\Services\TokenService;
-use Illuminate\Http\File;
+use Illuminate\Http\{File, JsonResponse, Response, UploadedFile};
-use Illuminate\Http\JsonResponse;
-use Illuminate\Http\UploadedFile;
-use Illuminate\Http\{Request, Response};
 use Illuminate\Support\Facades\Storage;
 use Intervention\Image\Exception\NotReadableException;
 use Intervention\Image\ImageManager;
@@ -42,9 +41,9 @@ class MicropubController extends Controller
 
     /**
      * This function receives an API request, verifies the authenticity
-     * then passes over the info to the relavent Service class.
+     * then passes over the info to the relevant Service class.
      *
-     * @return \Illuminate\Http\JsonResponse
+     * @return JsonResponse
      */
     public function post(): JsonResponse
     {
@@ -102,11 +101,11 @@ class MicropubController extends Controller
      * Respond to a GET request to the micropub endpoint.
      *
      * A GET request has been made to `api/post` with an accompanying
-     * token, here we check wether the token is valid and respond
+     * token, here we check whether the token is valid and respond
      * appropriately. Further if the request has the query parameter
-     * synidicate-to we respond with the known syndication endpoints.
+     * syndicate-to we respond with the known syndication endpoints.
      *
-     * @return \Illuminate\Http\JsonResponse
+     * @return JsonResponse
      */
     public function get(): JsonResponse
     {
@@ -131,7 +130,7 @@ class MicropubController extends Controller
 
         if (request()->has('q') && substr(request()->input('q'), 0, 4) === 'geo:') {
             preg_match_all(
-                '/([0-9\.\-]+)/',
+                '/([0-9.\-]+)/',
                 request()->input('q'),
                 $matches
             );
@@ -158,7 +157,9 @@ class MicropubController extends Controller
     /**
      * Process a media item posted to the media endpoint.
      *
-     * @return Illuminate\Http\JsonResponse
+     * @return JsonResponse
+     * @throws BindingResolutionException
+     * @throws Exception
      */
     public function media(): JsonResponse
     {
@@ -220,9 +221,9 @@ class MicropubController extends Controller
     }
 
     /**
-     * Return the relavent CORS headers to a pre-flight OPTIONS request.
+     * Return the relevant CORS headers to a pre-flight OPTIONS request.
      *
-     * @return \Illuminate\Http\Response
+     * @return Response
      */
     public function mediaOptionsResponse(): Response
     {
@@ -230,12 +231,12 @@ class MicropubController extends Controller
     }
 
     /**
-     * Get the file type from the mimetype of the uploaded file.
+     * Get the file type from the mime-type of the uploaded file.
      *
-     * @param  string  $mimetype
+     * @param string $mimeType
      * @return string
      */
-    private function getFileTypeFromMimeType(string $mimetype): string
+    private function getFileTypeFromMimeType(string $mimeType): string
     {
         //try known images
         $imageMimeTypes = [
@@ -246,7 +247,7 @@ class MicropubController extends Controller
             'image/tiff',
             'image/webp',
         ];
-        if (in_array($mimetype, $imageMimeTypes)) {
+        if (in_array($mimeType, $imageMimeTypes)) {
             return 'image';
         }
         //try known video
@@ -257,7 +258,7 @@ class MicropubController extends Controller
             'video/quicktime',
             'video/webm',
         ];
-        if (in_array($mimetype, $videoMimeTypes)) {
+        if (in_array($mimeType, $videoMimeTypes)) {
             return 'video';
         }
         //try known audio types
@@ -267,7 +268,7 @@ class MicropubController extends Controller
             'audio/ogg',
             'audio/x-m4a',
         ];
-        if (in_array($mimetype, $audioMimeTypes)) {
+        if (in_array($mimeType, $audioMimeTypes)) {
             return 'audio';
         }
 
@@ -301,12 +302,13 @@ class MicropubController extends Controller
     /**
      * Save an uploaded file to the local disk.
      *
-     * @param  \Illuminate\Http\UploadedFele  $file
+     * @param UploadedFile $file
-     * @return string $filename
+     * @return string
+     * @throws Exception
      */
     private function saveFile(UploadedFile $file): string
     {
-        $filename = Uuid::uuid4() . '.' . $file->extension();
+        $filename = Uuid::uuid4()->toString() . '.' . $file->extension();
         Storage::disk('local')->putFileAs('', $file, $filename);
 
         return $filename;
@@ -315,9 +317,9 @@ class MicropubController extends Controller
     /**
      * Generate a response to be returned when the token has insufficient scope.
      *
-     * @return \Illuminate\Http\JsonRepsonse
+     * @return JsonResponse
      */
-    private function insufficientScopeResponse()
+    private function insufficientScopeResponse(): JsonResponse
     {
         return response()->json([
             'response' => 'error',
@@ -329,9 +331,9 @@ class MicropubController extends Controller
     /**
      * Generate a response to be returned when the token is invalid.
      *
-     * @return \Illuminate\Http\JsonRepsonse
+     * @return JsonResponse
      */
-    private function invalidTokenResponse()
+    private function invalidTokenResponse(): JsonResponse
     {
         return response()->json([
             'response' => 'error',
@@ -343,9 +345,9 @@ class MicropubController extends Controller
     /**
      * Generate a response to be returned when the token has no scope.
      *
-     * @return \Illuminate\Http\JsonRepsonse
+     * @return JsonResponse
      */
-    private function tokenHasNoScopeResponse()
+    private function tokenHasNoScopeResponse(): JsonResponse
     {
         return response()->json([
             'response' => 'error',

app/Http/Controllers/WebMentionsController.php

@@ -19,7 +19,7 @@ class WebMentionsController extends Controller
      * This is probably someone looking for information about what
      * webmentions are, or about my particular implementation.
      *
-     * @return \Illuminate\View\View
+     * @return View
      */
     public function get(): View
     {
@@ -29,11 +29,11 @@ class WebMentionsController extends Controller
     /**
      * Receive and process a webmention.
      *
-     * @return \Illuminate\Http\Respone
+     * @return Response
      */
     public function receive(): Response
     {
-        //first we trivially reject requets that lack all required inputs
+        //first we trivially reject requests that lack all required inputs
         if ((request()->has('target') !== true) || (request()->has('source') !== true)) {
             return response(
                 'You need both the target and source parameters',

app/Models/Note.php

@@ -5,28 +5,19 @@ declare(strict_types=1);
 namespace App\Models;
 
 use App\Exceptions\TwitterContentException;
-use Cache;
 use Codebird\Codebird;
 use Exception;
 use GuzzleHttp\Client;
-use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\{Builder, Model, SoftDeletes};
-use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\{BelongsTo, BelongsToMany, HasMany, MorphMany};
-use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Support\Facades\Cache;
-use Illuminate\Database\Eloquent\Relations\BelongsToMany;
-use Illuminate\Database\Eloquent\Relations\HasMany;
-use Illuminate\Database\Eloquent\Relations\MorphMany;
-use Illuminate\Database\Eloquent\SoftDeletes;
 use Jonnybarnes\IndieWeb\Numbers;
 use Laravel\Scout\Searchable;
-use League\CommonMark\Block\Element\FencedCode;
+use League\CommonMark\{CommonMarkConverter, Environment};
-use League\CommonMark\Block\Element\IndentedCode;
+use League\CommonMark\Block\Element\{FencedCode, IndentedCode};
-use League\CommonMark\CommonMarkConverter;
-use League\CommonMark\Environment;
 use League\CommonMark\Ext\Autolink\AutolinkExtension;
 use Normalizer;
-use Spatie\CommonMarkHighlighter\FencedCodeRenderer;
+use Spatie\CommonMarkHighlighter\{FencedCodeRenderer, IndentedCodeRenderer};
-use Spatie\CommonMarkHighlighter\IndentedCodeRenderer;
-use Twitter;
 
 class Note extends Model
 {
@@ -178,9 +169,8 @@ class Note extends Model
 
         $hcards = $this->makeHCards($value);
         $hashtags = $this->autoLinkHashtag($hcards);
-        $html = $this->convertMarkdown($hashtags);
 
-        return $html;
+        return $this->convertMarkdown($hashtags);
     }
 
     /**
@@ -266,7 +256,7 @@ class Note extends Model
     }
 
     /**
-     * Get the pubdate value for RSS feeds.
+     * Get the publish date value for RSS feeds.
      *
      * @return string
      */
@@ -307,9 +297,9 @@ class Note extends Model
         }
         if ($this->location !== null) {
             $pieces = explode(':', $this->location);
-            $latlng = explode(',', $pieces[0]);
+            $latLng = explode(',', $pieces[0]);
 
-            return (float) trim($latlng[1]);
+            return (float) trim($latLng[1]);
         }
 
         return null;
@@ -375,6 +365,7 @@ class Note extends Model
      * That is we swap the contacts names for their known Twitter handles.
      *
      * @return string
+     * @throws TwitterContentException
      */
     public function getTwitterContentAttribute(): string
     {
@@ -416,9 +407,9 @@ class Note extends Model
     /**
      * Scope a query to select a note via a NewBase60 id.
      *
-     * @param  \Illuminate\Database\Eloquent\Builder  $query
+     * @param Builder $query
      * @param string $nb60id
-     * @return \Illuminate\Database\Eloquent\Builder
+     * @return Builder
      */
     public function scopeNb60(Builder $query, string $nb60id): Builder
     {
@@ -444,7 +435,7 @@ class Note extends Model
             return $text;
         }
 
-        $hcards = preg_replace_callback(
+        return preg_replace_callback(
             self::USERNAMES_REGEX,
             function ($matches) {
                 if (is_null($this->contacts[$matches[1]])) {
@@ -462,24 +453,28 @@ class Note extends Model
             },
             $text
         );
-
-        return $hcards;
     }
 
     /**
      * Get the value of the `contacts` property.
+     *
+     * @return array
      */
-    public function getContacts()
+    public function getContacts(): array
     {
         if ($this->contacts === null) {
             $this->setContacts();
         }
+
+        return $this->contacts;
     }
 
     /**
      * Process the note and save the contacts to the `contacts` property.
+     *
+     * @return void
      */
-    public function setContacts()
+    public function setContacts(): void
     {
         $contacts = [];
         if ($this->getOriginal('note')) {
@@ -542,9 +537,9 @@ class Note extends Model
      */
     public function reverseGeoCode(float $latitude, float $longitude): string
     {
-        $latlng = $latitude . ',' . $longitude;
+        $latLng = $latitude . ',' . $longitude;
 
-        return Cache::get($latlng, function () use ($latlng, $latitude, $longitude) {
+        return Cache::get($latLng, function () use ($latLng, $latitude, $longitude) {
             $guzzle = resolve(Client::class);
             $response = $guzzle->request('GET', 'https://nominatim.openstreetmap.org/reverse', [
                 'query' => [
@@ -567,7 +562,7 @@ class Note extends Model
                     . '</span>, <span class="p-country-name">'
                     . $json->address->country
                     . '</span>';
-                Cache::forever($latlng, $address);
+                Cache::forever($latLng, $address);
 
                 return $address;
             }
@@ -577,7 +572,7 @@ class Note extends Model
                     . '</span>, <span class="p-country-name">'
                     . $json->address->country
                     . '</span>';
-                Cache::forever($latlng, $address);
+                Cache::forever($latLng, $address);
 
                 return $address;
             }
@@ -587,12 +582,12 @@ class Note extends Model
                     . '</span>, <span class="p-country-name">'
                     . $json->address->country
                     . '</span>';
-                Cache::forever($latlng, $address);
+                Cache::forever($latLng, $address);
 
                 return $address;
             }
             $address = '<span class="p-country-name">' . $json->address->country . '</span>';
-            Cache::forever($latlng, $address);
+            Cache::forever($latLng, $address);
 
             return $address;
         });

app/Models/Place.php

@@ -5,8 +5,8 @@ declare(strict_types=1);
 namespace App\Models;
 
 use Cviebrock\EloquentSluggable\Sluggable;
-use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\{Builder, Model};
-use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Str;
 use Phaza\LaravelPostgis\Eloquent\PostgisTrait;
@@ -52,7 +52,7 @@ class Place extends Model
     /**
      * Define the relationship with Notes.
      *
-     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     * @return HasMany
      */
     public function notes()
     {
@@ -62,12 +62,12 @@ class Place extends Model
     /**
      * Select places near a given location.
      *
-     * @param  \Illuminate\Database\Eloquent\Builder  $query
+     * @param Builder $query
-     * @param  \Phaza\LaravelPostgis\Geometries\Point  $point
+     * @param Point $point
      * @param int $distance
-     * @return \Illuminate\Database\Eloquent\Builder
+     * @return Builder
      */
-    public function scopeNear(Builder $query, Point $point, $distance = 1000): Builder
+    public function scopeNear(Builder $query, Point $point, int $distance = 1000): Builder
     {
         $field = DB::raw(
             sprintf(
@@ -83,9 +83,9 @@ class Place extends Model
     /**
      * Select places based on a URL.
      *
-     * @param  \Illuminate\Database\Eloquent\Builder  $query
+     * @param Builder $query
      * @param string $url
-     * @return \Illuminate\Database\Eloquent\Builder
+     * @return Builder
      */
     public function scopeWhereExternalURL(Builder $query, string $url): Builder
     {

app/Services/NoteService.php

@@ -15,7 +15,7 @@ class NoteService
      *
      * @param  array  $request Data from request()->all()
      * @param  string  $client
-     * @return \App\Note
+     * @return Note
      */
     public function createNote(array $request, ?string $client = null): Note
     {
@@ -136,7 +136,7 @@ class NoteService
      * Get the checkin data from the request to create a new note. This will be a Place.
      *
      * @param array $request Data from request()->all()
-     * @return \App\Models\Place|null
+     * @return Place|null
      */
     private function getCheckin(array $request): ?Place
     {

app/Services/PlaceService.php

@@ -14,7 +14,7 @@ class PlaceService
      * Create a place.
      *
      * @param array $data
-     * @return \App\Place
+     * @return Place
      */
     public function createPlace(array $data): Place
     {
@@ -39,7 +39,7 @@ class PlaceService
     }
 
     /**
-     * Create a place from a h-card checkin, for exameple from OwnYourSwarm.
+     * Create a place from a h-card checkin, for example from OwnYourSwarm.
      *
      * @param array
      * @return Place