InnoFlash\LaraStart\Services\CRUDServices

Complexity

Total Complexity

25

Size/Duplication

Total Lines	186
Duplicated Lines	0 %

Importance

Changes	20
Bugs	2	Features	2

9 Methods

Rating	Name	Duplication	Size	Complexity
A	update()	0	12	4
A	getParentRelationship()	0	3	1
A	destroy()	0	12	3
A	create()	0	12	4
A	optimizeAttributes()	0	5	1
A	getParent()	0	20	4
A	createFromParent()	0	14	4
A	getModelClassName()	0	7	2
A	getServiceVariable()	0	8	2

<?php

namespace InnoFlash\LaraStart\Services;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;
use InnoFlash\LaraStart\Traits\APIResponses;
use InvalidArgumentException;

abstract class CRUDServices
{
    use APIResponses;

    /**
     * This sets the attributes to be removed from the given set for updating or creating.
     * @return array
     */
    abstract public function getUnsetFields(): array;

    /**
     * This gets the relationship of the given model to the parent.
     *
     * @return mixed
     */
    public function getParentRelationship()
    {
        throw new InvalidArgumentException('A relationship for these models is not set!');
    }

    /**
     * Deletes the model from the database.
     *
     * @param string $message
     *
     * @return
     */
    public function destroy(string $message = null)
    {
        try {
            $this->getServiceVariable()->delete();

            if (config('larastart.return_object')) {
                return '';
            }

            return $this->successResponse($message ?? $this->getModelClassName(true).' deleted successfully', [], 204);
        } catch (\Exception $e) {
            abort(500, $e->getMessage());
        }
    }

    /**
     *  Updates the model with the given filtered attributes.
     *
     * @param array $attributes
     * @param string $message
     * @param bool $returnObject
     *
     * @return \Illuminate\Http\JsonResponse|mixed
     */
    public function update(array $attributes, string $message = null, bool $returnObject = false)
    {
        try {
            $this->getServiceVariable()->update($this->optimizeAttributes($attributes));

            if ($returnObject || config('larastart.return_object')) {
                return $this->getServiceVariable()->refresh();
            }

            return $this->successResponse($message ?? $this->getModelClassName(true).' updated successfully');
        } catch (\Exception $e) {
            abort(500, $e->getMessage());
        }
    }

    /**
     * Creates a new model with the given filtered attributes.
     *
     * @param array $attributes
     * @param string $message
     * @param bool $returnObject
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function create(array $attributes, string $message = null, bool $returnObject = false)
    {
        try {
            $model = $this->getModelClassName()::create($this->optimizeAttributes($attributes));

            if ($returnObject || config('larastart.return_object')) {
                return $model;
            }

            return $this->successResponse($message ?? $this->getModelClassName(true).' created successfully', [], 201);
        } catch (\Exception $e) {
            abort(500, $e->getMessage());
        }
    }

    /**
     * Creates a new model from the given parent relationship.
     *
     * @param array $attributes
     * @param string $message
     * @param bool $returnObject
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function createFromParent(array $attributes, string $message = null, bool $returnObject = false)
    {
        $class = $this->getModelClassName();
        $model = new $class($this->optimizeAttributes($attributes));

        try {
            $this->getParent()->save($model);
            if ($returnObject || config('larastart.return_object')) {
                return $model;
            }

            return $this->successResponse($message ?? $this->getModelClassName(true).' created successfully', [], 201);
        } catch (\Exception $e) {
            abort(500, $e->getMessage());
        }
    }

    /**
     * This removes unwanted fields from the incoming create/update requests.
     *
     * @param array $attributes
     *
     * @return array
     */
    protected function optimizeAttributes(array $attributes)
    {
        return collect($attributes)
            ->except($this->getUnsetFields())
            ->toArray();
    }

    /**
     * Retrieves the parent to child relationship between this model and its parent.
     */
    private function getParent()
    {
        if (\is_object($this->getParentRelationship())) {
            return $this->getParentRelationship();
        }

        if (\is_array($this->getParentRelationship())) {
            [$class, $relationship, $parentIdRouteKey] = $this->getParentRelationship();

            $_class = new $class();
            $parent = $class::findOrFail(request($_class->getForeignKey()));

            if ($parentIdRouteKey) {
                $parent = $class::findOrFail(request($parentIdRouteKey));
            }

            return $parent->$relationship();
        }

        throw new InvalidArgumentException('You have set an invalid parent for this model');
    }

    /**
     * Return the class name of the service main model.
     *
     * Returns class base name if shortened.
     *
     * @param bool $shortened
     *
     * @return string
     */
    protected function getModelClassName(bool $shortened = false): string
    {
        if ($shortened) {
            return class_basename($this->getServiceVariable());
        }

        return get_class($this->getServiceVariable());
    }

    /**
     * Get the service variable.
     *
     * @return mixed
     */
    private function getServiceVariable()
    {
        return collect(get_object_vars($this))
            ->reject(fn($var) => ! ($var instanceof Model))
            ->filter(function ($var, $key) {
                return Str::contains('get'.Str::ucfirst($key), get_class_methods($this))
                    && Str::startsWith(Str::lower(class_basename($this)), $key);
            })->first();
    }
}