Update doc blocks for all app/
This commit is contained in:
parent
5e27772fef
commit
0312c974f5
114 changed files with 1360 additions and 949 deletions
|
@ -36,6 +36,12 @@ use Pterodactyl\Exceptions\DisplayValidationException;
|
|||
|
||||
class APIController extends Controller
|
||||
{
|
||||
/**
|
||||
* Display base API index page.
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\View\View
|
||||
*/
|
||||
public function index(Request $request)
|
||||
{
|
||||
return view('base.api.index', [
|
||||
|
@ -43,11 +49,23 @@ class APIController extends Controller
|
|||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Display API key creation page.
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\View\View
|
||||
*/
|
||||
public function create(Request $request)
|
||||
{
|
||||
return view('base.api.new');
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle saving new API key.
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\Http\RedirectResponse
|
||||
*/
|
||||
public function save(Request $request)
|
||||
{
|
||||
try {
|
||||
|
@ -71,6 +89,13 @@ class APIController extends Controller
|
|||
return redirect()->route('account.api.new')->withInput();
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle revoking API key.
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @param string $key
|
||||
* @return \Illuminate\Http\JsonResponse|\Illuminate\Http\Response
|
||||
*/
|
||||
public function revoke(Request $request, $key)
|
||||
{
|
||||
try {
|
||||
|
|
|
@ -38,8 +38,8 @@ class AccountController extends Controller
|
|||
/**
|
||||
* Display base account information page.
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\Contracts\View\View
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\View\View
|
||||
*/
|
||||
public function index(Request $request)
|
||||
{
|
||||
|
@ -48,8 +48,10 @@ class AccountController extends Controller
|
|||
|
||||
/**
|
||||
* Update details for a users account.
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return void
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\Http\RedirectResponse
|
||||
* @throws \Symfony\Component\HttpKernel\Exception\HttpException
|
||||
*/
|
||||
public function update(Request $request)
|
||||
{
|
||||
|
|
|
@ -30,19 +30,11 @@ use Pterodactyl\Http\Controllers\Controller;
|
|||
|
||||
class IndexController extends Controller
|
||||
{
|
||||
/**
|
||||
* Controller Constructor.
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
//
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns listing of user's servers.
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\Contracts\View\View
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\View\View
|
||||
*/
|
||||
public function getIndex(Request $request)
|
||||
{
|
||||
|
@ -54,8 +46,10 @@ class IndexController extends Controller
|
|||
/**
|
||||
* Generate a random string.
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @param int $length
|
||||
* @return string
|
||||
* @deprecated
|
||||
*/
|
||||
public function getPassword(Request $request, $length = 16)
|
||||
{
|
||||
|
|
|
@ -32,6 +32,11 @@ use Pterodactyl\Http\Controllers\Controller;
|
|||
|
||||
class LanguageController extends Controller
|
||||
{
|
||||
/**
|
||||
* A list of supported languages on the panel.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $languages = [
|
||||
'de' => 'German',
|
||||
'en' => 'English',
|
||||
|
@ -44,13 +49,12 @@ class LanguageController extends Controller
|
|||
];
|
||||
|
||||
/**
|
||||
* Controller Constructor.
|
||||
* Sets the language for a user.
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @param string $language
|
||||
* @return \Illuminate\Http\RedirectResponse
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
//
|
||||
}
|
||||
|
||||
public function setLanguage(Request $request, $language)
|
||||
{
|
||||
if (array_key_exists($language, $this->languages)) {
|
||||
|
|
|
@ -36,8 +36,8 @@ class SecurityController extends Controller
|
|||
/**
|
||||
* Returns Security Management Page.
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\Contracts\View\View
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\View\View
|
||||
*/
|
||||
public function index(Request $request)
|
||||
{
|
||||
|
@ -50,8 +50,8 @@ class SecurityController extends Controller
|
|||
* Generates TOTP Secret and returns popup data for user to verify
|
||||
* that they can generate a valid response.
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\Contracts\View\View
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function generateTotp(Request $request)
|
||||
{
|
||||
|
@ -73,7 +73,7 @@ class SecurityController extends Controller
|
|||
/**
|
||||
* Verifies that 2FA token recieved is valid and will work on the account.
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\Http\Response
|
||||
*/
|
||||
public function setTotp(Request $request)
|
||||
|
@ -95,8 +95,8 @@ class SecurityController extends Controller
|
|||
/**
|
||||
* Disables TOTP on an account.
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\Http\Response
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\Http\RedirectResponse
|
||||
*/
|
||||
public function disableTotp(Request $request)
|
||||
{
|
||||
|
@ -116,6 +116,13 @@ class SecurityController extends Controller
|
|||
return redirect()->route('account.security');
|
||||
}
|
||||
|
||||
/**
|
||||
* Revokes a user session.
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @param int $id
|
||||
* @return \Illuminate\Http\RedirectResponse
|
||||
*/
|
||||
public function revoke(Request $request, $id)
|
||||
{
|
||||
Session::where('user_id', $request->user()->id)->findOrFail($id)->delete();
|
||||
|
|
Reference in a new issue