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

gallery support

Browse Source
This commit is contained in:
James Collins
2023-07-18 18:35:58 +10:00
parent 64ef8e9acd
commit ef4efe723f
18 changed files with 447 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
app/Conductors/ArticleConductor.php
View File

@@ -32,13 +32,14 @@ class ArticleConductor extends Conductor
*
* @var string[]
*/
protected $includes = ['attachments', 'user'];
protected $includes = ['attachments', 'user', 'gallery'];
/**
* Run a scope query on the collection before anything else.
*
* @param Builder $builder The builder in use.
* @return void
*/
public function scope(Builder $builder): void
{
@@ -127,6 +128,19 @@ class ArticleConductor extends Conductor
});
}
/**
* Include Gallery Field.
*
* @param Model $model Them model.
* @return mixed The model result.
*/
public function includeGallery(Model $model)
{
return $model->gallery()->get()->map(function ($item) {
return MediaConductor::includeModel(request(), 'gallery', $item->media);
});
}
/**
* Include User Field.
*

2
app/Conductors/MediaConductor.php
View File

@@ -2,9 +2,9 @@
namespace App\Conductors;
use App\Models\User;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Foundation\Auth\User;
class MediaConductor extends Conductor
{

7
app/Conductors/UserConductor.php
View File

@@ -39,14 +39,17 @@ class UserConductor extends Conductor
{
$user = auth()->user();
$data = $model->toArray();
$limit = $this->fields($model);
// echo 'USER--' . implode(',', $limit) . "\n";
if ($user === null || ($user->hasPermission('admin/users') === false && strcasecmp($user->id, $model->id) !== 0)) {
$fields = ['id', 'display_name'];
$data = arrayLimitKeys($data, $fields);
$limit = ['id', 'display_name'];
} else {
$data['permissions'] = $user->permissions;
}
$data = arrayLimitKeys($data, $limit);
return $data;
}

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

@@ -24,9 +24,13 @@ class ApiController extends Controller
* @param array $data Response data.
* @param integer $respondCode Response status code.
* @param array $headers Response headers.
* @return JsonResponse
*/
public function respondJson(array $data, int $respondCode = HttpResponseCodes::HTTP_OK, array $headers = []): JsonResponse
{
public function respondJson(
array $data,
int $respondCode = HttpResponseCodes::HTTP_OK,
array $headers = []
): JsonResponse {
return response()->json($data, $respondCode, $headers);
}
@@ -34,9 +38,11 @@ class ApiController extends Controller
* Return forbidden message
*
* @param string $message Response message.
* @return JsonResponse
*/
public function respondForbidden(string $message = 'You do not have permission to access the resource.'): JsonResponse
{
public function respondForbidden(
string $message = 'You do not have permission to access the resource.'
): JsonResponse {
return response()->json(['message' => $message], HttpResponseCodes::HTTP_FORBIDDEN);
}
@@ -44,6 +50,7 @@ class ApiController extends Controller
* Return forbidden message
*
* @param string $message Response message.
* @return JsonResponse
*/
public function respondNotFound(string $message = 'The resource was not found.'): JsonResponse
{
@@ -54,6 +61,7 @@ class ApiController extends Controller
* Return too large message
*
* @param string $message Response message.
* @return JsonResponse
*/
public function respondTooLarge(string $message = 'The request entity is too large.'): JsonResponse
{
@@ -61,7 +69,9 @@ class ApiController extends Controller
}
/**
* Return no content
* Return no content.
*
* @return JsonResponse
*/
public function respondNoContent(): JsonResponse
{
@@ -69,7 +79,19 @@ class ApiController extends Controller
}
/**
* Return created
* Return no content
*
* @return JsonResponse
*/
public function respondNotImplmeneted(): JsonResponse
{
return response()->json([], HttpResponseCodes::HTTP_NOT_IMPLEMENTED);
}
/**
* Return created.
*
* @return JsonResponse
*/
public function respondCreated(): JsonResponse
{
@@ -77,7 +99,9 @@ class ApiController extends Controller
}
/**
* Return accepted
* Return accepted.
*
* @return JsonResponse
*/
public function respondAccepted(): JsonResponse
{
@@ -89,9 +113,12 @@ class ApiController extends Controller
*
* @param string $message Error message.
* @param integer $responseCode Resource code.
* @return JsonResponse
*/
public function respondError(string $message, int $responseCode = HttpResponseCodes::HTTP_UNPROCESSABLE_ENTITY): JsonResponse
{
public function respondError(
string $message,
int $responseCode = HttpResponseCodes::HTTP_UNPROCESSABLE_ENTITY
): JsonResponse {
return response()->json([
'message' => $message
], $responseCode);
@@ -102,9 +129,12 @@ class ApiController extends Controller
*
* @param array $errors Error messages.
* @param integer $responseCode Resource code.
* @return JsonResponse
*/
public function respondWithErrors(array $errors, int $responseCode = HttpResponseCodes::HTTP_UNPROCESSABLE_ENTITY): JsonResponse
{
public function respondWithErrors(
array $errors,
int $responseCode = HttpResponseCodes::HTTP_UNPROCESSABLE_ENTITY
): JsonResponse {
$keys = array_keys($errors);
$error = $errors[$keys[0]];
@@ -122,17 +152,20 @@ class ApiController extends Controller
/**
* Return resource data
*
* @param array|Model|Collection $data Resource data.
* @param array $options Respond options.
* @param array|Model|Collection $data Resource data.
* @param array $options Respond options.
* @param callable|null $validationFn Optional validation function to check the data before responding.
* @return JsonResponse
*/
protected function respondAsResource(
mixed $data,
array $options = [],
$validationFn = null
): JsonResponse {
$isCollection = $options['isCollection'] ?? false;
$appendData = $options['appendData'] ?? null;
$resourceName = $options['resourceName'] ?? null;
$isCollection = ($options['isCollection'] ?? false);
$appendData = ($options['appendData'] ?? null);
$resourceName = ($options['resourceName'] ?? '');
$transformResourceName = ($options['transformResourceName'] ?? true);
$respondCode = ($options['respondCode'] ?? HttpResponseCodes::HTTP_OK);
if ($data === null || ($data instanceof Collection && $data->count() === 0)) {
@@ -146,11 +179,11 @@ class ApiController extends Controller
}
}
if (is_null($resourceName) === true || empty($resourceName) === true) {
if (empty($resourceName) === true) {
$resourceName = $this->resourceName;
}
if (is_null($resourceName) === true || empty($resourceName) === true) {
if (empty($resourceName) === true) {
$resourceName = get_class($this);
$resourceName = substr($resourceName, (strrpos($resourceName, '\\') + 1));
$resourceName = substr($resourceName, 0, strpos($resourceName, 'Controller'));
@@ -163,15 +196,14 @@ class ApiController extends Controller
} elseif (is_array($data) === true) {
$dataArray = $data;
} elseif ($data instanceof Model) {
$is_multiple = false;
$dataArray = $data->toArray();
}
$resource = [];
if ($isCollection === true) {
$resource = [Str::plural($resourceName) => $dataArray];
$resource = [$transformResourceName === true ? Str::plural($resourceName) : $resourceName => $dataArray];
} else {
$resource = [Str::singular($resourceName) => $dataArray];
$resource = [$transformResourceName === true ? Str::singular($resourceName) : $resourceName => $dataArray];
}
if ($appendData !== null) {
@@ -180,4 +212,22 @@ class ApiController extends Controller
return response()->json($resource, $respondCode);
}
/**
* Get the Controller Model Class name.
*
* @return string
*/
public function getModelClass(): string
{
$controllerClass = static::class;
$modelName = 'App\\Models\\' . Str::replaceLast('Controller', '', Str::afterLast($controllerClass, '\\'));
if (class_exists($modelName) === false) {
return $modelName;
}
return $modelName;
}
}

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

@@ -8,6 +8,8 @@ use App\Enum\HttpResponseCodes;
use App\Http\Requests\ArticleRequest;
use App\Models\Media;
use App\Models\Article;
use App\Models\Gallery;
use App\Traits\HasGallery;
use Illuminate\Http\JsonResponse;
use Carbon\Exceptions\InvalidFormatException;
use Illuminate\Contracts\Container\BindingResolutionException;
@@ -17,6 +19,9 @@ use Illuminate\Http\Request;
class ArticleController extends ApiController
{
use HasGallery;
/**
* ApplicationController constructor.
*/
@@ -73,14 +78,19 @@ class ArticleController extends ApiController
public function store(ArticleRequest $request)
{
if (ArticleConductor::creatable() === true) {
$article = Article::create($request->all());
$article = Article::create($request->except('gallery'));
if ($request->has('gallery') === true) {
$article->galleryAddMany($request->get('gallery'));
}
return $this->respondAsResource(
ArticleConductor::model($request, $article),
['respondCode' => HttpResponseCodes::HTTP_CREATED]
);
} else {
return $this->respondForbidden();
}
}//end if
}
/**
@@ -93,7 +103,12 @@ class ArticleController extends ApiController
public function update(ArticleRequest $request, Article $article)
{
if (ArticleConductor::updatable($article) === true) {
$article->update($request->all());
if ($request->has('gallery') === true) {
$article->gallery()->delete();
$article->galleryAddMany($request->get('gallery'));
}
$article->update($request->except('gallery'));
return $this->respondAsResource(ArticleConductor::model($request, $article));
}
@@ -122,11 +137,8 @@ class ArticleController extends ApiController
* @param Request $request The user request.
* @param Article $article The article model.
* @return JsonResponse Returns the article attachments.
* @throws InvalidFormatException
* @throws BindingResolutionException
* @throws InvalidCastException
*/
public function getAttachments(Request $request, Article $article): JsonResponse
public function attachmentIndex(Request $request, Article $article): JsonResponse
{
if (ArticleConductor::viewable($article) === true) {
$medium = $article->attachments->map(function ($attachment) {
@@ -145,13 +157,11 @@ class ArticleController extends ApiController
* @param Request $request The user request.
* @param Article $article The article model.
* @return JsonResponse The response.
* @throws BindingResolutionException
* @throws MassAssignmentException
*/
public function storeAttachment(Request $request, Article $article): JsonResponse
public function attachmentStore(Request $request, Article $article): JsonResponse
{
if (ArticleConductor::updatable($article) === true) {
if ($request->has("medium") && Media::find($request->medium)) {
if ($request->has("medium") === true && Media::find($request->medium) !== null) {
$article->attachments()->create(['media_id' => $request->medium]);
return $this->respondCreated();
}
@@ -167,10 +177,9 @@ class ArticleController extends ApiController
*
* @param Request $request The user request.
* @param Article $article The related model.
* @throws BindingResolutionException
* @throws MassAssignmentException
* @return JsonResponse
*/
public function updateAttachments(Request $request, Article $article): JsonResponse
public function attachmentUpdate(Request $request, Article $article): JsonResponse
{
if (ArticleConductor::updatable($article) === true) {
$mediaIds = $request->attachments;
@@ -183,7 +192,7 @@ class ArticleController extends ApiController
// Delete attachments that are not in $mediaIds
foreach ($attachments as $attachment) {
if (!in_array($attachment->media_id, $mediaIds)) {
if (in_array($attachment->media_id, $mediaIds) === false) {
$attachment->delete();
}
}
@@ -193,13 +202,13 @@ class ArticleController extends ApiController
$found = false;
foreach ($attachments as $attachment) {
if ($attachment->media_id == $mediaId) {
if ($attachment->media_id === $mediaId) {
$found = true;
break;
}
}
if (!$found) {
if ($found === false) {
$article->attachments()->create(['media_id' => $mediaId]);
}
}
@@ -215,9 +224,9 @@ class ArticleController extends ApiController
* @param Request $request The user request.
* @param Article $article The model.
* @param Media $medium The attachment medium.
* @throws BindingResolutionException
* @return JsonResponse
*/
public function deleteAttachment(Request $request, Article $article, Media $medium): JsonResponse
public function attachmentDelete(Request $request, Article $article, Media $medium): JsonResponse
{
if (ArticleConductor::updatable($article) === true) {
$attachments = $article->attachments;
@@ -231,7 +240,7 @@ class ArticleController extends ApiController
}
}
if ($deleted) {
if ($deleted === true) {
// Attachment was deleted successfully
return $this->respondNoContent();
} else {

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

@@ -117,7 +117,7 @@ class EventController extends ApiController
* @param Event $event The event model.
* @return JsonResponse Returns the event attachments.
*/
public function getAttachments(Request $request, Event $event): JsonResponse
public function attachmentIndex(Request $request, Event $event): JsonResponse
{
if (EventConductor::viewable($event) === true) {
$medium = $event->attachments->map(function ($attachment) {
@@ -137,7 +137,7 @@ class EventController extends ApiController
* @param Event $event The event model.
* @return JsonResponse The response.
*/
public function storeAttachment(Request $request, Event $event): JsonResponse
public function attachmentStore(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 Request $request The user request.
* @param Event $event The related model.
*/
public function updateAttachments(Request $request, Event $event): JsonResponse
public function attachmentUpdate(Request $request, Event $event): JsonResponse
{
if (EventConductor::updatable($event) === true) {
$mediaIds = $request->attachments;
@@ -204,7 +204,7 @@ class EventController extends ApiController
* @param Event $event The model.
* @param Media $medium The attachment medium.
*/
public function deleteAttachment(Request $request, Event $event, Media $medium): JsonResponse
public function attachmentDelete(Request $request, Event $event, Media $medium): JsonResponse
{
if (EventConductor::updatable($event) === true) {
$attachments = $event->attachments;

7
app/Models/Article.php
View File

@@ -2,15 +2,18 @@
namespace App\Models;
use App\Traits\HasGallery;
use App\Traits\Uuids;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\MorphMany;
class Article extends Model
{
use HasFactory;
use Uuids;
use HasGallery;
/**
* The attributes that are mass assignable.
@@ -29,6 +32,8 @@ class Article extends Model
/**
* Get the article user
*
* @return Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function user(): BelongsTo
{
@@ -37,6 +42,8 @@ class Article extends Model
/**
* Get all of the article's attachments.
*
* @return Illuminate\Database\Eloquent\Relations\MorphMany
*/
public function attachments(): MorphMany
{

45
app/Models/Gallery.php Normal file
View File

@@ -0,0 +1,45 @@
<?php
namespace App\Models;
use App\Traits\Uuids;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\MorphTo;
class Gallery extends Model
{
use HasFactory;
use Uuids;
/**
* The attributes that are mass assignable.
*
* @var array<int, string>
*/
protected $fillable = [
'media_id',
];
/**
* Get gallery addendum model.
*
* @return Illuminate\Database\Eloquent\Relations\MorphTo Addenum model.
*/
public function addendum(): MorphTo
{
return $this->morphTo();
}
/**
* Get the media for this item.
*
* @return Illuminate\Database\Eloquent\Relations\BelongsTo The media model.
*/
public function media(): BelongsTo
{
return $this->belongsTo(Media::class);
}
}

25
app/Providers/RouteServiceProvider.php
View File

@@ -61,28 +61,27 @@ class RouteServiceProvider extends ServiceProvider
Route::macro('apiAddendumResource', function ($addendum, $uri, $controller) {
$singularUri = Str::singular($uri);
$pluralAddendumLC = strtolower(Str::plural($addendum));
$pluralAddendumTC = ucfirst($pluralAddendumLC);
$singularAddendumTC = Str::singular($pluralAddendumTC);
$signularAddendum = Str::singular((strtolower($addendum)));
$pluralAddendum = Str::plural($signularAddendum);
Route::get("$uri/{{$singularUri}}/{{$pluralAddendumLC}}", [$controller, "get{{$pluralAddendumTC}}"])
->name("{{$singularUri}}.{{$pluralAddendumLC}}.index");
Route::get("{$uri}/{{$singularUri}}/{$pluralAddendum}", [$controller, "{$signularAddendum}Index"])
->name("{$singularUri}.{$signularAddendum}.index");
Route::post("$uri/{{$singularUri}}/{{$pluralAddendumLC}}", [$controller, "store{{$singularAddendumTC}}"])
->name("{{$singularUri}}.{{$pluralAddendumLC}}.store");
Route::post("{$uri}/{{$singularUri}}/{$pluralAddendum}", [$controller, "{$signularAddendum}Store"])
->name("{$singularUri}.{$signularAddendum}.store");
Route::match(
['put', 'patch'],
"$uri/{{$singularUri}}/{{$pluralAddendumLC}}",
[$controller, "update{{$pluralAddendumTC}}"]
"{$uri}/{{$singularUri}}/{$pluralAddendum}",
[$controller, "{$signularAddendum}Update"]
)
->name("{{$singularUri}}.{{$pluralAddendumLC}}.update");
->name("{$singularUri}.{$signularAddendum}.update");
Route::delete(
"$uri/{{$singularUri}}/{{$pluralAddendumLC}}/{medium}",
[$controller,"delete{{$singularAddendumTC}}"]
"{$uri}/{{$singularUri}}/{$pluralAddendum}/{medium}",
[$controller,"{$signularAddendum}Delete"]
)
->name("{{$singularUri}}.{{$pluralAddendumLC}}.destroy");
->name("{$singularUri}.{$signularAddendum}.destroy");
});
}
}

63
app/Traits/HasGallery.php Normal file
View File

@@ -0,0 +1,63 @@
<?php
namespace App\Traits;
use App\Models\Media;
use Illuminate\Database\Eloquent\Relations\MorphMany;
trait HasGallery
{
/**
* Boot function from Laravel.
*
* @return void
*/
protected static function bootHasGallery(): void
{
static::deleting(function ($model) {
$model->gallery()->delete();
});
}
/**
* Add multiple gallery items to the model.
*
* @param array|string $ids The media ids to add.
* @param string $delimiter The split delimiter if $ids is a string.
* @param boolean $allowDuplicates Whether to allow duplicate media IDs or not.
* @return void
*/
public function galleryAddMany(array|string $ids, string $delimiter = ',', bool $allowDuplicates = false): void
{
if (is_array($ids) === false) {
$ids = explode($delimiter, $ids);
}
$ids = array_map('trim', $ids);
$existingIds = $this->gallery()->pluck('media_id')->toArray();
$galleryItems = [];
foreach ($ids as $id) {
if ($allowDuplicates === false && in_array($id, $existingIds) === true) {
continue;
}
$media = Media::find($id);
if ($media !== null) {
$galleryItems[] = ['media_id' => $id];
}
}
$this->gallery()->createMany($galleryItems);
}
/**
* Get the article's gallery.
*
* @return Illuminate\Database\Eloquent\Relations\MorphMany The gallery items
*/
public function gallery(): MorphMany
{
return $this->morphMany(\App\Models\Gallery::class, 'addendum');
}
}