Some minor fixes

1 files changed, 547 insertions, 547 deletions

diff --git a/main/app/sprinkles/core/src/Sprunje/Sprunje.php b/main/app/sprinkles/core/src/Sprunje/Sprunje.php
index ea066a3..b81d266 100644
--- a/main/app/sprinkles/core/src/Sprunje/Sprunje.php
+++ b/main/app/sprinkles/core/src/Sprunje/Sprunje.php
@@ -1,547 +1,547 @@
-<?php
-/**
- * UserFrosting (http://www.userfrosting.com)
- *
- * @link      https://github.com/userfrosting/UserFrosting
- * @license   https://github.com/userfrosting/UserFrosting/blob/master/licenses/UserFrosting.md (MIT License)
- */
-
-namespace UserFrosting\Sprinkle\Core\Sprunje;
-
-use Carbon\Carbon;
-use Illuminate\Database\Eloquent\Builder;
-use League\Csv\Writer;
-use Psr\Http\Message\ResponseInterface as Response;
-use UserFrosting\Sprinkle\Core\Facades\Debug;
-use UserFrosting\Sprinkle\Core\Util\ClassMapper;
-use UserFrosting\Support\Exception\BadRequestException;
-use Valitron\Validator;
-
-/**
- * Sprunje
- *
- * Implements a versatile API for sorting, filtering, and paginating an Eloquent query builder.
- *
- * @author Alex Weissman (https://alexanderweissman.com)
- */
-abstract class Sprunje
-{
-    /**
-     * @var UserFrosting\Sprinkle\Core\Util\ClassMapper
-     */
-    protected $classMapper;
-
-    /**
-     * Name of this Sprunje, used when generating output files.
-     *
-     * @var string
-     */
-    protected $name = '';
-
-    /**
-     * The base (unfiltered) query.
-     *
-     * @var \Illuminate\Database\Query\Builder|\Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Relations\Relation
-     */
-    protected $query;
-
-    /**
-     * Default HTTP request parameters
-     *
-     * @var array[string]
-     */
-    protected $options = [
-        'sorts' => [],
-        'filters' => [],
-        'lists' => [],
-        'size' => 'all',
-        'page' => NULL,
-        'format' => 'json'
-    ];
-
-    /**
-     * Fields to allow filtering upon.
-     *
-     * @var array[string]
-     */
-    protected $filterable = [];
-
-    /**
-     * Fields to allow listing (enumeration) upon.
-     *
-     * @var array[string]
-     */
-    protected $listable = [];
-
-    /**
-     * Fields to allow sorting upon.
-     *
-     * @var array[string]
-     */
-    protected $sortable = [];
-
-    /**
-     * List of fields to exclude when processing an "_all" filter.
-     *
-     * @var array[string]
-     */
-    protected $excludeForAll = [];
-
-    /**
-     * Separator to use when splitting filter values to treat them as ORs.
-     *
-     * @var string
-     */
-    protected $orSeparator = '||';
-
-    /**
-     * Array key for the total unfiltered object count.
-     *
-     * @var string
-     */
-    protected $countKey = 'count';
-
-    /**
-     * Array key for the filtered object count.
-     *
-     * @var string
-     */
-    protected $countFilteredKey = 'count_filtered';
-
-    /**
-     * Array key for the actual result set.
-     *
-     * @var string
-     */
-    protected $rowsKey = 'rows';
-
-    /**
-     * Array key for the list of enumerated columns and their enumerations.
-     *
-     * @var string
-     */
-    protected $listableKey = 'listable';
-
-    /**
-     * Constructor.
-     *
-     * @param ClassMapper $classMapper
-     * @param mixed[] $options
-     */
-    public function __construct(ClassMapper $classMapper, array $options) {
-        $this->classMapper = $classMapper;
-
-        // Validation on input data
-        $v = new Validator($options);
-        $v->rule('array', ['sorts', 'filters', 'lists']);
-        $v->rule('regex', 'sorts.*', '/asc|desc/i');
-        $v->rule('regex', 'size', '/all|[0-9]+/i');
-        $v->rule('integer', 'page');
-        $v->rule('regex', 'format', '/json|csv/i');
-
-        // translated rules
-        if (!$v->validate()) {
-            $e = new BadRequestException();
-            foreach ($v->errors() as $idx => $field) {
-                foreach ($field as $eidx => $error) {
-                    $e->addUserMessage($error);
-                }
-            }
-            throw $e;
-        }
-
-        $this->options = array_replace_recursive($this->options, $options);
-
-        $this->query = $this->baseQuery();
-
-        // Start a new query on any Model instances
-        if (is_a($this->baseQuery(), '\Illuminate\Database\Eloquent\Model')) {
-            $this->query = $this->baseQuery()->newQuery();
-        }
-    }
-
-    /**
-     * Extend the query by providing a callback.
-     *
-     * @param callable $callback A callback which accepts and returns a Builder instance.
-     * @return $this
-     */
-    public function extendQuery(callable $callback) {
-        $this->query = $callback($this->query);
-        return $this;
-    }
-
-    /**
-     * Execute the query and build the results, and append them in the appropriate format to the response.
-     *
-     * @param ResponseInterface $response
-     * @return ResponseInterface
-     */
-    public function toResponse(Response $response) {
-        $format = $this->options['format'];
-
-        if ($format == 'csv') {
-            $result = $this->getCsv();
-
-            // Prepare response
-            $settings = http_build_query($this->options);
-            $date = Carbon::now()->format('Ymd');
-            $response = $response->withAddedHeader('Content-Disposition', "attachment;filename=$date-{$this->name}-$settings.csv");
-            $response = $response->withAddedHeader('Content-Type', 'text/csv; charset=utf-8');
-            return $response->write($result);
-            // Default to JSON
-        } else {
-            $result = $this->getArray();
-            return $response->withJson($result, 200, JSON_PRETTY_PRINT);
-        }
-    }
-
-    /**
-     * Executes the sprunje query, applying all sorts, filters, and pagination.
-     *
-     * Returns an array containing `count` (the total number of rows, before filtering), `count_filtered` (the total number of rows after filtering),
-     * and `rows` (the filtered result set).
-     * @return mixed[]
-     */
-    public function getArray() {
-        list($count, $countFiltered, $rows) = $this->getModels();
-
-        // Return sprunjed results
-        return [
-            $this->countKey => $count,
-            $this->countFilteredKey => $countFiltered,
-            $this->rowsKey => $rows->values()->toArray(),
-            $this->listableKey => $this->getListable()
-        ];
-    }
-
-    /**
-     * Run the query and build a CSV object by flattening the resulting collection.  Ignores any pagination.
-     *
-     * @return SplTempFileObject
-     */
-    public function getCsv() {
-        $filteredQuery = clone $this->query;
-
-        // Apply filters
-        $this->applyFilters($filteredQuery);
-
-        // Apply sorts
-        $this->applySorts($filteredQuery);
-
-        $collection = collect($filteredQuery->get());
-
-        // Perform any additional transformations on the dataset
-        $this->applyTransformations($collection);
-
-        $csv = Writer::createFromFileObject(new \SplTempFileObject());
-
-        $columnNames = [];
-
-        // Flatten collection while simultaneously building the column names from the union of each element's keys
-        $collection->transform(function ($item, $key) use (&$columnNames) {
-            $item = array_dot($item->toArray());
-            foreach ($item as $itemKey => $itemValue) {
-                if (!in_array($itemKey, $columnNames)) {
-                    $columnNames[] = $itemKey;
-                }
-            }
-            return $item;
-        });
-
-        $csv->insertOne($columnNames);
-
-        // Insert the data as rows in the CSV document
-        $collection->each(function ($item) use ($csv, $columnNames) {
-            $row = [];
-            foreach ($columnNames as $itemKey) {
-                // Only add the value if it is set and not an array.  Laravel's array_dot sometimes creates empty child arrays :(
-                // See https://github.com/laravel/framework/pull/13009
-                if (isset($item[$itemKey]) && !is_array($item[$itemKey])) {
-                    $row[] = $item[$itemKey];
-                } else {
-                    $row[] = '';
-                }
-            }
-
-            $csv->insertOne($row);
-        });
-
-        return $csv;
-    }
-
-    /**
-     * Executes the sprunje query, applying all sorts, filters, and pagination.
-     *
-     * Returns the filtered, paginated result set and the counts.
-     * @return mixed[]
-     */
-    public function getModels() {
-        // Count unfiltered total
-        $count = $this->count($this->query);
-
-        // Clone the Query\Builder, Eloquent\Builder, or Relation
-        $filteredQuery = clone $this->query;
-
-        // Apply filters
-        $this->applyFilters($filteredQuery);
-
-        // Count filtered total
-        $countFiltered = $this->countFiltered($filteredQuery);
-
-        // Apply sorts
-        $this->applySorts($filteredQuery);
-
-        // Paginate
-        $this->applyPagination($filteredQuery);
-
-        $collection = collect($filteredQuery->get());
-
-        // Perform any additional transformations on the dataset
-        $this->applyTransformations($collection);
-
-        return [$count, $countFiltered, $collection];
-    }
-
-    /**
-     * Get lists of values for specified fields in 'lists' option, calling a custom lister callback when appropriate.
-     *
-     * @return array
-     */
-    public function getListable() {
-        $result = [];
-        foreach ($this->listable as $name) {
-
-            // Determine if a custom filter method has been defined
-            $methodName = 'list' . studly_case($name);
-
-            if (method_exists($this, $methodName)) {
-                $result[$name] = $this->$methodName();
-            } else {
-                $result[$name] = $this->getColumnValues($name);
-            }
-        }
-
-        return $result;
-    }
-
-    /**
-     * Get the underlying queriable object in its current state.
-     *
-     * @return Builder
-     */
-    public function getQuery() {
-        return $this->query;
-    }
-
-    /**
-     * Set the underlying QueryBuilder object.
-     *
-     * @param Builder $query
-     * @return $this
-     */
-    public function setQuery($query) {
-        $this->query = $query;
-        return $this;
-    }
-
-    /**
-     * Apply any filters from the options, calling a custom filter callback when appropriate.
-     *
-     * @param Builder $query
-     * @return $this
-     */
-    public function applyFilters($query) {
-        foreach ($this->options['filters'] as $name => $value) {
-            // Check that this filter is allowed
-            if (($name != '_all') && !in_array($name, $this->filterable)) {
-                $e = new BadRequestException();
-                $e->addUserMessage('VALIDATE.SPRUNJE.BAD_FILTER', ['name' => $name]);
-                throw $e;
-            }
-            // Since we want to match _all_ of the fields, we wrap the field callback in a 'where' callback
-            $query->where(function ($fieldQuery) use ($name, $value) {
-                $this->buildFilterQuery($fieldQuery, $name, $value);
-            });
-        }
-
-        return $this;
-    }
-
-    /**
-     * Apply any sorts from the options, calling a custom sorter callback when appropriate.
-     *
-     * @param Builder $query
-     * @return $this
-     */
-    public function applySorts($query) {
-        foreach ($this->options['sorts'] as $name => $direction) {
-            // Check that this sort is allowed
-            if (!in_array($name, $this->sortable)) {
-                $e = new BadRequestException();
-                $e->addUserMessage('VALIDATE.SPRUNJE.BAD_SORT', ['name' => $name]);
-                throw $e;
-            }
-
-            // Determine if a custom sort method has been defined
-            $methodName = 'sort' . studly_case($name);
-
-            if (method_exists($this, $methodName)) {
-                $this->$methodName($query, $direction);
-            } else {
-                $query->orderBy($name, $direction);
-            }
-        }
-
-        return $this;
-    }
-
-    /**
-     * Apply pagination based on the `page` and `size` options.
-     *
-     * @param Builder $query
-     * @return $this
-     */
-    public function applyPagination($query) {
-        if (
-            ($this->options['page'] !== NULL) &&
-            ($this->options['size'] !== NULL) &&
-            ($this->options['size'] != 'all')
-        ) {
-            $offset = $this->options['size'] * $this->options['page'];
-            $query->skip($offset)
-                ->take($this->options['size']);
-        }
-
-        return $this;
-    }
-
-    /**
-     * Match any filter in `filterable`.
-     *
-     * @param Builder $query
-     * @param mixed $value
-     * @return $this
-     */
-    protected function filterAll($query, $value) {
-        foreach ($this->filterable as $name) {
-            if (studly_case($name) != 'all' && !in_array($name, $this->excludeForAll)) {
-                // Since we want to match _any_ of the fields, we wrap the field callback in a 'orWhere' callback
-                $query->orWhere(function ($fieldQuery) use ($name, $value) {
-                    $this->buildFilterQuery($fieldQuery, $name, $value);
-                });
-            }
-        }
-
-        return $this;
-    }
-
-    /**
-     * Build the filter query for a single field.
-     *
-     * @param Builder $query
-     * @param string $name
-     * @param mixed $value
-     * @return $this
-     */
-    protected function buildFilterQuery($query, $name, $value) {
-        $methodName = 'filter' . studly_case($name);
-
-        // Determine if a custom filter method has been defined
-        if (method_exists($this, $methodName)) {
-            $this->$methodName($query, $value);
-        } else {
-            $this->buildFilterDefaultFieldQuery($query, $name, $value);
-        }
-
-        return $this;
-    }
-
-    /**
-     * Perform a 'like' query on a single field, separating the value string on the or separator and
-     * matching any of the supplied values.
-     *
-     * @param Builder $query
-     * @param string $name
-     * @param mixed $value
-     * @return $this
-     */
-    protected function buildFilterDefaultFieldQuery($query, $name, $value) {
-        // Default filter - split value on separator for OR queries
-        // and search by column name
-        $values = explode($this->orSeparator, $value);
-        foreach ($values as $value) {
-            $query->orLike($name, $value);
-        }
-
-        return $this;
-    }
-
-    /**
-     * Set any transformations you wish to apply to the collection, after the query is executed.
-     *
-     * @param \Illuminate\Database\Eloquent\Collection $collection
-     * @return \Illuminate\Database\Eloquent\Collection
-     */
-    protected function applyTransformations($collection) {
-        return $collection;
-    }
-
-    /**
-     * Set the initial query used by your Sprunje.
-     *
-     * @return Builder|Relation|Model
-     */
-    abstract protected function baseQuery();
-
-    /**
-     * Returns a list of distinct values for a specified column.
-     * Formats results to have a "value" and "text" attribute.
-     *
-     * @param string $column
-     * @return array
-     */
-    protected function getColumnValues($column) {
-        $rawValues = $this->query->select($column)->distinct()->orderBy($column, 'asc')->get();
-        $values = [];
-        foreach ($rawValues as $raw) {
-            $values[] = [
-                'value' => $raw[$column],
-                'text' => $raw[$column]
-            ];
-        }
-        return $values;
-    }
-
-    /**
-     * Get the unpaginated count of items (before filtering) in this query.
-     *
-     * @param Builder $query
-     * @return int
-     */
-    protected function count($query) {
-        return $query->count();
-    }
-
-    /**
-     * Get the unpaginated count of items (after filtering) in this query.
-     *
-     * @param Builder $query
-     * @return int
-     */
-    protected function countFiltered($query) {
-        return $query->count();
-    }
-
-    /**
-     * Executes the sprunje query, applying all sorts, filters, and pagination.
-     *
-     * Returns an array containing `count` (the total number of rows, before filtering), `count_filtered` (the total number of rows after filtering),
-     * and `rows` (the filtered result set).
-     * @deprecated since 4.1.7  Use getArray() instead.
-     * @return mixed[]
-     */
-    public function getResults() {
-        return $this->getArray();
-    }
-}
+<?php

