refactor: Refactor file headers and add Psalm suppressions

- Added Psalm suppression annotations to multiple controller classes
- Added PHPDoc comment blocks to seeders and factories
- Added comments to indicate unused classes and methods
- Removed unused annotations and imports
This commit is contained in:
Jonny Barnes 2023-07-28 11:48:07 +01:00
commit 39a197ae7b
Signed by: jonny
SSH key fingerprint: SHA256:CTuSlns5U7qlD9jqHvtnVmfYV3Zwl2Z7WnJ4/dqOaL8
61 changed files with 214 additions and 74 deletions

View file

@ -8,6 +8,7 @@ use Illuminate\Support\Facades\DB;
/** /**
* @codeCoverageIgnore * @codeCoverageIgnore
* @psalm-suppress UnusedClass
*/ */
class MigratePlaceDataFromPostgis extends Command class MigratePlaceDataFromPostgis extends Command
{ {

View file

@ -9,6 +9,9 @@ use Illuminate\Console\Command;
use Illuminate\Contracts\Filesystem\FileNotFoundException; use Illuminate\Contracts\Filesystem\FileNotFoundException;
use Illuminate\FileSystem\FileSystem; use Illuminate\FileSystem\FileSystem;
/**
* @psalm-suppress UnusedClass
*/
class ParseCachedWebMentions extends Command class ParseCachedWebMentions extends Command
{ {
/** /**

View file

@ -8,6 +8,9 @@ use App\Jobs\DownloadWebMention;
use App\Models\WebMention; use App\Models\WebMention;
use Illuminate\Console\Command; use Illuminate\Console\Command;
/**
* @psalm-suppress UnusedClass
*/
class ReDownloadWebMentions extends Command class ReDownloadWebMentions extends Command
{ {
/** /**

View file

@ -9,6 +9,9 @@ use App\Models\Article;
use Illuminate\Http\RedirectResponse; use Illuminate\Http\RedirectResponse;
use Illuminate\View\View; use Illuminate\View\View;
/**
* @psalm-suppress UnusedClass
*/
class ArticlesController extends Controller class ArticlesController extends Controller
{ {
public function index(): View public function index(): View

View file

@ -10,6 +10,9 @@ use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request; use Illuminate\Http\Request;
use Illuminate\View\View; use Illuminate\View\View;
/**
* @psalm-suppress UnusedClass
*/
class BioController extends Controller class BioController extends Controller
{ {
public function show(): View public function show(): View

View file

@ -9,6 +9,9 @@ use App\Models\MicropubClient;
use Illuminate\Http\RedirectResponse; use Illuminate\Http\RedirectResponse;
use Illuminate\View\View; use Illuminate\View\View;
/**
* @psalm-suppress UnusedClass
*/
class ClientsController extends Controller class ClientsController extends Controller
{ {
/** /**

View file

@ -12,6 +12,9 @@ use Illuminate\Http\RedirectResponse;
use Illuminate\Support\Arr; use Illuminate\Support\Arr;
use Illuminate\View\View; use Illuminate\View\View;
/**
* @psalm-suppress UnusedClass
*/
class ContactsController extends Controller class ContactsController extends Controller
{ {
/** /**

View file

@ -7,6 +7,9 @@ namespace App\Http\Controllers\Admin;
use App\Http\Controllers\Controller; use App\Http\Controllers\Controller;
use Illuminate\View\View; use Illuminate\View\View;
/**
* @psalm-suppress UnusedClass
*/
class HomeController extends Controller class HomeController extends Controller
{ {
/** /**

View file

@ -10,6 +10,9 @@ use App\Models\Like;
use Illuminate\Http\RedirectResponse; use Illuminate\Http\RedirectResponse;
use Illuminate\View\View; use Illuminate\View\View;
/**
* @psalm-suppress UnusedClass
*/
class LikesController extends Controller class LikesController extends Controller
{ {
/** /**

View file

@ -11,6 +11,9 @@ use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request; use Illuminate\Http\Request;
use Illuminate\View\View; use Illuminate\View\View;
/**
* @psalm-suppress UnusedClass
*/
class NotesController extends Controller class NotesController extends Controller
{ {
/** /**

View file

@ -10,6 +10,9 @@ use App\Services\PlaceService;
use Illuminate\Http\RedirectResponse; use Illuminate\Http\RedirectResponse;
use Illuminate\View\View; use Illuminate\View\View;
/**
* @psalm-suppress UnusedClass
*/
class PlacesController extends Controller class PlacesController extends Controller
{ {
protected PlaceService $placeService; protected PlaceService $placeService;

View file

@ -10,6 +10,9 @@ use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request; use Illuminate\Http\Request;
use Illuminate\View\View; use Illuminate\View\View;
/**
* @psalm-suppress UnusedClass
*/
class SyndicationTargetsController extends Controller class SyndicationTargetsController extends Controller
{ {
/** /**

View file

@ -10,6 +10,9 @@ use Illuminate\Http\RedirectResponse;
use Illuminate\View\View; use Illuminate\View\View;
use Jonnybarnes\IndieWeb\Numbers; use Jonnybarnes\IndieWeb\Numbers;
/**
* @psalm-suppress UnusedClass
*/
class ArticlesController extends Controller class ArticlesController extends Controller
{ {
/** /**

View file

@ -9,6 +9,9 @@ use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth; use Illuminate\Support\Facades\Auth;
use Illuminate\View\View; use Illuminate\View\View;
/**
* @psalm-suppress UnusedClass
*/
class AuthController extends Controller class AuthController extends Controller
{ {
/** /**

View file

@ -7,6 +7,9 @@ namespace App\Http\Controllers;
use App\Models\Bookmark; use App\Models\Bookmark;
use Illuminate\View\View; use Illuminate\View\View;
/**
* @psalm-suppress UnusedClass
*/
class BookmarksController extends Controller class BookmarksController extends Controller
{ {
/** /**

View file

@ -8,6 +8,9 @@ use App\Models\Contact;
use Illuminate\Filesystem\Filesystem; use Illuminate\Filesystem\Filesystem;
use Illuminate\View\View; use Illuminate\View\View;
/**
* @psalm-suppress UnusedClass
*/
class ContactsController extends Controller class ContactsController extends Controller
{ {
/** /**

View file

@ -9,6 +9,9 @@ use App\Models\Note;
use Illuminate\Http\JsonResponse; use Illuminate\Http\JsonResponse;
use Illuminate\Http\Response; use Illuminate\Http\Response;
/**
* @psalm-suppress UnusedClass
*/
class FeedsController extends Controller class FeedsController extends Controller
{ {
/** /**

View file

@ -10,6 +10,9 @@ use App\Models\Note;
use Illuminate\Http\Response; use Illuminate\Http\Response;
use Illuminate\View\View; use Illuminate\View\View;
/**
* @psalm-suppress UnusedClass
*/
class FrontPageController extends Controller class FrontPageController extends Controller
{ {
/** /**

View file

@ -7,6 +7,9 @@ namespace App\Http\Controllers;
use App\Models\Like; use App\Models\Like;
use Illuminate\View\View; use Illuminate\View\View;
/**
* @psalm-suppress UnusedClass
*/
class LikesController extends Controller class LikesController extends Controller
{ {
/** /**

View file

@ -19,6 +19,9 @@ use Lcobucci\JWT\Validation\RequiredConstraintsViolated;
use Monolog\Handler\StreamHandler; use Monolog\Handler\StreamHandler;
use Monolog\Logger; use Monolog\Logger;
/**
* @psalm-suppress UnusedClass
*/
class MicropubController extends Controller class MicropubController extends Controller
{ {
protected TokenService $tokenService; protected TokenService $tokenService;

Some files were not shown because too many files have changed in this diff Show more