PHPDoc the methods

This commit is contained in:
James Brooks
2014-12-01 08:38:26 +00:00
parent 13b858a99e
commit 4762864c6f
5 changed files with 29 additions and 5 deletions

View File

@@ -4,10 +4,18 @@
* Logs users into their account
*/
class AuthController extends Controller {
/**
* Shows the login view.
* @return \Illuminate\View\View
*/
public function showLogin() {
return View::make('auth.login');
}
/**
* Logs the user in.
* @return \Illuminate\Http\RedirectResponse
*/
public function postLogin() {
if (Auth::attempt(Input::only(['email', 'password']))) {
return Redirect::intended('dashboard');
@@ -18,9 +26,12 @@ class AuthController extends Controller {
}
}
/**
* Logs the user out, deleting their session etc.
* @return \Illuminate\Http\RedirectResponse
*/
public function logoutAction() {
Auth::logout();
return Redirect::to('/');
}
}

View File

@@ -1,9 +1,10 @@
<?php
/**
* AKA the Management Panel.
*/
class DashboardController extends Controller {
/**
* Shows the dashboard view.
* @return \Illuminate\View\View
*/
public function showDashboard() {
return View::make('dashboard.index');
}

View File

@@ -3,7 +3,7 @@
class HomeController extends Controller {
/**
* Returns the rendered Blade templates.
* @return View
* @return \Illuminate\View\View
*/
public function showIndex() {
return View::make('index', ['components' => Component::all()]);

View File

@@ -1,6 +1,10 @@
<?php
class RSSController extends Controller {
/**
* Generates an RSS feed of all incidents.
* @return \Illuminate\Http\Response
*/
public function feedAction() {
$feed = RSS::feed('2.0', 'UTF-8');
$feed->channel([

View File

@@ -1,12 +1,20 @@
<?php
class SetupController extends Controller {
/**
* Returns the setup page.
* @return \Illuminate\View\View
*/
public function showSetup() {
return View::make('setup')->with([
'pageTitle' => 'Setup'
]);
}
/**
* Handles the actual app setup.
* @return \Illuminate\Http\RedirectResponse
*/
public function setupCachet() {
$postData = Input::get();
$v = Validator::make($postData, [