+/**

+ * UserFrosting (http://www.userfrosting.com)

+ *

+ * @link      https://github.com/userfrosting/UserFrosting

+ * @license   https://github.com/userfrosting/UserFrosting/blob/master/licenses/UserFrosting.md (MIT License)

+ */

+

+namespace UserFrosting\Sprinkle\Core\Sprunje;

+

+use Carbon\Carbon;

+use Illuminate\Database\Eloquent\Builder;

+use League\Csv\Writer;

+use Psr\Http\Message\ResponseInterface as Response;

+use UserFrosting\Sprinkle\Core\Facades\Debug;

+use UserFrosting\Sprinkle\Core\Util\ClassMapper;

+use UserFrosting\Support\Exception\BadRequestException;

+use Valitron\Validator;

+

+/**

+ * Sprunje

+ *

+ * Implements a versatile API for sorting, filtering, and paginating an Eloquent query builder.

+ *

+ * @author Alex Weissman (https://alexanderweissman.com)

+ */

+abstract class Sprunje

+{

+    /**

+     * @var UserFrosting\Sprinkle\Core\Util\ClassMapper

+     */

+    protected $classMapper;

+

+    /**

+     * Name of this Sprunje, used when generating output files.

+     *

+     * @var string

+     */

+    protected $name = '';

+

+    /**

+     * The base (unfiltered) query.

+     *

+     * @var \Illuminate\Database\Query\Builder|\Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Relations\Relation

+     */

+    protected $query;

+

+    /**

+     * Default HTTP request parameters

+     *

+     * @var array[string]

+     */

+    protected $options = [

+        'sorts' => [],

+        'filters' => [],

+        'lists' => [],

+        'size' => 'all',

+        'page' => NULL,

+        'format' => 'json'

+    ];

+

+    /**

+     * Fields to allow filtering upon.

+     *

+     * @var array[string]

+     */

+    protected $filterable = [];

+

+    /**

+     * Fields to allow listing (enumeration) upon.

+     *

+     * @var array[string]

+     */

+    protected $listable = [];

+

+    /**

+     * Fields to allow sorting upon.

+     *

+     * @var array[string]

+     */

+    protected $sortable = [];

+

+    /**

+     * List of fields to exclude when processing an "_all" filter.

+     *

+     * @var array[string]

+     */

+    protected $excludeForAll = [];

+

+    /**

+     * Separator to use when splitting filter values to treat them as ORs.

+     *

+     * @var string

+     */

+    protected $orSeparator = '||';

+

+    /**

+     * Array key for the total unfiltered object count.

+     *

+     * @var string

+     */

+    protected $countKey = 'count';

+

+    /**

+     * Array key for the filtered object count.

+     *

+     * @var string

+     */

+    protected $countFilteredKey = 'count_filtered';

+

+    /**

+     * Array key for the actual result set.

+     *

+     * @var string

+     */

+    protected $rowsKey = 'rows';

+

+    /**

+     * Array key for the list of enumerated columns and their enumerations.

+     *

+     * @var string

+     */

+    protected $listableKey = 'listable';

+

+    /**

+     * Constructor.

+     *

+     * @param ClassMapper $classMapper

+     * @param mixed[] $options

+     */

+    public function __construct(ClassMapper $classMapper, array $options) {

+        $this->classMapper = $classMapper;

+

+        // Validation on input data

+        $v = new Validator($options);

+        $v->rule('array', ['sorts', 'filters', 'lists']);

+        $v->rule('regex', 'sorts.*', '/asc|desc/i');

+        $v->rule('regex', 'size', '/all|[0-9]+/i');

+        $v->rule('integer', 'page');

+        $v->rule('regex', 'format', '/json|csv/i');

+

+        // translated rules

+        if (!$v->validate()) {

+            $e = new BadRequestException();

+            foreach ($v->errors() as $idx => $field) {

+                foreach ($field as $eidx => $error) {

+                    $e->addUserMessage($error);

+                }

+            }

+            throw $e;

+        }

+

+        $this->options = array_replace_recursive($this->options, $options);

+

+        $this->query = $this->baseQuery();

+

+        // Start a new query on any Model instances

+        if (is_a($this->baseQuery(), '\Illuminate\Database\Eloquent\Model')) {

+            $this->query = $this->baseQuery()->newQuery();

+        }

+    }

+

+    /**

+     * Extend the query by providing a callback.

+     *

+     * @param callable $callback A callback which accepts and returns a Builder instance.

+     * @return $this

+     */

+    public function extendQuery(callable $callback) {

+        $this->query = $callback($this->query);

+        return $this;

+    }

+

+    /**

+     * Execute the query and build the results, and append them in the appropriate format to the response.

+     *

+     * @param ResponseInterface $response

+     * @return ResponseInterface

+     */

+    public function toResponse(Response $response) {

+        $format = $this->options['format'];

+

+        if ($format == 'csv') {

+            $result = $this->getCsv();

+

+            // Prepare response

+            $settings = http_build_query($this->options);

+            $date = Carbon::now()->format('Ymd');

+            $response = $response->withAddedHeader('Content-Disposition', "attachment;filename=$date-{$this->name}-$settings.csv");

+            $response = $response->withAddedHeader('Content-Type', 'text/csv; charset=utf-8');

+            return $response->write($result);

+            // Default to JSON

+        } else {

+            $result = $this->getArray();

+            return $response->withJson($result, 200, JSON_PRETTY_PRINT);

+        }

+    }

+

+    /**

+     * Executes the sprunje query, applying all sorts, filters, and pagination.

+     *

+     * Returns an array containing `count` (the total number of rows, before filtering), `count_filtered` (the total number of rows after filtering),

+     * and `rows` (the filtered result set).

+     * @return mixed[]

+     */

+    public function getArray() {

+        list($count, $countFiltered, $rows) = $this->getModels();

+

+        // Return sprunjed results

+        return [

+            $this->countKey => $count,

+            $this->countFilteredKey => $countFiltered,

+            $this->rowsKey => $rows->values()->toArray(),

+            $this->listableKey => $this->getListable()

+        ];

+    }

+

+    /**

+     * Run the query and build a CSV object by flattening the resulting collection.  Ignores any pagination.

+     *

+     * @return SplTempFileObject

+     */

+    public function getCsv() {

+        $filteredQuery = clone $this->query;

+

+        // Apply filters

+        $this->applyFilters($filteredQuery);

+

+        // Apply sorts

+        $this->applySorts($filteredQuery);

+

+        $collection = collect($filteredQuery->get());

+

+        // Perform any additional transformations on the dataset

+        $this->applyTransformations($collection);

+

+        $csv = Writer::createFromFileObject(new \SplTempFileObject());

+

+        $columnNames = [];

+

+        // Flatten collection while simultaneously building the column names from the union of each element's keys

+        $collection->transform(function ($item, $key) use (&$columnNames) {

+            $item = array_dot($item->toArray());

+            foreach ($item as $itemKey => $itemValue) {

+                if (!in_array($itemKey, $columnNames)) {

+                    $columnNames[] = $itemKey;

+                }

+            }

+            return $item;

+        });

+

+        $csv->insertOne($columnNames);

+

+        // Insert the data as rows in the CSV document

+        $collection->each(function ($item) use ($csv, $columnNames) {

+            $row = [];

+            foreach ($columnNames as $itemKey) {

+                // Only add the value if it is set and not an array.  Laravel's array_dot sometimes creates empty child arrays :(

+                // See https://github.com/laravel/framework/pull/13009

+                if (isset($item[$itemKey]) && !is_array($item[$itemKey])) {

+                    $row[] = $item[$itemKey];

+                } else {

+                    $row[] = '';

+                }

+            }

+

+            $csv->insertOne($row);

+        });

+

+        return $csv;

+    }

+

+    /**

+     * Executes the sprunje query, applying all sorts, filters, and pagination.

+     *

+     * Returns the filtered, paginated result set and the counts.

+     * @return mixed[]

+     */

+    public function getModels() {

+        // Count unfiltered total

+        $count = $this->count($this->query);

+

+        // Clone the Query\Builder, Eloquent\Builder, or Relation

+        $filteredQuery = clone $this->query;

+

+        // Apply filters

+        $this->applyFilters($filteredQuery);

+

+        // Count filtered total

+        $countFiltered = $this->countFiltered($filteredQuery);

+

+        // Apply sorts

+        $this->applySorts($filteredQuery);

+

+        // Paginate

+        $this->applyPagination($filteredQuery);

+

+        $collection = collect($filteredQuery->get());

+

+        // Perform any additional transformations on the dataset

+        $this->applyTransformations($collection);

+

+        return [$count, $countFiltered, $collection];

+    }

+

+    /**

+     * Get lists of values for specified fields in 'lists' option, calling a custom lister callback when appropriate.

+     *

+     * @return array

+     */

+    public function getListable() {

+        $result = [];

+        foreach ($this->listable as $name) {

+

+            // Determine if a custom filter method has been defined

+            $methodName = 'list' . studly_case($name);

+

+            if (method_exists($this, $methodName)) {

+                $result[$name] = $this->$methodName();

+            } else {

+                $result[$name] = $this->getColumnValues($name);

+            }

+        }

+

+        return $result;

+    }

+

+    /**

+     * Get the underlying queriable object in its current state.

+     *

+     * @return Builder

+     */

+    public function getQuery() {

+        return $this->query;

+    }

+

+    /**

+     * Set the underlying QueryBuilder object.

+     *

+     * @param Builder $query

+     * @return $this

+     */

+    public function setQuery($query) {

+        $this->query = $query;

+        return $this;

+    }

+

+    /**

+     * Apply any filters from the options, calling a custom filter callback when appropriate.

+     *

+     * @param Builder $query

+     * @return $this

+     */

+    public function applyFilters($query) {

+        foreach ($this->options['filters'] as $name => $value) {

+            // Check that this filter is allowed

+            if (($name != '_all') && !in_array($name, $this->filterable)) {

+                $e = new BadRequestException();

+                $e->addUserMessage('VALIDATE.SPRUNJE.BAD_FILTER', ['name' => $name]);

+                throw $e;

+            }

+            // Since we want to match _all_ of the fields, we wrap the field callback in a 'where' callback

+            $query->where(function ($fieldQuery) use ($name, $value) {

+                $this->buildFilterQuery($fieldQuery, $name, $value);

+            });

+        }

+

+        return $this;

+    }

+

+    /**

+     * Apply any sorts from the options, calling a custom sorter callback when appropriate.

+     *

+     * @param Builder $query

+     * @return $this

+     */

+    public function applySorts($query) {

+        foreach ($this->options['sorts'] as $name => $direction) {

+            // Check that this sort is allowed

+            if (!in_array($name, $this->sortable)) {

+                $e = new BadRequestException();

+                $e->addUserMessage('VALIDATE.SPRUNJE.BAD_SORT', ['name' => $name]);

+                throw $e;

+            }

+

+            // Determine if a custom sort method has been defined

+            $methodName = 'sort' . studly_case($name);

+

+            if (method_exists($this, $methodName)) {

+                $this->$methodName($query, $direction);

+            } else {

+                $query->orderBy($name, $direction);

+            }

+        }

+

+        return $this;

+    }

+

+    /**

+     * Apply pagination based on the `page` and `size` options.

+     *

+     * @param Builder $query

+     * @return $this

+     */

+    public function applyPagination($query) {

+        if (

+            ($this->options['page'] !== NULL) &&

+            ($this->options['size'] !== NULL) &&

+            ($this->options['size'] != 'all')

+        ) {

+            $offset = $this->options['size'] * $this->options['page'];

+            $query->skip($offset)

+                ->take($this->options['size']);

+        }

+

+        return $this;

+    }

+

+    /**

+     * Match any filter in `filterable`.

+     *

+     * @param Builder $query

+     * @param mixed $value

+     * @return $this

+     */

+    protected function filterAll($query, $value) {

+        foreach ($this->filterable as $name) {

+            if (studly_case($name) != 'all' && !in_array($name, $this->excludeForAll)) {

+                // Since we want to match _any_ of the fields, we wrap the field callback in a 'orWhere' callback

+                $query->orWhere(function ($fieldQuery) use ($name, $value) {

+                    $this->buildFilterQuery($fieldQuery, $name, $value);

+                });

+            }

+        }

+

+        return $this;

+    }

+

+    /**

+     * Build the filter query for a single field.

+     *

+     * @param Builder $query

+     * @param string $name

+     * @param mixed $value

+     * @return $this

+     */

+    protected function buildFilterQuery($query, $name, $value) {

+        $methodName = 'filter' . studly_case($name);

+

+        // Determine if a custom filter method has been defined

+        if (method_exists($this, $methodName)) {

+            $this->$methodName($query, $value);

+        } else {

+            $this->buildFilterDefaultFieldQuery($query, $name, $value);

+        }

+

+        return $this;

+    }

+

+    /**

+     * Perform a 'like' query on a single field, separating the value string on the or separator and

+     * matching any of the supplied values.

+     *

+     * @param Builder $query

+     * @param string $name

+     * @param mixed $value

+     * @return $this

+     */

+    protected function buildFilterDefaultFieldQuery($query, $name, $value) {

+        // Default filter - split value on separator for OR queries

+        // and search by column name

+        $values = explode($this->orSeparator, $value);

+        foreach ($values as $value) {

+            $query->orLike($name, $value);

+        }

+

+        return $this;

+    }

+

+    /**

+     * Set any transformations you wish to apply to the collection, after the query is executed.

+     *

+     * @param \Illuminate\Database\Eloquent\Collection $collection

+     * @return \Illuminate\Database\Eloquent\Collection

+     */

+    protected function applyTransformations($collection) {

+        return $collection;

+    }

+

+    /**

+     * Set the initial query used by your Sprunje.

+     *

+     * @return Builder|Relation|Model

+     */

+    abstract protected function baseQuery();

+

+    /**

+     * Returns a list of distinct values for a specified column.

+     * Formats results to have a "value" and "text" attribute.

+     *

+     * @param string $column

+     * @return array

+     */

+    protected function getColumnValues($column) {

+        $rawValues = $this->query->select($column)->distinct()->orderBy($column, 'asc')->get();

+        $values = [];

+        foreach ($rawValues as $raw) {

+            $values[] = [

+                'value' => $raw[$column],

+                'text' => $raw[$column]

+            ];

+        }

+        return $values;

+    }

+

+    /**

+     * Get the unpaginated count of items (before filtering) in this query.

+     *

+     * @param Builder $query

+     * @return int

+     */

+    protected function count($query) {

+        return $query->count();

+    }

+

+    /**

+     * Get the unpaginated count of items (after filtering) in this query.

+     *

+     * @param Builder $query

+     * @return int

+     */

+    protected function countFiltered($query) {

+        return $query->count();

+    }

+

+    /**

+     * Executes the sprunje query, applying all sorts, filters, and pagination.

+     *

+     * Returns an array containing `count` (the total number of rows, before filtering), `count_filtered` (the total number of rows after filtering),

+     * and `rows` (the filtered result set).

+     * @deprecated since 4.1.7  Use getArray() instead.

+     * @return mixed[]

+     */

+    public function getResults() {

+        return $this->getArray();

+    }

+}