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

@@ -53,6 +53,8 @@ class AuthenticateTwoFactor
/**
* Handle 2FA request.
*
* @param $request
* @param Closure $next
*

View File

@@ -28,7 +28,7 @@ use Illuminate\Contracts\Auth\Factory as Auth;
use Illuminate\Routing\Route;
/**
* Class HttpBinder
* Class Binder
*/
class Binder
{
@@ -39,6 +39,8 @@ class Binder
*/
protected $auth;
/**
* The binders.
*
* @var array
*/
protected $binders = [];
@@ -77,6 +79,8 @@ class Binder
}
/**
* Do the binding.
*
* @param $key
* @param $value
* @param $route

View File

@@ -25,8 +25,9 @@ namespace FireflyIII\Http\Middleware;
use Illuminate\Cookie\Middleware\EncryptCookies as Middleware;
/**
* @codeCoverageIgnore
* Class EncryptCookies
*
* @codeCoverageIgnore
*/
class EncryptCookies extends Middleware
{

View File

@@ -99,6 +99,8 @@ class Installer
}
/**
* Is access denied error.
*
* @param string $message
*
* @return bool
@@ -109,6 +111,8 @@ class Installer
}
/**
* Is no tables exist error.
*
* @param string $message
*
* @return bool

View File

@@ -25,7 +25,7 @@ namespace FireflyIII\Http\Middleware;
use Closure;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Session;
/**
* Class IsSandStormUser.

View File

@@ -61,7 +61,7 @@ class Range
}
/**
*
* Configure the list length.
*/
private function configureList(): void
{
@@ -70,7 +70,7 @@ class Range
}
/**
*
* Configure the user's view.
*/
private function configureView(): void
{
@@ -101,6 +101,8 @@ class Range
}
/**
* Error when sqlite in docker.
*
* @param Request $request
*/
private function loseItAll(Request $request): void
@@ -113,6 +115,8 @@ class Range
}
/**
* Set the range for the current view.
*
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
private function setRange(): void

View File

@@ -26,8 +26,9 @@ use Closure;
use Illuminate\Support\Facades\Auth;
/**
* @codeCoverageIgnore
* Class RedirectIfAuthenticated
*
* @codeCoverageIgnore
*/
class RedirectIfAuthenticated
{

View File

@@ -60,7 +60,7 @@ class Sandstorm
$repository = app(UserRepositoryInterface::class);
$userId = (string)$request->header('X-Sandstorm-User-Id');
// catch anonymous:
$userId = $userId === '' ? 'anonymous' : $userId;
$userId = '' === $userId ? 'anonymous' : $userId;
$email = $userId . '@firefly';
$user = $repository->findByEmail($email) ?? $this->createUser($email);
Log::debug(sprintf('Sandstorm user email is "%s"', $email));
@@ -75,6 +75,8 @@ class Sandstorm
/**
* Create a user.
*
* @param string $email
*
* @return User

View File

@@ -26,8 +26,9 @@ use Illuminate\Http\Request;
use Illuminate\Session\Middleware\StartSession;
/**
* @codeCoverageIgnore
* Class StartFireflySession.
*
* @codeCoverageIgnore
*/
class StartFireflySession extends StartSession
{

View File

@@ -25,8 +25,9 @@ namespace FireflyIII\Http\Middleware;
use Illuminate\Foundation\Http\Middleware\TrimStrings as Middleware;
/**
* @codeCoverageIgnore
* Class TrimStrings
*
* @codeCoverageIgnore
*/
class TrimStrings extends Middleware
{

View File

@@ -27,12 +27,13 @@ use Illuminate\Contracts\Config\Repository;
use Illuminate\Http\Request;
/**
* @codeCoverageIgnore
* Class TrustProxies
*
* @codeCoverageIgnore
*/
class TrustProxies extends Middleware
{
/** @var int */
/** @var int The headers to check. */
protected $headers = Request::HEADER_X_FORWARDED_ALL;
/**

View File

@@ -25,8 +25,9 @@ namespace FireflyIII\Http\Middleware;
use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as Middleware;
/**
* Class VerifyCsrfToken.
*
* @codeCoverageIgnore
* Class VerifyCsrfToken
*/
class VerifyCsrfToken extends Middleware
{