Remove redundant typing from DocBlocks

This commit is contained in:
Shift
2023-05-24 21:33:17 +00:00
parent 4d7d0ed74d
commit 5faf49688d
86 changed files with 3 additions and 396 deletions

View File

@@ -24,7 +24,6 @@ class ApiController extends Controller
* @param array $data Response data.
* @param integer $respondCode Response status code.
* @param array $headers Response headers.
* @return \Illuminate\Http\JsonResponse
*/
public function respondJson(array $data, int $respondCode = HttpResponseCodes::HTTP_OK, array $headers = []): JsonResponse
{
@@ -35,7 +34,6 @@ class ApiController extends Controller
* Return forbidden message
*
* @param string $message Response message.
* @return \Illuminate\Http\JsonResponse
*/
public function respondForbidden(string $message = 'You do not have permission to access the resource.'): JsonResponse
{
@@ -46,7 +44,6 @@ class ApiController extends Controller
* Return forbidden message
*
* @param string $message Response message.
* @return \Illuminate\Http\JsonResponse
*/
public function respondNotFound(string $message = 'The resource was not found.'): JsonResponse
{
@@ -57,7 +54,6 @@ class ApiController extends Controller
* Return too large message
*
* @param string $message Response message.
* @return \Illuminate\Http\JsonResponse
*/
public function respondTooLarge(string $message = 'The request entity is too large.'): JsonResponse
{
@@ -66,7 +62,6 @@ class ApiController extends Controller
/**
* Return no content
* @return \Illuminate\Http\JsonResponse
*/
public function respondNoContent(): JsonResponse
{
@@ -75,7 +70,6 @@ class ApiController extends Controller
/**
* Return created
* @return \Illuminate\Http\JsonResponse
*/
public function respondCreated(): JsonResponse
{
@@ -84,7 +78,6 @@ class ApiController extends Controller
/**
* Return accepted
* @return \Illuminate\Http\JsonResponse
*/
public function respondAccepted(): JsonResponse
{
@@ -96,7 +89,6 @@ class ApiController extends Controller
*
* @param string $message Error message.
* @param integer $responseCode Resource code.
* @return \Illuminate\Http\JsonResponse
*/
public function respondError(string $message, int $responseCode = HttpResponseCodes::HTTP_UNPROCESSABLE_ENTITY): JsonResponse
{
@@ -110,7 +102,6 @@ class ApiController extends Controller
*
* @param array $errors Error messages.
* @param integer $responseCode Resource code.
* @return \Illuminate\Http\JsonResponse
*/
public function respondWithErrors(array $errors, int $responseCode = HttpResponseCodes::HTTP_UNPROCESSABLE_ENTITY): JsonResponse
{
@@ -133,7 +124,6 @@ class ApiController extends Controller
*
* @param array|Model|Collection $data Resource data.
* @param array $options Respond options.
* @return \Illuminate\Http\JsonResponse
*/
protected function respondAsResource(
mixed $data,

View File

@@ -167,7 +167,6 @@ class ArticleController extends ApiController
*
* @param Request $request The user request.
* @param Article $article The related model.
* @return JsonResponse
* @throws BindingResolutionException
* @throws MassAssignmentException
*/
@@ -216,7 +215,6 @@ class ArticleController extends ApiController
* @param Request $request The user request.
* @param Article $article The model.
* @param Media $medium The attachment medium.
* @return JsonResponse
* @throws BindingResolutionException
*/
public function deleteAttachment(Request $request, Article $article, Media $medium): JsonResponse

View File

@@ -29,7 +29,6 @@ class AttachmentController extends ApiController
/**
* Store a newly created resource in storage.
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\Response
*/
public function store(Request $request)
@@ -40,7 +39,6 @@ class AttachmentController extends ApiController
/**
* Display the specified resource.
*
* @param \App\Models\Attachment $attachment
* @return \Illuminate\Http\Response
*/
public function show(Attachment $attachment)
@@ -51,7 +49,6 @@ class AttachmentController extends ApiController
/**
* Show the form for editing the specified resource.
*
* @param \App\Models\Attachment $attachment
* @return \Illuminate\Http\Response
*/
public function edit(Attachment $attachment)
@@ -62,8 +59,6 @@ class AttachmentController extends ApiController
/**
* Update the specified resource in storage.
*
* @param \Illuminate\Http\Request $request
* @param \App\Models\Attachment $attachment
* @return \Illuminate\Http\Response
*/
public function update(Request $request, Attachment $attachment)
@@ -74,7 +69,6 @@ class AttachmentController extends ApiController
/**
* Remove the specified resource from storage.
*
* @param \App\Models\Attachment $attachment
* @return \Illuminate\Http\Response
*/
public function destroy(Attachment $attachment)

View File

@@ -31,7 +31,6 @@ class AuthController extends ApiController
* Current User details
*
* @param Request $request Current request data.
* @return JsonResponse
*/
public function me(Request $request): JsonResponse
{
@@ -87,7 +86,6 @@ class AuthController extends ApiController
* Logout current user
*
* @param Request $request Current request data.
* @return JsonResponse
*/
public function logout(Request $request): JsonResponse
{

View File

@@ -155,7 +155,6 @@ class EventController extends ApiController
*
* @param Request $request The user request.
* @param Event $event The related model.
* @return JsonResponse
*/
public function updateAttachments(Request $request, Event $event): JsonResponse
{
@@ -203,7 +202,6 @@ class EventController extends ApiController
* @param Request $request The user request.
* @param Event $event The model.
* @param Media $medium The attachment medium.
* @return JsonResponse
*/
public function deleteAttachment(Request $request, Event $event, Media $medium): JsonResponse
{

View File

@@ -145,7 +145,6 @@ class UserController extends ApiController
* Register a new user
*
* @param \App\Http\Requests\UserRegisterRequest $request The register user request.
* @return \Illuminate\Http\Response
*/
public function register(UserRegisterRequest $request): JsonResponse
{
@@ -286,7 +285,6 @@ class UserController extends ApiController
* Resend a new verify email
*
* @param \App\Http\Requests\UserResendVerifyEmailRequest $request The resend verify email request.
* @return \Illuminate\Http\Response
*/
public function resendVerifyEmail(UserResendVerifyEmailRequest $request): JsonResponse
{
@@ -340,7 +338,6 @@ class UserController extends ApiController
*
* @param Request $request The http request.
* @param User $user The specified user.
* @return JsonResponse
*/
public function eventList(Request $request, User $user): JsonResponse
{