Update php doc blocks
This commit is contained in:
parent
5f6ee45f44
commit
f82b419d47
19 changed files with 43 additions and 12 deletions
|
@ -94,6 +94,7 @@ class EggVariableController extends Controller
|
||||||
*
|
*
|
||||||
* @return \Illuminate\Http\RedirectResponse
|
* @return \Illuminate\Http\RedirectResponse
|
||||||
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||||
|
* @throws \Pterodactyl\Exceptions\Service\Egg\Variable\BadValidationRuleException
|
||||||
* @throws \Pterodactyl\Exceptions\Service\Egg\Variable\ReservedVariableNameException
|
* @throws \Pterodactyl\Exceptions\Service\Egg\Variable\ReservedVariableNameException
|
||||||
*/
|
*/
|
||||||
public function store(EggVariableFormRequest $request, Egg $egg): RedirectResponse
|
public function store(EggVariableFormRequest $request, Egg $egg): RedirectResponse
|
||||||
|
|
|
@ -462,6 +462,7 @@ class ServersController extends Controller
|
||||||
*
|
*
|
||||||
* @param \Pterodactyl\Models\Server $server
|
* @param \Pterodactyl\Models\Server $server
|
||||||
* @return \Illuminate\Http\RedirectResponse
|
* @return \Illuminate\Http\RedirectResponse
|
||||||
|
* @throws \Pterodactyl\Exceptions\Http\Connection\DaemonConnectionException
|
||||||
*/
|
*/
|
||||||
public function rebuildContainer(Server $server)
|
public function rebuildContainer(Server $server)
|
||||||
{
|
{
|
||||||
|
@ -540,7 +541,8 @@ class ServersController extends Controller
|
||||||
* @param \Pterodactyl\Models\Server $server
|
* @param \Pterodactyl\Models\Server $server
|
||||||
* @return \Illuminate\Http\RedirectResponse
|
* @return \Illuminate\Http\RedirectResponse
|
||||||
*
|
*
|
||||||
* @throws \Pterodactyl\Exceptions\DisplayException
|
* @throws \Illuminate\Validation\ValidationException
|
||||||
|
* @throws \Pterodactyl\Exceptions\Http\Connection\DaemonConnectionException
|
||||||
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||||
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -76,6 +76,8 @@ class AdvancedController extends Controller
|
||||||
/**
|
/**
|
||||||
* @param \Pterodactyl\Http\Requests\Admin\Settings\AdvancedSettingsFormRequest $request
|
* @param \Pterodactyl\Http\Requests\Admin\Settings\AdvancedSettingsFormRequest $request
|
||||||
* @return \Illuminate\Http\RedirectResponse
|
* @return \Illuminate\Http\RedirectResponse
|
||||||
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
*/
|
*/
|
||||||
public function update(AdvancedSettingsFormRequest $request): RedirectResponse
|
public function update(AdvancedSettingsFormRequest $request): RedirectResponse
|
||||||
{
|
{
|
||||||
|
|
|
@ -74,6 +74,8 @@ class IndexController extends Controller
|
||||||
*
|
*
|
||||||
* @param \Pterodactyl\Http\Requests\Admin\Settings\BaseSettingsFormRequest $request
|
* @param \Pterodactyl\Http\Requests\Admin\Settings\BaseSettingsFormRequest $request
|
||||||
* @return \Illuminate\Http\RedirectResponse
|
* @return \Illuminate\Http\RedirectResponse
|
||||||
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
*/
|
*/
|
||||||
public function update(BaseSettingsFormRequest $request): RedirectResponse
|
public function update(BaseSettingsFormRequest $request): RedirectResponse
|
||||||
{
|
{
|
||||||
|
|
|
@ -83,7 +83,9 @@ class MailController extends Controller
|
||||||
* @param \Pterodactyl\Http\Requests\Admin\Settings\MailSettingsFormRequest $request
|
* @param \Pterodactyl\Http\Requests\Admin\Settings\MailSettingsFormRequest $request
|
||||||
* @return \Illuminate\Http\RedirectResponse
|
* @return \Illuminate\Http\RedirectResponse
|
||||||
*
|
*
|
||||||
* @throws \Pterodactyl\Exceptions\DisplayException
|
* @throws DisplayException
|
||||||
|
* @throws \Pterodactyl\Exceptions\Model\DataValidationException
|
||||||
|
* @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
|
||||||
*/
|
*/
|
||||||
public function update(MailSettingsFormRequest $request): RedirectResponse
|
public function update(MailSettingsFormRequest $request): RedirectResponse
|
||||||
{
|
{
|
||||||
|
|
|
@ -82,6 +82,7 @@ class EggVariable extends Model implements CleansAttributes, ValidableContract
|
||||||
];
|
];
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
* @param $value
|
||||||
* @return bool
|
* @return bool
|
||||||
*/
|
*/
|
||||||
public function getRequiredAttribute($value)
|
public function getRequiredAttribute($value)
|
||||||
|
|
|
@ -18,7 +18,6 @@ class AuthServiceProvider extends ServiceProvider
|
||||||
/**
|
/**
|
||||||
* Register any application authentication / authorization services.
|
* Register any application authentication / authorization services.
|
||||||
*
|
*
|
||||||
* @param \Illuminate\Contracts\Auth\Access\Gate $gate
|
|
||||||
*/
|
*/
|
||||||
public function boot()
|
public function boot()
|
||||||
{
|
{
|
||||||
|
|
|
@ -12,6 +12,7 @@ class CommandRepository extends BaseRepository implements CommandRepositoryInter
|
||||||
*
|
*
|
||||||
* @param string $command
|
* @param string $command
|
||||||
* @return \Psr\Http\Message\ResponseInterface
|
* @return \Psr\Http\Message\ResponseInterface
|
||||||
|
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||||
*/
|
*/
|
||||||
public function send(string $command): ResponseInterface
|
public function send(string $command): ResponseInterface
|
||||||
{
|
{
|
||||||
|
|
|
@ -12,6 +12,7 @@ class ConfigurationRepository extends BaseRepository implements ConfigurationRep
|
||||||
*
|
*
|
||||||
* @param array $overrides
|
* @param array $overrides
|
||||||
* @return \Psr\Http\Message\ResponseInterface
|
* @return \Psr\Http\Message\ResponseInterface
|
||||||
|
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||||
*/
|
*/
|
||||||
public function update(array $overrides = []): ResponseInterface
|
public function update(array $overrides = []): ResponseInterface
|
||||||
{
|
{
|
||||||
|
|
|
@ -14,7 +14,7 @@ class FileRepository extends BaseRepository implements FileRepositoryInterface
|
||||||
* @param string $path
|
* @param string $path
|
||||||
* @return \stdClass
|
* @return \stdClass
|
||||||
*
|
*
|
||||||
* @throws \GuzzleHttp\Exception\RequestException
|
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||||
*/
|
*/
|
||||||
public function getFileStat(string $path): stdClass
|
public function getFileStat(string $path): stdClass
|
||||||
{
|
{
|
||||||
|
@ -35,7 +35,7 @@ class FileRepository extends BaseRepository implements FileRepositoryInterface
|
||||||
* @param string $path
|
* @param string $path
|
||||||
* @return string
|
* @return string
|
||||||
*
|
*
|
||||||
* @throws \GuzzleHttp\Exception\RequestException
|
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||||
*/
|
*/
|
||||||
public function getContent(string $path): string
|
public function getContent(string $path): string
|
||||||
{
|
{
|
||||||
|
@ -57,7 +57,7 @@ class FileRepository extends BaseRepository implements FileRepositoryInterface
|
||||||
* @param string $content
|
* @param string $content
|
||||||
* @return \Psr\Http\Message\ResponseInterface
|
* @return \Psr\Http\Message\ResponseInterface
|
||||||
*
|
*
|
||||||
* @throws \GuzzleHttp\Exception\RequestException
|
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||||
*/
|
*/
|
||||||
public function putContent(string $path, string $content): ResponseInterface
|
public function putContent(string $path, string $content): ResponseInterface
|
||||||
{
|
{
|
||||||
|
@ -78,7 +78,7 @@ class FileRepository extends BaseRepository implements FileRepositoryInterface
|
||||||
* @param string $path
|
* @param string $path
|
||||||
* @return array
|
* @return array
|
||||||
*
|
*
|
||||||
* @throws \GuzzleHttp\Exception\RequestException
|
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||||
*/
|
*/
|
||||||
public function getDirectory(string $path): array
|
public function getDirectory(string $path): array
|
||||||
{
|
{
|
||||||
|
|
|
@ -14,7 +14,8 @@ class PowerRepository extends BaseRepository implements PowerRepositoryInterface
|
||||||
* @param string $signal
|
* @param string $signal
|
||||||
* @return \Psr\Http\Message\ResponseInterface
|
* @return \Psr\Http\Message\ResponseInterface
|
||||||
*
|
*
|
||||||
* @throws \Pterodactyl\Exceptions\Repository\Daemon\InvalidPowerSignalException
|
* @throws InvalidPowerSignalException
|
||||||
|
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||||
*/
|
*/
|
||||||
public function sendSignal(string $signal): ResponseInterface
|
public function sendSignal(string $signal): ResponseInterface
|
||||||
{
|
{
|
||||||
|
|
|
@ -15,7 +15,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
||||||
* @param array $overrides
|
* @param array $overrides
|
||||||
* @return \Psr\Http\Message\ResponseInterface
|
* @return \Psr\Http\Message\ResponseInterface
|
||||||
*
|
*
|
||||||
* @throws \GuzzleHttp\Exception\RequestException
|
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||||
*/
|
*/
|
||||||
public function create(array $structure, array $overrides = []): ResponseInterface
|
public function create(array $structure, array $overrides = []): ResponseInterface
|
||||||
{
|
{
|
||||||
|
@ -33,6 +33,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
||||||
*
|
*
|
||||||
* @param array $data
|
* @param array $data
|
||||||
* @return \Psr\Http\Message\ResponseInterface
|
* @return \Psr\Http\Message\ResponseInterface
|
||||||
|
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||||
*/
|
*/
|
||||||
public function update(array $data): ResponseInterface
|
public function update(array $data): ResponseInterface
|
||||||
{
|
{
|
||||||
|
@ -46,6 +47,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
||||||
*
|
*
|
||||||
* @param array|null $data
|
* @param array|null $data
|
||||||
* @return \Psr\Http\Message\ResponseInterface
|
* @return \Psr\Http\Message\ResponseInterface
|
||||||
|
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||||
*/
|
*/
|
||||||
public function reinstall(array $data = null): ResponseInterface
|
public function reinstall(array $data = null): ResponseInterface
|
||||||
{
|
{
|
||||||
|
@ -58,6 +60,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
||||||
* Mark a server as needing a container rebuild the next time the server is booted.
|
* Mark a server as needing a container rebuild the next time the server is booted.
|
||||||
*
|
*
|
||||||
* @return \Psr\Http\Message\ResponseInterface
|
* @return \Psr\Http\Message\ResponseInterface
|
||||||
|
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||||
*/
|
*/
|
||||||
public function rebuild(): ResponseInterface
|
public function rebuild(): ResponseInterface
|
||||||
{
|
{
|
||||||
|
@ -68,6 +71,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
||||||
* Suspend a server on the daemon.
|
* Suspend a server on the daemon.
|
||||||
*
|
*
|
||||||
* @return \Psr\Http\Message\ResponseInterface
|
* @return \Psr\Http\Message\ResponseInterface
|
||||||
|
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||||
*/
|
*/
|
||||||
public function suspend(): ResponseInterface
|
public function suspend(): ResponseInterface
|
||||||
{
|
{
|
||||||
|
@ -78,6 +82,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
||||||
* Un-suspend a server on the daemon.
|
* Un-suspend a server on the daemon.
|
||||||
*
|
*
|
||||||
* @return \Psr\Http\Message\ResponseInterface
|
* @return \Psr\Http\Message\ResponseInterface
|
||||||
|
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||||
*/
|
*/
|
||||||
public function unsuspend(): ResponseInterface
|
public function unsuspend(): ResponseInterface
|
||||||
{
|
{
|
||||||
|
@ -88,6 +93,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
||||||
* Delete a server on the daemon.
|
* Delete a server on the daemon.
|
||||||
*
|
*
|
||||||
* @return \Psr\Http\Message\ResponseInterface
|
* @return \Psr\Http\Message\ResponseInterface
|
||||||
|
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||||
*/
|
*/
|
||||||
public function delete(): ResponseInterface
|
public function delete(): ResponseInterface
|
||||||
{
|
{
|
||||||
|
@ -98,6 +104,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
||||||
* Return detials on a specific server.
|
* Return detials on a specific server.
|
||||||
*
|
*
|
||||||
* @return \Psr\Http\Message\ResponseInterface
|
* @return \Psr\Http\Message\ResponseInterface
|
||||||
|
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||||
*/
|
*/
|
||||||
public function details(): ResponseInterface
|
public function details(): ResponseInterface
|
||||||
{
|
{
|
||||||
|
@ -110,7 +117,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
||||||
* @param string|array $key
|
* @param string|array $key
|
||||||
* @return \Psr\Http\Message\ResponseInterface
|
* @return \Psr\Http\Message\ResponseInterface
|
||||||
*
|
*
|
||||||
* @throws \GuzzleHttp\Exception\RequestException
|
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||||
*/
|
*/
|
||||||
public function revokeAccessKey($key): ResponseInterface
|
public function revokeAccessKey($key): ResponseInterface
|
||||||
{
|
{
|
||||||
|
|
|
@ -70,6 +70,7 @@ class AdminAcl
|
||||||
* Return a list of all resource constants defined in this ACL.
|
* Return a list of all resource constants defined in this ACL.
|
||||||
*
|
*
|
||||||
* @return array
|
* @return array
|
||||||
|
* @throws \ReflectionException
|
||||||
*/
|
*/
|
||||||
public static function getResourceList(): array
|
public static function getResourceList(): array
|
||||||
{
|
{
|
||||||
|
|
|
@ -46,6 +46,7 @@ class AllocationTransformer extends BaseTransformer
|
||||||
*
|
*
|
||||||
* @param \Pterodactyl\Models\Allocation $allocation
|
* @param \Pterodactyl\Models\Allocation $allocation
|
||||||
* @return \League\Fractal\Resource\Item|\League\Fractal\Resource\NullResource
|
* @return \League\Fractal\Resource\Item|\League\Fractal\Resource\NullResource
|
||||||
|
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
|
||||||
*/
|
*/
|
||||||
public function includeNode(Allocation $allocation)
|
public function includeNode(Allocation $allocation)
|
||||||
{
|
{
|
||||||
|
@ -65,6 +66,7 @@ class AllocationTransformer extends BaseTransformer
|
||||||
*
|
*
|
||||||
* @param \Pterodactyl\Models\Allocation $allocation
|
* @param \Pterodactyl\Models\Allocation $allocation
|
||||||
* @return \League\Fractal\Resource\Item|\League\Fractal\Resource\NullResource
|
* @return \League\Fractal\Resource\Item|\League\Fractal\Resource\NullResource
|
||||||
|
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
|
||||||
*/
|
*/
|
||||||
public function includeServer(Allocation $allocation)
|
public function includeServer(Allocation $allocation)
|
||||||
{
|
{
|
||||||
|
|
|
@ -55,6 +55,7 @@ class DatabaseHostTransformer extends BaseTransformer
|
||||||
*
|
*
|
||||||
* @param \Pterodactyl\Models\DatabaseHost $model
|
* @param \Pterodactyl\Models\DatabaseHost $model
|
||||||
* @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
|
* @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
|
||||||
|
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
|
||||||
*/
|
*/
|
||||||
public function includeDatabases(DatabaseHost $model)
|
public function includeDatabases(DatabaseHost $model)
|
||||||
{
|
{
|
||||||
|
|
|
@ -70,6 +70,7 @@ class EggTransformer extends BaseTransformer
|
||||||
*
|
*
|
||||||
* @param \Pterodactyl\Models\Egg $model
|
* @param \Pterodactyl\Models\Egg $model
|
||||||
* @return \League\Fractal\Resource\Item|\League\Fractal\Resource\NullResource
|
* @return \League\Fractal\Resource\Item|\League\Fractal\Resource\NullResource
|
||||||
|
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
|
||||||
*/
|
*/
|
||||||
public function includeNest(Egg $model)
|
public function includeNest(Egg $model)
|
||||||
{
|
{
|
||||||
|
@ -87,6 +88,7 @@ class EggTransformer extends BaseTransformer
|
||||||
*
|
*
|
||||||
* @param \Pterodactyl\Models\Egg $model
|
* @param \Pterodactyl\Models\Egg $model
|
||||||
* @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
|
* @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
|
||||||
|
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
|
||||||
*/
|
*/
|
||||||
public function includeServers(Egg $model)
|
public function includeServers(Egg $model)
|
||||||
{
|
{
|
||||||
|
@ -154,6 +156,7 @@ class EggTransformer extends BaseTransformer
|
||||||
*
|
*
|
||||||
* @param \Pterodactyl\Models\Egg $model
|
* @param \Pterodactyl\Models\Egg $model
|
||||||
* @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
|
* @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
|
||||||
|
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
|
||||||
*/
|
*/
|
||||||
public function includeVariables(Egg $model)
|
public function includeVariables(Egg $model)
|
||||||
{
|
{
|
||||||
|
|
|
@ -52,6 +52,7 @@ class NodeTransformer extends BaseTransformer
|
||||||
*
|
*
|
||||||
* @param \Pterodactyl\Models\Node $node
|
* @param \Pterodactyl\Models\Node $node
|
||||||
* @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
|
* @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
|
||||||
|
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
|
||||||
*/
|
*/
|
||||||
public function includeAllocations(Node $node)
|
public function includeAllocations(Node $node)
|
||||||
{
|
{
|
||||||
|
@ -71,6 +72,7 @@ class NodeTransformer extends BaseTransformer
|
||||||
*
|
*
|
||||||
* @param \Pterodactyl\Models\Node $node
|
* @param \Pterodactyl\Models\Node $node
|
||||||
* @return \League\Fractal\Resource\Item|\League\Fractal\Resource\NullResource
|
* @return \League\Fractal\Resource\Item|\League\Fractal\Resource\NullResource
|
||||||
|
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
|
||||||
*/
|
*/
|
||||||
public function includeLocation(Node $node)
|
public function includeLocation(Node $node)
|
||||||
{
|
{
|
||||||
|
@ -90,6 +92,7 @@ class NodeTransformer extends BaseTransformer
|
||||||
*
|
*
|
||||||
* @param \Pterodactyl\Models\Node $node
|
* @param \Pterodactyl\Models\Node $node
|
||||||
* @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
|
* @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
|
||||||
|
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
|
||||||
*/
|
*/
|
||||||
public function includeServers(Node $node)
|
public function includeServers(Node $node)
|
||||||
{
|
{
|
||||||
|
|
|
@ -85,6 +85,7 @@ class ServerDatabaseTransformer extends BaseTransformer
|
||||||
*
|
*
|
||||||
* @param \Pterodactyl\Models\Database $model
|
* @param \Pterodactyl\Models\Database $model
|
||||||
* @return \League\Fractal\Resource\Item|\League\Fractal\Resource\NullResource
|
* @return \League\Fractal\Resource\Item|\League\Fractal\Resource\NullResource
|
||||||
|
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
|
||||||
*/
|
*/
|
||||||
public function includeHost(Database $model)
|
public function includeHost(Database $model)
|
||||||
{
|
{
|
||||||
|
|
|
@ -40,6 +40,7 @@ class ServerVariableTransformer extends BaseTransformer
|
||||||
*
|
*
|
||||||
* @param \Pterodactyl\Models\ServerVariable $variable
|
* @param \Pterodactyl\Models\ServerVariable $variable
|
||||||
* @return \League\Fractal\Resource\Item|\League\Fractal\Resource\NullResource
|
* @return \League\Fractal\Resource\Item|\League\Fractal\Resource\NullResource
|
||||||
|
* @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
|
||||||
*/
|
*/
|
||||||
public function includeParent(ServerVariable $variable)
|
public function includeParent(ServerVariable $variable)
|
||||||
{
|
{
|
||||||
|
|
Loading…
Reference in a new issue