STEMMechanics/Website
1
0
Fork 0
Code Issues 4 Pull Requests 3 Actions Packages Projects Releases 3 Wiki Activity

Add type hints from DocBlocks

Browse Source
This commit is contained in:
Shift
2023-05-24 21:33:16 +00:00
parent 979b9f704c
commit 4d7d0ed74d
46 changed files with 191 additions and 190 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
app/Http/Controllers/Api/ApiController.php
View File

@@ -2,6 +2,7 @@
namespace App\Http\Controllers\Api;
use Illuminate\Http\JsonResponse;
use App\Enum\HttpResponseCodes;
use App\Http\Controllers\Controller;
use Illuminate\Database\Eloquent\Model;
@@ -25,7 +26,7 @@ class ApiController extends Controller
* @param array $headers Response headers.
* @return \Illuminate\Http\JsonResponse
*/
public function respondJson(array $data, int $respondCode = HttpResponseCodes::HTTP_OK, array $headers = [])
public function respondJson(array $data, int $respondCode = HttpResponseCodes::HTTP_OK, array $headers = []): JsonResponse
{
return response()->json($data, $respondCode, $headers);
}
@@ -36,7 +37,7 @@ class ApiController extends Controller
* @param string $message Response message.
* @return \Illuminate\Http\JsonResponse
*/
public function respondForbidden(string $message = 'You do not have permission to access the resource.')
public function respondForbidden(string $message = 'You do not have permission to access the resource.'): JsonResponse
{
return response()->json(['message' => $message], HttpResponseCodes::HTTP_FORBIDDEN);
}
@@ -47,7 +48,7 @@ class ApiController extends Controller
* @param string $message Response message.
* @return \Illuminate\Http\JsonResponse
*/
public function respondNotFound(string $message = 'The resource was not found.')
public function respondNotFound(string $message = 'The resource was not found.'): JsonResponse
{
return response()->json(['message' => $message], HttpResponseCodes::HTTP_NOT_FOUND);
}
@@ -58,7 +59,7 @@ class ApiController extends Controller
* @param string $message Response message.
* @return \Illuminate\Http\JsonResponse
*/
public function respondTooLarge(string $message = 'The request entity is too large.')
public function respondTooLarge(string $message = 'The request entity is too large.'): JsonResponse
{
return response()->json(['message' => $message], HttpResponseCodes::HTTP_REQUEST_ENTITY_TOO_LARGE);
}
@@ -67,7 +68,7 @@ class ApiController extends Controller
* Return no content
* @return \Illuminate\Http\JsonResponse
*/
public function respondNoContent()
public function respondNoContent(): JsonResponse
{
return response()->json([], HttpResponseCodes::HTTP_NO_CONTENT);
}
@@ -76,7 +77,7 @@ class ApiController extends Controller
* Return created
* @return \Illuminate\Http\JsonResponse
*/
public function respondCreated()
public function respondCreated(): JsonResponse
{
return response()->json([], HttpResponseCodes::HTTP_CREATED);
}
@@ -85,7 +86,7 @@ class ApiController extends Controller
* Return accepted
* @return \Illuminate\Http\JsonResponse
*/
public function respondAccepted()
public function respondAccepted(): JsonResponse
{
return response()->json([], HttpResponseCodes::HTTP_ACCEPTED);
}
@@ -97,7 +98,7 @@ class ApiController extends Controller
* @param integer $responseCode Resource code.
* @return \Illuminate\Http\JsonResponse
*/
public function respondError(string $message, int $responseCode = HttpResponseCodes::HTTP_UNPROCESSABLE_ENTITY)
public function respondError(string $message, int $responseCode = HttpResponseCodes::HTTP_UNPROCESSABLE_ENTITY): JsonResponse
{
return response()->json([
'message' => $message
@@ -111,7 +112,7 @@ class ApiController extends Controller
* @param integer $responseCode Resource code.
* @return \Illuminate\Http\JsonResponse
*/
public function respondWithErrors(array $errors, int $responseCode = HttpResponseCodes::HTTP_UNPROCESSABLE_ENTITY)
public function respondWithErrors(array $errors, int $responseCode = HttpResponseCodes::HTTP_UNPROCESSABLE_ENTITY): JsonResponse
{
$keys = array_keys($errors);
$error = $errors[$keys[0]];
@@ -138,7 +139,7 @@ class ApiController extends Controller
mixed $data,
array $options = [],
$validationFn = null
) {
): JsonResponse {
$isCollection = $options['isCollection'] ?? false;
$appendData = $options['appendData'] ?? null;
$resourceName = $options['resourceName'] ?? null;

8
app/Http/Controllers/Api/ArticleController.php
View File

@@ -126,7 +126,7 @@ class ArticleController extends ApiController
* @throws BindingResolutionException
* @throws InvalidCastException
*/
public function getAttachments(Request $request, Article $article)
public function getAttachments(Request $request, Article $article): JsonResponse
{
if (ArticleConductor::viewable($article) === true) {
$medium = $article->attachments->map(function ($attachment) {
@@ -148,7 +148,7 @@ class ArticleController extends ApiController
* @throws BindingResolutionException
* @throws MassAssignmentException
*/
public function storeAttachment(Request $request, Article $article)
public function storeAttachment(Request $request, Article $article): JsonResponse
{
if (ArticleConductor::updatable($article) === true) {
if ($request->has("medium") && Media::find($request->medium)) {
@@ -171,7 +171,7 @@ class ArticleController extends ApiController
* @throws BindingResolutionException
* @throws MassAssignmentException
*/
public function updateAttachments(Request $request, Article $article)
public function updateAttachments(Request $request, Article $article): JsonResponse
{
if (ArticleConductor::updatable($article) === true) {
$mediaIds = $request->attachments;
@@ -219,7 +219,7 @@ class ArticleController extends ApiController
* @return JsonResponse
* @throws BindingResolutionException
*/
public function deleteAttachment(Request $request, Article $article, Media $medium)
public function deleteAttachment(Request $request, Article $article, Media $medium): JsonResponse
{
if (ArticleConductor::updatable($article) === true) {
$attachments = $article->attachments;

4
app/Http/Controllers/Api/AuthController.php
View File

@@ -33,7 +33,7 @@ class AuthController extends ApiController
* @param Request $request Current request data.
* @return JsonResponse
*/
public function me(Request $request)
public function me(Request $request): JsonResponse
{
$user = $request->user()->makeVisible(['permissions']);
return $this->respondAsResource($user);
@@ -89,7 +89,7 @@ class AuthController extends ApiController
* @param Request $request Current request data.
* @return JsonResponse
*/
public function logout(Request $request)
public function logout(Request $request): JsonResponse
{
$user = $request->user();

8
app/Http/Controllers/Api/EventController.php
View File

@@ -116,7 +116,7 @@ class EventController extends ApiController
* @param Event $event The event model.
* @return JsonResponse Returns the event attachments.
*/
public function getAttachments(Request $request, Event $event)
public function getAttachments(Request $request, Event $event): JsonResponse
{
if (EventConductor::viewable($event) === true) {
$medium = $event->attachments->map(function ($attachment) {
@@ -136,7 +136,7 @@ class EventController extends ApiController
* @param Event $event The event model.
* @return JsonResponse The response.
*/
public function storeAttachment(Request $request, Event $event)
public function storeAttachment(Request $request, Event $event): JsonResponse
{
if (EventConductor::updatable($event) === true) {
if ($request->has("medium") === true && Media::find($request->medium) !== null) {
@@ -157,7 +157,7 @@ class EventController extends ApiController
* @param Event $event The related model.
* @return JsonResponse
*/
public function updateAttachments(Request $request, Event $event)
public function updateAttachments(Request $request, Event $event): JsonResponse
{
if (EventConductor::updatable($event) === true) {
$mediaIds = $request->attachments;
@@ -205,7 +205,7 @@ class EventController extends ApiController
* @param Media $medium The attachment medium.
* @return JsonResponse
*/
public function deleteAttachment(Request $request, Event $event, Media $medium)
public function deleteAttachment(Request $request, Event $event, Media $medium): JsonResponse
{
if (EventConductor::updatable($event) === true) {
$attachments = $event->attachments;

6
app/Http/Controllers/Api/UserController.php
View File

@@ -147,7 +147,7 @@ class UserController extends ApiController
* @param \App\Http\Requests\UserRegisterRequest $request The register user request.
* @return \Illuminate\Http\Response
*/
public function register(UserRegisterRequest $request)
public function register(UserRegisterRequest $request): JsonResponse
{
try {
$userData = $request->only([
@@ -288,7 +288,7 @@ class UserController extends ApiController
* @param \App\Http\Requests\UserResendVerifyEmailRequest $request The resend verify email request.
* @return \Illuminate\Http\Response
*/
public function resendVerifyEmail(UserResendVerifyEmailRequest $request)
public function resendVerifyEmail(UserResendVerifyEmailRequest $request): JsonResponse
{
UserCode::clearExpired();
@@ -342,7 +342,7 @@ class UserController extends ApiController
* @param User $user The specified user.
* @return JsonResponse
*/
public function eventList(Request $request, User $user)
public function eventList(Request $request, User $user): JsonResponse
{
if ($request->user() !== null && ($request->user() === $user || $request->user()->hasPermission('admin/events') === true)) {
$collection = $user->events;