initial version of package

Author: secmohammed

.DS_Store

@@ -0,0 +1,34 @@
+{
+    "name": "sectheater/laravel-datatables",
+    "description": "Modern Laravel Datatable",
+    "keywords" : ["Laravel Datatable", "Datatables", "Datatables Vue", "Datatables React"],
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Mohammed Osama",
+            "email": "[email protected]"
+        }, 
+        {
+            "name": "Mohammed Zayed",
+            "email": "[email protected]"
+        },
+    ],
+    "minimum-stability": "dev",
+    "require": {},
+    "autoload": {
+         "psr-4": {
+            "Laravel\\DataTables\\" : "src/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Laravel\\DataTables\\LaravelDataTablesServiceProvider"
+            ]
+        }
+    }
+
+
+
+}

composer.json

@@ -0,0 +1,13 @@
+<?php
+
+namespace Laravel\DataTables\Commands;
+
+use Illuminate\Console\Command;
+
+class RegisterServiceDataTableCommand extends Command
+{
+    public function handle()
+    {
+
+    }
+}

src/Commands/RegisterServiceDataTableCommand.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Laravel\DataTables\Contracts;
+
+interface Displayable
+{
+    public function getCustomColumnNames();
+
+    public function getDisplayableColumns();
+
+    public function getUpdatableColumns();
+}

src/Contracts/Displayable.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Laravel\DataTables\Exceptions;
+
+use Exception;
+
+class EloquentBuilderWasSetToNullException extends Exception
+{
+    /**
+     * @var string
+     */
+    public $message = 'You have set your Eloquent query builder to null, perhaps you forgot to return the builder at your callback.';
+}

src/Exceptions/EloquentBuilderWasSetToNullException.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Laravel\DataTables;
+
+use Illuminate\Support\ServiceProvider;
+
+class LaravelDataTablesServiceProvider extends ServiceProvider
+{
+    //TODO: ask the user for the preset (react/vue/angular)
+    public function register()
+    {
+        if ($this->app->runningInConsole()) {
+            $this->registerConsoleCommands();
+        }
+        $this->registerPublishables();
+    }
+
+    public function registerPublishables()
+    {
+        $publishablePath = __DIR__ . '/publishable';
+        $this->publishes([
+            $publishablePath . '/js' => resource_path('js/laravel-datatables/components'),
+        ], 'datatable');
+    }
+
+    protected function registerConsoleCommands()
+    {
+        $this->commands(\Laravel\DataTables\Commands\RegisterServiceDataTableCommand::class);
+    }
+}

src/LaravelDataTablesServiceProvider.php

