44 lines
1.2 KiB
PHP
44 lines
1.2 KiB
PHP
<?php
|
|
|
|
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 \Illuminate\Support\Collection
|
|
*/
|
|
public function getAllWithDetails(): Collection;
|
|
|
|
/**
|
|
* Return all of the available locations with the nodes as a relationship.
|
|
*
|
|
* @return \Illuminate\Support\Collection
|
|
*/
|
|
public function getAllWithNodes(): Collection;
|
|
|
|
/**
|
|
* Return all of the nodes and their respective count of servers for a location.
|
|
*
|
|
* @param int $id
|
|
* @return mixed
|
|
*
|
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
|
*/
|
|
public function getWithNodes(int $id): Location;
|
|
|
|
/**
|
|
* Return a location and the count of nodes in that location.
|
|
*
|
|
* @param int $id
|
|
* @return mixed
|
|
*
|
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
|
*/
|
|
public function getWithNodeCount(int $id): Location;
|
|
}
|