Update last of existing services to use repositories, includes unit tests

Also update PHPDocs on all the repository interfaces and classes to be correct.

app/Contracts/Repository/ApiKeyRepositoryInterface.php

@@ -0,0 +1,30 @@
+<?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;
+
+interface ApiKeyRepositoryInterface extends RepositoryInterface
+{
+    //
+}

app/Contracts/Repository/ApiPermissionRepositoryInterface.php

@@ -0,0 +1,30 @@
+<?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;
+
+interface ApiPermissionRepositoryInterface extends RepositoryInterface
+{
+    //
+}

app/Contracts/Repository/Attributes/SearchableInterface.php

@@ -26,5 +26,11 @@ namespace Pterodactyl\Contracts\Repository\Attributes;
 
 interface SearchableInterface
 {
+    /**
+     * Filter results by search term.
+     *
+     * @param  string $term
+     * @return $this
+     */
     public function search($term);
 }

app/Contracts/Repository/DatabaseHostInterface.php

@@ -26,5 +26,14 @@ namespace Pterodactyl\Contracts\Repository;
 
 interface DatabaseHostInterface extends RepositoryInterface
 {
+    /**
+     * Delete a database host from the DB if there are no databases using it.
+     *
+     * @param  int $id
+     * @return bool|null
+     *
+     * @throws \Pterodactyl\Exceptions\DisplayException
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
     public function deleteIfNoDatabases($id);
 }

app/Contracts/Repository/LocationRepositoryInterface.php

@@ -28,5 +28,14 @@ use Pterodactyl\Contracts\Repository\Attributes\SearchableInterface;
 
 interface LocationRepositoryInterface extends RepositoryInterface, SearchableInterface
 {
+    /**
+     * Delete a location only if there are no nodes attached to it.
+     *
+     * @param  $id
+     * @return bool|mixed|null
+     *
+     * @throws \Pterodactyl\Exceptions\DisplayException
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
     public function deleteIfNoNodes($id);
 }

app/Contracts/Repository/RepositoryInterface.php

@@ -26,25 +26,108 @@ namespace Pterodactyl\Contracts\Repository;
 
 interface RepositoryInterface
 {
+    /**
+     * Return an identifier or Model object to be used by the repository.
+     *
+     * @return string|\Closure|object
+     */
     public function model();
 
+    /**
+     * Return the model being used for this repository instance.
+     *
+     * @return mixed
+     */
     public function getModel();
 
+    /**
+     * Returns an instance of a query builder.
+     *
+     * @return mixed
+     */
     public function getBuilder();
 
+    /**
+     * Returns the colummns to be selected or returned by the query.
+     *
+     * @return mixed
+     */
     public function getColumns();
 
+    /**
+     * An array of columns to filter the response by.
+     *
+     * @param  array $columns
+     * @return $this
+     */
     public function withColumns($columns = ['*']);
 
-    public function create($fields);
+    /**
+     * Disable returning a fresh model when data is inserted or updated.
+     *
+     * @return $this
+     */
+    public function withoutFresh();
 
+    /**
+     * Create a new model instance and persist it to the database.
+     *
+     * @param  array $fields
+     * @param  bool  $validate
+     * @return mixed
+     *
+     * @throws \Pterodactyl\Exceptions\Model\DataValidationException
+     */
+    public function create(array $fields, $validate = true);
+
+    /**
+     * Delete a given record from the database.
+     *
+     * @param  int  $id
+     * @return bool|null
+     */
     public function delete($id);
 
+    /**
+     * Find a model that has the specific ID passed.
+     *
+     * @param  int $id
+     * @return mixed
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
     public function find($id);
 
-    public function findWhere($fields);
+    /**
+     * Find a model matching an array of where clauses.
+     *
+     * @param  array $fields
+     * @return mixed
+     *
+     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
+     */
+    public function findWhere(array $fields);
 
-    public function update($id, $fields);
+    /**
+     * Update a given ID with the passed array of fields.
+     *
+     * @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, array $fields, $validate = true, $force = false);
 
-    public function massUpdate($fields);
+    /**
+     * Update multiple records matching the passed clauses.
+     *
+     * @param  array $where
+     * @param  array $fields
+     * @return mixed
+     */
+    public function massUpdate(array $where, array $fields);
 }

app/Contracts/Repository/UserRepositoryInterface.php

@@ -28,7 +28,20 @@ use Pterodactyl\Contracts\Repository\Attributes\SearchableInterface;
 
 interface UserRepositoryInterface extends RepositoryInterface, SearchableInterface
 {
+    /**
+     * Return all users with counts of servers and subusers of servers.
+     *
+     * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
+     */
     public function getAllUsersWithCounts();
 
+    /**
+     * 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);
 }