@@ -0,0 +1,240 @@
+<?php
+namespace Laravel\Datatables\Services;
+
+use Arr;
+use Schema;
+use Illuminate\Http\Request;
+use Illuminate\Database\QueryException;
+use Illuminate\Support\Traits\Macroable;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Collection;
+use Laravel\DataTables\Contracts\Displayable;
+use Laravel\DataTables\Exceptions\EloquentBuilderWasSetToNullException;
+
+abstract class BaseDatatableService implements Displayable
+{
+    use Macroable;
+
+    /**
+     * @var Builder
+     */
+    public $builder;
+
+    /**
+     * load the relationships associated with the collection that will be returned.
+     * @var array
+     */
+    public $relations;
+
+    /**
+     * get/set the eloquent builder
+     * @return Builder
+     */
+    public function builder(): Builder
+    {
+        /**
+         * @var mixed
+         */
+        static $builder = null;
+
+        if (!is_null($builder)) {
+            return $builder;
+        }
+        $builder = $this->query();
+
+        return $builder;
+    }
+
+    public function filename()
+    {
+        return vsprintf('%name_%date', [
+            'name' => ucfirst($this->getTable()),
+            'date' => date('Y-m-d H:i:s'),
+        ]);
+    }
+
+    /**
+     * @param $columns
+     */
+    public function getColumnsWithoutPrimaryKey($columns)
+    {
+        $primaryKey = $this->builder()->getModel()->getKeyName();
+
+        return array_filter($columns, fn($column) => $primaryKey !== $column);
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getCustomColumnNames(): array
+    {
+        if (method_exists($this->builder()->getModel(), 'getCustomColumnNames')) {
+            return $this->builder()->getModel()->getCustomColumnNames();
+        }
+
+        return [
+
+        ];
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getDisplayableColumns(): array
+    {
+        if (method_exists($this->builder()->getModel(), 'getDisplayableColumns')) {
+            return array_values($this->builder()->getModel()->getDisplayableColumns());
+        }
+
+        return array_values(
+            array_diff(
+                $this->getDatabaseColumnNames(),
+                $this->builder()->getModel()->getHidden()
+            )
+        );
+    }
+
+    /**
+     * @return Collection
+     */
+
+    //
+    public function getRecords(Request $request = null, callable $callback = null): Collection
+    {
+        $builder = $this->builder();
+        // we will check if the request has a query string for search. the query string for searching must contain column, operator which identified at resolveQueryParts method in form of the keys of the array. and the value that user is trying to search for
+        // example: http://localhost:8000/api/posts?column=title&operator=contains&value=hello
+        if ($request && $this->hasSearchQuery($request)) {
+            $builder = $this->buildSearchQuery($builder, $request);
+        }
+        // Turn on the flexibility for the programmer to apply his own query to chain on the current query then we will retrieve back the query builder after the programmer applies his logic and proceed our own queries.
+        if ($callback) {
+            $builder = $callback($builder);
+            throw_unless($builder, new EloquentBuilderWasSetToNullException);
+        }
+        // we will try to parse the query and return the output of it, if anything goes wrong, by default we will be returning an empty collection.
+        try {
+            return $builder->select(...$this->getSelectableColumns())->limit($request->limit)->get($this->getDisplayableColumns());
+        } catch (QueryException $e) {
+            return collect([]);
+        }
+    }
+
+    /**
+     * @return array
+     */
+    public function getSelectableColumns(): array
+    {
+        return $this->getDatabaseColumnNames();
+    }
+
+    /**
+     * @return string
+     */
+    public function getTable(): string
+    {
+        return $this->builder()->getModel()->getTable();
+    }
+
+    /**
+     * get the columns that user can see at the frontend to update.
+     * @return array
+     */
+    public function getUpdatableColumns(): array
+    {
+        if (method_exists($this->builder()->getModel(), 'getUpdatableColumns')) {
+            return array_values($this->getColumnsWithoutPrimaryKey($this->builder()->getModel()->getUpdatableColumns()));
+        }
+
+        return array_values($this->getColumnsWithoutPrimaryKey($this->getDisplayableColumns()));
+    }
+
+    abstract public function query(): Builder;
+
+    /**
+     * return the response skeleton.
+     * @return array
+     */
+    public function response(callable $callback = null): array
+    {
+
+        return [
+            'table' => $this->getTable(),
+            'displayable' => $this->getDisplayableColumns(),
+            'records' => $this->getRecords(request(), $callback)->load((array) $this->relations),
+            'updatable' => $this->getUpdatableColumns(),
+            'custom_columns' => $this->getCustomColumnNames(),
+            'allow' => [
+                'creatable' => $this->allowCreating ?? false,
+                'deletable' => $this->allowDeleting ?? false,
+                'updatable' => $this->allowUpdating ?? false,
+            ],
+        ];
+    }
+
+    /**
+     * @param Builder $builder
+     */
+    protected function buildSearchQuery(Builder $builder, Request $request): Builder
+    {
+        ['operator' => $operator, 'value' => $value] = $this->resolveQueryParts($request->operator, $request->value);
+
+        return $builder->where($request->column, $operator, $value);
+    }
+
+    /**
+     * [getDatabaseColumnNames]
+     * @return array
+     */
+    protected function getDatabaseColumnNames(): array
+    {
+        return Schema::getColumnListing($this->getTable());
+    }
+
+    /**
+     * @param $request
+     * @return int
+     */
+    protected function hasSearchQuery(Request $request): bool
+    {
+        return count(array_filter($request->only(['column', 'operator', 'value']))) === 3;
+    }
+
+    /**
+     * @param $operator
+     * @param $value
+     * @return array
+     */
+    protected function resolveQueryParts($operator, $value)
+    {
+        return Arr::get([
+            'equals' => [
+                'operator' => '=',
+                'value' => $value,
+            ],
+            'contains' => [
+                'operator' => 'LIKE',
+                'value' => "%{$value}%",
+            ],
+            'starts_with' => [
+                'operator' => 'LIKE',
+                'value' => "{$value}%",
+            ],
+            'ends_with' => [
+                'operator' => 'LIKE',
+                'value' => "%{$value}",
+
+            ],
+            'greater_than' => [
+                'operator' => '>',
+                'value' => $value,
+
+            ],
+            'less_than' => [
+                'operator' => '<',
+                'value' => $value,
+
+            ],
+        ], $operator);
+    }
+}

src/Services/BaseDataTableService.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Laravel\DataTables\Traits;
+
+use Arr;
+use Illuminate\Database\Eloquent\Model;
+trait Creatable
+{
+    /**
+     * @var mixed
+     */
+    public $allowCreation = false;
+
+    /**
+     * @param array $data
+     * @return mixed
+     */
+    public function create(array $data):  ? Model
+    {
+        if (!$this->allowCreation) {
+            return null;
+        }
+
+        return $this->builder()->create(
+            Arr::only(
+                $data,
+                $this->getUpdatableColumns()
+            )
+        );
+    }
+}