Files
librenms-librenms/app/Http/Controllers/PaginatedAjaxController.php
Tony Murray 74882e3950 Dashboard widget update (#9515)
Implemented in Laravel
Doesn't use legacy PHP session
Several widgets have new features and settings, for example:

- Multiple ports in one graph
- Maps settings are configurable and override system settings but default to system settings
- Graylog stream and/or device selection
- Much improved graph widget selection
- Many more

DO NOT DELETE THIS TEXT

#### Please note

> Please read this information carefully. You can run `./scripts/pre-commit.php` to check your code before submitting.

- [x] Have you followed our [code guidelines?](http://docs.librenms.org/Developing/Code-Guidelines/)

#### Testers

If you would like to test this pull request then please run: `./scripts/github-apply <pr_id>`, i.e `./scripts/github-apply 5926`
After you are done testing, you can remove the changes with `./scripts/github-remove`.  If there are schema changes, you can ask on discord how to revert.
2018-12-16 21:18:17 +00:00

127 lines
3.3 KiB
PHP

<?php
/**
* AjaxController.php
*
* -Description-
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @package LibreNMS
* @link http://librenms.org
* @copyright 2018 Tony Murray
* @author Tony Murray <murraytony@gmail.com>
*/
namespace App\Http\Controllers;
use Illuminate\Contracts\Pagination\Paginator;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Http\Request;
use Illuminate\Support\Collection;
abstract class PaginatedAjaxController extends Controller
{
/**
* Base rules for this controller.
*
* @return mixed
*/
abstract protected function baseRules();
/**
* Defines the base query for this resource
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Query\Builder
*/
abstract protected function baseQuery($request);
/**
* @param Paginator $paginator
* @return \Illuminate\Http\JsonResponse
*/
abstract protected function formatResponse($paginator);
/**
* Defines validation rules (will override base validation rules for select2 responses too)
*
* @return array
*/
protected function rules()
{
return [];
}
/**
* Defines search fields will be searched in order
*
* @param \Illuminate\Http\Request $request
* @return array
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function searchFields($request)
{
return [];
}
/**
* Format an item for display. Default is pass-through
*
* @param Model $model
* @return array|Collection|Model
*/
protected function formatItem($model)
{
return $model;
}
/**
* @param string
* @param Builder $query
* @param array $fields
* @return Builder
*/
protected function search($search, $query, $fields)
{
if ($search) {
$query->where(function ($query) use ($fields, $search) {
/** @var Builder $query */
foreach ($fields as $field) {
$query->orWhere($field, 'like', '%' . $search . '%');
}
});
}
return $query;
}
/**
* Validate the given request with the given rules.
*
* @param \Illuminate\Http\Request $request
* @param array $rules
* @param array $messages
* @param array $customAttributes
* @return void
*/
public function validate(Request $request, array $rules = [], array $messages = [], array $customAttributes = [])
{
$full_rules = array_replace($this->baseRules(), $rules);
parent::validate($request, $full_rules, $messages, $customAttributes);
}
}