diff --git a/app/Constants/ControllerRating.php b/app/Constants/ControllerRating.php index e27bcfa..d2be66a 100644 --- a/app/Constants/ControllerRating.php +++ b/app/Constants/ControllerRating.php @@ -47,6 +47,7 @@ public static function getRatingCodeByNumber(int $index): ?string /** * Get the human readable version of a given code. + * * @param string $code * @return string */ diff --git a/app/GraphQL/Scalars/DateTimeZulu.php b/app/GraphQL/Scalars/DateTimeZulu.php index 3f6b5c5..cd713d1 100644 --- a/app/GraphQL/Scalars/DateTimeZulu.php +++ b/app/GraphQL/Scalars/DateTimeZulu.php @@ -15,8 +15,9 @@ class DateTimeZulu extends ScalarType /** * Serialize an internal value, ensuring it is a valid datetime string. * - * @param \Carbon\Carbon|string $value + * @param \Carbon\Carbon|string $value * @return string + * * @throws */ public function serialize($value): string @@ -35,6 +36,7 @@ public function serialize($value): string * * @param mixed $value * @return \Carbon\Carbon + * * @throws */ public function parseValue($value): Carbon diff --git a/app/Modules/Availability/Mutations/AvailabilityHandler.php b/app/Modules/Availability/Mutations/AvailabilityHandler.php index cb25c5c..61227ff 100644 --- a/app/Modules/Availability/Mutations/AvailabilityHandler.php +++ b/app/Modules/Availability/Mutations/AvailabilityHandler.php @@ -15,13 +15,14 @@ class AvailabilityHandler /** * Return a value for the field. * - * @param null $rootValue Usually contains the result returned from the parent field. In this case, - * it is always `null`. - * @param mixed[] $args The arguments that were passed into the field. - * @param GraphQLContext $context Arbitrary data that is shared between all fields of a single query. - * @param ResolveInfo $resolveInfo Information about the query itself, such as the execution state, the field name, - * path to the field from the root, and more. + * @param null $rootValue Usually contains the result returned from the parent field. In this case, + * it is always `null`. + * @param mixed[] $args The arguments that were passed into the field. + * @param GraphQLContext $context Arbitrary data that is shared between all fields of a single query. + * @param ResolveInfo $resolveInfo Information about the query itself, such as the execution state, the field name, + * path to the field from the root, and more. * @return Availability + * * @throws BindingResolutionException */ public function update($rootValue, array $args, GraphQLContext $context, ResolveInfo $resolveInfo) @@ -39,12 +40,13 @@ public function update($rootValue, array $args, GraphQLContext $context, Resolve * Return a value for the field. * * @param null $rootValue Usually contains the result returned from the parent field. In this case, - * it is always `null`. + * it is always `null`. * @param mixed[] $args The arguments that were passed into the field. * @param GraphQLContext $context Arbitrary data that is shared between all fields of a single query. * @param ResolveInfo $resolveInfo Information about the query itself, such as the execution state, - * the field name, path to the field from the root, and more. + * the field name, path to the field from the root, and more. * @return mixed + * * @throws OverlappingAvailabilityException * @throws BindingResolutionException */ @@ -60,13 +62,14 @@ public function create($rootValue, array $args, GraphQLContext $context, Resolve /** * Remove date range. * - * @param null $rootValue Usually contains the result returned from the parent field. In this case, - * it is always `null`. - * @param mixed[] $args The arguments that were passed into the field. - * @param GraphQLContext $context Arbitrary data that is shared between all fields of a single query. - * @param ResolveInfo $resolveInfo Information about the query itself, such as the execution state, - * the field name, path to the field from the root, and more. + * @param null $rootValue Usually contains the result returned from the parent field. In this case, + * it is always `null`. + * @param mixed[] $args The arguments that were passed into the field. + * @param GraphQLContext $context Arbitrary data that is shared between all fields of a single query. + * @param ResolveInfo $resolveInfo Information about the query itself, such as the execution state, + * the field name, path to the field from the root, and more. * @return mixed + * * @throws BindingResolutionException */ public function remove($rootValue, array $args, GraphQLContext $context, ResolveInfo $resolveInfo) diff --git a/app/Modules/Availability/Services/AvailabilityService.php b/app/Modules/Availability/Services/AvailabilityService.php index 16468ab..e09e69f 100644 --- a/app/Modules/Availability/Services/AvailabilityService.php +++ b/app/Modules/Availability/Services/AvailabilityService.php @@ -27,11 +27,12 @@ public function __construct(User $user) /** * Validate that two given times are valid within the context of other availability. * - * @param Carbon $from - * @param Carbon $to - * @param User $user - User - * @param int $doNotCheck - Pass in an int to exclude from the search + * @param Carbon $from + * @param Carbon $to + * @param User $user - User + * @param int $doNotCheck - Pass in an int to exclude from the search * @return bool + * * @throws AvailabilityMinimumTimeException * @throws AvailabilityInPastException * @throws \Throwable diff --git a/app/Modules/Bookings/Mutations/CreateBookingHandler.php b/app/Modules/Bookings/Mutations/CreateBookingHandler.php index 1907b10..d955d31 100644 --- a/app/Modules/Bookings/Mutations/CreateBookingHandler.php +++ b/app/Modules/Bookings/Mutations/CreateBookingHandler.php @@ -19,6 +19,7 @@ class CreateBookingHandler * @param GraphQLContext $context Arbitrary data that is shared between all fields of a single query. * @param ResolveInfo $resolveInfo Information about the query itself. * @return mixed + * * @throws RatingRequirementNotMetException * @throws SpecialEndorsementNotAttainedException * @throws OverlappingBookingException diff --git a/app/Modules/Bookings/Mutations/UpdateBookingHandler.php b/app/Modules/Bookings/Mutations/UpdateBookingHandler.php index 97e709a..5c659b5 100644 --- a/app/Modules/Bookings/Mutations/UpdateBookingHandler.php +++ b/app/Modules/Bookings/Mutations/UpdateBookingHandler.php @@ -17,6 +17,7 @@ class UpdateBookingHandler * @param mixed[] $args The arguments that were passed into the field. * @param GraphQLContext $context Arbitrary data that is shared between all fields of a single query. * @param ResolveInfo $resolveInfo Information about the query itself. + * * @throws OverlappingBookingException */ public function __invoke($rootValue, array $args, GraphQLContext $context, ResolveInfo $resolveInfo) diff --git a/app/Modules/Endorsement/Solo/Mutations/GrantSoloEndorsementHandler.php b/app/Modules/Endorsement/Solo/Mutations/GrantSoloEndorsementHandler.php index ddb6a2a..26dbc43 100644 --- a/app/Modules/Endorsement/Solo/Mutations/GrantSoloEndorsementHandler.php +++ b/app/Modules/Endorsement/Solo/Mutations/GrantSoloEndorsementHandler.php @@ -18,6 +18,7 @@ class GrantSoloEndorsementHandler * @param mixed[] $args The arguments that were passed into the field. * @param GraphQLContext $context Arbitrary data that is shared between all fields of a single query. * @param ResolveInfo $resolveInfo Information about the query itself. + * * @throws OverlappingBookingException */ public function __invoke($rootValue, array $args, GraphQLContext $context, ResolveInfo $resolveInfo) diff --git a/app/Modules/Endorsement/Special/Mutations/GrantSpecialEndorsementHandler.php b/app/Modules/Endorsement/Special/Mutations/GrantSpecialEndorsementHandler.php index 22aa334..ab33d8f 100644 --- a/app/Modules/Endorsement/Special/Mutations/GrantSpecialEndorsementHandler.php +++ b/app/Modules/Endorsement/Special/Mutations/GrantSpecialEndorsementHandler.php @@ -19,6 +19,7 @@ class GrantSpecialEndorsementHandler * @param \Nuwave\Lighthouse\Support\Contracts\GraphQLContext $context Arbitrary data that is shared between all fields of a single query. * @param \GraphQL\Type\Definition\ResolveInfo $resolveInfo Information about the query itself. * @return mixed + * * @throws EndorsementAlreadyGrantedException */ public function __invoke($rootValue, array $args, GraphQLContext $context, ResolveInfo $resolveInfo) diff --git a/app/Modules/Endorsement/Special/Mutations/RequestSpecialEndorsementHandler.php b/app/Modules/Endorsement/Special/Mutations/RequestSpecialEndorsementHandler.php index 6eaf3ce..3c9a94b 100644 --- a/app/Modules/Endorsement/Special/Mutations/RequestSpecialEndorsementHandler.php +++ b/app/Modules/Endorsement/Special/Mutations/RequestSpecialEndorsementHandler.php @@ -27,6 +27,7 @@ public function __construct(User $user) * @param \Nuwave\Lighthouse\Support\Contracts\GraphQLContext $context Arbitrary data that is shared between all fields of a single query. * @param \GraphQL\Type\Definition\ResolveInfo $resolveInfo Information about the query itself. * @return mixed + * * @throws EndorsementRequestAlreadyExistsException * @throws EndorsementAlreadyGrantedException */ diff --git a/app/Modules/Endorsement/Special/Mutations/SpecialEndorsementsForUser.php b/app/Modules/Endorsement/Special/Mutations/SpecialEndorsementsForUser.php index ab49ae3..455e6ff 100644 --- a/app/Modules/Endorsement/Special/Mutations/SpecialEndorsementsForUser.php +++ b/app/Modules/Endorsement/Special/Mutations/SpecialEndorsementsForUser.php @@ -24,6 +24,7 @@ public function __construct(User $user) * @param GraphQLContext $context Arbitrary data that is shared between all fields of a single query. * @param ResolveInfo $resolveInfo Information about the query itself. * @return mixed + * * @throws \InvalidArgumentException */ public function __invoke($rootValue, array $args, GraphQLContext $context, ResolveInfo $resolveInfo) diff --git a/app/Modules/SessionRequest/SessionRequestService.php b/app/Modules/SessionRequest/SessionRequestService.php index 0de9862..b9dd3bf 100644 --- a/app/Modules/SessionRequest/SessionRequestService.php +++ b/app/Modules/SessionRequest/SessionRequestService.php @@ -23,8 +23,8 @@ public function __construct(BookingsService $bookingsService) /** * Creates a session request for a given user on a particular position. * - * @param User $user - * @param Position $position + * @param User $user + * @param Position $position * @return SessionRequest */ public function createSessionRequest(User $user, Position $position): SessionRequest @@ -45,7 +45,7 @@ public function createSessionRequest(User $user, Position $position): SessionReq /** * Revokes a session request for a given session which hasn't been accepted. * - * @param SessionRequest $sessionRequest + * @param SessionRequest $sessionRequest * @return bool */ public function revokeSessionRequest(SessionRequest $sessionRequest): bool @@ -58,13 +58,13 @@ public function revokeSessionRequest(SessionRequest $sessionRequest): bool /** * Accept a session request with the given times. * - * @param SessionRequest $sessionRequest - * @param User $acceptingUser - * @param Carbon $sessionDateFrom - * @param Carbon $sessionDateTo - * @param Carbon $bookingDateFrom - * @param Carbon $bookingDateTo - * @param int $networkType + * @param SessionRequest $sessionRequest + * @param User $acceptingUser + * @param Carbon $sessionDateFrom + * @param Carbon $sessionDateTo + * @param Carbon $bookingDateFrom + * @param Carbon $bookingDateTo + * @param int $networkType * @return SessionRequest */ public function acceptSessionRequest( @@ -106,8 +106,8 @@ public function acceptSessionRequest( /** * Cancel a session request which has already been accepted. * - * @param SessionRequest $sessionRequest - * @param string $reason + * @param SessionRequest $sessionRequest + * @param string $reason * @return SessionRequest */ public function cancelSession(SessionRequest $sessionRequest, string $reason): SessionRequest diff --git a/app/Rules/UserExistsRule.php b/app/Rules/UserExistsRule.php index cee11d4..bcf998f 100644 --- a/app/Rules/UserExistsRule.php +++ b/app/Rules/UserExistsRule.php @@ -9,8 +9,8 @@ class UserExistsRule implements Rule /** * Determine if the validation rule passes. * - * @param string $attribute - * @param mixed $value + * @param string $attribute + * @param mixed $value * @return bool */ public function passes($attribute, $value) diff --git a/tests/Feature/Booking/BookingCreateTest.php b/tests/Feature/Booking/BookingCreateTest.php index 041c01a..dd621bd 100644 --- a/tests/Feature/Booking/BookingCreateTest.php +++ b/tests/Feature/Booking/BookingCreateTest.php @@ -514,6 +514,7 @@ public function testItCanDeleteABooking() /** * Setup a test case to pass the rating check for testing overlapping. + * * @param string $callsign */ private function bypassRatingChecks($callsign = 'EGGD_TWR') diff --git a/yarn.lock b/yarn.lock index 4466dc2..0b808fd 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2057,7 +2057,7 @@ commander@~2.19.0: resolved "https://registry.yarnpkg.com/commander/-/commander-2.19.0.tgz#f6198aa84e5b83c46054b94ddedbfed5ee9ff12a" integrity sha512-6tvAOO+D6OENvRAh524Dh9jcfKTYDQAqvqezbCW82xj5X0pSrcpxtvRKHLG0yBY6SD7PSDrJaj+0AiOcKVd1Xg== -commitizen@^4.0.3, commitizen@^4.1.2: +commitizen@^4.0.3: version "4.1.2" resolved "https://registry.yarnpkg.com/commitizen/-/commitizen-4.1.2.tgz#6095eb825fd3f0d3611df88e6803c69b23307e9a" integrity sha512-LBxTQKHbVgroMz9ohpm86N+GfJobonGyvDc3zBGdZazbwCLz2tqLa48Rf2TnAdKx7/06W1i1R3SXUt5QW97qVQ== @@ -4498,9 +4498,9 @@ json3@^3.3.2: integrity sha512-c7/8mbUsKigAbLkD5B010BK4D9LZm7A1pNItkEwiUZRpIN66exu/e7YQWysGun+TRKaJp8MhemM+VkfWv42aCA== json5@^1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/json5/-/json5-1.0.1.tgz#779fb0018604fa854eacbf6252180d83543e3dbe" - integrity sha512-aKS4WQjPenRxiQsC93MNfjx+nbF4PAdYzmd/1JIj8HYzqfbu86beTuNgXDzPknWk0n0uARlyewZo4s++ES36Ow== + version "1.0.2" + resolved "https://registry.yarnpkg.com/json5/-/json5-1.0.2.tgz#63d98d60f21b313b77c4d6da18bfa69d80e1d593" + integrity sha512-g1MWMLBiz8FKi1e4w0UyVL3w+iJceWAFBAaBnnGKOpNa5f8TLktkbre1+s6oICydWAm+HRUGTmI+//xv2hvXYA== dependencies: minimist "^1.2.0" @@ -5064,11 +5064,16 @@ minimatch@^3.0.4, minimatch@~3.0.2: dependencies: brace-expansion "^1.1.7" -minimist@1.2.5, minimist@^1.1.1, minimist@^1.1.3, minimist@^1.2.0, minimist@^1.2.5: +minimist@1.2.5: version "1.2.5" resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.5.tgz#67d66014b66a6a8aaa0c083c5fd58df4e4e97602" integrity sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw== +minimist@^1.1.1, minimist@^1.1.3, minimist@^1.2.0, minimist@^1.2.5: + version "1.2.7" + resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.7.tgz#daa1c4d91f507390437c6a8bc01078e7000c4d18" + integrity sha512-bzfL1YUZsP41gmu/qjrEk0Q6i2ix/cVeAhbCbqH9u3zYutS1cLg00qhrD0M2MVdCcx4Sc0UpP2eBWo9rotpq6g== + mississippi@^3.0.0: version "3.0.0" resolved "https://registry.yarnpkg.com/mississippi/-/mississippi-3.0.0.tgz#ea0a3291f97e0b5e8776b363d5f0a12d94c67022"