Update repository base code to be cleaner and make use of PHP 7 features

Author: DaneEveritt

app/Console/Commands/User/DeleteUserCommand.php

@@ -61,7 +61,7 @@ public function handle()
         $search = $this->option('user') ?? $this->ask(trans('command/messages.user.search_users'));
         Assert::notEmpty($search, 'Search term must be a non-null value, received %s.');
 
-        $results = $this->repository->search($search)->all();
+        $results = $this->repository->setSearchTerm($search)->all();
         if (count($results) < 1) {
             $this->error(trans('command/messages.user.no_users_found'));
             if ($this->input->isInteractive()) {

app/Console/Commands/User/DisableTwoFactorCommand.php

@@ -54,7 +54,7 @@ public function handle()
         }
 
         $email = $this->option('email') ?? $this->ask(trans('command/messages.user.ask_email'));
-        $user = $this->repository->withColumns(['id', 'email'])->findFirstWhere([['email', '=', $email]]);
+        $user = $this->repository->setColumns(['id', 'email'])->findFirstWhere([['email', '=', $email]]);
 
         $this->repository->withoutFresh()->update($user->id, [
             'use_totp' => false,

app/Contracts/Repository/AllocationRepositoryInterface.php

@@ -1,14 +1,9 @@
 <?php
-/**
- * Pterodactyl - Panel
- * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
- *
- * This software is licensed under the terms of the MIT license.
- * https://opensource.org/licenses/MIT
- */
 
 namespace Pterodactyl\Contracts\Repository;
 
+use Illuminate\Support\Collection;
+
 interface AllocationRepositoryInterface extends RepositoryInterface
 {
     /**
@@ -18,13 +13,13 @@ interface AllocationRepositoryInterface extends RepositoryInterface
      * @param array    $ids
      * @return int
      */
-    public function assignAllocationsToServer($server, array $ids);
+    public function assignAllocationsToServer(int $server = null, array $ids): int;
 
     /**
      * Return all of the allocations for a specific node.
      *
      * @param int $node
-     * @return \Illuminate\Database\Eloquent\Collection
+     * @return \Illuminate\Support\Collection
      */
-    public function getAllocationsForNode($node);
+    public function getAllocationsForNode(int $node): Collection;
 }

app/Contracts/Repository/Attributes/SearchableInterface.php

@@ -1,21 +1,38 @@
 <?php
-/**
- * Pterodactyl - Panel
- * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
- *
- * This software is licensed under the terms of the MIT license.
- * https://opensource.org/licenses/MIT
- */
 
 namespace Pterodactyl\Contracts\Repository\Attributes;
 
 interface SearchableInterface
 {
     /**
-     * Filter results by search term.
+     * Set the search term.
      *
-     * @param string $term
+     * @param string|null $term
      * @return $this
+     * @deprecated
      */
     public function search($term);
+
+    /**
+     * Set the search term to use when requesting all records from
+     * the model.
+     *
+     * @param string|null $term
+     * @return $this
+     */
+    public function setSearchTerm(string $term = null);
+
+    /**
+     * Determine if a valid search term is set on this repository.
+     *
+     * @return bool
+     */
+    public function hasSearchTerm(): bool;
+
+    /**
+     * Return the search term.
+     *
+     * @return string|null
+     */
+    public function getSearchTerm();
 }

app/Contracts/Repository/DaemonKeyRepositoryInterface.php

@@ -1,26 +1,4 @@
 <?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\Contracts\Repository;
 
@@ -44,14 +22,6 @@ interface DaemonKeyRepositoryInterface extends RepositoryInterface
      */
     public function loadServerAndUserRelations(DaemonKey $key, bool $refresh = false): DaemonKey;
 
-    /**
-     * Gets the daemon keys associated with a specific server.
-     *
-     * @param int $server
-     * @return \Illuminate\Support\Collection
-     */
-    public function getServerKeys($server);
-
     /**
      * Return a daemon key with the associated server relation attached.
      *
@@ -60,7 +30,7 @@ public function getServerKeys($server);
      *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
-    public function getKeyWithServer($key);
+    public function getKeyWithServer(string $key): DaemonKey;
 
     /**
      * Get all of the keys for a specific user including the information needed

app/Contracts/Repository/DatabaseHostRepositoryInterface.php

@@ -1,30 +1,28 @@
 <?php
-/**
- * Pterodactyl - Panel
- * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
- *
- * This software is licensed under the terms of the MIT license.
- * https://opensource.org/licenses/MIT
- */
 
 namespace Pterodactyl\Contracts\Repository;
 
+use Illuminate\Support\Collection;
+use Pterodactyl\Models\DatabaseHost;
+
 interface DatabaseHostRepositoryInterface extends RepositoryInterface
 {
     /**
-     * Return database hosts with a count of databases and the node information for which it is attached.
+     * Return database hosts with a count of databases and the node
+     * information for which it is attached.
      *
      * @return \Illuminate\Support\Collection
      */
-    public function getWithViewDetails();
+    public function getWithViewDetails(): Collection;
 
     /**
-     * Return a database host with the databases and associated servers that are attached to said databases.
+     * Return a database host with the databases and associated servers
+     * that are attached to said databases.
      *
      * @param int $id
-     * @return mixed
+     * @return \Pterodactyl\Models\DatabaseHost
      *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
-    public function getWithServers($id);
+    public function getWithServers(int $id): DatabaseHost;
 }

app/Contracts/Repository/DatabaseRepositoryInterface.php

@@ -9,6 +9,7 @@
 
 namespace Pterodactyl\Contracts\Repository;
 
+use Pterodactyl\Models\Database;
 use Illuminate\Support\Collection;
 
 interface DatabaseRepositoryInterface extends RepositoryInterface
@@ -43,20 +44,20 @@ public function getDatabasesForServer(int $server): Collection;
      * the provided details.
      *
      * @param array $data
-     * @return mixed
+     * @return \Pterodactyl\Models\Database
      *
-     * @throws \Pterodactyl\Exceptions\DisplayException
      * @throws \Pterodactyl\Exceptions\Model\DataValidationException
+     * @throws \Pterodactyl\Exceptions\Repository\DuplicateDatabaseNameException
      */
-    public function createIfNotExists(array $data);
+    public function createIfNotExists(array $data): Database;
 
     /**
      * Create a new database on a given connection.
      *
      * @param string $database
      * @return bool
      */
-    public function createDatabase($database);
+    public function createDatabase(string $database): bool;
 
     /**
      * Create a new database user on a given connection.
@@ -66,7 +67,7 @@ public function createDatabase($database);
      * @param string $password
      * @return bool
      */
-    public function createUser($username, $remote, $password);
+    public function createUser(string $username, string $remote, string $password): bool;
 
     /**
      * Give a specific user access to a given database.
@@ -76,22 +77,22 @@ public function createUser($username, $remote, $password);
      * @param string $remote
      * @return bool
      */
-    public function assignUserToDatabase($database, $username, $remote);
+    public function assignUserToDatabase(string $database, string $username, string $remote): bool;
 
     /**
      * Flush the privileges for a given connection.
      *
-     * @return mixed
+     * @return bool
      */
-    public function flush();
+    public function flush(): bool;
 
     /**
      * Drop a given database on a specific connection.
      *
      * @param string $database
      * @return bool
      */
-    public function dropDatabase($database);
+    public function dropDatabase(string $database): bool;
 
     /**
      * Drop a given user on a specific connection.
@@ -100,5 +101,5 @@ public function dropDatabase($database);
      * @param string $remote
      * @return mixed
      */
-    public function dropUser($username, $remote);
+    public function dropUser(string $username, string $remote): bool;
 }

app/Contracts/Repository/LocationRepositoryInterface.php

@@ -1,31 +1,26 @@
 <?php
-/**
- * Pterodactyl - Panel
- * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
- *
- * This software is licensed under the terms of the MIT license.
- * https://opensource.org/licenses/MIT
- */
 
 namespace Pterodactyl\Contracts\Repository;
 
+use Pterodactyl\Models\Location;
+use Illuminate\Support\Collection;
 use Pterodactyl\Contracts\Repository\Attributes\SearchableInterface;
 
 interface LocationRepositoryInterface extends RepositoryInterface, SearchableInterface
 {
     /**
      * Return locations with a count of nodes and servers attached to it.
      *
-     * @return mixed
+     * @return \Illuminate\Support\Collection
      */
-    public function getAllWithDetails();
+    public function getAllWithDetails(): Collection;
 
     /**
      * Return all of the available locations with the nodes as a relationship.
      *
      * @return \Illuminate\Support\Collection
      */
-    public function getAllWithNodes();
+    public function getAllWithNodes(): Collection;
 
     /**
      * Return all of the nodes and their respective count of servers for a location.
@@ -35,7 +30,7 @@ public function getAllWithNodes();
      *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
-    public function getWithNodes($id);
+    public function getWithNodes(int $id): Location;
 
     /**
      * Return a location and the count of nodes in that location.
@@ -45,5 +40,5 @@ public function getWithNodes($id);
      *
      * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
-    public function getWithNodeCount($id);
+    public function getWithNodeCount(int $id): Location;
 }