Merge pull request #1148 from pterodactyl/feature/doc-block-improvements
@throws docblock improvements
This commit is contained in:
commit
00df0b66a6
23 changed files with 47 additions and 15 deletions
|
@ -12,6 +12,7 @@ class CommandRepository extends BaseRepository implements CommandRepositoryInter
|
|||
*
|
||||
* @param string $command
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||
*/
|
||||
public function send(string $command): ResponseInterface
|
||||
{
|
||||
|
|
|
@ -12,6 +12,7 @@ class ConfigurationRepository extends BaseRepository implements ConfigurationRep
|
|||
*
|
||||
* @param array $overrides
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||
*/
|
||||
public function update(array $overrides = []): ResponseInterface
|
||||
{
|
||||
|
|
|
@ -14,7 +14,7 @@ class FileRepository extends BaseRepository implements FileRepositoryInterface
|
|||
* @param string $path
|
||||
* @return \stdClass
|
||||
*
|
||||
* @throws \GuzzleHttp\Exception\RequestException
|
||||
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||
*/
|
||||
public function getFileStat(string $path): stdClass
|
||||
{
|
||||
|
@ -35,7 +35,7 @@ class FileRepository extends BaseRepository implements FileRepositoryInterface
|
|||
* @param string $path
|
||||
* @return string
|
||||
*
|
||||
* @throws \GuzzleHttp\Exception\RequestException
|
||||
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||
*/
|
||||
public function getContent(string $path): string
|
||||
{
|
||||
|
@ -57,7 +57,7 @@ class FileRepository extends BaseRepository implements FileRepositoryInterface
|
|||
* @param string $content
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
*
|
||||
* @throws \GuzzleHttp\Exception\RequestException
|
||||
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||
*/
|
||||
public function putContent(string $path, string $content): ResponseInterface
|
||||
{
|
||||
|
@ -78,7 +78,7 @@ class FileRepository extends BaseRepository implements FileRepositoryInterface
|
|||
* @param string $path
|
||||
* @return array
|
||||
*
|
||||
* @throws \GuzzleHttp\Exception\RequestException
|
||||
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||
*/
|
||||
public function getDirectory(string $path): array
|
||||
{
|
||||
|
|
|
@ -14,7 +14,8 @@ class PowerRepository extends BaseRepository implements PowerRepositoryInterface
|
|||
* @param string $signal
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
*
|
||||
* @throws \Pterodactyl\Exceptions\Repository\Daemon\InvalidPowerSignalException
|
||||
* @throws InvalidPowerSignalException
|
||||
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||
*/
|
||||
public function sendSignal(string $signal): ResponseInterface
|
||||
{
|
||||
|
|
|
@ -15,7 +15,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
|||
* @param array $overrides
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
*
|
||||
* @throws \GuzzleHttp\Exception\RequestException
|
||||
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||
*/
|
||||
public function create(array $structure, array $overrides = []): ResponseInterface
|
||||
{
|
||||
|
@ -33,6 +33,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
|||
*
|
||||
* @param array $data
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||
*/
|
||||
public function update(array $data): ResponseInterface
|
||||
{
|
||||
|
@ -46,6 +47,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
|||
*
|
||||
* @param array|null $data
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||
*/
|
||||
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.
|
||||
*
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||
*/
|
||||
public function rebuild(): ResponseInterface
|
||||
{
|
||||
|
@ -68,6 +71,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
|||
* Suspend a server on the daemon.
|
||||
*
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||
*/
|
||||
public function suspend(): ResponseInterface
|
||||
{
|
||||
|
@ -78,6 +82,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
|||
* Un-suspend a server on the daemon.
|
||||
*
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||
*/
|
||||
public function unsuspend(): ResponseInterface
|
||||
{
|
||||
|
@ -88,6 +93,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
|||
* Delete a server on the daemon.
|
||||
*
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||
*/
|
||||
public function delete(): ResponseInterface
|
||||
{
|
||||
|
@ -98,6 +104,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
|||
* Return details on a specific server.
|
||||
*
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||
*/
|
||||
public function details(): ResponseInterface
|
||||
{
|
||||
|
@ -110,7 +117,7 @@ class ServerRepository extends BaseRepository implements ServerRepositoryInterfa
|
|||
* @param string|array $key
|
||||
* @return \Psr\Http\Message\ResponseInterface
|
||||
*
|
||||
* @throws \GuzzleHttp\Exception\RequestException
|
||||
* @throws \GuzzleHttp\Exception\GuzzleException
|
||||
*/
|
||||
public function revokeAccessKey($key): ResponseInterface
|
||||
{
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue