misc_pterodactyl-panel/app/Contracts/Repository/ServiceRepositoryInterface.php

46 lines
1.4 KiB
PHP
Raw Normal View History

<?php
2017-09-26 02:43:01 +00:00
/**
* Pterodactyl - Panel
* Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
*
2017-09-26 02:43:01 +00:00
* This software is licensed under the terms of the MIT license.
* https://opensource.org/licenses/MIT
*/
namespace Pterodactyl\Contracts\Repository;
2017-10-03 03:51:13 +00:00
use Pterodactyl\Models\Service;
2017-07-15 16:52:34 +00:00
interface ServiceRepositoryInterface extends RepositoryInterface
{
/**
2017-07-15 16:52:34 +00:00
* Return a service or all services with their associated options, variables, and packs.
*
2017-08-22 03:10:48 +00:00
* @param int $id
2017-10-04 04:31:04 +00:00
* @return \Illuminate\Database\Eloquent\Collection|\Pterodactyl\Models\Service
*
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
*/
2017-10-04 04:31:04 +00:00
public function getWithOptions(int $id = null);
2017-10-03 03:51:13 +00:00
/**
* Return a service or all services and the count of options, packs, and servers for that service.
*
* @param int|null $id
2017-10-04 04:31:04 +00:00
* @return \Pterodactyl\Models\Service|\Illuminate\Database\Eloquent\Collection
*
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
2017-10-03 03:51:13 +00:00
*/
2017-10-04 04:31:04 +00:00
public function getWithCounts(int $id = null);
/**
* Return a service along with its associated options and the servers relation on those options.
*
2017-08-22 03:10:48 +00:00
* @param int $id
2017-10-04 04:31:04 +00:00
* @return \Pterodactyl\Models\Service
*
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
*/
2017-10-03 03:51:13 +00:00
public function getWithOptionServers(int $id): Service;
}