Addition of repository to ease testing and maintainability
This commit is contained in:
Dane Everitt
parent
2f4ec64f2a
commit
5c3dc60d1e
22 changed files with 617 additions and 853 deletions
150
app/Repositories/Eloquent/EloquentRepository.php
Normal file
150
app/Repositories/Eloquent/EloquentRepository.php
Normal file
|
|
@ -0,0 +1,150 @@
|
|||
<?php
|
||||
/*
|
||||
* Pterodactyl - Panel
|
||||
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
* of this software and associated documentation files (the "Software"), to deal
|
||||
* in the Software without restriction, including without limitation the rights
|
||||
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
* copies of the Software, and to permit persons to whom the Software is
|
||||
* furnished to do so, subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
* SOFTWARE.
|
||||
*/
|
||||
|
||||
namespace Pterodactyl\Repositories\Eloquent;
|
||||
|
||||
use Pterodactyl\Exceptions\Model\DataValidationException;
|
||||
use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
|
||||
use Pterodactyl\Repository\Repository;
|
||||
use Pterodactyl\Contracts\Repository\RepositoryInterface;
|
||||
|
||||
abstract class EloquentRepository extends Repository implements RepositoryInterface
|
||||
{
|
||||
/**
|
||||
* @return \Illuminate\Database\Eloquent\Builder
|
||||
*/
|
||||
public function getBuilder()
|
||||
{
|
||||
return $this->getModel()->newQuery();
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new model instance and persist it to the database.
|
||||
* @param array $fields
|
||||
* @param bool $validate
|
||||
* @param bool $force
|
||||
* @return bool|\Illuminate\Database\Eloquent\Model
|
||||
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||
*/
|
||||
public function create($fields, $validate = true, $force = false)
|
||||
{
|
||||
$instance = $this->getBuilder()->newModelInstance();
|
||||
|
||||
if ($force) {
|
||||
$instance->forceFill($fields);
|
||||
} else {
|
||||
$instance->fill($fields);
|
||||
}
|
||||
|
||||
if (! $validate) {
|
||||
$saved = $instance->skipValidation()->save();
|
||||
} else {
|
||||
if (! $saved = $instance->save()) {
|
||||
throw new DataValidationException($instance->getValidator());
|
||||
}
|
||||
}
|
||||
|
||||
return ($this->withFresh) ? $instance->fresh() : $saved;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a record from the database for a given ID.
|
||||
*
|
||||
* @param int $id
|
||||
* @return \Illuminate\Database\Eloquent\Builder|\Illuminate\Database\Eloquent\Model
|
||||
*
|
||||
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||
*/
|
||||
public function find($id)
|
||||
{
|
||||
$instance = $this->getBuilder()->find($id, $this->getColumns());
|
||||
|
||||
if (! $instance) {
|
||||
throw new RecordNotFoundException();
|
||||
}
|
||||
|
||||
return $instance;
|
||||
}
|
||||
|
||||
public function findWhere($fields)
|
||||
{
|
||||
// TODO: Implement findWhere() method.
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a record from the DB given an ID.
|
||||
*
|
||||
* @param int $id
|
||||
* @param bool $destroy
|
||||
* @return bool|null
|
||||
*/
|
||||
public function delete($id, $destroy = false)
|
||||
{
|
||||
if ($destroy) {
|
||||
return $this->getBuilder()->where($this->getModel()->getKeyName(), $id)->forceDelete();
|
||||
}
|
||||
|
||||
return $this->getBuilder()->where($this->getModel()->getKeyName(), $id)->delete();
|
||||
}
|
||||
|
||||
/**
|
||||
* @param int $id
|
||||
* @param array $fields
|
||||
* @param bool $validate
|
||||
* @param bool $force
|
||||
* @return mixed
|
||||
*
|
||||
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||
*/
|
||||
public function update($id, $fields, $validate = true, $force = false)
|
||||
{
|
||||
$instance = $this->getBuilder()->where('id', $id)->first();
|
||||
|
||||
if (! $instance) {
|
||||
throw new RecordNotFoundException();
|
||||
}
|
||||
|
||||
if ($force) {
|
||||
$instance->forceFill($fields);
|
||||
} else {
|
||||
$instance->fill($fields);
|
||||
}
|
||||
|
||||
if (! $validate) {
|
||||
$saved = $instance->skipValidation()->save();
|
||||
} else {
|
||||
if (! $saved = $instance->save()) {
|
||||
throw new DataValidationException($instance->getValidator());
|
||||
}
|
||||
}
|
||||
|
||||
return ($this->withFresh) ? $instance->fresh($this->getColumns()) : $saved;
|
||||
}
|
||||
|
||||
public function massUpdate($fields)
|
||||
{
|
||||
// TODO: Implement massUpdate() method.
|
||||
}
|
||||
}
|
||||
|
|
@ -24,52 +24,85 @@
|
|||
|
||||
namespace Pterodactyl\Repositories\Eloquent;
|
||||
|
||||
use Pterodactyl\Models\User;
|
||||
use Illuminate\Contracts\Auth\Guard;
|
||||
use Pterodactyl\Repositories\Repository;
|
||||
use Illuminate\Contracts\Config\Repository as ConfigRepository;
|
||||
use Illuminate\Foundation\Application;
|
||||
use Pterodactyl\Contracts\Repository\UserRepositoryInterface;
|
||||
use Pterodactyl\Exceptions\DisplayException;
|
||||
use Pterodactyl\Contracts\Repositories\UserInterface;
|
||||
use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
|
||||
use Pterodactyl\Models\User;
|
||||
|
||||
class UserRepository extends Repository implements UserInterface
|
||||
class UserRepository extends EloquentRepository implements UserRepositoryInterface
|
||||
{
|
||||
/**
|
||||
* Dependencies to automatically inject into the repository.
|
||||
*
|
||||
* @var array
|
||||
* @var \Illuminate\Contracts\Config\Repository
|
||||
*/
|
||||
protected $inject = [
|
||||
'guard' => Guard::class,
|
||||
];
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* Return the model to be used for the repository.
|
||||
*
|
||||
* @return string
|
||||
* @var bool|array
|
||||
*/
|
||||
protected $searchTerm = false;
|
||||
|
||||
/**
|
||||
* UserRepository constructor.
|
||||
*
|
||||
* @param \Illuminate\Foundation\Application $application
|
||||
* @param \Illuminate\Contracts\Config\Repository $config
|
||||
*/
|
||||
public function __construct(Application $application, ConfigRepository $config)
|
||||
{
|
||||
parent::__construct($application);
|
||||
|
||||
$this->config = $config;
|
||||
}
|
||||
|
||||
public function model()
|
||||
{
|
||||
return User::class;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function search($term)
|
||||
{
|
||||
$this->model->search($term);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function delete($id)
|
||||
{
|
||||
$user = $this->model->withCount('servers')->find($id);
|
||||
|
||||
if ($this->guard->user() && $this->guard->user()->id === $user->id) {
|
||||
throw new DisplayException('You cannot delete your own account.');
|
||||
if (empty($term)) {
|
||||
return $this;
|
||||
}
|
||||
|
||||
if ($user->server_count > 0) {
|
||||
$clone = clone $this;
|
||||
$clone->searchTerm = $term;
|
||||
|
||||
return $clone;
|
||||
}
|
||||
|
||||
public function getAllUsersWithCounts()
|
||||
{
|
||||
$users = $this->getBuilder()->withCount('servers', 'subuserOf');
|
||||
|
||||
if ($this->searchTerm) {
|
||||
$users->search($this->searchTerm);
|
||||
}
|
||||
|
||||
return $users->paginate(
|
||||
$this->config->get('pterodactyl.paginate.admin.users'), $this->getColumns()
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a user if they have no servers attached to their account.
|
||||
*
|
||||
* @param int $id
|
||||
* @return bool
|
||||
*
|
||||
* @throws \Pterodactyl\Exceptions\DisplayException
|
||||
*/
|
||||
public function deleteIfNoServers($id)
|
||||
{
|
||||
$user = $this->getBuilder()->withCount('servers')->where('id', $id)->first();
|
||||
|
||||
if (! $user) {
|
||||
throw new RecordNotFoundException();
|
||||
}
|
||||
|
||||
if ($user->servers_count > 0) {
|
||||
throw new DisplayException('Cannot delete an account that has active servers attached to it.');
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -22,67 +22,77 @@
|
|||
* SOFTWARE.
|
||||
*/
|
||||
|
||||
namespace Pterodactyl\Repositories;
|
||||
namespace Pterodactyl\Repository;
|
||||
|
||||
use Illuminate\Container\Container;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Pterodactyl\Exceptions\Repository\RepositoryException;
|
||||
use Pterodactyl\Contracts\Repositories\RepositoryInterface;
|
||||
use Illuminate\Foundation\Application;
|
||||
use Pterodactyl\Contracts\Repository\RepositoryInterface;
|
||||
|
||||
abstract class Repository implements RepositoryInterface
|
||||
{
|
||||
const RULE_UPDATED = 'updated';
|
||||
const RULE_CREATED = 'created';
|
||||
|
||||
/**
|
||||
* @var \Illuminate\Container\Container
|
||||
* @var \Illuminate\Foundation\Application
|
||||
*/
|
||||
protected $container;
|
||||
protected $app;
|
||||
|
||||
/**
|
||||
* Array of classes to inject automatically into the container.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $inject = [];
|
||||
protected $columns = ['*'];
|
||||
|
||||
/**
|
||||
* @var \Illuminate\Database\Eloquent\Model
|
||||
* @var mixed
|
||||
*/
|
||||
protected $model;
|
||||
|
||||
/**
|
||||
* Array of validation rules that can be accessed from this repository.
|
||||
*
|
||||
* @var array
|
||||
* @var bool
|
||||
*/
|
||||
protected $rules = [];
|
||||
protected $withFresh = true;
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
* Repository constructor.
|
||||
*
|
||||
* @param \Illuminate\Foundation\Application $application
|
||||
*/
|
||||
public function __construct(Container $container)
|
||||
public function __construct(Application $application)
|
||||
{
|
||||
$this->container = $container;
|
||||
$this->app = $application;
|
||||
|
||||
foreach ($this->inject as $key => $value) {
|
||||
if (isset($this->{$key})) {
|
||||
throw new \Exception('Cannot override a defined object in this class.');
|
||||
}
|
||||
|
||||
$this->{$key} = $this->container->make($value);
|
||||
}
|
||||
|
||||
$this->makeModel();
|
||||
$this->setModel($this->model());
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
* Take the provided model and make it accessible to the rest of the repository.
|
||||
*
|
||||
* @param string|array $model
|
||||
* @return mixed
|
||||
*/
|
||||
protected function setModel($model)
|
||||
{
|
||||
if (is_array($model)) {
|
||||
if (count($model) !== 2) {
|
||||
throw new \InvalidArgumentException(
|
||||
printf('setModel expected exactly 2 parameters, %d received.', count($model))
|
||||
);
|
||||
}
|
||||
|
||||
return $this->model = call_user_func(
|
||||
$model[1], $this->app->make($model[0])
|
||||
);
|
||||
}
|
||||
|
||||
return $this->model = $this->app->make($model);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return mixed
|
||||
*/
|
||||
abstract public function model();
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
* Return the model being used for this repository.
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function getModel()
|
||||
{
|
||||
|
|
@ -90,140 +100,39 @@ abstract class Repository implements RepositoryInterface
|
|||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
* Setup column selection functionality.
|
||||
*
|
||||
* @param array $columns
|
||||
* @return $this
|
||||
*/
|
||||
public function makeModel()
|
||||
public function withColumns($columns = ['*'])
|
||||
{
|
||||
$model = $this->container->make($this->model());
|
||||
$clone = clone $this;
|
||||
$clone->columns = is_array($columns) ? $columns : func_get_args();
|
||||
|
||||
if (! $model instanceof Model) {
|
||||
throw new RepositoryException(
|
||||
"Class {$this->model()} must be an instance of \\Illuminate\\Database\\Eloquent\\Model"
|
||||
);
|
||||
}
|
||||
|
||||
return $this->model = $model->newQuery();
|
||||
return $clone;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
* Return the columns to be selected in the repository call.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getRules()
|
||||
public function getColumns()
|
||||
{
|
||||
return $this->rules;
|
||||
return $this->columns;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
* Set repository to not return a fresh record from the DB when completed.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function getUpdateRules()
|
||||
public function withoutFresh()
|
||||
{
|
||||
if (array_key_exists(self::RULE_UPDATED, $this->rules)) {
|
||||
return $this->rules[self::RULE_UPDATED];
|
||||
}
|
||||
$clone = clone $this;
|
||||
$clone->withFresh = false;
|
||||
|
||||
return [];
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getCreateRules()
|
||||
{
|
||||
if (array_key_exists(self::RULE_CREATED, $this->rules)) {
|
||||
return $this->rules[self::RULE_CREATED];
|
||||
}
|
||||
|
||||
return [];
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function with(...$params)
|
||||
{
|
||||
$this->model = $this->model->with($params);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function withCount(...$params)
|
||||
{
|
||||
$this->model = $this->model->withCount($params);
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function all(array $columns = ['*'])
|
||||
{
|
||||
return $this->model->get($columns);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function paginate($limit = 15, array $columns = ['*'])
|
||||
{
|
||||
return $this->model->paginate($limit, $columns);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function create(array $data)
|
||||
{
|
||||
return $this->model->create($data);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function update($attributes, array $data)
|
||||
{
|
||||
// If only a number is passed, we assume it is an ID
|
||||
// for the specific model at hand.
|
||||
if (is_numeric($attributes)) {
|
||||
$attributes = [['id', '=', $attributes]];
|
||||
}
|
||||
|
||||
return $this->model->where($attributes)->get()->each->update($data);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function delete($id)
|
||||
{
|
||||
return $this->model->find($id)->delete();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function destroy($id)
|
||||
{
|
||||
return $this->model->find($id)->forceDelete();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function find($id, array $columns = ['*'])
|
||||
{
|
||||
return $this->model->find($id, $columns);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function findBy(array $attributes, array $columns = ['*'])
|
||||
{
|
||||
return $this->model->where($attributes)->first($columns);
|
||||
return $clone;
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue