From 684ce6bc56e7bed079bdf8b1fdacb352e937e964 Mon Sep 17 00:00:00 2001 From: Matthew Brown Date: Sat, 16 Feb 2019 13:20:28 -0500 Subject: [PATCH] refactor: fix bad return types with Psalter (#2435) --- app/Console/Commands/CalculateStatistics.php | 4 +- app/Console/Commands/ExportAll.php | 4 +- app/Console/Commands/GetVersion.php | 4 +- app/Console/Commands/Inspire.php | 4 +- app/Console/Commands/LangGenerate.php | 4 +- app/Console/Commands/SendReminders.php | 4 +- app/Console/Commands/SendStayInTouch.php | 4 +- app/Console/Commands/SetPremiumAccount.php | 4 +- app/Console/Commands/SetupFrontEndTest.php | 4 +- app/Console/Commands/Update.php | 4 +- app/Helpers/DateHelper.php | 11 +++-- app/Helpers/RequestHelper.php | 2 +- .../ActivityTypeCategoriesController.php | 3 +- .../Activity/ActivityTypesController.php | 3 +- app/Http/Controllers/ActivitiesController.php | 18 ++++--- .../ApiActivityTypeCategoryController.php | 26 +++++----- .../Activity/ApiActivityTypeController.php | 24 ++++++---- .../Api/Account/ApiCompanyController.php | 24 ++++++---- .../Api/Account/ApiGenderController.php | 24 ++++++---- .../Api/Account/ApiPlaceController.php | 24 ++++++---- .../Api/Account/ApiUserController.php | 16 ++++--- .../Controllers/Api/ApiActivityController.php | 32 ++++++++----- .../Controllers/Api/ApiContactController.php | 25 ++++++---- .../Api/ApiContactFieldController.php | 35 ++++++++------ .../Controllers/Api/ApiDebtController.php | 32 ++++++++----- .../Controllers/Api/ApiGiftController.php | 32 ++++++++----- .../Controllers/Api/ApiJournalController.php | 30 +++++++----- .../Controllers/Api/ApiNoteController.php | 32 ++++++++----- app/Http/Controllers/Api/ApiPetController.php | 40 ++++++++++------ .../Api/ApiRelationshipController.php | 26 +++++----- .../Api/ApiRelationshipTypeController.php | 10 ++-- .../ApiRelationshipTypeGroupController.php | 10 ++-- .../Controllers/Api/ApiReminderController.php | 30 +++++++----- app/Http/Controllers/Api/ApiTagController.php | 26 ++++++---- .../Controllers/Api/ApiTaskController.php | 30 +++++++----- .../Controllers/Api/Auth/OAuthController.php | 7 +-- .../Api/Contact/ApiAddressController.php | 29 ++++++----- .../Api/Contact/ApiCallController.php | 28 ++++++----- .../Api/Contact/ApiConversationController.php | 28 ++++++----- .../Api/Contact/ApiDocumentController.php | 9 ++-- .../Api/Contact/ApiLifeEventController.php | 26 +++++----- .../Api/Contact/ApiMessageController.php | 23 +++++---- .../Api/Contact/ApiOccupationController.php | 24 ++++++---- .../Api/Misc/ApiCountryController.php | 2 +- .../Api/Settings/ApiComplianceController.php | 8 ++-- .../ApiContactFieldTypeController.php | 30 +++++++----- .../Api/Settings/ApiCurrencyController.php | 7 +-- .../Statistics/ApiStatisticsController.php | 2 +- .../Auth/EmailChangeController.php | 20 ++++---- .../Auth/PasswordChangeController.php | 9 ++-- .../Auth/RecoveryLoginController.php | 8 ++-- .../Controllers/Auth/RegisterController.php | 2 +- .../Auth/Validate2faController.php | 5 +- app/Http/Controllers/ChangelogController.php | 3 +- app/Http/Controllers/ComplianceController.php | 8 ++-- .../Contacts/AddressesController.php | 3 +- .../Controllers/Contacts/CallsController.php | 8 ++-- .../Contacts/ConversationsController.php | 19 +++++--- .../Controllers/Contacts/DebtController.php | 23 +++++---- .../Contacts/DocumentsController.php | 13 +++-- .../Controllers/Contacts/GiftsController.php | 23 +++++---- .../Contacts/IntroductionsController.php | 6 ++- .../Contacts/LifeEventsController.php | 18 ++++--- .../Controllers/Contacts/NotesController.php | 10 ++-- .../Controllers/Contacts/PhotosController.php | 13 +++-- .../Contacts/RelationshipsController.php | 17 ++++--- .../Contacts/RemindersController.php | 15 ++++-- .../Controllers/Contacts/TagsController.php | 10 ++-- app/Http/Controllers/ContactsController.php | 48 ++++++++++++------- .../DAV/Backend/CalDAV/CalDAVBackend.php | 5 +- .../DAV/Backend/CardDAV/CardDAVBackend.php | 4 +- app/Http/Controllers/DashboardController.php | 2 +- app/Http/Controllers/EmotionController.php | 6 +-- app/Http/Controllers/JournalController.php | 9 ++-- .../Settings/MultiFAController.php | 9 ++-- .../Settings/PersonalizationController.php | 8 ++-- .../Settings/SubscriptionsController.php | 14 +++--- app/Http/Controllers/SettingsController.php | 41 +++++++++------- app/Http/Controllers/TasksController.php | 5 +- .../Location/Drivers/CloudflareDriver.php | 4 ++ app/Models/Account/ActivityTypeCategory.php | 1 + app/Models/Account/ImportJob.php | 12 ++--- app/Models/Contact/Gift.php | 5 +- app/Models/Contact/Reminder.php | 4 +- app/Models/Relationship/RelationshipType.php | 5 +- app/Models/User/User.php | 7 +-- .../Contact/UpdateBirthdayInformation.php | 5 +- .../Contact/UpdateDeceasedInformation.php | 5 +- app/Services/VCard/ImportVCard.php | 15 +++--- psalm.xml | 2 - 90 files changed, 774 insertions(+), 503 deletions(-) diff --git a/app/Console/Commands/CalculateStatistics.php b/app/Console/Commands/CalculateStatistics.php index 8dc5af20a..235dbb7db 100644 --- a/app/Console/Commands/CalculateStatistics.php +++ b/app/Console/Commands/CalculateStatistics.php @@ -26,9 +26,9 @@ class CalculateStatistics extends Command /** * Execute the console command. * - * @return mixed + * @return void */ - public function handle() + public function handle(): void { $statistic = new Statistic; $statistic->number_of_users = DB::table('users')->count(); diff --git a/app/Console/Commands/ExportAll.php b/app/Console/Commands/ExportAll.php index 569d59c17..6803f5e18 100644 --- a/app/Console/Commands/ExportAll.php +++ b/app/Console/Commands/ExportAll.php @@ -24,9 +24,9 @@ class ExportAll extends Command /** * Execute the console command. * - * @return mixed + * @return void */ - public function handle() + public function handle(): void { $job = new ExportAllAsSQL(); $this->info('Exported as '.$job->handle().''); diff --git a/app/Console/Commands/GetVersion.php b/app/Console/Commands/GetVersion.php index f89dfcbec..6b8d47087 100644 --- a/app/Console/Commands/GetVersion.php +++ b/app/Console/Commands/GetVersion.php @@ -23,9 +23,9 @@ class GetVersion extends Command /** * Execute the console command. * - * @return mixed + * @return void */ - public function handle() + public function handle(): void { $this->line(config('monica.app_version')); } diff --git a/app/Console/Commands/Inspire.php b/app/Console/Commands/Inspire.php index db9ab8542..6f3440cc2 100644 --- a/app/Console/Commands/Inspire.php +++ b/app/Console/Commands/Inspire.php @@ -24,9 +24,9 @@ class Inspire extends Command /** * Execute the console command. * - * @return mixed + * @return void */ - public function handle() + public function handle(): void { $this->comment(PHP_EOL.Inspiring::quote().PHP_EOL); } diff --git a/app/Console/Commands/LangGenerate.php b/app/Console/Commands/LangGenerate.php index 72609ffe0..5d988c5be 100644 --- a/app/Console/Commands/LangGenerate.php +++ b/app/Console/Commands/LangGenerate.php @@ -24,9 +24,9 @@ class LangGenerate extends Command /** * Execute the console command. * - * @return mixed + * @return void */ - public function handle() + public function handle(): void { $dirs = new DirectoryIterator(resource_path('lang').'/'); diff --git a/app/Console/Commands/SendReminders.php b/app/Console/Commands/SendReminders.php index e51ede62c..5169d17cc 100644 --- a/app/Console/Commands/SendReminders.php +++ b/app/Console/Commands/SendReminders.php @@ -25,9 +25,9 @@ class SendReminders extends Command /** * Execute the console command. * - * @return mixed + * @return void */ - public function handle() + public function handle(): void { // Grab all the reminders that are supposed to be sent in the next two days // Why 2? because in terms of timezone, we can have up to more than 24 hours diff --git a/app/Console/Commands/SendStayInTouch.php b/app/Console/Commands/SendStayInTouch.php index 383effb76..ee2f0d56d 100644 --- a/app/Console/Commands/SendStayInTouch.php +++ b/app/Console/Commands/SendStayInTouch.php @@ -25,9 +25,9 @@ class SendStayInTouch extends Command /** * Execute the console command. * - * @return mixed + * @return void */ - public function handle() + public function handle(): void { // we add two days to make sure we cover all timezones Contact::where('stay_in_touch_trigger_date', '<', now()->addDays(2)) diff --git a/app/Console/Commands/SetPremiumAccount.php b/app/Console/Commands/SetPremiumAccount.php index 8dfb88754..dfe48d55d 100644 --- a/app/Console/Commands/SetPremiumAccount.php +++ b/app/Console/Commands/SetPremiumAccount.php @@ -24,9 +24,9 @@ class SetPremiumAccount extends Command /** * Execute the console command. * - * @return mixed + * @return void */ - public function handle() + public function handle(): void { $account = Account::findOrFail($this->argument('accountId')); $account->has_access_to_paid_version_for_free = 1; diff --git a/app/Console/Commands/SetupFrontEndTest.php b/app/Console/Commands/SetupFrontEndTest.php index 936350f0a..c4a7a2fd9 100644 --- a/app/Console/Commands/SetupFrontEndTest.php +++ b/app/Console/Commands/SetupFrontEndTest.php @@ -47,9 +47,9 @@ class SetupFrontEndTest extends Command /** * Execute the console command. * - * @return mixed + * @return void */ - public function handle() + public function handle(): void { $connection = DB::connection(); if (file_exists('monicadump.sql')) { diff --git a/app/Console/Commands/Update.php b/app/Console/Commands/Update.php index 798934537..65143a44e 100644 --- a/app/Console/Commands/Update.php +++ b/app/Console/Commands/Update.php @@ -46,9 +46,9 @@ class Update extends Command /** * Execute the console command. * - * @return mixed + * @return void */ - public function handle() + public function handle(): void { if ($this->confirmToProceed()) { try { diff --git a/app/Helpers/DateHelper.php b/app/Helpers/DateHelper.php index b7867bf24..4d62ff53d 100644 --- a/app/Helpers/DateHelper.php +++ b/app/Helpers/DateHelper.php @@ -13,9 +13,10 @@ class DateHelper * Set the locale of the instance for Date frameworks. * * @param string $locale - * @return string + * + * @return void */ - public static function setLocale($locale) + public static function setLocale($locale): void { $locale = $locale ?: config('app.locale'); Carbon::setLocale($locale); @@ -123,7 +124,7 @@ class DateHelper /** * Return a date in a short format like "Oct 29, 1981". * - * @param Carbon $date + * @param string $date * @return string */ public static function getShortDate($date) : string @@ -138,7 +139,7 @@ class DateHelper * Return the month of the date according to the timezone of the user * like "Oct", or "Dec". * - * @param Carbon $date + * @param string $date * @return string */ public static function getShortMonth($date) : string @@ -153,7 +154,7 @@ class DateHelper * Return the month and year of the date according to the timezone of the user * like "October 2010", or "March 2032". * - * @param Carbon $date + * @param string $date * @return string */ public static function getFullMonthAndDate($date) : string diff --git a/app/Helpers/RequestHelper.php b/app/Helpers/RequestHelper.php index 005c66e88..3431344f3 100644 --- a/app/Helpers/RequestHelper.php +++ b/app/Helpers/RequestHelper.php @@ -12,7 +12,7 @@ class RequestHelper /** * Get client ip. * - * @return string + * @return array|string */ public static function ip() { diff --git a/app/Http/Controllers/Account/Activity/ActivityTypeCategoriesController.php b/app/Http/Controllers/Account/Activity/ActivityTypeCategoriesController.php index fdc5ca48c..710a28fc0 100644 --- a/app/Http/Controllers/Account/Activity/ActivityTypeCategoriesController.php +++ b/app/Http/Controllers/Account/Activity/ActivityTypeCategoriesController.php @@ -88,7 +88,8 @@ class ActivityTypeCategoriesController extends Controller * * @param Request $request * @param int $activityTypeCategoryId - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $activityTypeCategoryId) { diff --git a/app/Http/Controllers/Account/Activity/ActivityTypesController.php b/app/Http/Controllers/Account/Activity/ActivityTypesController.php index fdff61095..dbc6b593c 100644 --- a/app/Http/Controllers/Account/Activity/ActivityTypesController.php +++ b/app/Http/Controllers/Account/Activity/ActivityTypesController.php @@ -59,7 +59,8 @@ class ActivityTypesController extends Controller * * @param Request $request * @param int $activityTypeId - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $activityTypeId) { diff --git a/app/Http/Controllers/ActivitiesController.php b/app/Http/Controllers/ActivitiesController.php index 4a9d32b33..15d323b5e 100644 --- a/app/Http/Controllers/ActivitiesController.php +++ b/app/Http/Controllers/ActivitiesController.php @@ -15,7 +15,8 @@ class ActivitiesController extends Controller * Display a listing of the resource. * * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View */ public function index(Contact $contact) { @@ -27,7 +28,8 @@ class ActivitiesController extends Controller * Show the form for creating a new resource. * * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View */ public function create(Contact $contact) { @@ -42,7 +44,8 @@ class ActivitiesController extends Controller * * @param ActivitiesRequest $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function store(ActivitiesRequest $request, Contact $contact) { @@ -89,7 +92,8 @@ class ActivitiesController extends Controller * * @param Contact $contact * @param Activity $activity - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View */ public function edit(Activity $activity, Contact $contact) { @@ -105,7 +109,8 @@ class ActivitiesController extends Controller * @param ActivitiesRequest $request * @param Contact $contact * @param Activity $activity - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function update(ActivitiesRequest $request, Activity $activity, Contact $contact) { @@ -165,7 +170,8 @@ class ActivitiesController extends Controller * * @param Contact $contact * @param Activity $activity - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function destroy(Activity $activity, Contact $contact) { diff --git a/app/Http/Controllers/Api/Account/Activity/ApiActivityTypeCategoryController.php b/app/Http/Controllers/Api/Account/Activity/ApiActivityTypeCategoryController.php index 834276152..e218e814c 100644 --- a/app/Http/Controllers/Api/Account/Activity/ApiActivityTypeCategoryController.php +++ b/app/Http/Controllers/Api/Account/Activity/ApiActivityTypeCategoryController.php @@ -18,7 +18,7 @@ class ApiActivityTypeCategoryController extends ApiController /** * Get the list of activity type categories. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -36,9 +36,10 @@ class ApiActivityTypeCategoryController extends ApiController /** * Get the detail of a given activity type category. * - * @param Request $request - * @param int $activityTypeCategoryId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $activityTypeCategoryId + * + * @return ActivityTypeCategoryResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $activityTypeCategoryId) { @@ -56,8 +57,9 @@ class ApiActivityTypeCategoryController extends ApiController /** * Store the activity type category. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return ActivityTypeCategoryResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -83,9 +85,10 @@ class ApiActivityTypeCategoryController extends ApiController /** * Update the activity type category. * - * @param Request $request - * @param int $activityTypeCategoryId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $activityTypeCategoryId + * + * @return ActivityTypeCategoryResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $activityTypeCategoryId) { @@ -112,8 +115,9 @@ class ApiActivityTypeCategoryController extends ApiController /** * Delete an activity type category. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $activityTypeCategoryId) { diff --git a/app/Http/Controllers/Api/Account/Activity/ApiActivityTypeController.php b/app/Http/Controllers/Api/Account/Activity/ApiActivityTypeController.php index 1677491f3..b78be1c70 100644 --- a/app/Http/Controllers/Api/Account/Activity/ApiActivityTypeController.php +++ b/app/Http/Controllers/Api/Account/Activity/ApiActivityTypeController.php @@ -18,7 +18,7 @@ class ApiActivityTypeController extends ApiController /** * Get the list of activity types. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -36,8 +36,9 @@ class ApiActivityTypeController extends ApiController /** * Get the detail of a given activity type. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return ActivityTypeResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $activityTypeId) { @@ -55,8 +56,9 @@ class ApiActivityTypeController extends ApiController /** * Store the activity type. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return ActivityTypeResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -82,9 +84,10 @@ class ApiActivityTypeController extends ApiController /** * Update the activity type. * - * @param Request $request - * @param int $activityTypeId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $activityTypeId + * + * @return ActivityTypeResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $activityTypeId) { @@ -111,9 +114,10 @@ class ApiActivityTypeController extends ApiController /** * Delete an activity type. * - * @param Request $request + * @param Request $request * @param int $activityTypeId - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $activityTypeId) { diff --git a/app/Http/Controllers/Api/Account/ApiCompanyController.php b/app/Http/Controllers/Api/Account/ApiCompanyController.php index a91f10e13..79d5fda90 100644 --- a/app/Http/Controllers/Api/Account/ApiCompanyController.php +++ b/app/Http/Controllers/Api/Account/ApiCompanyController.php @@ -18,7 +18,7 @@ class ApiCompanyController extends ApiController /** * Get the list of companies. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -36,8 +36,9 @@ class ApiCompanyController extends ApiController /** * Get the detail of a given company. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return CompanyResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $companyId) { @@ -55,8 +56,9 @@ class ApiCompanyController extends ApiController /** * Store the company. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return CompanyResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -82,9 +84,10 @@ class ApiCompanyController extends ApiController /** * Update a company. * - * @param Request $request - * @param int $companyId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $companyId + * + * @return CompanyResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $companyId) { @@ -111,8 +114,9 @@ class ApiCompanyController extends ApiController /** * Delete a company. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $companyId) { diff --git a/app/Http/Controllers/Api/Account/ApiGenderController.php b/app/Http/Controllers/Api/Account/ApiGenderController.php index dbe6ada28..55382adde 100644 --- a/app/Http/Controllers/Api/Account/ApiGenderController.php +++ b/app/Http/Controllers/Api/Account/ApiGenderController.php @@ -18,7 +18,7 @@ class ApiGenderController extends ApiController /** * Get the list of genders. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -36,8 +36,9 @@ class ApiGenderController extends ApiController /** * Get the detail of a given gender. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return GenderResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $genderId) { @@ -55,8 +56,9 @@ class ApiGenderController extends ApiController /** * Store the gender. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return GenderResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -82,9 +84,10 @@ class ApiGenderController extends ApiController /** * Update a gender. * - * @param Request $request - * @param int $genderId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $genderId + * + * @return GenderResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $genderId) { @@ -111,8 +114,9 @@ class ApiGenderController extends ApiController /** * Delete a gender. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $genderId) { diff --git a/app/Http/Controllers/Api/Account/ApiPlaceController.php b/app/Http/Controllers/Api/Account/ApiPlaceController.php index 4b1a54ab3..111758760 100644 --- a/app/Http/Controllers/Api/Account/ApiPlaceController.php +++ b/app/Http/Controllers/Api/Account/ApiPlaceController.php @@ -18,7 +18,7 @@ class ApiPlaceController extends ApiController /** * Get the list of places. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -36,8 +36,9 @@ class ApiPlaceController extends ApiController /** * Get the detail of a given place. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return PlaceResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $placeId) { @@ -55,8 +56,9 @@ class ApiPlaceController extends ApiController /** * Store the place. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return PlaceResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -82,9 +84,10 @@ class ApiPlaceController extends ApiController /** * Update a place. * - * @param Request $request - * @param int $placeId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $placeId + * + * @return PlaceResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $placeId) { @@ -111,8 +114,9 @@ class ApiPlaceController extends ApiController /** * Delete a place. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $placeId) { diff --git a/app/Http/Controllers/Api/Account/ApiUserController.php b/app/Http/Controllers/Api/Account/ApiUserController.php index 5398ff77d..757bfb6ea 100644 --- a/app/Http/Controllers/Api/Account/ApiUserController.php +++ b/app/Http/Controllers/Api/Account/ApiUserController.php @@ -15,10 +15,11 @@ class ApiUserController extends ApiController /** * Get the detail of the authenticated user. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return UserResource */ - public function show(Request $request) + public function show(Request $request): UserResource { return new UserResource(auth()->user()); } @@ -28,7 +29,8 @@ class ApiUserController extends ApiController * * @param Request $request * @param int $termId - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\JsonResponse */ public function get(Request $request, $termId) { @@ -47,7 +49,8 @@ class ApiUserController extends ApiController * Get all the policies ever signed by the authenticated user. * * @param Request $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\JsonResponse */ public function compliance(Request $request) { @@ -62,7 +65,8 @@ class ApiUserController extends ApiController * Sign the latest policy for the authenticated user. * * @param Request $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\JsonResponse */ public function set(Request $request) { diff --git a/app/Http/Controllers/Api/ApiActivityController.php b/app/Http/Controllers/Api/ApiActivityController.php index 266b5b932..1eb99f73c 100644 --- a/app/Http/Controllers/Api/ApiActivityController.php +++ b/app/Http/Controllers/Api/ApiActivityController.php @@ -17,7 +17,7 @@ class ApiActivityController extends ApiController /** * Get the list of activities. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -36,8 +36,10 @@ class ApiActivityController extends ApiController /** * Get the detail of a given activity. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return ActivityResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $activityId) { @@ -53,8 +55,10 @@ class ApiActivityController extends ApiController /** * Store the activity. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return ActivityResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -96,9 +100,11 @@ class ApiActivityController extends ApiController /** * Update the activity. - * @param Request $request - * @param int $activityId - * @return \Illuminate\Http\Response + * + * @param Request $request + * @param int $activityId + * + * @return ActivityResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $activityId) { @@ -168,7 +174,7 @@ class ApiActivityController extends ApiController * Validate the request for update. * * @param Request $request - * @return mixed + * @return \Illuminate\Http\JsonResponse|true */ private function validateUpdate(Request $request) { @@ -213,8 +219,10 @@ class ApiActivityController extends ApiController /** * Delete an activity. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $activityId) { @@ -235,7 +243,7 @@ class ApiActivityController extends ApiController /** * Get the list of activities for the given contact. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function activities(Request $request, $contactId) { diff --git a/app/Http/Controllers/Api/ApiContactController.php b/app/Http/Controllers/Api/ApiContactController.php index a02e1679e..fdc7e476e 100644 --- a/app/Http/Controllers/Api/ApiContactController.php +++ b/app/Http/Controllers/Api/ApiContactController.php @@ -22,7 +22,7 @@ class ApiContactController extends ApiController * We will only retrieve the contacts that are "real", not the partials * ones. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\JsonResource|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -63,8 +63,10 @@ class ApiContactController extends ApiController /** * Get the detail of a given contact. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return ContactResource|\Illuminate\Http\JsonResponse|ContactWithContactFieldsResource */ public function show(Request $request, $id) { @@ -88,8 +90,9 @@ class ApiContactController extends ApiController /** * Store the contact. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return ContactResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -114,8 +117,10 @@ class ApiContactController extends ApiController /** * Update the contact. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return ContactResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $contactId) { @@ -141,8 +146,10 @@ class ApiContactController extends ApiController /** * Delete a contact. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $contactId) { diff --git a/app/Http/Controllers/Api/ApiContactFieldController.php b/app/Http/Controllers/Api/ApiContactFieldController.php index 6f33e8e09..9c5c35edd 100644 --- a/app/Http/Controllers/Api/ApiContactFieldController.php +++ b/app/Http/Controllers/Api/ApiContactFieldController.php @@ -16,9 +16,10 @@ class ApiContactFieldController extends ApiController /** * Get the detail of a given contactField. * - * @param Request $request - * @param int $contactFieldId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $contactFieldId + * + * @return ContactFieldResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $contactFieldId) { @@ -35,8 +36,9 @@ class ApiContactFieldController extends ApiController /** * Store the contactField. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return ContactFieldResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -60,9 +62,10 @@ class ApiContactFieldController extends ApiController /** * Update the contactField. * - * @param Request $request - * @param int $contactFieldId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $contactFieldId + * + * @return ContactFieldResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $contactFieldId) { @@ -91,7 +94,7 @@ class ApiContactFieldController extends ApiController * Validate the request for update. * * @param Request $request - * @return mixed + * @return \Illuminate\Http\JsonResponse|true */ private function validateUpdate(Request $request) { @@ -126,9 +129,10 @@ class ApiContactFieldController extends ApiController /** * Delete a contactField. * - * @param Request $request - * @param int $contactFieldId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $contactFieldId + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $contactFieldId) { @@ -148,9 +152,10 @@ class ApiContactFieldController extends ApiController /** * Get the list of contact fields for the given contact. * - * @param Request $request - * @param int $contactId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $contactId + * + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function contactFields(Request $request, $contactId) { diff --git a/app/Http/Controllers/Api/ApiDebtController.php b/app/Http/Controllers/Api/ApiDebtController.php index cf9a9f52c..f25dfefdc 100644 --- a/app/Http/Controllers/Api/ApiDebtController.php +++ b/app/Http/Controllers/Api/ApiDebtController.php @@ -16,7 +16,7 @@ class ApiDebtController extends ApiController /** * Get the list of debts. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -33,8 +33,10 @@ class ApiDebtController extends ApiController /** * Get the detail of a given debt. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return DebtResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $debtId) { @@ -51,8 +53,10 @@ class ApiDebtController extends ApiController /** * Store the debt. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return DebtResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -75,9 +79,11 @@ class ApiDebtController extends ApiController /** * Update the debt. - * @param Request $request - * @param int $debtId - * @return \Illuminate\Http\Response + * + * @param Request $request + * @param int $debtId + * + * @return DebtResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $debtId) { @@ -107,7 +113,7 @@ class ApiDebtController extends ApiController * Validate the request for update. * * @param Request $request - * @return mixed + * @return \Illuminate\Http\JsonResponse|true */ private function validateUpdate(Request $request) { @@ -145,8 +151,10 @@ class ApiDebtController extends ApiController /** * Delete a debt. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $debtId) { @@ -166,7 +174,7 @@ class ApiDebtController extends ApiController /** * Get the list of debts for the given contact. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function debts(Request $request, $contactId) { diff --git a/app/Http/Controllers/Api/ApiGiftController.php b/app/Http/Controllers/Api/ApiGiftController.php index f4b51a83d..0092e8c7a 100644 --- a/app/Http/Controllers/Api/ApiGiftController.php +++ b/app/Http/Controllers/Api/ApiGiftController.php @@ -15,7 +15,7 @@ class ApiGiftController extends ApiController /** * Get the list of gifts. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -32,8 +32,10 @@ class ApiGiftController extends ApiController /** * Get the detail of a given gift. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return GiftResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $id) { @@ -50,8 +52,10 @@ class ApiGiftController extends ApiController /** * Store the gift. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return GiftResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -74,9 +78,11 @@ class ApiGiftController extends ApiController /** * Update the gift. - * @param Request $request - * @param int $giftId - * @return \Illuminate\Http\Response + * + * @param Request $request + * @param int $giftId + * + * @return GiftResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $giftId) { @@ -111,7 +117,7 @@ class ApiGiftController extends ApiController * Validate the request for update. * * @param Request $request - * @return mixed + * @return \Illuminate\Http\JsonResponse|true */ private function validateUpdate(Request $request) { @@ -155,8 +161,10 @@ class ApiGiftController extends ApiController /** * Delete a gift. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $giftId) { @@ -176,7 +184,7 @@ class ApiGiftController extends ApiController /** * Get the list of gifts for the given contact. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function gifts(Request $request, $contactId) { diff --git a/app/Http/Controllers/Api/ApiJournalController.php b/app/Http/Controllers/Api/ApiJournalController.php index 54a910ec1..9d776b731 100644 --- a/app/Http/Controllers/Api/ApiJournalController.php +++ b/app/Http/Controllers/Api/ApiJournalController.php @@ -14,7 +14,7 @@ class ApiJournalController extends ApiController /** * Get the list of journal entries. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -31,8 +31,10 @@ class ApiJournalController extends ApiController /** * Get the detail of a given journal entry. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return JournalResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $entryId) { @@ -49,8 +51,10 @@ class ApiJournalController extends ApiController /** * Store the call. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return JournalResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -73,9 +77,11 @@ class ApiJournalController extends ApiController /** * Update the note. - * @param Request $request - * @param int $entryId - * @return \Illuminate\Http\Response + * + * @param Request $request + * @param int $entryId + * + * @return JournalResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $entryId) { @@ -105,7 +111,7 @@ class ApiJournalController extends ApiController * Validate the request for update. * * @param Request $request - * @return mixed + * @return \Illuminate\Http\JsonResponse|true */ private function validateUpdate(Request $request) { @@ -124,8 +130,10 @@ class ApiJournalController extends ApiController /** * Delete a journal entry. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $entryId) { diff --git a/app/Http/Controllers/Api/ApiNoteController.php b/app/Http/Controllers/Api/ApiNoteController.php index ae83ac6bf..8ae071132 100644 --- a/app/Http/Controllers/Api/ApiNoteController.php +++ b/app/Http/Controllers/Api/ApiNoteController.php @@ -15,7 +15,7 @@ class ApiNoteController extends ApiController /** * Get the list of notes. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -32,8 +32,10 @@ class ApiNoteController extends ApiController /** * Get the detail of a given note. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return NoteResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $id) { @@ -50,8 +52,10 @@ class ApiNoteController extends ApiController /** * Store the note. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return NoteResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -79,9 +83,11 @@ class ApiNoteController extends ApiController /** * Update the note. - * @param Request $request - * @param int $noteId - * @return \Illuminate\Http\Response + * + * @param Request $request + * @param int $noteId + * + * @return NoteResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $noteId) { @@ -118,7 +124,7 @@ class ApiNoteController extends ApiController * Validate the request for update. * * @param Request $request - * @return mixed + * @return \Illuminate\Http\JsonResponse|true */ private function validateUpdate(Request $request) { @@ -146,8 +152,10 @@ class ApiNoteController extends ApiController /** * Delete a note. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $noteId) { @@ -167,7 +175,7 @@ class ApiNoteController extends ApiController /** * Get the list of notes for the given contact. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function notes(Request $request, $contactId) { diff --git a/app/Http/Controllers/Api/ApiPetController.php b/app/Http/Controllers/Api/ApiPetController.php index 1974e0c2a..4ec4a76cb 100644 --- a/app/Http/Controllers/Api/ApiPetController.php +++ b/app/Http/Controllers/Api/ApiPetController.php @@ -15,7 +15,7 @@ class ApiPetController extends ApiController /** * Get the list of pet. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -32,8 +32,10 @@ class ApiPetController extends ApiController /** * Get the detail of a given pet. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return PetResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $id) { @@ -50,8 +52,10 @@ class ApiPetController extends ApiController /** * Store the pet. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return PetResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -74,9 +78,11 @@ class ApiPetController extends ApiController /** * Update the pet. - * @param Request $request - * @param int $petId - * @return \Illuminate\Http\Response + * + * @param Request $request + * @param int $petId + * + * @return PetResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $petId) { @@ -106,7 +112,7 @@ class ApiPetController extends ApiController * Validate the request for update. * * @param Request $request - * @return mixed + * @return \Illuminate\Http\JsonResponse|true */ private function validateUpdate(Request $request) { @@ -134,9 +140,11 @@ class ApiPetController extends ApiController /** * Delete a pet. - * @param Request $request - * @param int $petId - * @return \Illuminate\Http\Response + * + * @param Request $request + * @param int $petId + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $petId) { @@ -155,9 +163,11 @@ class ApiPetController extends ApiController /** * Get the list of pets for the given contact. - * @param Request $request - * @param int $contactId - * @return \Illuminate\Http\Response + * + * @param Request $request + * @param int $contactId + * + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function pets(Request $request, $contactId) { diff --git a/app/Http/Controllers/Api/ApiRelationshipController.php b/app/Http/Controllers/Api/ApiRelationshipController.php index c6bb508c9..9eb05fb75 100644 --- a/app/Http/Controllers/Api/ApiRelationshipController.php +++ b/app/Http/Controllers/Api/ApiRelationshipController.php @@ -16,8 +16,9 @@ class ApiRelationshipController extends ApiController /** * Get all of relationships of a contact. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request, $contactId) { @@ -35,8 +36,9 @@ class ApiRelationshipController extends ApiController /** * Get the detail of a given relationship. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return RelationshipResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $id) { @@ -53,8 +55,9 @@ class ApiRelationshipController extends ApiController /** * Create a new relationship. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return RelationshipResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -86,7 +89,7 @@ class ApiRelationshipController extends ApiController * Update an existing relationship. * * @param Request $request - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\JsonResponse|RelationshipResource */ public function update(Request $request, $relationshipId) { @@ -108,8 +111,9 @@ class ApiRelationshipController extends ApiController /** * Delete a relationship. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $relationshipId) { @@ -137,7 +141,7 @@ class ApiRelationshipController extends ApiController * Validate the parameters. * * @param Request $request - * @return mixed + * @return \Illuminate\Http\JsonResponse|true */ private function validateParameters(Request $request) { @@ -186,7 +190,7 @@ class ApiRelationshipController extends ApiController * Validate the update parameters. * * @param Request $request - * @return mixed + * @return \Illuminate\Http\JsonResponse|true */ private function validateUpdateParameters(Request $request, $relationshipId) { diff --git a/app/Http/Controllers/Api/ApiRelationshipTypeController.php b/app/Http/Controllers/Api/ApiRelationshipTypeController.php index 1e58b9537..88cb17199 100644 --- a/app/Http/Controllers/Api/ApiRelationshipTypeController.php +++ b/app/Http/Controllers/Api/ApiRelationshipTypeController.php @@ -12,8 +12,9 @@ class ApiRelationshipTypeController extends ApiController /** * Get all relationship types in an instance. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -30,8 +31,9 @@ class ApiRelationshipTypeController extends ApiController /** * Get the detail of a given relationship type. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return RelationshipTypeResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $id) { diff --git a/app/Http/Controllers/Api/ApiRelationshipTypeGroupController.php b/app/Http/Controllers/Api/ApiRelationshipTypeGroupController.php index 02334752a..98d813ab4 100644 --- a/app/Http/Controllers/Api/ApiRelationshipTypeGroupController.php +++ b/app/Http/Controllers/Api/ApiRelationshipTypeGroupController.php @@ -17,8 +17,9 @@ class ApiRelationshipTypeGroupController extends ApiController /** * Get all relationship type groups in an instance. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -35,8 +36,9 @@ class ApiRelationshipTypeGroupController extends ApiController /** * Get the detail of a given relationship type group. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return RelationshipTypeGroupResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $id) { diff --git a/app/Http/Controllers/Api/ApiReminderController.php b/app/Http/Controllers/Api/ApiReminderController.php index 967616675..3e590a71c 100644 --- a/app/Http/Controllers/Api/ApiReminderController.php +++ b/app/Http/Controllers/Api/ApiReminderController.php @@ -18,7 +18,7 @@ class ApiReminderController extends ApiController /** * Get the list of reminders. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -35,8 +35,10 @@ class ApiReminderController extends ApiController /** * Get the detail of a given reminder. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return ReminderResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $reminderId) { @@ -53,8 +55,10 @@ class ApiReminderController extends ApiController /** * Store the reminder. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return ReminderResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -79,9 +83,11 @@ class ApiReminderController extends ApiController /** * Update the reminder. - * @param Request $request - * @param int $reminderId - * @return \Illuminate\Http\Response + * + * @param Request $request + * @param int $reminderId + * + * @return ReminderResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $reminderId) { @@ -107,8 +113,10 @@ class ApiReminderController extends ApiController /** * Delete a reminder. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $reminderId) { @@ -131,7 +139,7 @@ class ApiReminderController extends ApiController /** * Get the list of reminders for the given contact. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function reminders(Request $request, $contactId) { diff --git a/app/Http/Controllers/Api/ApiTagController.php b/app/Http/Controllers/Api/ApiTagController.php index 93a59f007..3acfba236 100644 --- a/app/Http/Controllers/Api/ApiTagController.php +++ b/app/Http/Controllers/Api/ApiTagController.php @@ -19,7 +19,7 @@ class ApiTagController extends ApiController * We will only retrieve the contacts that are "real", not the partials * ones. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -36,8 +36,10 @@ class ApiTagController extends ApiController /** * Get the detail of a given tag. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return TagResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $id) { @@ -54,8 +56,10 @@ class ApiTagController extends ApiController /** * Store the tag. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return TagResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -78,8 +82,10 @@ class ApiTagController extends ApiController /** * Update the tag. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return TagResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $id) { @@ -103,8 +109,10 @@ class ApiTagController extends ApiController /** * Delete a tag. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $id) { diff --git a/app/Http/Controllers/Api/ApiTaskController.php b/app/Http/Controllers/Api/ApiTaskController.php index e4085e51d..6893b7528 100644 --- a/app/Http/Controllers/Api/ApiTaskController.php +++ b/app/Http/Controllers/Api/ApiTaskController.php @@ -18,7 +18,7 @@ class ApiTaskController extends ApiController /** * Get the list of task. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -35,8 +35,10 @@ class ApiTaskController extends ApiController /** * Get the detail of a given task. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return TaskResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $taskId) { @@ -53,8 +55,10 @@ class ApiTaskController extends ApiController /** * Store the task. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return TaskResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -76,9 +80,11 @@ class ApiTaskController extends ApiController /** * Update the task. - * @param Request $request - * @param int $taskId - * @return \Illuminate\Http\Response + * + * @param Request $request + * @param int $taskId + * + * @return TaskResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $taskId) { @@ -102,8 +108,10 @@ class ApiTaskController extends ApiController /** * Delete a task. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $taskId) { @@ -124,7 +132,7 @@ class ApiTaskController extends ApiController /** * Get the list of tasks for the given contact. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function tasks(Request $request, $contactId) { diff --git a/app/Http/Controllers/Api/Auth/OAuthController.php b/app/Http/Controllers/Api/Auth/OAuthController.php index 9b1aeeb26..d27a2fc60 100644 --- a/app/Http/Controllers/Api/Auth/OAuthController.php +++ b/app/Http/Controllers/Api/Auth/OAuthController.php @@ -17,8 +17,9 @@ class OAuthController extends Controller /** * Log in a user and returns an accessToken. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function login(Request $request) { @@ -49,7 +50,7 @@ class OAuthController extends Controller * Validate the request. * * @param Request $request - * @return mixed + * @return \Illuminate\Http\JsonResponse|true */ private function validateRequest(Request $request) { diff --git a/app/Http/Controllers/Api/Contact/ApiAddressController.php b/app/Http/Controllers/Api/Contact/ApiAddressController.php index 1e7419958..d2f005d4f 100644 --- a/app/Http/Controllers/Api/Contact/ApiAddressController.php +++ b/app/Http/Controllers/Api/Contact/ApiAddressController.php @@ -19,7 +19,7 @@ class ApiAddressController extends ApiController /** * Get the list of addresses. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -36,8 +36,10 @@ class ApiAddressController extends ApiController /** * Get the detail of a given address. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return AddressResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $id) { @@ -55,8 +57,9 @@ class ApiAddressController extends ApiController /** * Store the address. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return AddressResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -81,9 +84,11 @@ class ApiAddressController extends ApiController /** * Update the address. - * @param Request $request - * @param int $addressId - * @return \Illuminate\Http\Response + * + * @param Request $request + * @param int $addressId + * + * @return AddressResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $addressId) { @@ -109,8 +114,10 @@ class ApiAddressController extends ApiController /** * Delete an address. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $addressId) { @@ -133,7 +140,7 @@ class ApiAddressController extends ApiController /** * Get the list of addresses for the given contact. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function addresses(Request $request, $contactId) { diff --git a/app/Http/Controllers/Api/Contact/ApiCallController.php b/app/Http/Controllers/Api/Contact/ApiCallController.php index c77f15bca..3c014c83e 100644 --- a/app/Http/Controllers/Api/Contact/ApiCallController.php +++ b/app/Http/Controllers/Api/Contact/ApiCallController.php @@ -19,7 +19,7 @@ class ApiCallController extends ApiController /** * Get the list of calls. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -38,8 +38,10 @@ class ApiCallController extends ApiController /** * Get the detail of a given call. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return CallResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $callId) { @@ -56,8 +58,10 @@ class ApiCallController extends ApiController /** * Store the call. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return CallResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -83,9 +87,10 @@ class ApiCallController extends ApiController /** * Update a call. * - * @param Request $request - * @param int $callId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $callId + * + * @return CallResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $callId) { @@ -112,8 +117,9 @@ class ApiCallController extends ApiController /** * Delete a call. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $callId) { @@ -136,7 +142,7 @@ class ApiCallController extends ApiController /** * Get the list of calls for a given contact. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function calls(Request $request, $contactId) { diff --git a/app/Http/Controllers/Api/Contact/ApiConversationController.php b/app/Http/Controllers/Api/Contact/ApiConversationController.php index d29b20c7d..2e880fce8 100644 --- a/app/Http/Controllers/Api/Contact/ApiConversationController.php +++ b/app/Http/Controllers/Api/Contact/ApiConversationController.php @@ -19,7 +19,7 @@ class ApiConversationController extends ApiController /** * Get the list of conversations. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -37,7 +37,7 @@ class ApiConversationController extends ApiController /** * Get the list of conversations for a specific contact. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function conversations(Request $request, $contactId) { @@ -64,8 +64,9 @@ class ApiConversationController extends ApiController /** * Get the detail of a given conversation. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return ConversationResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $conversationId) { @@ -82,8 +83,9 @@ class ApiConversationController extends ApiController /** * Store the conversation. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return ConversationResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -109,9 +111,10 @@ class ApiConversationController extends ApiController /** * Update the conversation. * - * @param Request $request - * @param int $conversationId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $conversationId + * + * @return ConversationResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $conversationId) { @@ -138,9 +141,10 @@ class ApiConversationController extends ApiController /** * Destroy the conversation. * - * @param Request $request - * @param int $conversationId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $conversationId + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $conversationId) { diff --git a/app/Http/Controllers/Api/Contact/ApiDocumentController.php b/app/Http/Controllers/Api/Contact/ApiDocumentController.php index 4ccdeec98..00d2309a0 100644 --- a/app/Http/Controllers/Api/Contact/ApiDocumentController.php +++ b/app/Http/Controllers/Api/Contact/ApiDocumentController.php @@ -15,7 +15,7 @@ class ApiDocumentController extends ApiController /** * Get the list of documents. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -33,7 +33,7 @@ class ApiDocumentController extends ApiController /** * Get the list of documents for a specific contact. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function documents(Request $request, $contactId) { @@ -60,8 +60,9 @@ class ApiDocumentController extends ApiController /** * Get the detail of a given document. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return DocumentResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $documentId) { diff --git a/app/Http/Controllers/Api/Contact/ApiLifeEventController.php b/app/Http/Controllers/Api/Contact/ApiLifeEventController.php index ba6074d8e..c28c97b06 100644 --- a/app/Http/Controllers/Api/Contact/ApiLifeEventController.php +++ b/app/Http/Controllers/Api/Contact/ApiLifeEventController.php @@ -17,7 +17,7 @@ class ApiLifeEventController extends ApiController /** * Get the list of life events. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection */ public function index(Request $request) { @@ -31,8 +31,9 @@ class ApiLifeEventController extends ApiController /** * Get the detail of a given life event. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return LifeEventResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $lifeEventId) { @@ -49,8 +50,9 @@ class ApiLifeEventController extends ApiController /** * Store the life event. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return LifeEventResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -74,9 +76,10 @@ class ApiLifeEventController extends ApiController /** * Update the life event. * - * @param Request $request - * @param int $lifeEventId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $lifeEventId + * + * @return LifeEventResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $lifeEventId) { @@ -101,9 +104,10 @@ class ApiLifeEventController extends ApiController /** * Destroy the life event. * - * @param Request $request - * @param int $lifeEventId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $lifeEventId + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $lifeEventId) { diff --git a/app/Http/Controllers/Api/Contact/ApiMessageController.php b/app/Http/Controllers/Api/Contact/ApiMessageController.php index 7918d09f6..84cd99e52 100644 --- a/app/Http/Controllers/Api/Contact/ApiMessageController.php +++ b/app/Http/Controllers/Api/Contact/ApiMessageController.php @@ -19,8 +19,9 @@ class ApiMessageController extends ApiController /** * Store the message. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return ConversationResource|\Illuminate\Http\JsonResponse */ public function store(Request $request, int $conversationId) { @@ -54,10 +55,11 @@ class ApiMessageController extends ApiController /** * Update the message. * - * @param Request $request - * @param int $conversationId - * @param int $messageId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $conversationId + * @param int $messageId + * + * @return ConversationResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, int $conversationId, int $messageId) { @@ -93,10 +95,11 @@ class ApiMessageController extends ApiController /** * Destroy the message. * - * @param Request $request - * @param int $conversationId - * @param int $messageId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $conversationId + * @param int $messageId + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, int $conversationId, int $messageId) { diff --git a/app/Http/Controllers/Api/Contact/ApiOccupationController.php b/app/Http/Controllers/Api/Contact/ApiOccupationController.php index c741bc02d..76a6bd9de 100644 --- a/app/Http/Controllers/Api/Contact/ApiOccupationController.php +++ b/app/Http/Controllers/Api/Contact/ApiOccupationController.php @@ -18,7 +18,7 @@ class ApiOccupationController extends ApiController /** * Get the list of occupations. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { @@ -36,8 +36,9 @@ class ApiOccupationController extends ApiController /** * Get the detail of a given occupation. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return OccupationResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $occupationId) { @@ -55,8 +56,9 @@ class ApiOccupationController extends ApiController /** * Store the occupation. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return OccupationResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -82,9 +84,10 @@ class ApiOccupationController extends ApiController /** * Update an occupation. * - * @param Request $request - * @param int $occupationId - * @return \Illuminate\Http\Response + * @param Request $request + * @param int $occupationId + * + * @return OccupationResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $occupationId) { @@ -111,8 +114,9 @@ class ApiOccupationController extends ApiController /** * Delete an occupation. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $occupationId) { diff --git a/app/Http/Controllers/Api/Misc/ApiCountryController.php b/app/Http/Controllers/Api/Misc/ApiCountryController.php index ec3a26a43..1a3f0af0f 100644 --- a/app/Http/Controllers/Api/Misc/ApiCountryController.php +++ b/app/Http/Controllers/Api/Misc/ApiCountryController.php @@ -14,7 +14,7 @@ class ApiCountryController extends ApiController /** * Get the list of countries. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection */ public function index(Request $request) { diff --git a/app/Http/Controllers/Api/Settings/ApiComplianceController.php b/app/Http/Controllers/Api/Settings/ApiComplianceController.php index 94e3f4ca0..75e04048b 100644 --- a/app/Http/Controllers/Api/Settings/ApiComplianceController.php +++ b/app/Http/Controllers/Api/Settings/ApiComplianceController.php @@ -13,7 +13,7 @@ class ApiComplianceController extends ApiController /** * Get the list of terms and privacy policies. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection */ public function index(Request $request) { @@ -24,8 +24,10 @@ class ApiComplianceController extends ApiController /** * Get the detail of a given term. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return ComplianceResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $termId) { diff --git a/app/Http/Controllers/Api/Settings/ApiContactFieldTypeController.php b/app/Http/Controllers/Api/Settings/ApiContactFieldTypeController.php index 5b896bb72..f4e47b4d5 100644 --- a/app/Http/Controllers/Api/Settings/ApiContactFieldTypeController.php +++ b/app/Http/Controllers/Api/Settings/ApiContactFieldTypeController.php @@ -15,7 +15,7 @@ class ApiContactFieldTypeController extends ApiController /** * Get the list of contact field types. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection */ public function index(Request $request) { @@ -27,8 +27,10 @@ class ApiContactFieldTypeController extends ApiController /** * Get the detail of a given contact field type. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return ContactFieldTypeResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $contactFieldTypeId) { @@ -45,8 +47,10 @@ class ApiContactFieldTypeController extends ApiController /** * Store the contactfieldtype. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return ContactFieldTypeResource|\Illuminate\Http\JsonResponse */ public function store(Request $request) { @@ -69,9 +73,11 @@ class ApiContactFieldTypeController extends ApiController /** * Update the contact field type. - * @param Request $request - * @param int $contactFieldTypeId - * @return \Illuminate\Http\Response + * + * @param Request $request + * @param int $contactFieldTypeId + * + * @return ContactFieldTypeResource|\Illuminate\Http\JsonResponse */ public function update(Request $request, $contactFieldTypeId) { @@ -110,7 +116,7 @@ class ApiContactFieldTypeController extends ApiController * Validate the request for update. * * @param Request $request - * @return mixed + * @return \Illuminate\Http\JsonResponse|true */ private function validateUpdate(Request $request) { @@ -132,8 +138,10 @@ class ApiContactFieldTypeController extends ApiController /** * Delete an contactfieldtype. - * @param Request $request - * @return \Illuminate\Http\Response + * + * @param Request $request + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, $contactFieldTypeId) { diff --git a/app/Http/Controllers/Api/Settings/ApiCurrencyController.php b/app/Http/Controllers/Api/Settings/ApiCurrencyController.php index f1d60e93d..07c67037b 100644 --- a/app/Http/Controllers/Api/Settings/ApiCurrencyController.php +++ b/app/Http/Controllers/Api/Settings/ApiCurrencyController.php @@ -13,7 +13,7 @@ class ApiCurrencyController extends ApiController /** * Get the list of currencies. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection */ public function index(Request $request) { @@ -25,8 +25,9 @@ class ApiCurrencyController extends ApiController /** * Get the detail of a given currency. * - * @param Request $request - * @return \Illuminate\Http\Response + * @param Request $request + * + * @return CurrencyResource|\Illuminate\Http\JsonResponse */ public function show(Request $request, $currencyId) { diff --git a/app/Http/Controllers/Api/Statistics/ApiStatisticsController.php b/app/Http/Controllers/Api/Statistics/ApiStatisticsController.php index 07a825a35..be60d41c0 100644 --- a/app/Http/Controllers/Api/Statistics/ApiStatisticsController.php +++ b/app/Http/Controllers/Api/Statistics/ApiStatisticsController.php @@ -13,7 +13,7 @@ class ApiStatisticsController extends ApiController /** * Get the list of general, public statistics. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Support\Collection|\Illuminate\Http\JsonResponse */ public function index(Request $request) { diff --git a/app/Http/Controllers/Auth/EmailChangeController.php b/app/Http/Controllers/Auth/EmailChangeController.php index 2218dc9bd..28f41b144 100644 --- a/app/Http/Controllers/Auth/EmailChangeController.php +++ b/app/Http/Controllers/Auth/EmailChangeController.php @@ -24,8 +24,9 @@ class EmailChangeController extends Controller /** * Show the application's login form. * - * @param \Illuminate\Http\Request $request - * @return \Illuminate\Http\Response + * @param \Illuminate\Http\Request $request + * + * @return \Illuminate\Http\RedirectResponse|\Illuminate\View\View */ public function showLoginFormSpecial(Request $request) { @@ -43,10 +44,11 @@ class EmailChangeController extends Controller /** * Display a listing of the resource. * - * @param \Illuminate\Http\Request $request - * @return \Illuminate\Http\Response + * @param \Illuminate\Http\Request $request + * + * @return \Illuminate\View\View */ - public function index(Request $request) + public function index(Request $request): \Illuminate\View\View { $user = auth()->user(); @@ -58,7 +60,7 @@ class EmailChangeController extends Controller * Change user email. * * @param EmailChangeRequest $request - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\RedirectResponse */ public function save(EmailChangeRequest $request) { @@ -96,7 +98,8 @@ class EmailChangeController extends Controller * Get the response for a successful password changed. * * @param string $response - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ protected function sendChangedResponse($response) { @@ -108,7 +111,8 @@ class EmailChangeController extends Controller * Get the response for a failed password. * * @param string $response - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ protected function sendChangedFailedResponse($response) { diff --git a/app/Http/Controllers/Auth/PasswordChangeController.php b/app/Http/Controllers/Auth/PasswordChangeController.php index 86e1dec08..ffc8bab13 100644 --- a/app/Http/Controllers/Auth/PasswordChangeController.php +++ b/app/Http/Controllers/Auth/PasswordChangeController.php @@ -53,7 +53,8 @@ class PasswordChangeController extends Controller * Validate a password change request and update password of the user. * * @param array $credentials - * @return string + * + * @return string|Authenticatable */ protected function validateAndPasswordChange($credentials) { @@ -73,7 +74,8 @@ class PasswordChangeController extends Controller * Validate a password change request with the given credentials. * * @param array $credentials - * @return CanResetPassword|string + * + * @return string|Authenticatable * * @throws \UnexpectedValueException */ @@ -94,7 +96,8 @@ class PasswordChangeController extends Controller * Get the user with the given credentials. * * @param array $credentials - * @return CanResetPassword|null + * + * @return null|Authenticatable */ protected function getUser(array $credentials) { diff --git a/app/Http/Controllers/Auth/RecoveryLoginController.php b/app/Http/Controllers/Auth/RecoveryLoginController.php index d8d7a749d..a4fea4e29 100644 --- a/app/Http/Controllers/Auth/RecoveryLoginController.php +++ b/app/Http/Controllers/Auth/RecoveryLoginController.php @@ -25,8 +25,9 @@ class RecoveryLoginController extends Controller /** * Display a listing of the resource. * - * @param \Illuminate\Http\Request $request - * @return \Illuminate\Http\Response + * @param \Illuminate\Http\Request $request + * + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory */ public function get(Request $request) { @@ -37,7 +38,8 @@ class RecoveryLoginController extends Controller * Validate recovery login. * * @param Request $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Routing\Redirector|\Illuminate\Http\RedirectResponse */ public function store(Request $request) { diff --git a/app/Http/Controllers/Auth/RegisterController.php b/app/Http/Controllers/Auth/RegisterController.php index 485013f91..c69182037 100644 --- a/app/Http/Controllers/Auth/RegisterController.php +++ b/app/Http/Controllers/Auth/RegisterController.php @@ -49,7 +49,7 @@ class RegisterController extends Controller /** * Show the application registration form. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View */ public function showRegistrationForm(Request $request) { diff --git a/app/Http/Controllers/Auth/Validate2faController.php b/app/Http/Controllers/Auth/Validate2faController.php index 6d5bb5c89..88877fa8f 100644 --- a/app/Http/Controllers/Auth/Validate2faController.php +++ b/app/Http/Controllers/Auth/Validate2faController.php @@ -10,8 +10,9 @@ class Validate2faController extends Controller /** * Redirect the user after 2fa form has been submitted. * - * @param \Illuminate\Http\Request $request - * @return \Illuminate\Http\Response + * @param \Illuminate\Http\Request $request + * + * @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector */ public function index(Request $request) { diff --git a/app/Http/Controllers/ChangelogController.php b/app/Http/Controllers/ChangelogController.php index 005c6b518..5dc24bfdf 100644 --- a/app/Http/Controllers/ChangelogController.php +++ b/app/Http/Controllers/ChangelogController.php @@ -12,7 +12,8 @@ class ChangelogController extends Controller * Display a listing of the resource. * * @param Request $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View */ public function index(Request $request) { diff --git a/app/Http/Controllers/ComplianceController.php b/app/Http/Controllers/ComplianceController.php index cbd05c0b4..27f084450 100644 --- a/app/Http/Controllers/ComplianceController.php +++ b/app/Http/Controllers/ComplianceController.php @@ -10,7 +10,8 @@ class ComplianceController extends Controller * Display a listing of the resource. * * @param Request $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory */ public function index(Request $request) { @@ -18,8 +19,9 @@ class ComplianceController extends Controller } /** - * @param \Illuminate\Http\Request $request - * @return \Illuminate\Http\Response + * @param \Illuminate\Http\Request $request + * + * @return \Illuminate\Http\RedirectResponse */ public function store(Request $request) { diff --git a/app/Http/Controllers/Contacts/AddressesController.php b/app/Http/Controllers/Contacts/AddressesController.php index d35c89817..2346d91ea 100644 --- a/app/Http/Controllers/Contacts/AddressesController.php +++ b/app/Http/Controllers/Contacts/AddressesController.php @@ -103,7 +103,8 @@ class AddressesController extends Controller * @param Request $request * @param Contact $contact * @param Address $address - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\JsonResponse */ public function destroy(Request $request, Contact $contact, Address $address) { diff --git a/app/Http/Controllers/Contacts/CallsController.php b/app/Http/Controllers/Contacts/CallsController.php index ce3cd53c6..a5609ed53 100644 --- a/app/Http/Controllers/Contacts/CallsController.php +++ b/app/Http/Controllers/Contacts/CallsController.php @@ -19,8 +19,9 @@ class CallsController extends Controller /** * Display the list of calls. * - * @param Contact $contact - * @return \Illuminate\Http\Response + * @param Contact $contact + * + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection */ public function index(Request $request, Contact $contact) { @@ -72,7 +73,8 @@ class CallsController extends Controller * @param Request $request * @param Contact $contact * @param Call $call - * @return \Illuminate\Http\Response + * + * @return null|\Illuminate\Http\JsonResponse */ public function destroy(Request $request, Contact $contact, Call $call) { diff --git a/app/Http/Controllers/Contacts/ConversationsController.php b/app/Http/Controllers/Contacts/ConversationsController.php index ff9dcede5..dc20f9453 100644 --- a/app/Http/Controllers/Contacts/ConversationsController.php +++ b/app/Http/Controllers/Contacts/ConversationsController.php @@ -22,8 +22,9 @@ class ConversationsController extends Controller /** * Display the Create conversation page. * - * @param Contact $contact - * @return \Illuminate\Http\Response + * @param Contact $contact + * + * @return \Illuminate\View\View */ public function create(Request $request, Contact $contact) { @@ -65,7 +66,8 @@ class ConversationsController extends Controller * * @param Request $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function store(Request $request, Contact $contact) { @@ -123,8 +125,9 @@ class ConversationsController extends Controller /** * Display a specific conversation. * - * @param Contact $contact - * @return \Illuminate\Http\Response + * @param Contact $contact + * + * @return \Illuminate\View\View */ public function edit(Request $request, Contact $contact, Conversation $conversation) { @@ -151,7 +154,8 @@ class ConversationsController extends Controller * @param Request $request * @param Contact $contact * @param Conversation $conversation - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function update(Request $request, Contact $contact, Conversation $conversation) { @@ -222,7 +226,8 @@ class ConversationsController extends Controller * @param Request $request * @param Contact $contact * @param Conversation $conversation - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\JsonResponse */ public function destroy(Request $request, Contact $contact, Conversation $conversation) { diff --git a/app/Http/Controllers/Contacts/DebtController.php b/app/Http/Controllers/Contacts/DebtController.php index 666198601..103f54120 100644 --- a/app/Http/Controllers/Contacts/DebtController.php +++ b/app/Http/Controllers/Contacts/DebtController.php @@ -14,7 +14,8 @@ class DebtController extends Controller * Display a listing of the resource. * * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View */ public function index(Contact $contact) { @@ -26,7 +27,8 @@ class DebtController extends Controller * Show the form for creating a new resource. * * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View */ public function create(Contact $contact) { @@ -41,7 +43,8 @@ class DebtController extends Controller * * @param DebtRequest $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function store(DebtRequest $request, Contact $contact) { @@ -66,9 +69,10 @@ class DebtController extends Controller * * @param Contact $contact * @param Debt $debt - * @return \Illuminate\Http\Response + * + * @return void */ - public function show(Contact $contact, Debt $debt) + public function show(Contact $contact, Debt $debt): void { // } @@ -78,7 +82,8 @@ class DebtController extends Controller * * @param Contact $contact * @param Debt $debt - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View */ public function edit(Contact $contact, Debt $debt) { @@ -94,7 +99,8 @@ class DebtController extends Controller * @param DebtRequest $request * @param Contact $contact * @param Debt $debt - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function update(DebtRequest $request, Contact $contact, Debt $debt) { @@ -119,7 +125,8 @@ class DebtController extends Controller * * @param Contact $contact * @param Debt $debt - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function destroy(Contact $contact, Debt $debt) { diff --git a/app/Http/Controllers/Contacts/DocumentsController.php b/app/Http/Controllers/Contacts/DocumentsController.php index 200f2b8f5..125e66892 100644 --- a/app/Http/Controllers/Contacts/DocumentsController.php +++ b/app/Http/Controllers/Contacts/DocumentsController.php @@ -18,8 +18,9 @@ class DocumentsController extends Controller /** * Display the list of documents. * - * @param Contact $contact - * @return \Illuminate\Http\Response + * @param Contact $contact + * + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection */ public function index(Request $request, Contact $contact) { @@ -33,9 +34,10 @@ class DocumentsController extends Controller * * @param Request $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return Document */ - public function store(Request $request, Contact $contact) + public function store(Request $request, Contact $contact): Document { return app(UploadDocument::class)->execute([ 'account_id' => auth()->user()->account->id, @@ -50,7 +52,8 @@ class DocumentsController extends Controller * @param Request $request * @param Contact $contact * @param Document $document - * @return \Illuminate\Http\Response + * + * @return null|\Illuminate\Http\JsonResponse */ public function destroy(Request $request, Contact $contact, Document $document) { diff --git a/app/Http/Controllers/Contacts/GiftsController.php b/app/Http/Controllers/Contacts/GiftsController.php index 881310048..0fb67856e 100644 --- a/app/Http/Controllers/Contacts/GiftsController.php +++ b/app/Http/Controllers/Contacts/GiftsController.php @@ -16,7 +16,8 @@ class GiftsController extends Controller * List all the gifts for the given contact. * * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Support\Collection */ public function index(Contact $contact) { @@ -71,7 +72,8 @@ class GiftsController extends Controller * Show the form for creating a new resource. * * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View */ public function create(Contact $contact) { @@ -89,7 +91,8 @@ class GiftsController extends Controller * * @param GiftsRequest $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function store(GiftsRequest $request, Contact $contact) { @@ -104,7 +107,8 @@ class GiftsController extends Controller * * @param Contact $contact * @param Gift $gift - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View */ public function edit(Contact $contact, Gift $gift) { @@ -123,7 +127,8 @@ class GiftsController extends Controller * @param GiftsRequest $request * @param Contact $contact * @param Gift $gift - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function update(GiftsRequest $request, Contact $contact, Gift $gift) { @@ -138,9 +143,10 @@ class GiftsController extends Controller * * @param Contact $contact * @param Gift $gift - * @return \Illuminate\Http\Response + * + * @return void */ - public function destroy(Contact $contact, Gift $gift) + public function destroy(Contact $contact, Gift $gift): void { $gift->delete(); } @@ -150,7 +156,8 @@ class GiftsController extends Controller * * @param GiftsRequest $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Database\Eloquent\Model */ public function updateOrCreate(GiftsRequest $request, Contact $contact, Gift $gift = null) { diff --git a/app/Http/Controllers/Contacts/IntroductionsController.php b/app/Http/Controllers/Contacts/IntroductionsController.php index e4067b264..d2a0770f9 100644 --- a/app/Http/Controllers/Contacts/IntroductionsController.php +++ b/app/Http/Controllers/Contacts/IntroductionsController.php @@ -18,7 +18,8 @@ class IntroductionsController extends Controller * Show the form for editing the specified resource. * * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View */ public function edit(Contact $contact) { @@ -31,7 +32,8 @@ class IntroductionsController extends Controller * * @param IntroductionsRequest $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse|\Illuminate\Http\JsonResponse */ public function update(IntroductionsRequest $request, Contact $contact) { diff --git a/app/Http/Controllers/Contacts/LifeEventsController.php b/app/Http/Controllers/Contacts/LifeEventsController.php index b4b45559e..b6a4f60ea 100644 --- a/app/Http/Controllers/Contacts/LifeEventsController.php +++ b/app/Http/Controllers/Contacts/LifeEventsController.php @@ -49,9 +49,10 @@ class LifeEventsController extends Controller /** * Display the list of life events. * - * @param Request $request - * @param Contact $contact - * @return \Illuminate\Http\Response + * @param Request $request + * @param Contact $contact + * + * @return Collection */ public function index(Request $request, Contact $contact) { @@ -78,7 +79,8 @@ class LifeEventsController extends Controller * * @param Request $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return LifeEvent|\Illuminate\Http\RedirectResponse */ public function store(Request $request, Contact $contact) { @@ -108,9 +110,11 @@ class LifeEventsController extends Controller /** * Destroy the life event. - * @param Request $request - * @param LifeEvent $lifeEvent - * @return \Illuminate\Http\Response + * + * @param Request $request + * @param LifeEvent $lifeEvent + * + * @return \Illuminate\Http\JsonResponse|\Illuminate\Http\RedirectResponse */ public function destroy(Request $request, LifeEvent $lifeEvent) { diff --git a/app/Http/Controllers/Contacts/NotesController.php b/app/Http/Controllers/Contacts/NotesController.php index 988067e58..6e49a3379 100644 --- a/app/Http/Controllers/Contacts/NotesController.php +++ b/app/Http/Controllers/Contacts/NotesController.php @@ -68,9 +68,10 @@ class NotesController extends Controller * @param NotesRequest $request * @param Contact $contact * @param Note $note - * @return \Illuminate\Http\Response + * + * @return Note */ - public function update(NotesRequest $request, Contact $contact, Note $note) + public function update(NotesRequest $request, Contact $contact, Note $note): Note { $note->update( $request->only([ @@ -87,9 +88,10 @@ class NotesController extends Controller * * @param Contact $contact * @param Note $note - * @return \Illuminate\Http\Response + * + * @return void */ - public function destroy(Contact $contact, Note $note) + public function destroy(Contact $contact, Note $note): void { $note->delete(); } diff --git a/app/Http/Controllers/Contacts/PhotosController.php b/app/Http/Controllers/Contacts/PhotosController.php index d9f0a3dff..65b5296b1 100644 --- a/app/Http/Controllers/Contacts/PhotosController.php +++ b/app/Http/Controllers/Contacts/PhotosController.php @@ -18,8 +18,9 @@ class PhotosController extends Controller /** * Display the list of photos. * - * @param Contact $contact - * @return \Illuminate\Http\Response + * @param Contact $contact + * + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection */ public function index(Request $request, Contact $contact) { @@ -33,9 +34,10 @@ class PhotosController extends Controller * * @param Request $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return PhotoResource */ - public function store(Request $request, Contact $contact) + public function store(Request $request, Contact $contact): PhotoResource { $photo = app(UploadPhoto::class)->execute([ 'account_id' => auth()->user()->account->id, @@ -55,7 +57,8 @@ class PhotosController extends Controller * @param Request $request * @param Contact $contact * @param Photo $photo - * @return \Illuminate\Http\Response + * + * @return null|\Illuminate\Http\JsonResponse */ public function destroy(Request $request, Contact $contact, Photo $photo) { diff --git a/app/Http/Controllers/Contacts/RelationshipsController.php b/app/Http/Controllers/Contacts/RelationshipsController.php index d62295884..76aa30f3f 100644 --- a/app/Http/Controllers/Contacts/RelationshipsController.php +++ b/app/Http/Controllers/Contacts/RelationshipsController.php @@ -15,8 +15,9 @@ class RelationshipsController extends Controller /** * Display the Create relationship page. * - * @param Contact $contact - * @return \Illuminate\Http\Response + * @param Contact $contact + * + * @return \Illuminate\View\View */ public function create(Request $request, Contact $contact) { @@ -69,7 +70,8 @@ class RelationshipsController extends Controller * * @param Request $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function store(Request $request, Contact $contact) { @@ -169,7 +171,8 @@ class RelationshipsController extends Controller * * @param Contact $contact * @param Contact $otherContact significant other contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View */ public function edit(Contact $contact, Contact $otherContact) { @@ -216,7 +219,8 @@ class RelationshipsController extends Controller * @param Request $request * @param Contact $contact * @param Contact $otherContact significant other contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function update(Request $request, Contact $contact, Contact $otherContact) { @@ -287,7 +291,8 @@ class RelationshipsController extends Controller * * @param Contact $contact * @param Contact $otherContact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function destroy(Contact $contact, Contact $otherContact) { diff --git a/app/Http/Controllers/Contacts/RemindersController.php b/app/Http/Controllers/Contacts/RemindersController.php index 8f7a04949..ea40f03db 100644 --- a/app/Http/Controllers/Contacts/RemindersController.php +++ b/app/Http/Controllers/Contacts/RemindersController.php @@ -17,7 +17,8 @@ class RemindersController extends Controller * Show the form for creating a new reminder. * * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View */ public function create(Contact $contact) { @@ -32,7 +33,8 @@ class RemindersController extends Controller * * @param Request $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function store(Request $request, Contact $contact) { @@ -57,7 +59,8 @@ class RemindersController extends Controller * * @param Contact $contact * @param Reminder $reminder - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View */ public function edit(Contact $contact, Reminder $reminder) { @@ -73,7 +76,8 @@ class RemindersController extends Controller * @param Request $request * @param Contact $contact * @param Reminder $reminder - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function update(Request $request, Contact $contact, Reminder $reminder) { @@ -100,7 +104,8 @@ class RemindersController extends Controller * @param Request $request * @param Contact $contact * @param Reminder $reminder - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function destroy(Request $request, Contact $contact, Reminder $reminder) { diff --git a/app/Http/Controllers/Contacts/TagsController.php b/app/Http/Controllers/Contacts/TagsController.php index 5defcf507..d91a2a8c1 100644 --- a/app/Http/Controllers/Contacts/TagsController.php +++ b/app/Http/Controllers/Contacts/TagsController.php @@ -15,7 +15,8 @@ class TagsController extends Controller * Get the list of all the tags in the account. * * @param Request $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection */ public function index(Request $request) { @@ -28,7 +29,8 @@ class TagsController extends Controller * Get the list of all the tags for this contact. * * @param Request $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection */ public function get(Request $request, Contact $contact) { @@ -43,9 +45,9 @@ class TagsController extends Controller * @param Request $request * @param Contact $contact * - * @return \Illuminate\Http\Response + * @return void */ - public function update(Request $request, Contact $contact) + public function update(Request $request, Contact $contact): void { $tags = $request->all(); diff --git a/app/Http/Controllers/ContactsController.php b/app/Http/Controllers/ContactsController.php index 882f932a1..d29a0398e 100644 --- a/app/Http/Controllers/ContactsController.php +++ b/app/Http/Controllers/ContactsController.php @@ -27,7 +27,8 @@ class ContactsController extends Controller * Display a listing of the resource. * * @param Request $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View|\Illuminate\Http\RedirectResponse */ public function index(Request $request) { @@ -38,7 +39,8 @@ class ContactsController extends Controller * Display a listing of the resource. * * @param Request $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View|\Illuminate\Http\RedirectResponse */ public function archived(Request $request) { @@ -49,7 +51,8 @@ class ContactsController extends Controller * Display contacts. * * @param Request $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View|\Illuminate\Http\RedirectResponse */ private function contacts(Request $request, bool $active) { @@ -145,7 +148,7 @@ class ContactsController extends Controller /** * Show the form to add a new contact. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory|\Illuminate\Http\RedirectResponse */ public function create() { @@ -170,8 +173,9 @@ class ContactsController extends Controller /** * Store the contact. * - * @param \Illuminate\Http\Request $request - * @return \Illuminate\Http\Response + * @param \Illuminate\Http\Request $request + * + * @return \Illuminate\Http\RedirectResponse */ public function store(Request $request) { @@ -204,8 +208,9 @@ class ContactsController extends Controller /** * Display the contact profile. * - * @param Contact $contact - * @return \Illuminate\Http\Response + * @param Contact $contact + * + * @return \Illuminate\View\View|\Illuminate\Http\RedirectResponse */ public function show(Contact $contact) { @@ -284,7 +289,8 @@ class ContactsController extends Controller * Display the Edit people's view. * * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View */ public function edit(Contact $contact) { @@ -312,9 +318,10 @@ class ContactsController extends Controller /** * Update the contact. * - * @param Request $request + * @param Request $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function update(Request $request, Contact $contact) { @@ -386,7 +393,8 @@ class ContactsController extends Controller * * @param Request $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function destroy(Request $request, Contact $contact) { @@ -408,9 +416,10 @@ class ContactsController extends Controller /** * Show the Edit work view. * - * @param Request $request + * @param Request $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View */ public function editWork(Request $request, Contact $contact) { @@ -423,7 +432,8 @@ class ContactsController extends Controller * * @param Request $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function updateWork(Request $request, Contact $contact) { @@ -442,9 +452,10 @@ class ContactsController extends Controller /** * Show the Edit food preferencies view. * - * @param Request $request + * @param Request $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View */ public function editFoodPreferencies(Request $request, Contact $contact) { @@ -458,7 +469,8 @@ class ContactsController extends Controller * * @param Request $request * @param Contact $contact - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function updateFoodPreferencies(Request $request, Contact $contact) { diff --git a/app/Http/Controllers/DAV/Backend/CalDAV/CalDAVBackend.php b/app/Http/Controllers/DAV/Backend/CalDAV/CalDAVBackend.php index 80283c27f..0a0eb558b 100644 --- a/app/Http/Controllers/DAV/Backend/CalDAV/CalDAVBackend.php +++ b/app/Http/Controllers/DAV/Backend/CalDAV/CalDAVBackend.php @@ -283,9 +283,10 @@ class CalDAVBackend extends AbstractBackend implements SyncSupport * @param string $principalUri * @param string $calendarUri * @param array $properties - * @return mixed + * + * @return void */ - public function createCalendar($principalUri, $calendarUri, array $properties) + public function createCalendar($principalUri, $calendarUri, array $properties): void { } diff --git a/app/Http/Controllers/DAV/Backend/CardDAV/CardDAVBackend.php b/app/Http/Controllers/DAV/Backend/CardDAV/CardDAVBackend.php index 33e4d6af2..da7e0ecb9 100644 --- a/app/Http/Controllers/DAV/Backend/CardDAV/CardDAVBackend.php +++ b/app/Http/Controllers/DAV/Backend/CardDAV/CardDAVBackend.php @@ -368,7 +368,7 @@ class CardDAVBackend extends AbstractBackend implements SyncSupport, IDAVBackend * * @param string $addressBookId * @param \Sabre\DAV\PropPatch $propPatch - * @return void|bool + * @return bool|null */ public function updateAddressBook($addressBookId, DAV\PropPatch $propPatch) { @@ -395,7 +395,7 @@ class CardDAVBackend extends AbstractBackend implements SyncSupport, IDAVBackend * Deletes an entire addressbook and all its contents. * * @param mixed $addressBookId - * @return void|bool + * @return bool|null */ public function deleteAddressBook($addressBookId) { diff --git a/app/Http/Controllers/DashboardController.php b/app/Http/Controllers/DashboardController.php index 85d552023..0bfa41d6d 100644 --- a/app/Http/Controllers/DashboardController.php +++ b/app/Http/Controllers/DashboardController.php @@ -17,7 +17,7 @@ class DashboardController extends Controller /** * Display a listing of the resource. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory */ public function index() { diff --git a/app/Http/Controllers/EmotionController.php b/app/Http/Controllers/EmotionController.php index 189451448..5f6fb46fb 100644 --- a/app/Http/Controllers/EmotionController.php +++ b/app/Http/Controllers/EmotionController.php @@ -13,7 +13,7 @@ class EmotionController extends Controller /** * Get the list of primary emotions. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection */ public function primaries() { @@ -23,7 +23,7 @@ class EmotionController extends Controller /** * Get the list of secondary emotions. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection */ public function secondaries(Request $request, $primaryEmotionId) { @@ -36,7 +36,7 @@ class EmotionController extends Controller /** * Get the list of emotions. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection */ public function emotions(Request $request, $primaryEmotionId, $secondaryEmotionId) { diff --git a/app/Http/Controllers/JournalController.php b/app/Http/Controllers/JournalController.php index 7e868d721..ce146999c 100644 --- a/app/Http/Controllers/JournalController.php +++ b/app/Http/Controllers/JournalController.php @@ -16,7 +16,7 @@ class JournalController extends Controller /** * Display a listing of the resource. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory */ public function index() { @@ -106,9 +106,10 @@ class JournalController extends Controller /** * Delete the Day entry. - * @return mixed + * + * @return void */ - public function trashDay(Day $day) + public function trashDay(Day $day): void { $day->deleteJournalEntry(); $day->delete(); @@ -130,7 +131,7 @@ class JournalController extends Controller /** * Display the Create journal entry screen. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory */ public function create() { diff --git a/app/Http/Controllers/Settings/MultiFAController.php b/app/Http/Controllers/Settings/MultiFAController.php index 023039927..faefd82f1 100644 --- a/app/Http/Controllers/Settings/MultiFAController.php +++ b/app/Http/Controllers/Settings/MultiFAController.php @@ -98,7 +98,8 @@ class MultiFAController extends Controller /** * @param \Illuminate\Http\Request $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory */ public function disableTwoFactor(Request $request) { @@ -150,7 +151,8 @@ class MultiFAController extends Controller /** * @param \Illuminate\Http\Request $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\JsonResponse */ public function u2fRegisterData(Request $request) { @@ -187,7 +189,8 @@ class MultiFAController extends Controller * Remove an existing security key. * * @param \Illuminate\Http\Request $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\JsonResponse */ public function u2fRemove(Request $request, int $u2fKeyId) { diff --git a/app/Http/Controllers/Settings/PersonalizationController.php b/app/Http/Controllers/Settings/PersonalizationController.php index 3a313180d..fdbf04856 100644 --- a/app/Http/Controllers/Settings/PersonalizationController.php +++ b/app/Http/Controllers/Settings/PersonalizationController.php @@ -14,7 +14,8 @@ class PersonalizationController extends Controller /** * Display the personalization page. - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory */ public function index() { @@ -60,9 +61,10 @@ class PersonalizationController extends Controller * * @param Request $request * @param ContactFieldType $contactFieldType - * @return \Illuminate\Http\Response + * + * @return ContactFieldType */ - public function editContactFieldType(Request $request, ContactFieldType $contactFieldType) + public function editContactFieldType(Request $request, ContactFieldType $contactFieldType): ContactFieldType { Validator::make($request->all(), [ 'name' => 'required|max:255', diff --git a/app/Http/Controllers/Settings/SubscriptionsController.php b/app/Http/Controllers/Settings/SubscriptionsController.php index 537415164..6a2c96381 100644 --- a/app/Http/Controllers/Settings/SubscriptionsController.php +++ b/app/Http/Controllers/Settings/SubscriptionsController.php @@ -12,7 +12,7 @@ class SubscriptionsController extends Controller /** * Display a listing of the resource. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory|\Illuminate\Http\RedirectResponse */ public function index() { @@ -37,7 +37,7 @@ class SubscriptionsController extends Controller /** * Display the upgrade view page. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory|\Illuminate\Http\RedirectResponse */ public function upgrade(Request $request) { @@ -60,7 +60,7 @@ class SubscriptionsController extends Controller /** * Display the upgrade success page. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory|\Illuminate\Http\RedirectResponse */ public function upgradeSuccess(Request $request) { @@ -74,7 +74,7 @@ class SubscriptionsController extends Controller /** * Display the downgrade success page. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory|\Illuminate\Http\RedirectResponse */ public function downgradeSuccess(Request $request) { @@ -88,7 +88,7 @@ class SubscriptionsController extends Controller /** * Display the downgrade view page. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory|\Illuminate\Http\RedirectResponse */ public function downgrade() { @@ -106,7 +106,7 @@ class SubscriptionsController extends Controller /** * Process the downgrade process. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\RedirectResponse */ public function processDowngrade() { @@ -126,7 +126,7 @@ class SubscriptionsController extends Controller /** * Process the upgrade payment. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\RedirectResponse */ public function processPayment(Request $request) { diff --git a/app/Http/Controllers/SettingsController.php b/app/Http/Controllers/SettingsController.php index c394ff5ce..54731e5fa 100644 --- a/app/Http/Controllers/SettingsController.php +++ b/app/Http/Controllers/SettingsController.php @@ -76,7 +76,7 @@ class SettingsController /** * Display a listing of the resource. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View */ public function index() { @@ -105,7 +105,8 @@ class SettingsController * Save user settings. * * @param SettingsRequest $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function save(SettingsRequest $request) { @@ -144,7 +145,8 @@ class SettingsController * Delete user account. * * @param Request $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function delete(Request $request) { @@ -185,7 +187,8 @@ class SettingsController * Reset user account. * * @param Request $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function reset(Request $request) { @@ -220,7 +223,7 @@ class SettingsController /** * Display the export view. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory */ public function export() { @@ -250,7 +253,7 @@ class SettingsController /** * Display the import view. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory */ public function import() { @@ -264,7 +267,7 @@ class SettingsController /** * Display the Import people's view. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory|\Illuminate\Http\RedirectResponse */ public function upload() { @@ -293,7 +296,7 @@ class SettingsController /** * Display the import report view. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory */ public function report($importJobId) { @@ -306,7 +309,7 @@ class SettingsController /** * Display the users view. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory */ public function users() { @@ -322,7 +325,7 @@ class SettingsController /** * Show the form for creating a new resource. * - * @return \Illuminate\Http\Response + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory|\Illuminate\Http\RedirectResponse */ public function addUser() { @@ -337,7 +340,8 @@ class SettingsController * Store a newly created resource in storage. * * @param InvitationRequest $request - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function inviteUser(InvitationRequest $request) { @@ -383,7 +387,8 @@ class SettingsController * Remove the specified resource from storage. * * @param Invitation $invitation - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function destroyInvitation(Invitation $invitation) { @@ -397,7 +402,8 @@ class SettingsController * Display the specified resource. * * @param string $key - * @return \Illuminate\Http\Response + * + * @return \Illuminate\View\View|\Illuminate\Contracts\View\Factory|\Illuminate\Http\RedirectResponse */ public function acceptInvitation($key) { @@ -416,7 +422,8 @@ class SettingsController * * @param Request $request * @param string $key - * @return \Illuminate\Http\Response + * + * @return null|\Illuminate\Http\RedirectResponse */ public function storeAcceptedInvitation(Request $request, $key) { @@ -453,7 +460,8 @@ class SettingsController * Delete additional user account. * * @param int $userID - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function deleteAdditionalUser($userID) { @@ -483,7 +491,8 @@ class SettingsController * Destroy the tag. * * @param int $tagId - * @return \Illuminate\Http\Response + * + * @return \Illuminate\Http\RedirectResponse */ public function deleteTag($tagId) { diff --git a/app/Http/Controllers/TasksController.php b/app/Http/Controllers/TasksController.php index 3f564e3bb..ccf4bf0ef 100644 --- a/app/Http/Controllers/TasksController.php +++ b/app/Http/Controllers/TasksController.php @@ -17,7 +17,7 @@ class TasksController extends Controller /** * Get the list of tasks for the account. * - * @return \Illuminate\Http\Response + * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection */ public function index() { @@ -63,7 +63,8 @@ class TasksController extends Controller * Destroy the task. * * @param Task $task - * @return \Illuminate\Http\Response + * + * @return null|\Illuminate\Http\JsonResponse */ public function destroy(Task $task) { diff --git a/app/Http/Location/Drivers/CloudflareDriver.php b/app/Http/Location/Drivers/CloudflareDriver.php index 59ae1ffd4..141f6ba9d 100644 --- a/app/Http/Location/Drivers/CloudflareDriver.php +++ b/app/Http/Location/Drivers/CloudflareDriver.php @@ -10,8 +10,12 @@ use Stevebauman\Location\Drivers\Driver; class CloudflareDriver extends Driver { + /** + * @return string + */ public function url() { + return ''; } protected function hydrate(Position $position, Fluent $location) diff --git a/app/Models/Account/ActivityTypeCategory.php b/app/Models/Account/ActivityTypeCategory.php index b378208fc..e3231605c 100644 --- a/app/Models/Account/ActivityTypeCategory.php +++ b/app/Models/Account/ActivityTypeCategory.php @@ -47,6 +47,7 @@ class ActivityTypeCategory extends Model * Get the activity type category's attribute. * * @return string + * @psalm-suppress InvalidReturnStatement */ public function getNameAttribute($value) { diff --git a/app/Models/Account/ImportJob.php b/app/Models/Account/ImportJob.php index 5a2a4f593..9a36bcbf6 100644 --- a/app/Models/Account/ImportJob.php +++ b/app/Models/Account/ImportJob.php @@ -2,7 +2,6 @@ namespace App\Models\Account; -use Exception; use App\Models\User\User; use Sabre\VObject\Reader; use Sabre\VObject\ParseException; @@ -128,10 +127,11 @@ class ImportJob extends Model /** * Mark the import job as failed. * - * @param string $reason - * @return Exception + * @param string $reason + * + * @return void */ - private function fail(string $reason) + private function fail(string $reason): void { $this->failed = true; $this->failed_reason = $reason; @@ -157,9 +157,9 @@ class ImportJob extends Model /** * Delete the physical file from the disk. * - * @return self + * @return void */ - private function deletePhysicalFile() + private function deletePhysicalFile(): void { if (! Storage::disk('public')->delete($this->filename)) { $this->fail(trans('settings.import_vcard_file_not_found')); diff --git a/app/Models/Contact/Gift.php b/app/Models/Contact/Gift.php index 70c1f2a59..1e5c6fc28 100644 --- a/app/Models/Contact/Gift.php +++ b/app/Models/Contact/Gift.php @@ -112,9 +112,10 @@ class Gift extends Model * Set the recipient for the gift. * * @param int $value - * @return string + * + * @return void */ - public function setRecipientAttribute($value) + public function setRecipientAttribute($value): void { $this->attributes['is_for'] = $value; } diff --git a/app/Models/Contact/Reminder.php b/app/Models/Contact/Reminder.php index a971c7811..696c4ca21 100644 --- a/app/Models/Contact/Reminder.php +++ b/app/Models/Contact/Reminder.php @@ -98,9 +98,9 @@ class Reminder extends Model /** * Set the title of a reminder. * - * @return string + * @return void */ - public function setTitleAttribute($title) + public function setTitleAttribute($title): void { $this->attributes['title'] = $title; } diff --git a/app/Models/Relationship/RelationshipType.php b/app/Models/Relationship/RelationshipType.php index 33e1c53cb..013eec3bb 100644 --- a/app/Models/Relationship/RelationshipType.php +++ b/app/Models/Relationship/RelationshipType.php @@ -50,7 +50,10 @@ class RelationshipType extends Model /** * Get the i18n version of the name attribute, like "Significant other". * - * @return string + * @psalm-suppress InvalidReturnType + * @psalm-suppress InvalidReturnStatement + * + * @return array|string|null|\Illuminate\Contracts\Translation\Translator */ public function getLocalizedName(Contact $contact = null, bool $includeOpposite = false, string $gender = 'man') { diff --git a/app/Models/User/User.php b/app/Models/User/User.php index 57f474cfb..985163fed 100644 --- a/app/Models/User/User.php +++ b/app/Models/User/User.php @@ -307,10 +307,11 @@ class User extends Authenticatable implements MustVerifyEmail /** * Ecrypt the user's google_2fa secret. * - * @param string $value - * @return string + * @param string $value + * + * @return void */ - public function setGoogle2faSecretAttribute($value) + public function setGoogle2faSecretAttribute($value): void { $this->attributes['google2fa_secret'] = encrypt($value); } diff --git a/app/Services/Contact/Contact/UpdateBirthdayInformation.php b/app/Services/Contact/Contact/UpdateBirthdayInformation.php index 4d66bd28f..45523e3c4 100644 --- a/app/Services/Contact/Contact/UpdateBirthdayInformation.php +++ b/app/Services/Contact/Contact/UpdateBirthdayInformation.php @@ -92,9 +92,10 @@ class UpdateBirthdayInformation extends BaseService * * @param array $data * @param Contact $contact - * @return void|null + * + * @return void */ - private function manageBirthday(array $data, Contact $contact) + private function manageBirthday(array $data, Contact $contact): void { if (! $data['is_date_known']) { return; diff --git a/app/Services/Contact/Contact/UpdateDeceasedInformation.php b/app/Services/Contact/Contact/UpdateDeceasedInformation.php index b25dfa9ec..7bb66f910 100644 --- a/app/Services/Contact/Contact/UpdateDeceasedInformation.php +++ b/app/Services/Contact/Contact/UpdateDeceasedInformation.php @@ -51,9 +51,10 @@ class UpdateDeceasedInformation extends BaseService * * @param array $data * @param Contact $contact - * @return void|null + * + * @return void */ - private function manageDeceasedDate(array $data, Contact $contact) + private function manageDeceasedDate(array $data, Contact $contact): void { if (! $data['is_deceased']) { // remove all information about deceased date in the DB diff --git a/app/Services/VCard/ImportVCard.php b/app/Services/VCard/ImportVCard.php index 26e0b253b..e042f1a4f 100644 --- a/app/Services/VCard/ImportVCard.php +++ b/app/Services/VCard/ImportVCard.php @@ -324,11 +324,10 @@ class ImportVCard extends BaseService * Check whether the email is valid. * * @param string $email - * @return bool */ - private function isValidEmail(string $email): bool + private function isValidEmail(string $email) : bool { - return filter_var($email, FILTER_VALIDATE_EMAIL); + return (bool) filter_var($email, FILTER_VALIDATE_EMAIL); } /** @@ -458,10 +457,14 @@ class ImportVCard extends BaseService * John Doe Johnny john@doe.com. * Only used for report display. * - * @param VCard $entry - * @return string + * @psalm-suppress InvalidReturnStatement + * @psalm-suppress InvalidReturnType + * + * @param VCard $entry + * + * @return array|string|null|\Illuminate\Contracts\Translation\Translator */ - private function name($entry): string + private function name($entry) { if ($this->hasFirstnameInN($entry)) { $parts = $entry->N->getParts(); diff --git a/psalm.xml b/psalm.xml index 210052a0e..232a815ec 100644 --- a/psalm.xml +++ b/psalm.xml @@ -89,8 +89,6 @@ - -