From 2cca45bcea9e33effa5bb69aa2e37b3267a5c5e3 Mon Sep 17 00:00:00 2001 From: Refringe Date: Tue, 17 Sep 2024 13:30:11 -0400 Subject: [PATCH] Removes Array Definition Docblock Information Part of moving back to PHPStan level 5 means we can remove some of these. They're very busy and don't give enough context to outweigh the ugly. --- .../Fortify/PasswordValidationRules.php | 2 - app/Actions/Fortify/ResetUserPassword.php | 2 - app/Actions/Fortify/UpdateUserPassword.php | 2 - .../Fortify/UpdateUserProfileInformation.php | 2 - app/Http/Controllers/Api/V0/ApiController.php | 2 - app/Http/Controllers/Api/V0/ModController.php | 6 --- .../Controllers/Api/V0/UsersController.php | 6 --- app/Http/Filters/ModFilter.php | 21 +-------- app/Http/Filters/V1/ModFilter.php | 26 ---------- app/Http/Filters/V1/QueryFilter.php | 16 ------- app/Http/Filters/V1/UserFilter.php | 10 ---- app/Http/Requests/Api/LoginUserRequest.php | 2 - app/Http/Requests/Api/V0/StoreModRequest.php | 2 - app/Http/Requests/Api/V0/StoreUserRequest.php | 2 - app/Http/Requests/Api/V0/UpdateModRequest.php | 2 - .../Requests/Api/V0/UpdateUserRequest.php | 2 - app/Http/Requests/ModRequest.php | 2 - app/Http/Resources/Api/V0/LicenseResource.php | 2 - app/Http/Resources/Api/V0/ModResource.php | 2 - .../Resources/Api/V0/ModVersionResource.php | 2 - app/Http/Resources/Api/V0/UserResource.php | 2 - .../Resources/Api/V0/UserRoleResource.php | 2 - app/Http/Resources/LicenseResource.php | 2 - app/Http/Resources/ModResource.php | 2 - app/Http/Resources/ModVersionResource.php | 2 - app/Http/Resources/SptVersionResource.php | 2 - app/Jobs/Import/ImportHubDataJob.php | 16 ------- app/Livewire/GlobalSearch.php | 8 ---- app/Livewire/Mod/Listing.php | 7 --- app/Livewire/Profile/UpdateProfileForm.php | 2 - app/Models/License.php | 3 -- app/Models/Mod.php | 10 ---- app/Models/ModDependency.php | 2 - app/Models/ModVersion.php | 5 -- app/Models/Scopes/DisabledScope.php | 5 -- app/Models/Scopes/PublishedScope.php | 5 -- app/Models/SptVersion.php | 9 ---- app/Models/User.php | 12 ----- app/Models/UserRole.php | 2 - app/Notifications/ResetPassword.php | 2 - app/Notifications/VerifyEmail.php | 2 - app/Services/DependencyVersionService.php | 2 - app/Services/SptVersionService.php | 2 - app/Traits/HasCoverPhoto.php | 2 - app/Traits/V1/FilterMethods.php | 47 ++++--------------- app/View/Components/HomepageMods.php | 6 --- 46 files changed, 9 insertions(+), 265 deletions(-) diff --git a/app/Actions/Fortify/PasswordValidationRules.php b/app/Actions/Fortify/PasswordValidationRules.php index 76b19d3..3c53605 100644 --- a/app/Actions/Fortify/PasswordValidationRules.php +++ b/app/Actions/Fortify/PasswordValidationRules.php @@ -8,8 +8,6 @@ trait PasswordValidationRules { /** * Get the validation rules used to validate passwords. - * - * @return array|string> */ protected function passwordRules(): array { diff --git a/app/Actions/Fortify/ResetUserPassword.php b/app/Actions/Fortify/ResetUserPassword.php index 7a57c50..e6bd3db 100644 --- a/app/Actions/Fortify/ResetUserPassword.php +++ b/app/Actions/Fortify/ResetUserPassword.php @@ -13,8 +13,6 @@ class ResetUserPassword implements ResetsUserPasswords /** * Validate and reset the user's forgotten password. - * - * @param array $input */ public function reset(User $user, array $input): void { diff --git a/app/Actions/Fortify/UpdateUserPassword.php b/app/Actions/Fortify/UpdateUserPassword.php index 7005639..39f2cb9 100644 --- a/app/Actions/Fortify/UpdateUserPassword.php +++ b/app/Actions/Fortify/UpdateUserPassword.php @@ -13,8 +13,6 @@ class UpdateUserPassword implements UpdatesUserPasswords /** * Validate and update the user's password. - * - * @param array $input */ public function update(User $user, array $input): void { diff --git a/app/Actions/Fortify/UpdateUserProfileInformation.php b/app/Actions/Fortify/UpdateUserProfileInformation.php index 10569dd..170c9ce 100644 --- a/app/Actions/Fortify/UpdateUserProfileInformation.php +++ b/app/Actions/Fortify/UpdateUserProfileInformation.php @@ -12,8 +12,6 @@ class UpdateUserProfileInformation implements UpdatesUserProfileInformation { /** * Validate and update the given user's profile information. - * - * @param array $input */ public function update(User $user, array $input): void { diff --git a/app/Http/Controllers/Api/V0/ApiController.php b/app/Http/Controllers/Api/V0/ApiController.php index 152e1fe..f8b8860 100644 --- a/app/Http/Controllers/Api/V0/ApiController.php +++ b/app/Http/Controllers/Api/V0/ApiController.php @@ -12,8 +12,6 @@ class ApiController extends Controller /** * Determine if the given relationship should be included in the request. If more than one relationship is provided, * only one needs to be present in the request for this method to return true. - * - * @param string|string[] $relationships */ public static function shouldInclude(string|array $relationships): bool { diff --git a/app/Http/Controllers/Api/V0/ModController.php b/app/Http/Controllers/Api/V0/ModController.php index 1eca110..b0f738a 100644 --- a/app/Http/Controllers/Api/V0/ModController.php +++ b/app/Http/Controllers/Api/V0/ModController.php @@ -38,8 +38,6 @@ class ModController extends ApiController return ModResource::collection(Mod::filter($filters)->paginate()); } - //public function store(StoreModRequest $request): void {} - /** * Get Mod * @@ -53,8 +51,4 @@ class ModController extends ApiController { return new ModResource($mod); } - - //public function update(UpdateModRequest $request, Mod $mod): void {} - - //public function destroy(Mod $mod): void {} } diff --git a/app/Http/Controllers/Api/V0/UsersController.php b/app/Http/Controllers/Api/V0/UsersController.php index 737e87e..69a4b56 100644 --- a/app/Http/Controllers/Api/V0/UsersController.php +++ b/app/Http/Controllers/Api/V0/UsersController.php @@ -29,8 +29,6 @@ class UsersController extends ApiController return UserResource::collection(User::filter($filters)->paginate()); } - //public function store(StoreUserRequest $request): void {} - /** * Get User * @@ -43,8 +41,4 @@ class UsersController extends ApiController { return new UserResource($user); } - - //public function update(UpdateUserRequest $request, User $user): void {} - - //public function destroy(User $user): void {} } diff --git a/app/Http/Filters/ModFilter.php b/app/Http/Filters/ModFilter.php index 878fd1c..ec3f493 100644 --- a/app/Http/Filters/ModFilter.php +++ b/app/Http/Filters/ModFilter.php @@ -10,22 +10,16 @@ class ModFilter { /** * The query builder instance for the mod model. - * - * @var Builder */ protected Builder $builder; /** * The filters to apply. - * - * @var array */ protected array $filters; /** - * Constructor. - * - * @param array $filters + * Create a new ModFilter instance. */ public function __construct(array $filters) { @@ -35,8 +29,6 @@ class ModFilter /** * The base query for the mod listing. - * - * @return Builder */ private function baseQuery(): Builder { @@ -59,8 +51,6 @@ class ModFilter /** * Filter the results by the given search term. - * - * @return Builder */ private function query(string $term): Builder { @@ -69,8 +59,6 @@ class ModFilter /** * Apply the filters to the query. - * - * @return Builder */ public function apply(): Builder { @@ -85,8 +73,6 @@ class ModFilter /** * Order the query by the given type. - * - * @return Builder */ private function order(string $type): Builder { @@ -99,8 +85,6 @@ class ModFilter /** * Filter the results by the featured status. - * - * @return Builder */ private function featured(string $option): Builder { @@ -113,9 +97,6 @@ class ModFilter /** * Filter the results to specific SPT versions. - * - * @param array $versions - * @return Builder */ private function sptVersions(array $versions): Builder { diff --git a/app/Http/Filters/V1/ModFilter.php b/app/Http/Filters/V1/ModFilter.php index 8ef54ac..ffd8d6e 100644 --- a/app/Http/Filters/V1/ModFilter.php +++ b/app/Http/Filters/V1/ModFilter.php @@ -12,8 +12,6 @@ class ModFilter extends QueryFilter { /** * The sortable fields. - * - * @var array */ protected array $sortable = [ 'name', @@ -30,8 +28,6 @@ class ModFilter extends QueryFilter /** * Filter by ID. - * - * @return Builder */ public function id(string $value): Builder { @@ -40,8 +36,6 @@ class ModFilter extends QueryFilter /** * Filter by hub ID. - * - * @return Builder */ public function hub_id(string $value): Builder { @@ -50,8 +44,6 @@ class ModFilter extends QueryFilter /** * Filter by name. - * - * @return Builder */ public function name(string $value): Builder { @@ -60,8 +52,6 @@ class ModFilter extends QueryFilter /** * Filter by slug. - * - * @return Builder */ public function slug(string $value): Builder { @@ -70,8 +60,6 @@ class ModFilter extends QueryFilter /** * Filter by teaser. - * - * @return Builder */ public function teaser(string $value): Builder { @@ -80,8 +68,6 @@ class ModFilter extends QueryFilter /** * Filter by source code link. - * - * @return Builder */ public function source_code_link(string $value): Builder { @@ -90,8 +76,6 @@ class ModFilter extends QueryFilter /** * Filter by created at date. - * - * @return Builder */ public function created_at(string $value): Builder { @@ -100,8 +84,6 @@ class ModFilter extends QueryFilter /** * Filter by updated at date. - * - * @return Builder */ public function updated_at(string $value): Builder { @@ -110,8 +92,6 @@ class ModFilter extends QueryFilter /** * Filter by published at date. - * - * @return Builder */ public function published_at(string $value): Builder { @@ -120,8 +100,6 @@ class ModFilter extends QueryFilter /** * Filter by featured. - * - * @return Builder */ public function featured(string $value): Builder { @@ -130,8 +108,6 @@ class ModFilter extends QueryFilter /** * Filter by contains ads. - * - * @return Builder */ public function contains_ads(string $value): Builder { @@ -140,8 +116,6 @@ class ModFilter extends QueryFilter /** * Filter by contains AI content. - * - * @return Builder */ public function contains_ai_content(string $value): Builder { diff --git a/app/Http/Filters/V1/QueryFilter.php b/app/Http/Filters/V1/QueryFilter.php index bdaa249..4823273 100644 --- a/app/Http/Filters/V1/QueryFilter.php +++ b/app/Http/Filters/V1/QueryFilter.php @@ -4,25 +4,17 @@ namespace App\Http\Filters\V1; use App\Traits\V1\FilterMethods; use Illuminate\Database\Eloquent\Builder; -use Illuminate\Database\Eloquent\Model; use Illuminate\Http\Request; -/** - * @template TModelClass of Model - */ abstract class QueryFilter { /** * Include general filter methods. - * - * @use FilterMethods */ use FilterMethods; /** * The query builder instance. - * - * @var Builder */ protected Builder $builder; @@ -33,8 +25,6 @@ abstract class QueryFilter /** * The sortable fields. - * - * @var array */ protected array $sortable = []; @@ -48,9 +38,6 @@ abstract class QueryFilter /** * Iterate over each of the filter options and call the appropriate method if it exists. - * - * @param array $filters - * @return Builder */ public function filter(array $filters): Builder { @@ -65,9 +52,6 @@ abstract class QueryFilter /** * Iterate over all request data and call the appropriate method if it exists. - * - * @param Builder $builder - * @return Builder */ public function apply(Builder $builder): Builder { diff --git a/app/Http/Filters/V1/UserFilter.php b/app/Http/Filters/V1/UserFilter.php index e3d7ff2..99ac7b0 100644 --- a/app/Http/Filters/V1/UserFilter.php +++ b/app/Http/Filters/V1/UserFilter.php @@ -12,8 +12,6 @@ class UserFilter extends QueryFilter { /** * The sortable fields. - * - * @var array */ protected array $sortable = [ 'name', @@ -23,8 +21,6 @@ class UserFilter extends QueryFilter /** * Filter by ID. - * - * @return Builder */ public function id(string $value): Builder { @@ -33,8 +29,6 @@ class UserFilter extends QueryFilter /** * Filter by name. - * - * @return Builder */ public function name(string $value): Builder { @@ -43,8 +37,6 @@ class UserFilter extends QueryFilter /** * Filter by created at date. - * - * @return Builder */ public function created_at(string $value): Builder { @@ -53,8 +45,6 @@ class UserFilter extends QueryFilter /** * Filter by updated at date. - * - * @return Builder */ public function updated_at(string $value): Builder { diff --git a/app/Http/Requests/Api/LoginUserRequest.php b/app/Http/Requests/Api/LoginUserRequest.php index 0fc932a..4ad184e 100644 --- a/app/Http/Requests/Api/LoginUserRequest.php +++ b/app/Http/Requests/Api/LoginUserRequest.php @@ -16,8 +16,6 @@ class LoginUserRequest extends FormRequest /** * Get the validation rules that apply to the request. - * - * @return array */ public function rules(): array { diff --git a/app/Http/Requests/Api/V0/StoreModRequest.php b/app/Http/Requests/Api/V0/StoreModRequest.php index 267f46f..b7a0267 100644 --- a/app/Http/Requests/Api/V0/StoreModRequest.php +++ b/app/Http/Requests/Api/V0/StoreModRequest.php @@ -16,8 +16,6 @@ class StoreModRequest extends FormRequest /** * Get the validation rules that apply to the request. - * - * @return array */ public function rules(): array { diff --git a/app/Http/Requests/Api/V0/StoreUserRequest.php b/app/Http/Requests/Api/V0/StoreUserRequest.php index 38b3837..552e486 100644 --- a/app/Http/Requests/Api/V0/StoreUserRequest.php +++ b/app/Http/Requests/Api/V0/StoreUserRequest.php @@ -16,8 +16,6 @@ class StoreUserRequest extends FormRequest /** * Get the validation rules that apply to the request. - * - * @return array */ public function rules(): array { diff --git a/app/Http/Requests/Api/V0/UpdateModRequest.php b/app/Http/Requests/Api/V0/UpdateModRequest.php index 2193e6b..25fed3b 100644 --- a/app/Http/Requests/Api/V0/UpdateModRequest.php +++ b/app/Http/Requests/Api/V0/UpdateModRequest.php @@ -16,8 +16,6 @@ class UpdateModRequest extends FormRequest /** * Get the validation rules that apply to the request. - * - * @return array */ public function rules(): array { diff --git a/app/Http/Requests/Api/V0/UpdateUserRequest.php b/app/Http/Requests/Api/V0/UpdateUserRequest.php index d52533e..0200f3e 100644 --- a/app/Http/Requests/Api/V0/UpdateUserRequest.php +++ b/app/Http/Requests/Api/V0/UpdateUserRequest.php @@ -16,8 +16,6 @@ class UpdateUserRequest extends FormRequest /** * Get the validation rules that apply to the request. - * - * @return array */ public function rules(): array { diff --git a/app/Http/Requests/ModRequest.php b/app/Http/Requests/ModRequest.php index 3899ae6..816527c 100644 --- a/app/Http/Requests/ModRequest.php +++ b/app/Http/Requests/ModRequest.php @@ -8,8 +8,6 @@ class ModRequest extends FormRequest { /** * Get the validation rules that apply to the request. - * - * @return array */ public function rules(): array { diff --git a/app/Http/Resources/Api/V0/LicenseResource.php b/app/Http/Resources/Api/V0/LicenseResource.php index e2e54b2..1ac360c 100644 --- a/app/Http/Resources/Api/V0/LicenseResource.php +++ b/app/Http/Resources/Api/V0/LicenseResource.php @@ -11,8 +11,6 @@ class LicenseResource extends JsonResource { /** * Transform the resource into an array. - * - * @return array */ public function toArray(Request $request): array { diff --git a/app/Http/Resources/Api/V0/ModResource.php b/app/Http/Resources/Api/V0/ModResource.php index 36bcfba..23ed9cc 100644 --- a/app/Http/Resources/Api/V0/ModResource.php +++ b/app/Http/Resources/Api/V0/ModResource.php @@ -12,8 +12,6 @@ class ModResource extends JsonResource { /** * Transform the resource into an array. - * - * @return array */ public function toArray(Request $request): array { diff --git a/app/Http/Resources/Api/V0/ModVersionResource.php b/app/Http/Resources/Api/V0/ModVersionResource.php index 107b21c..63e5a3e 100644 --- a/app/Http/Resources/Api/V0/ModVersionResource.php +++ b/app/Http/Resources/Api/V0/ModVersionResource.php @@ -11,8 +11,6 @@ class ModVersionResource extends JsonResource { /** * Transform the resource into an array. - * - * @return array */ public function toArray(Request $request): array { diff --git a/app/Http/Resources/Api/V0/UserResource.php b/app/Http/Resources/Api/V0/UserResource.php index 8dfd91f..ce37906 100644 --- a/app/Http/Resources/Api/V0/UserResource.php +++ b/app/Http/Resources/Api/V0/UserResource.php @@ -12,8 +12,6 @@ class UserResource extends JsonResource { /** * Transform the resource into an array. - * - * @return array */ public function toArray(Request $request): array { diff --git a/app/Http/Resources/Api/V0/UserRoleResource.php b/app/Http/Resources/Api/V0/UserRoleResource.php index 4d16ad6..0932611 100644 --- a/app/Http/Resources/Api/V0/UserRoleResource.php +++ b/app/Http/Resources/Api/V0/UserRoleResource.php @@ -11,8 +11,6 @@ class UserRoleResource extends JsonResource { /** * Transform the resource into an array. - * - * @return array */ public function toArray(Request $request): array { diff --git a/app/Http/Resources/LicenseResource.php b/app/Http/Resources/LicenseResource.php index 46d9f43..773e084 100644 --- a/app/Http/Resources/LicenseResource.php +++ b/app/Http/Resources/LicenseResource.php @@ -11,8 +11,6 @@ class LicenseResource extends JsonResource { /** * Transform the resource into an array. - * - * @return array */ public function toArray(Request $request): array { diff --git a/app/Http/Resources/ModResource.php b/app/Http/Resources/ModResource.php index db56e51..c5d8cde 100644 --- a/app/Http/Resources/ModResource.php +++ b/app/Http/Resources/ModResource.php @@ -11,8 +11,6 @@ class ModResource extends JsonResource { /** * Transform the resource into an array. - * - * @return array */ public function toArray(Request $request): array { diff --git a/app/Http/Resources/ModVersionResource.php b/app/Http/Resources/ModVersionResource.php index 1878b8b..831622b 100644 --- a/app/Http/Resources/ModVersionResource.php +++ b/app/Http/Resources/ModVersionResource.php @@ -11,8 +11,6 @@ class ModVersionResource extends JsonResource { /** * Transform the resource into an array. - * - * @return array */ public function toArray(Request $request): array { diff --git a/app/Http/Resources/SptVersionResource.php b/app/Http/Resources/SptVersionResource.php index 58d3d62..87542c1 100644 --- a/app/Http/Resources/SptVersionResource.php +++ b/app/Http/Resources/SptVersionResource.php @@ -11,8 +11,6 @@ class SptVersionResource extends JsonResource { /** * Transform the resource into an array. - * - * @return array */ public function toArray(Request $request): array { diff --git a/app/Jobs/Import/ImportHubDataJob.php b/app/Jobs/Import/ImportHubDataJob.php index 745a73f..57006d0 100644 --- a/app/Jobs/Import/ImportHubDataJob.php +++ b/app/Jobs/Import/ImportHubDataJob.php @@ -348,8 +348,6 @@ class ImportHubDataJob implements ShouldBeUnique, ShouldQueue /** * Build an array of user data ready to be inserted into the local database. - * - * @return array */ protected function collectUserData(CurlHandle $curl, HubUser $hubUser): array { @@ -464,8 +462,6 @@ class ImportHubDataJob implements ShouldBeUnique, ShouldQueue /** * Build an array of banned user data ready to be inserted into the local database. - * - * @return array|null */ protected function collectBannedUserData(HubUser $hubUser): ?array { @@ -522,8 +518,6 @@ class ImportHubDataJob implements ShouldBeUnique, ShouldQueue /** * Build an array of user rank data ready to be inserted into the local database. - * - * @return array|null */ protected function collectUserRankData(HubUser $hubUser): ?array { @@ -539,8 +533,6 @@ class ImportHubDataJob implements ShouldBeUnique, ShouldQueue /** * Insert or update the users in the local database. - * - * @param array> $usersData */ protected function upsertUsers(array $usersData): void { @@ -557,8 +549,6 @@ class ImportHubDataJob implements ShouldBeUnique, ShouldQueue /** * Fetch the hub-banned users from the local database and ban them locally. - * - * @param array> $bannedUsers */ protected function handleBannedUsers(array $bannedUsers): void { @@ -573,8 +563,6 @@ class ImportHubDataJob implements ShouldBeUnique, ShouldQueue /** * Fetch or create the user ranks in the local database and assign them to the users. - * - * @param array> $userRanks */ protected function handleUserRoles(array $userRanks): void { @@ -591,8 +579,6 @@ class ImportHubDataJob implements ShouldBeUnique, ShouldQueue /** * Build the user role data based on the role name. - * - * @return array */ protected function buildUserRoleData(string $name): array { @@ -710,8 +696,6 @@ class ImportHubDataJob implements ShouldBeUnique, ShouldQueue /** * Get the latest current version from the response data. - * - * @param array> $versions */ protected function getLatestVersion(array $versions): string { diff --git a/app/Livewire/GlobalSearch.php b/app/Livewire/GlobalSearch.php index 10fc1d7..46dabd7 100644 --- a/app/Livewire/GlobalSearch.php +++ b/app/Livewire/GlobalSearch.php @@ -35,8 +35,6 @@ class GlobalSearch extends Component /** * Execute the search against each of the searchable models. - * - * @return array>> */ protected function executeSearch(string $query): array { @@ -58,8 +56,6 @@ class GlobalSearch extends Component /** * Fetch the user search results. - * - * @return Collection> */ protected function fetchUserResults(string $query): Collection { @@ -71,8 +67,6 @@ class GlobalSearch extends Component /** * Fetch the mod search results. - * - * @return Collection> */ protected function fetchModResults(string $query): Collection { @@ -84,8 +78,6 @@ class GlobalSearch extends Component /** * Count the total number of results across all models. - * - * @param array>> $results */ protected function countTotalResults(array $results): int { diff --git a/app/Livewire/Mod/Listing.php b/app/Livewire/Mod/Listing.php index 1edf8dd..422ad0c 100644 --- a/app/Livewire/Mod/Listing.php +++ b/app/Livewire/Mod/Listing.php @@ -3,7 +3,6 @@ namespace App\Livewire\Mod; use App\Http\Filters\ModFilter; -use App\Models\Mod; use App\Models\SptVersion; use Illuminate\Contracts\Pagination\LengthAwarePaginator; use Illuminate\Contracts\View\View; @@ -32,8 +31,6 @@ class Listing extends Component /** * The SPT versions filter value. - * - * @var array */ #[Url] public array $sptVersions = []; @@ -65,8 +62,6 @@ class Listing extends Component /** * Get all patch versions of the latest minor SPT version. - * - * @return Collection */ public function getLatestMinorVersions(): Collection { @@ -96,8 +91,6 @@ class Listing extends Component /** * Check if the current page is greater than the last page. Redirect if it is. - * - * @param LengthAwarePaginator $mods */ private function redirectOutOfBoundsPage(LengthAwarePaginator $mods): void { diff --git a/app/Livewire/Profile/UpdateProfileForm.php b/app/Livewire/Profile/UpdateProfileForm.php index 127e34f..2408030 100644 --- a/app/Livewire/Profile/UpdateProfileForm.php +++ b/app/Livewire/Profile/UpdateProfileForm.php @@ -12,8 +12,6 @@ class UpdateProfileForm extends UpdateProfileInformationForm { /** * The new cover photo for the user. - * - * @var mixed */ public $cover; diff --git a/app/Models/License.php b/app/Models/License.php index 00533bc..5c013b6 100644 --- a/app/Models/License.php +++ b/app/Models/License.php @@ -2,7 +2,6 @@ namespace App\Models; -use Database\Factories\LicenseFactory; use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\HasMany; @@ -10,9 +9,7 @@ use Illuminate\Database\Eloquent\SoftDeletes; class License extends Model { - /** @use HasFactory */ use HasFactory; - use SoftDeletes; /** diff --git a/app/Models/Mod.php b/app/Models/Mod.php index 75755bc..292a49c 100644 --- a/app/Models/Mod.php +++ b/app/Models/Mod.php @@ -96,8 +96,6 @@ class Mod extends Model /** * The data that is searchable by Scout. - * - * @return array */ public function toSearchableArray(): array { @@ -173,8 +171,6 @@ class Mod extends Model /** * Build the URL to the mod's thumbnail. - * - * @return Attribute */ public function thumbnailUrl(): Attribute { @@ -198,10 +194,6 @@ class Mod extends Model /** * Scope a query by applying QueryFilter filters. - * - * @param Builder $builder - * @param QueryFilter $filters - * @return Builder */ public function scopeFilter(Builder $builder, QueryFilter $filters): Builder { @@ -218,8 +210,6 @@ class Mod extends Model /** * The attributes that should be cast to native types. - * - * @return array */ protected function casts(): array { diff --git a/app/Models/ModDependency.php b/app/Models/ModDependency.php index 1a65b71..31de493 100644 --- a/app/Models/ModDependency.php +++ b/app/Models/ModDependency.php @@ -2,7 +2,6 @@ namespace App\Models; -use Database\Factories\ModDependencyFactory; use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\BelongsTo; @@ -10,7 +9,6 @@ use Illuminate\Database\Eloquent\Relations\HasMany; class ModDependency extends Model { - /** @use HasFactory */ use HasFactory; /** diff --git a/app/Models/ModVersion.php b/app/Models/ModVersion.php index f05435f..15d867b 100644 --- a/app/Models/ModVersion.php +++ b/app/Models/ModVersion.php @@ -6,7 +6,6 @@ use App\Exceptions\InvalidVersionNumberException; use App\Models\Scopes\DisabledScope; use App\Models\Scopes\PublishedScope; use App\Support\Version; -use Database\Factories\ModFactory; use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\BelongsTo; @@ -17,15 +16,11 @@ use Illuminate\Database\Eloquent\SoftDeletes; class ModVersion extends Model { - /** @use HasFactory */ use HasFactory; - use SoftDeletes; /** * Update the parent mod's updated_at timestamp when the mod version is updated. - * - * @var array */ protected $touches = ['mod']; diff --git a/app/Models/Scopes/DisabledScope.php b/app/Models/Scopes/DisabledScope.php index 58a982e..517d3ba 100644 --- a/app/Models/Scopes/DisabledScope.php +++ b/app/Models/Scopes/DisabledScope.php @@ -6,15 +6,10 @@ use Illuminate\Database\Eloquent\Builder; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Scope; -/** - * @template TModelClass of Model - */ class DisabledScope implements Scope { /** * Apply the scope to a given Eloquent query builder. - * - * @param Builder $builder */ public function apply(Builder $builder, Model $model): void { diff --git a/app/Models/Scopes/PublishedScope.php b/app/Models/Scopes/PublishedScope.php index ac8a2a9..a4576ed 100644 --- a/app/Models/Scopes/PublishedScope.php +++ b/app/Models/Scopes/PublishedScope.php @@ -6,15 +6,10 @@ use Illuminate\Database\Eloquent\Builder; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Scope; -/** - * @template TModelClass of Model - */ class PublishedScope implements Scope { /** * Apply the scope to a given Eloquent query builder. - * - * @param Builder $builder */ public function apply(Builder $builder, Model $model): void { diff --git a/app/Models/SptVersion.php b/app/Models/SptVersion.php index 4649434..dfb7086 100644 --- a/app/Models/SptVersion.php +++ b/app/Models/SptVersion.php @@ -4,7 +4,6 @@ namespace App\Models; use App\Exceptions\InvalidVersionNumberException; use App\Support\Version; -use Database\Factories\SptVersionFactory; use Illuminate\Database\Eloquent\Collection; use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Database\Eloquent\Model; @@ -14,15 +13,11 @@ use Illuminate\Support\Facades\Cache; class SptVersion extends Model { - /** @use HasFactory */ use HasFactory; - use SoftDeletes; /** * Get all versions for the last three minor versions. - * - * @return Collection */ public static function getVersionsForLastThreeMinors(): Collection { @@ -51,8 +46,6 @@ class SptVersion extends Model /** * Get the last three minor versions (major.minor format). - * - * @return array */ public static function getLastThreeMinorVersions(): array { @@ -75,8 +68,6 @@ class SptVersion extends Model /** * Extract the version sections from the version string. * - * @return array{major: int, minor: int, patch: int, pre_release: string} - * * @throws InvalidVersionNumberException */ public static function extractVersionSections(string $version): array diff --git a/app/Models/User.php b/app/Models/User.php index c5efa96..74df4fd 100644 --- a/app/Models/User.php +++ b/app/Models/User.php @@ -6,7 +6,6 @@ use App\Http\Filters\V1\QueryFilter; use App\Notifications\ResetPassword; use App\Notifications\VerifyEmail; use App\Traits\HasCoverPhoto; -use Database\Factories\UserFactory; use Illuminate\Contracts\Auth\MustVerifyEmail; use Illuminate\Database\Eloquent\Builder; use Illuminate\Database\Eloquent\Factories\HasFactory; @@ -26,10 +25,7 @@ class User extends Authenticatable implements MustVerifyEmail use Bannable; use HasApiTokens; use HasCoverPhoto; - - /** @use HasFactory */ use HasFactory; - use HasProfilePhoto; use Notifiable; use Searchable; @@ -58,8 +54,6 @@ class User extends Authenticatable implements MustVerifyEmail /** * The data that is searchable by Scout. - * - * @return array */ public function toSearchableArray(): array { @@ -150,10 +144,6 @@ class User extends Authenticatable implements MustVerifyEmail /** * Scope a query by applying QueryFilter filters. - * - * @param Builder $builder - * @param QueryFilter $filters - * @return Builder */ public function scopeFilter(Builder $builder, QueryFilter $filters): Builder { @@ -170,8 +160,6 @@ class User extends Authenticatable implements MustVerifyEmail /** * The attributes that should be cast to native types. - * - * @return array */ protected function casts(): array { diff --git a/app/Models/UserRole.php b/app/Models/UserRole.php index e56dfe3..09f1906 100644 --- a/app/Models/UserRole.php +++ b/app/Models/UserRole.php @@ -2,14 +2,12 @@ namespace App\Models; -use Database\Factories\UserFactory; use Illuminate\Database\Eloquent\Factories\HasFactory; use Illuminate\Database\Eloquent\Model; use Illuminate\Database\Eloquent\Relations\HasMany; class UserRole extends Model { - /** @use HasFactory */ use HasFactory; /** diff --git a/app/Notifications/ResetPassword.php b/app/Notifications/ResetPassword.php index 9545c9a..3c61a98 100644 --- a/app/Notifications/ResetPassword.php +++ b/app/Notifications/ResetPassword.php @@ -20,8 +20,6 @@ class ResetPassword extends OriginalResetPassword implements ShouldQueue /** * Get the array representation of the notification. - * - * @return array */ public function toArray(object $notifiable): array { diff --git a/app/Notifications/VerifyEmail.php b/app/Notifications/VerifyEmail.php index fc3fd55..461f840 100644 --- a/app/Notifications/VerifyEmail.php +++ b/app/Notifications/VerifyEmail.php @@ -15,8 +15,6 @@ class VerifyEmail extends OriginalVerifyEmail implements ShouldQueue /** * Get the array representation of the notification. - * - * @return array */ public function toArray(object $notifiable): array { diff --git a/app/Services/DependencyVersionService.php b/app/Services/DependencyVersionService.php index 9598ade..556314e 100644 --- a/app/Services/DependencyVersionService.php +++ b/app/Services/DependencyVersionService.php @@ -18,8 +18,6 @@ class DependencyVersionService /** * Satisfies all dependency constraints of a ModVersion. - * - * @return array> */ private function satisfyConstraint(ModVersion $modVersion): array { diff --git a/app/Services/SptVersionService.php b/app/Services/SptVersionService.php index 2a8aa53..8eba213 100644 --- a/app/Services/SptVersionService.php +++ b/app/Services/SptVersionService.php @@ -19,8 +19,6 @@ class SptVersionService /** * Satisfies the version constraint of a given ModVersion. Returns the ID of the satisfying SptVersion. - * - * @return array */ private function satisfyConstraint(ModVersion $modVersion): array { diff --git a/app/Traits/HasCoverPhoto.php b/app/Traits/HasCoverPhoto.php index d52adb4..b366079 100644 --- a/app/Traits/HasCoverPhoto.php +++ b/app/Traits/HasCoverPhoto.php @@ -52,8 +52,6 @@ trait HasCoverPhoto /** * Get the cover photo URL for the user. - * - * @return Attribute */ public function coverPhotoUrl(): Attribute { diff --git a/app/Traits/V1/FilterMethods.php b/app/Traits/V1/FilterMethods.php index 39059c1..d20b94c 100644 --- a/app/Traits/V1/FilterMethods.php +++ b/app/Traits/V1/FilterMethods.php @@ -2,93 +2,63 @@ namespace App\Traits\V1; -use App\Http\Filters\V1\QueryFilter; use Illuminate\Database\Eloquent\Builder; -use Illuminate\Database\Eloquent\Model; use Illuminate\Support\Str; -/** - * @template TModelClass of Model - * - * @mixin QueryFilter - */ trait FilterMethods { /** * Filter using a whereIn clause. - * - * @return Builder */ public function filterWhereIn(string $column, string $value): Builder { $ids = array_map('trim', explode(',', $value)); - $result = $this->builder->whereIn($column, $ids); - - /** @var Builder $result */ - return $result; + return $this->builder->whereIn($column, $ids); } /** * Filter using a LIKE clause with a wildcard characters. - * - * @return Builder */ public function filterByWildcardLike(string $column, string $value): Builder { $like = Str::replace('*', '%', $value); - $result = $this->builder->where($column, 'like', $like); - - /** @var Builder $result */ - return $result; + return $this->builder->where($column, 'like', $like); } /** * Filter by date range or specific date. - * - * @return Builder */ public function filterByDate(string $column, string $value): Builder { $dates = array_map('trim', explode(',', $value)); if (count($dates) > 1) { - $result = $this->builder->whereBetween($column, $dates); - } else { - $result = $this->builder->whereDate($column, $dates[0]); + return $this->builder->whereBetween($column, $dates); } - /** @var Builder $result */ - return $result; + return $this->builder->whereDate($column, $dates[0]); } /** * Filter by boolean value. - * - * @return Builder */ public function filterByBoolean(string $column, string $value): Builder { $value = filter_var($value, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE); if ($value === null) { - $result = $this->builder; // The unmodified builder - } else { - $result = $this->builder->where($column, $value); + return $this->builder; // The unmodified builder } - /** @var Builder $result */ - return $result; + return $this->builder->where($column, $value); } /** * Apply the sort type to the query. - * - * @return Builder */ protected function sort(string $values): Builder { - $result = $this->builder; $sortables = array_map('trim', explode(',', $values)); foreach ($sortables as $sortable) { @@ -96,11 +66,10 @@ trait FilterMethods $column = Str::of($sortable)->remove('-')->value(); if (in_array($column, $this->sortable)) { - $result = $this->builder->orderBy($column, $direction); + $this->builder->orderBy($column, $direction); } } - /** @var Builder $result */ - return $result; + return $this->builder; } } diff --git a/app/View/Components/HomepageMods.php b/app/View/Components/HomepageMods.php index 74e40ca..a0d3520 100644 --- a/app/View/Components/HomepageMods.php +++ b/app/View/Components/HomepageMods.php @@ -33,8 +33,6 @@ class HomepageMods extends Component /** * Fetches the featured mods homepage listing. - * - * @return Collection */ private function fetchFeaturedMods(): Collection { @@ -54,8 +52,6 @@ class HomepageMods extends Component /** * Fetches the latest mods homepage listing. - * - * @return Collection */ private function fetchLatestMods(): Collection { @@ -74,8 +70,6 @@ class HomepageMods extends Component /** * Fetches the recently updated mods homepage listing. - * - * @return Collection */ private function fetchUpdatedMods(): Collection {