Nette: added missing docblocks, unified php file headings

RodionSlepnev · Nov 19, 2015 · 4b8a075 · 4b8a075
1 parent 864cf93
commit 4b8a075
Show file tree

Hide file tree

Showing 27 changed files with 98 additions and 30 deletions.
diff --git a/nette/notejam/app/components/Notes/INotesFactory.php b/nette/notejam/app/components/Notes/INotesFactory.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Components\Notes;
 
 use Nette\Database\Table\Selection;

diff --git a/nette/notejam/app/components/Notes/Notes.php b/nette/notejam/app/components/Notes/Notes.php
@@ -1,9 +1,7 @@
 <?php
 
-
 namespace App\Components\Notes;
 
-
 use Nette;
 use Nette\Database\Table\Selection;
 

diff --git a/nette/notejam/app/components/Pads/IPadsFactory.php b/nette/notejam/app/components/Pads/IPadsFactory.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Components\Pads;
 
 

diff --git a/nette/notejam/app/components/Pads/Pads.php b/nette/notejam/app/components/Pads/Pads.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Components\Pads;
 
 use Nette\Application\UI\Control;

diff --git a/nette/notejam/app/components/UserBar/IUserBarFactory.php b/nette/notejam/app/components/UserBar/IUserBarFactory.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Components\UserBar;
 
 

diff --git a/nette/notejam/app/components/UserBar/UserBar.php b/nette/notejam/app/components/UserBar/UserBar.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Components\UserBar;
 
 use Nette;

diff --git a/nette/notejam/app/forms/Account/AccountSettingsFormFactory.php b/nette/notejam/app/forms/Account/AccountSettingsFormFactory.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Forms\Account;
 
 use App\Model\CurrentPasswordMismatch;

diff --git a/nette/notejam/app/forms/Note/DeleteNoteFormFactory.php b/nette/notejam/app/forms/Note/DeleteNoteFormFactory.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Forms\Note;
 
 use App\Model\NoteManager;

diff --git a/nette/notejam/app/forms/Note/EditNoteFormFactory.php b/nette/notejam/app/forms/Note/EditNoteFormFactory.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Forms\Note;
 
 use App\Model\NoteManager;

diff --git a/nette/notejam/app/forms/Note/NewNoteFormFactory.php b/nette/notejam/app/forms/Note/NewNoteFormFactory.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Forms\Note;
 
 use App\Model\NoteManager;

diff --git a/nette/notejam/app/forms/Pad/DeletePadFormFactory.php b/nette/notejam/app/forms/Pad/DeletePadFormFactory.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Forms\Pad;
 
 use Nette;

diff --git a/nette/notejam/app/forms/Pad/EditPadFormFactory.php b/nette/notejam/app/forms/Pad/EditPadFormFactory.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Forms\Pad;
 
 use Nette;

diff --git a/nette/notejam/app/forms/Pad/NewPadFormFactory.php b/nette/notejam/app/forms/Pad/NewPadFormFactory.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Forms\Pad;
 
 use Nette;

diff --git a/nette/notejam/app/forms/Sign/ForgottenPasswordFormFactory.php b/nette/notejam/app/forms/Sign/ForgottenPasswordFormFactory.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Forms\Sign;
 
 use App\Model\UserManager;

diff --git a/nette/notejam/app/forms/Sign/SignUpFormFactory.php b/nette/notejam/app/forms/Sign/SignUpFormFactory.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Forms\Sign;
 
 use App\Model\DuplicateNameException;

diff --git a/nette/notejam/app/helpers/OrderHelper.php b/nette/notejam/app/helpers/OrderHelper.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Helpers;
 
 

diff --git a/nette/notejam/app/model/NoteManager.php b/nette/notejam/app/model/NoteManager.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Model;
 
 use Nette;

diff --git a/nette/notejam/app/model/PadManager.php b/nette/notejam/app/model/PadManager.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Model;
 
 use Nette;

diff --git a/nette/notejam/app/model/UserManager.php b/nette/notejam/app/model/UserManager.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Model;
 
 use Nette;

diff --git a/nette/notejam/app/presenters/AccountPresenter.php b/nette/notejam/app/presenters/AccountPresenter.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Presenters;
 
 use Nette;
@@ -13,7 +12,6 @@ class AccountPresenter extends BasePresenter
 	/** @var AccountSettingsFormFactory @inject */
 	public $formFactory;
 
-
 	/**
 	 * Sign-in form factory.
 	 * @return Nette\Application\UI\Form

diff --git a/nette/notejam/app/presenters/Error4xxPresenter.php b/nette/notejam/app/presenters/Error4xxPresenter.php
@@ -8,6 +8,9 @@
 class Error4xxPresenter extends BasePresenter
 {
 
+	/**
+	 * @param \Exception $exception
+	 */
 	public function renderDefault(\Exception $exception)
 	{
 		// load template 403.latte or 404.latte or ... 4xx.latte

diff --git a/nette/notejam/app/presenters/ErrorPresenter.php b/nette/notejam/app/presenters/ErrorPresenter.php
@@ -8,16 +8,19 @@
 
 class ErrorPresenter extends Nette\Object implements Nette\Application\IPresenter
 {
+
 	/** @var ILogger */
 	private $logger;
 
-
+	/**
+	 * ErrorPresenter constructor.
+	 * @param ILogger $logger
+	 */
 	public function __construct(ILogger $logger)
 	{
 		$this->logger = $logger;
 	}
 
-
 	/**
 	 * @return Nette\Application\IResponse
 	 */

diff --git a/nette/notejam/app/presenters/HomepagePresenter.php b/nette/notejam/app/presenters/HomepagePresenter.php
@@ -20,6 +20,9 @@ class HomepagePresenter extends SecuredBasePresenter
 	/** @var object[] */
 	protected $notes;
 
+
+	/********************* Controls ***********************************************************************************/
+
 	/**
 	 * @return \App\Components\Notes\Notes
 	 */
@@ -28,6 +31,12 @@ protected function createComponentNotes()
 		return $this->notesFactory->create($this->notes);
 	}
 
+	/********************* Actions ************************************************************************************/
+
+	/**
+	 * Homepage:default.
+	 * @param string $order
+	 */
 	public function actionDefault($order)
 	{
 		$this->notes = $this->noteManager->findAll();
@@ -36,6 +45,9 @@ public function actionDefault($order)
 		}
 	}
 
+	/**
+	 * Homepage:default render.
+	 */
 	public function renderDefault()
 	{
 		$this->template->notes = $this->notes;

diff --git a/nette/notejam/app/presenters/NotePresenter.php b/nette/notejam/app/presenters/NotePresenter.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Presenters;
 
 use App\Forms\Note\DeleteNoteFormFactory;
@@ -43,6 +42,9 @@ class NotePresenter extends SecuredBasePresenter
 	/** @var object[] */
 	private $notes;
 
+
+	/********************* Controls ***********************************************************************************/
+
 	/**
 	 * @return \Nette\Application\UI\Form
 	 */
@@ -97,44 +99,74 @@ protected function createComponentNewNoteForm()
 		return $form;
 	}
 
+	/********************* Actions ************************************************************************************/
 
+	/**
+	 * Note:default.
+	 * @param int $id
+	 * @throws BadRequestException
+	 */
 	public function actionDefault($id)
 	{
 		$this->loadNote($id);
 		$this->notes = $this->noteManager->findByPad($id);
 	}
 
+	/**
+	 * Note:default render.
+	 */
 	public function renderDefault()
 	{
 		$this->template->note = $this->note;
 	}
 
+	/**
+	 * Note:edit.
+	 * @param int $id
+	 * @throws BadRequestException
+	 */
 	public function actionEdit($id)
 	{
 		$this->loadNote($id);
 	}
 
+	/**
+	 * Note:edit render.
+	 */
 	public function renderEdit()
 	{
 		$this->template->note = $this->note;
 	}
 
+	/**
+	 * Note:delete.
+	 * @param int $id
+	 * @throws BadRequestException
+	 */
 	public function actionDelete($id)
 	{
 		$this->loadNote($id);
 	}
 
+	/**
+	 * Note:delete render.
+	 */
 	public function renderDelete()
 	{
 		$this->template->note = $this->note;
 	}
 
+	/**
+	 * Note:new.
+	 * @param int $pad
+	 */
 	public function actionNew($pad)
 	{
 		$this->padId = $pad;
 	}
 
 	/**
+	 * Loads note with given id and if not found, throws BadRequestException.
 	 * @param int $id
 	 * @throws BadRequestException
 	 */
@@ -147,5 +179,4 @@ private function loadNote($id)
 		}
 	}
 
-
 }
diff --git a/nette/notejam/app/presenters/PadPresenter.php b/nette/notejam/app/presenters/PadPresenter.php
@@ -1,6 +1,5 @@
 <?php
 
-
 namespace App\Presenters;
 
 use App\Components\Notes\INotesFactory;
@@ -43,6 +42,8 @@ class PadPresenter extends SecuredBasePresenter
 	/** @var object[] */
 	private $notes;
 
+	/********************* Controls ***********************************************************************************/
+
 	/**
 	 * @return \Nette\Application\UI\Form
 	 */
@@ -106,6 +107,14 @@ protected function createComponentNotes()
 	}
 
 
+	/********************* Actions ************************************************************************************/
+
+	/**
+	 * Pad:default.
+	 * @param int         $id
+	 * @param string|null $order
+	 * @throws BadRequestException
+	 */
 	public function actionDefault($id, $order)
 	{
 		$this->loadPad($id);
@@ -115,32 +124,52 @@ public function actionDefault($id, $order)
 		}
 	}
 
+	/**
+	 * Pad:default render.
+	 */
 	public function renderDefault()
 	{
 		$this->template->pad = $this->pad;
 	}
 
+	/**
+	 * Pad:edit.
+	 * @param int $id
+	 * @throws BadRequestException
+	 */
 	public function actionEdit($id)
 	{
 		$this->loadPad($id);
 	}
 
+	/**
+	 * Pad:edit render.
+	 */
 	public function renderEdit()
 	{
 		$this->template->pad = $this->pad;
 	}
 
+	/**
+	 * Pad:delete.
+	 * @param int $id
+	 * @throws BadRequestException
+	 */
 	public function actionDelete($id)
 	{
 		$this->loadPad($id);
 	}
 
+	/**
+	 * Pad:delete render.
+	 */
 	public function renderDelete()
 	{
 		$this->template->pad = $this->pad;
 	}
 
 	/**
+	 * Loads pad with given id and if not found, throws BadRequestException.
 	 * @param int $id
 	 * @throws BadRequestException
 	 */
Original file line number	Diff line number	Diff line change
		@@ -1,6 +1,5 @@
		<?php


		namespace App\Components\Pads;


Expand Down
Original file line number	Diff line number	Diff line change
		@@ -1,6 +1,5 @@
		<?php


		namespace App\Components\UserBar;


Expand Down