From 7d8a12fe21abd36e57ec0b07d95399c2ab9cb4c2 Mon Sep 17 00:00:00 2001 From: Nafies Luthfi Date: Sat, 30 Jun 2018 08:33:42 +0800 Subject: [PATCH] Update some classes docblocks --- .../Controllers/Auth/ChangePasswordController.php | 11 +++++++++++ .../Controllers/Customers/InvoicesController.php | 6 ++++++ .../Controllers/Customers/PaymentsController.php | 6 ++++++ .../Controllers/Customers/ProjectsController.php | 6 ++++++ .../Customers/SubscriptionsController.php | 6 ++++++ app/Http/Controllers/Projects/FeesController.php | 12 ++++++++++++ .../Controllers/Projects/InvoicesController.php | 6 ++++++ app/Http/Controllers/Projects/TasksController.php | 21 +++++++++++++++++++++ app/Http/Requests/Accounts/RegisterRequest.php | 5 +++++ app/Http/Requests/Projects/CreateRequest.php | 5 +++++ 10 files changed, 84 insertions(+) diff --git a/app/Http/Controllers/Auth/ChangePasswordController.php b/app/Http/Controllers/Auth/ChangePasswordController.php index 7b9f1f1..34f698e 100644 --- a/app/Http/Controllers/Auth/ChangePasswordController.php +++ b/app/Http/Controllers/Auth/ChangePasswordController.php @@ -17,11 +17,22 @@ class ChangePasswordController extends Controller $this->middleware('auth'); } + /** + * Show user change password form. + * + * @return \Illuminate\View\View + */ public function show() { return view('auth.passwords.change'); } + /** + * Update user password. + * + * @param \Illuminate\Http\Request $request + * @return \Illuminate\Routing\Redirector + */ public function update(Request $request) { $input = $request->validate([ diff --git a/app/Http/Controllers/Customers/InvoicesController.php b/app/Http/Controllers/Customers/InvoicesController.php index 67e4a04..70b51d5 100644 --- a/app/Http/Controllers/Customers/InvoicesController.php +++ b/app/Http/Controllers/Customers/InvoicesController.php @@ -12,6 +12,12 @@ use App\Http\Controllers\Controller; */ class InvoicesController extends Controller { + /** + * Invoice list of a customer. + * + * @param \App\Entities\Partners\Customer $customer + * @return \Illuminate\View\View + */ public function index(Customer $customer) { $invoices = $customer->invoices()->orderBy('due_date')->get(); diff --git a/app/Http/Controllers/Customers/PaymentsController.php b/app/Http/Controllers/Customers/PaymentsController.php index f15f11d..3298aa4 100644 --- a/app/Http/Controllers/Customers/PaymentsController.php +++ b/app/Http/Controllers/Customers/PaymentsController.php @@ -12,6 +12,12 @@ use App\Http\Controllers\Controller; */ class PaymentsController extends Controller { + /** + * Payment list of a customer. + * + * @param \App\Entities\Partners\Customer $customer + * @return \Illuminate\View\View + */ public function index(Customer $customer) { $payments = $customer->payments() diff --git a/app/Http/Controllers/Customers/ProjectsController.php b/app/Http/Controllers/Customers/ProjectsController.php index 2430c93..0e9b826 100644 --- a/app/Http/Controllers/Customers/ProjectsController.php +++ b/app/Http/Controllers/Customers/ProjectsController.php @@ -12,6 +12,12 @@ use App\Http\Controllers\Controller; */ class ProjectsController extends Controller { + /** + * Project list of a customer. + * + * @param \App\Entities\Partners\Customer $customer + * @return \Illuminate\View\View + */ public function index(Customer $customer) { $projects = $customer->projects; diff --git a/app/Http/Controllers/Customers/SubscriptionsController.php b/app/Http/Controllers/Customers/SubscriptionsController.php index f6c4152..a272c2a 100644 --- a/app/Http/Controllers/Customers/SubscriptionsController.php +++ b/app/Http/Controllers/Customers/SubscriptionsController.php @@ -12,6 +12,12 @@ use App\Http\Controllers\Controller; */ class SubscriptionsController extends Controller { + /** + * Subscription list of a customer. + * + * @param \App\Entities\Partners\Customer $customer + * @return \Illuminate\View\View + */ public function index(Customer $customer) { $subscriptions = $customer->subscriptions()->orderBy('due_date')->get(); diff --git a/app/Http/Controllers/Projects/FeesController.php b/app/Http/Controllers/Projects/FeesController.php index 9d296fc..5140c4a 100644 --- a/app/Http/Controllers/Projects/FeesController.php +++ b/app/Http/Controllers/Projects/FeesController.php @@ -14,6 +14,12 @@ use App\Http\Controllers\Controller; */ class FeesController extends Controller { + /** + * Show create project fee form. + * + * @param \App\Entities\Projects\Project $project + * @return \Illuminate\View\View + */ public function create(Project $project) { $this->authorize('create', new Payment()); @@ -23,6 +29,12 @@ class FeesController extends Controller return view('projects.fees.create', compact('project', 'partners')); } + /** + * Store new fee entry to the database. + * + * @param \App\Entities\Projects\Project $project + * @return \Illuminate\Routing\Redirector + */ public function store(Project $project) { $this->authorize('create', new Payment()); diff --git a/app/Http/Controllers/Projects/InvoicesController.php b/app/Http/Controllers/Projects/InvoicesController.php index 9fca613..da46d81 100644 --- a/app/Http/Controllers/Projects/InvoicesController.php +++ b/app/Http/Controllers/Projects/InvoicesController.php @@ -12,6 +12,12 @@ use App\Http\Controllers\Controller; */ class InvoicesController extends Controller { + /** + * Invoice list of a project. + * + * @param \App\Entities\Projects\Project $project + * @return \Illuminate\View\View + */ public function index(Project $project) { $this->authorize('view-invoices', $project); diff --git a/app/Http/Controllers/Projects/TasksController.php b/app/Http/Controllers/Projects/TasksController.php index fa6b2fc..2511800 100755 --- a/app/Http/Controllers/Projects/TasksController.php +++ b/app/Http/Controllers/Projects/TasksController.php @@ -16,6 +16,13 @@ use App\Http\Requests\Tasks\UpdateRequest; */ class TasksController extends Controller { + /** + * Store a created job task to the database. + * + * @param \App\Http\Requests\Tasks\CreateRequest $request + * @param \App\Entities\Projects\Job $job + * @return \Illuminate\Routing\Redirector + */ public function store(CreateRequest $request, Job $job) { $newTask = $request->validated(); @@ -27,6 +34,13 @@ class TasksController extends Controller return redirect()->route('jobs.show', $job); } + /** + * Update a task on the database. + * + * @param \App\Http\Requests\Tasks\UpdateRequest $request + * @param \App\Entities\Projects\Task $task + * @return \Illuminate\Routing\Redirector + */ public function update(UpdateRequest $request, Task $task) { $task->update($request->validated()); @@ -36,6 +50,13 @@ class TasksController extends Controller return redirect()->route('jobs.show', $task->job_id); } + /** + * Delete task from the database. + * + * @param \App\Http\Requests\Tasks\DeleteRequest $request + * @param \App\Entities\Projects\Task $task + * @return \Illuminate\Routing\Redirector + */ public function destroy(DeleteRequest $request, Task $task) { if ($task->id == $request->get('task_id')) { diff --git a/app/Http/Requests/Accounts/RegisterRequest.php b/app/Http/Requests/Accounts/RegisterRequest.php index b9d8633..3c4b6de 100644 --- a/app/Http/Requests/Accounts/RegisterRequest.php +++ b/app/Http/Requests/Accounts/RegisterRequest.php @@ -33,6 +33,11 @@ class RegisterRequest extends Request ]; } + /** + * Get custom messages for validator errors. + * + * @return array + */ public function messages() { return [ diff --git a/app/Http/Requests/Projects/CreateRequest.php b/app/Http/Requests/Projects/CreateRequest.php index d0044e8..eccd8a5 100644 --- a/app/Http/Requests/Projects/CreateRequest.php +++ b/app/Http/Requests/Projects/CreateRequest.php @@ -35,6 +35,11 @@ class CreateRequest extends Request ]; } + /** + * Get custom messages for validator errors. + * + * @return array + */ public function messages() { return [