Backpack\CRUD\app\Http\Controllers\Operations\FetchOperation

Complexity

Total Complexity

15

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	setupFetchOperationRoutes()	0	11	3
C	fetch()	0	51	12

<?php

namespace Backpack\CRUD\app\Http\Controllers\Operations;

use Illuminate\Support\Facades\Route;
use Illuminate\Support\Str;

trait FetchOperation
{
    /**
     * Define which routes are needed for this operation.
     *
     * @param string $segment    Name of the current entity (singular). Used as first URL segment.
     * @param string $routeName  Prefix of the route name.
     * @param string $controller Name of the current CrudController.
     */
    protected function setupFetchOperationRoutes($segment, $routeName, $controller)
    {
        // get all method names on the current model that start with "fetch" (ex: fetchCategory)
        // if a method that looks like that is present, it means we need to add the routes that fetch that entity
        preg_match_all('/(?<=^|;)fetch([^;]+?)(;|$)/', implode(';', get_class_methods($this)), $matches);

        if (count($matches[1])) {
            foreach ($matches[1] as $methodName) {
                Route::post($segment.'/fetch/'.Str::kebab($methodName), [
                    'uses'      => $controller.'@fetch'.$methodName,
                    'operation' => 'FetchOperation',
                ]);
            }
        }
    }

    /**
     * Gets items from database and returns to selects.
     *
     * @param string|array $arg
     * @return void
     */
    private function fetch($arg)
    {
        // get the actual words that were used to search for an item (the search term / search string)
        $search_string = request()->input('q') ?? false;

        // if the Class was passed as the sole argument, use that as the configured Model
        // otherwise assume the arguments are actually the configuration array
        $config = [];

        if (! is_array($arg)) {
            if (! class_exists($arg)) {
                return response()->json(['error' => 'Class: '.$arg.' does not exists'], 500);

The expression return response()->json(array('error' => 'Class: ' . $arg . ' does not exists'), 500) returns the type Illuminate\Http\JsonResponse which is incompatible with the documented return type void.

            }
            $config['model'] = $arg;
        } else {
            $config = $arg;
        }

        $model_instance = new $config['model'];
        // set configuration defaults
        $config['paginate'] = isset($config['paginate']) ? $config['paginate'] : 10;
        $config['searchable_attributes'] = $config['searchable_attributes'] ?? $model_instance->identifiableAttribute();
        $config['query'] = isset($config['query']) && is_callable($config['query']) ? $config['query']($config['model']) : $model_instance; // if a closure that has been passed as "query", use the closure - otherwise use the model

        // FetchOperation sends an empty query to retrieve the default entry for select when field is not nullable.
        // Also sends an empty query in case we want to load all entities to emulate non-ajax fields
        // when using InlineCreate.

        if ($search_string === false) {
            return ($config['paginate'] !== false) ?
            $config['query']->paginate($config['paginate']) :
            $config['query']->get();
        }

        $textColumnTypes = ['string', 'json_string', 'text'];
        // for each searchable attribute, add a WHERE clause
        foreach ((array) $config['searchable_attributes'] as $k => $searchColumn) {
            $operation = ($k == 0) ? 'where' : 'orWhere';
            $columnType = $config['query']->getColumnType($searchColumn);

            if (in_array($columnType, $textColumnTypes)) {
                $config['query'] = $config['query']->{$operation}($searchColumn, 'LIKE', '%'.$search_string.'%');
            } else {
                $config['query'] = $config['query']->{$operation}($searchColumn, $search_string);
            }
        }

        // return the results with or without pagination
        return ($config['paginate'] !== false) ?
                    $config['query']->paginate($config['paginate']) :
                    $config['query']->get();
    }
}