Add phpdocs everywhere.

This commit is contained in:
James Cole
2018-07-22 08:10:16 +02:00
parent 4a90ce35f2
commit 4d5bdd25a8
86 changed files with 661 additions and 80 deletions

View File

@@ -44,13 +44,13 @@ class Controller extends BaseController
{
use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
/** @var string */
/** @var string Format for date and time. */
protected $dateTimeFormat;
/** @var string */
/** @var string Format for "23 Feb, 2016". */
protected $monthAndDayFormat;
/** @var string */
/** @var string Format for "March 2018" */
protected $monthFormat;
/** @var string */
/** @var string Redirect user */
protected $redirectUri = '/';
/**
@@ -119,6 +119,10 @@ class Controller extends BaseController
}
/**
* Is transaction opening balance?
*
* TODO move to trait.
*
* @param TransactionJournal $journal
*
* @return bool
@@ -130,6 +134,10 @@ class Controller extends BaseController
/**
* Redirect to asset account that transaction belongs to.
*
* TODO move to trait.
*
* @param TransactionJournal $journal
*
* @return \Illuminate\Http\RedirectResponse|\Illuminate\Routing\Redirector
@@ -153,6 +161,8 @@ class Controller extends BaseController
}
/**
* Remember previous URL.
*
* @param string $identifier
*/
protected function rememberPreviousUri(string $identifier): void
@@ -161,6 +171,10 @@ class Controller extends BaseController
}
/**
* Get user's language.
*
* TODO pretty sure nobody uses this.
*
* @return string
*/
private function getLanguage(): string
@@ -180,6 +194,10 @@ class Controller extends BaseController
}
/**
* Get the specific name of a page for intro.
*
* TODO move to trait.
*
* @return string
*/
private function getSpecificPageName(): string
@@ -188,6 +206,10 @@ class Controller extends BaseController
}
/**
* Returns if user has seen demo.
*
* TODO move to trait.
*
* @return bool
*/
private function hasSeenDemo(): bool