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:
parent
cd9fed3a68
commit
39a197ae7b
61 changed files with 214 additions and 74 deletions
|
@ -9,6 +9,9 @@ use App\Models\Article;
|
|||
use Illuminate\Http\RedirectResponse;
|
||||
use Illuminate\View\View;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class ArticlesController extends Controller
|
||||
{
|
||||
public function index(): View
|
||||
|
|
|
@ -10,6 +10,9 @@ use Illuminate\Http\RedirectResponse;
|
|||
use Illuminate\Http\Request;
|
||||
use Illuminate\View\View;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class BioController extends Controller
|
||||
{
|
||||
public function show(): View
|
||||
|
|
|
@ -9,6 +9,9 @@ use App\Models\MicropubClient;
|
|||
use Illuminate\Http\RedirectResponse;
|
||||
use Illuminate\View\View;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class ClientsController extends Controller
|
||||
{
|
||||
/**
|
||||
|
|
|
@ -12,6 +12,9 @@ use Illuminate\Http\RedirectResponse;
|
|||
use Illuminate\Support\Arr;
|
||||
use Illuminate\View\View;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class ContactsController extends Controller
|
||||
{
|
||||
/**
|
||||
|
|
|
@ -7,6 +7,9 @@ namespace App\Http\Controllers\Admin;
|
|||
use App\Http\Controllers\Controller;
|
||||
use Illuminate\View\View;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class HomeController extends Controller
|
||||
{
|
||||
/**
|
||||
|
|
|
@ -10,6 +10,9 @@ use App\Models\Like;
|
|||
use Illuminate\Http\RedirectResponse;
|
||||
use Illuminate\View\View;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class LikesController extends Controller
|
||||
{
|
||||
/**
|
||||
|
|
|
@ -11,6 +11,9 @@ use Illuminate\Http\RedirectResponse;
|
|||
use Illuminate\Http\Request;
|
||||
use Illuminate\View\View;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class NotesController extends Controller
|
||||
{
|
||||
/**
|
||||
|
|
|
@ -10,6 +10,9 @@ use App\Services\PlaceService;
|
|||
use Illuminate\Http\RedirectResponse;
|
||||
use Illuminate\View\View;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class PlacesController extends Controller
|
||||
{
|
||||
protected PlaceService $placeService;
|
||||
|
|
|
@ -10,6 +10,9 @@ use Illuminate\Http\RedirectResponse;
|
|||
use Illuminate\Http\Request;
|
||||
use Illuminate\View\View;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class SyndicationTargetsController extends Controller
|
||||
{
|
||||
/**
|
||||
|
|
|
@ -10,6 +10,9 @@ use Illuminate\Http\RedirectResponse;
|
|||
use Illuminate\View\View;
|
||||
use Jonnybarnes\IndieWeb\Numbers;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class ArticlesController extends Controller
|
||||
{
|
||||
/**
|
||||
|
|
|
@ -9,6 +9,9 @@ use Illuminate\Http\Request;
|
|||
use Illuminate\Support\Facades\Auth;
|
||||
use Illuminate\View\View;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class AuthController extends Controller
|
||||
{
|
||||
/**
|
||||
|
|
|
@ -7,6 +7,9 @@ namespace App\Http\Controllers;
|
|||
use App\Models\Bookmark;
|
||||
use Illuminate\View\View;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class BookmarksController extends Controller
|
||||
{
|
||||
/**
|
||||
|
|
|
@ -8,6 +8,9 @@ use App\Models\Contact;
|
|||
use Illuminate\Filesystem\Filesystem;
|
||||
use Illuminate\View\View;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class ContactsController extends Controller
|
||||
{
|
||||
/**
|
||||
|
|
|
@ -9,6 +9,9 @@ use App\Models\Note;
|
|||
use Illuminate\Http\JsonResponse;
|
||||
use Illuminate\Http\Response;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class FeedsController extends Controller
|
||||
{
|
||||
/**
|
||||
|
|
|
@ -10,6 +10,9 @@ use App\Models\Note;
|
|||
use Illuminate\Http\Response;
|
||||
use Illuminate\View\View;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class FrontPageController extends Controller
|
||||
{
|
||||
/**
|
||||
|
|
|
@ -7,6 +7,9 @@ namespace App\Http\Controllers;
|
|||
use App\Models\Like;
|
||||
use Illuminate\View\View;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class LikesController extends Controller
|
||||
{
|
||||
/**
|
||||
|
|
|
@ -19,6 +19,9 @@ use Lcobucci\JWT\Validation\RequiredConstraintsViolated;
|
|||
use Monolog\Handler\StreamHandler;
|
||||
use Monolog\Logger;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class MicropubController extends Controller
|
||||
{
|
||||
protected TokenService $tokenService;
|
||||
|
|
|
@ -24,6 +24,9 @@ use Lcobucci\JWT\Token\InvalidTokenStructure;
|
|||
use Lcobucci\JWT\Validation\RequiredConstraintsViolated;
|
||||
use Ramsey\Uuid\Uuid;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class MicropubMediaController extends Controller
|
||||
{
|
||||
protected TokenService $tokenService;
|
||||
|
|
|
@ -13,14 +13,16 @@ use Illuminate\Http\Response;
|
|||
use Illuminate\View\View;
|
||||
use Jonnybarnes\IndieWeb\Numbers;
|
||||
|
||||
// Need to sort out Twitter and webmentions!
|
||||
|
||||
/**
|
||||
* @todo Need to sort out Twitter and webmentions!
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class NotesController extends Controller
|
||||
{
|
||||
/**
|
||||
* Show all the notes. This is also the homepage.
|
||||
*/
|
||||
public function index(Request $request): View|Response
|
||||
public function index(): View|Response
|
||||
{
|
||||
$notes = Note::latest()
|
||||
->with('place', 'media', 'client')
|
||||
|
|
|
@ -7,6 +7,9 @@ namespace App\Http\Controllers;
|
|||
use App\Models\Place;
|
||||
use Illuminate\View\View;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class PlacesController extends Controller
|
||||
{
|
||||
/**
|
||||
|
|
|
@ -6,6 +6,9 @@ use App\Models\Note;
|
|||
use Illuminate\Http\Request;
|
||||
use Illuminate\View\View;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class SearchController extends Controller
|
||||
{
|
||||
public function search(Request $request): View
|
||||
|
|
|
@ -6,6 +6,9 @@ namespace App\Http\Controllers;
|
|||
|
||||
use Illuminate\Http\RedirectResponse;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class ShortURLsController extends Controller
|
||||
{
|
||||
/*
|
||||
|
|
|
@ -12,6 +12,9 @@ use Illuminate\Http\Request;
|
|||
use IndieAuth\Client;
|
||||
use JsonException;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class TokenEndpointController extends Controller
|
||||
{
|
||||
/**
|
||||
|
|
|
@ -12,6 +12,9 @@ use Illuminate\Http\Response;
|
|||
use Illuminate\View\View;
|
||||
use Jonnybarnes\IndieWeb\Numbers;
|
||||
|
||||
/**
|
||||
* @psalm-suppress UnusedClass
|
||||
*/
|
||||
class WebMentionsController extends Controller
|
||||
{
|
||||
/**
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue