Did some code cleanup. Comments and headers mostly.

This commit is contained in:
James Cole 2016-01-09 08:20:55 +01:00
parent 9ff0b282f3
commit 2980860377
32 changed files with 198 additions and 69 deletions

View File

@ -1,10 +1,22 @@
<?php
/**
* Kernel.php
* Copyright (C) 2016 Sander Dorigo
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
namespace FireflyIII\Console;
use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;
/**
* Class Kernel
*
* @package FireflyIII\Console
*/
class Kernel extends ConsoleKernel
{
/**

View File

@ -2,6 +2,11 @@
namespace FireflyIII\Events;
/**
* Class Event
*
* @package FireflyIII\Events
*/
abstract class Event
{
//

View File

@ -5,11 +5,15 @@ namespace FireflyIII\Exceptions;
use Exception;
use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Symfony\Component\HttpKernel\Exception\HttpException;
use Illuminate\Foundation\Validation\ValidationException;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
use Illuminate\Foundation\Validation\ValidationException;
use Symfony\Component\HttpKernel\Exception\HttpException;
/**
* Class Handler
*
* @package FireflyIII\Exceptions
*/
class Handler extends ExceptionHandler
{
/**
@ -17,19 +21,21 @@ class Handler extends ExceptionHandler
*
* @var array
*/
protected $dontReport = [
AuthorizationException::class,
HttpException::class,
ModelNotFoundException::class,
ValidationException::class,
];
protected $dontReport
= [
AuthorizationException::class,
HttpException::class,
ModelNotFoundException::class,
ValidationException::class,
];
/**
* Report or log an exception.
*
* This is a great spot to send exceptions to Sentry, Bugsnag, etc.
*
* @param \Exception $e
* @param \Exception $e
*
* @return void
*/
public function report(Exception $e)
@ -40,8 +46,9 @@ class Handler extends ExceptionHandler
/**
* Render an exception into an HTTP response.
*
* @param \Illuminate\Http\Request $request
* @param \Exception $e
* @param \Illuminate\Http\Request $request
* @param \Exception $e
*
* @return \Illuminate\Http\Response
*/
public function render($request, Exception $e)

View File

@ -511,4 +511,4 @@ class ReportHelper implements ReportHelperInterface
return $sum;
}
}
}

View File

@ -18,6 +18,11 @@ use Session;
use Validator;
/**
* Class AuthController
*
* @package FireflyIII\Http\Controllers\Auth
*/
class AuthController extends Controller
{
use AuthenticatesAndRegistersUsers, ThrottlesLogins;
@ -32,11 +37,11 @@ class AuthController extends Controller
/**
* Create a new authentication controller instance.
*
* @return void
*/
public function __construct()
{
$this->middleware('guest', ['except' => 'logout']);
parent::__construct();
}
/**
@ -113,6 +118,8 @@ class AuthController extends Controller
*
* @param \Illuminate\Http\Request $request
*
* @param $message
*
* @return \Illuminate\Http\Response
*/
protected function sendFailedLoginResponse(Request $request, $message)
@ -129,6 +136,8 @@ class AuthController extends Controller
/**
* Get the failed login message.
*
* @param $message
*
* @return string
*/
protected function getFailedLoginMessage($message)

View File

@ -10,6 +10,11 @@ use Illuminate\Mail\Message;
use Illuminate\Support\Facades\Password;
/**
* Class PasswordController
*
* @package FireflyIII\Http\Controllers\Auth
*/
class PasswordController extends Controller
{
/*
@ -28,7 +33,6 @@ class PasswordController extends Controller
/**
* Create a new password controller instance.
*
* @return void
*/
public function __construct()
{

View File

@ -11,6 +11,9 @@ use Response;
*/
class HelpController extends Controller
{
/**
* HelpController constructor.
*/
public function __construct()
{
parent::__construct();

View File

@ -18,6 +18,9 @@ use Steam;
*/
class HomeController extends Controller
{
/**
* HomeController constructor.
*/
public function __construct()
{
parent::__construct();

View File

@ -20,6 +20,9 @@ use Session;
*/
class JsonController extends Controller
{
/**
* JsonController constructor.
*/
public function __construct()
{
parent::__construct();

View File

@ -17,6 +17,9 @@ use View;
*/
class NewUserController extends Controller
{
/**
* NewUserController constructor.
*/
public function __construct()
{
parent::__construct();

View File

@ -15,6 +15,9 @@ use Session;
*/
class ProfileController extends Controller
{
/**
* ProfileController constructor.
*/
public function __construct()
{
parent::__construct();

View File

@ -10,6 +10,9 @@ use Input;
*/
class SearchController extends Controller
{
/**
* SearchController constructor.
*/
public function __construct()
{
parent::__construct();

View File

@ -2,8 +2,24 @@
namespace FireflyIII\Http;
use FireflyIII\Http\Middleware\Authenticate;
use FireflyIII\Http\Middleware\EncryptCookies;
use FireflyIII\Http\Middleware\Range;
use FireflyIII\Http\Middleware\RedirectIfAuthenticated;
use FireflyIII\Http\Middleware\VerifyCsrfToken;
use Illuminate\Auth\Middleware\AuthenticateWithBasicAuth;
use Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse;
use Illuminate\Foundation\Http\Kernel as HttpKernel;
use Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode;
use Illuminate\Routing\Middleware\ThrottleRequests;
use Illuminate\Session\Middleware\StartSession;
use Illuminate\View\Middleware\ShareErrorsFromSession;
/**
* Class Kernel
*
* @package FireflyIII\Http
*/
class Kernel extends HttpKernel
{
/**
@ -15,7 +31,7 @@ class Kernel extends HttpKernel
*/
protected $middleware
= [
\Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode::class,
CheckForMaintenanceMode::class,
];
/**
@ -26,28 +42,28 @@ class Kernel extends HttpKernel
protected $middlewareGroups
= [
'web' => [
\FireflyIII\Http\Middleware\EncryptCookies::class,
\Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
\Illuminate\Session\Middleware\StartSession::class,
\Illuminate\View\Middleware\ShareErrorsFromSession::class,
\FireflyIII\Http\Middleware\VerifyCsrfToken::class,
EncryptCookies::class,
AddQueuedCookiesToResponse::class,
StartSession::class,
ShareErrorsFromSession::class,
VerifyCsrfToken::class,
],
'web-auth' => [
\FireflyIII\Http\Middleware\EncryptCookies::class,
\Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
\Illuminate\Session\Middleware\StartSession::class,
\Illuminate\View\Middleware\ShareErrorsFromSession::class,
\FireflyIII\Http\Middleware\VerifyCsrfToken::class,
\FireflyIII\Http\Middleware\Authenticate::class,
EncryptCookies::class,
AddQueuedCookiesToResponse::class,
StartSession::class,
ShareErrorsFromSession::class,
VerifyCsrfToken::class,
Authenticate::class,
],
'web-auth-range' => [
\FireflyIII\Http\Middleware\EncryptCookies::class,
\Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
\Illuminate\Session\Middleware\StartSession::class,
\Illuminate\View\Middleware\ShareErrorsFromSession::class,
\FireflyIII\Http\Middleware\VerifyCsrfToken::class,
\FireflyIII\Http\Middleware\Authenticate::class,
\FireflyIII\Http\Middleware\Range::class,
EncryptCookies::class,
AddQueuedCookiesToResponse::class,
StartSession::class,
ShareErrorsFromSession::class,
VerifyCsrfToken::class,
Authenticate::class,
Range::class,
],
'api' => [
@ -64,10 +80,10 @@ class Kernel extends HttpKernel
*/
protected $routeMiddleware
= [
'auth' => \FireflyIII\Http\Middleware\Authenticate::class,
'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,
'guest' => \FireflyIII\Http\Middleware\RedirectIfAuthenticated::class,
'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,
'range' => \FireflyIII\Http\Middleware\Range::class,
'auth' => Authenticate::class,
'auth.basic' => AuthenticateWithBasicAuth::class,
'guest' => RedirectIfAuthenticated::class,
'throttle' => ThrottleRequests::class,
'range' => Range::class,
];
}

View File

@ -2,12 +2,14 @@
namespace FireflyIII\Http\Middleware;
use App;
use Carbon\Carbon;
use Closure;
use Illuminate\Support\Facades\Auth;
use Preferences;
/**
* Class Authenticate
*
* @package FireflyIII\Http\Middleware
*/
class Authenticate
{
/**

View File

@ -4,6 +4,11 @@ namespace FireflyIII\Http\Middleware;
use Illuminate\Cookie\Middleware\EncryptCookies as BaseEncrypter;
/**
* Class EncryptCookies
*
* @package FireflyIII\Http\Middleware
*/
class EncryptCookies extends BaseEncrypter
{
/**

View File

@ -42,10 +42,11 @@ class Range
* Handle an incoming request.
*
* @param \Illuminate\Http\Request $request
* @param \Closure $next
* @param Closure $theNext
* @param string|null $guard
*
* @return mixed
* @internal param Closure $next
*/
public function handle($request, Closure $theNext, $guard = null)
{

View File

@ -4,8 +4,12 @@ namespace FireflyIII\Http\Middleware;
use Closure;
use Illuminate\Support\Facades\Auth;
use Log;
/**
* Class RedirectIfAuthenticated
*
* @package FireflyIII\Http\Middleware
*/
class RedirectIfAuthenticated
{
/**

View File

@ -3,6 +3,11 @@ namespace FireflyIII\Http\Middleware;
use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as BaseVerifier;
/**
* Class VerifyCsrfToken
*
* @package FireflyIII\Http\Middleware
*/
class VerifyCsrfToken extends BaseVerifier
{
/**
@ -14,4 +19,4 @@ class VerifyCsrfToken extends BaseVerifier
= [
//
];
}
}

View File

@ -4,6 +4,11 @@ namespace FireflyIII\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
/**
* Class Request
*
* @package FireflyIII\Http\Requests
*/
abstract class Request extends FormRequest
{
//

View File

@ -4,6 +4,11 @@ namespace FireflyIII\Jobs;
use Illuminate\Bus\Queueable;
/**
* Class Job
*
* @package FireflyIII\Jobs
*/
abstract class Job
{
/*

View File

@ -11,28 +11,32 @@ use Illuminate\Database\Query\Builder;
use Illuminate\Database\Query\JoinClause;
use Watson\Validating\ValidatingTrait;
/**
* FireflyIII\Models\Account
*
* @property integer $id
* @property Carbon $created_at
* @property Carbon $updated_at
* @property Carbon $deleted_at
* @property integer $user_id
* @property integer $account_type_id
* @property string $name
* @property boolean $active
* @property boolean $encrypted
* @property float $virtual_balance
* @property string $iban
* @property-read Collection|AccountMeta[] $accountMeta
* @property-read AccountType $accountType
* @property-read mixed $name_for_editform
* @property-read Collection|PiggyBank[] $piggyBanks
* @property-read Collection|Transaction[] $transactions
* @property-read User $user
* @method static Builder|Account accountTypeIn($types)
* @method static Builder|Account hasMetaValue($name, $value)
* @property integer $id
* @property \Carbon\Carbon $created_at
* @property \Carbon\Carbon $updated_at
* @property \Carbon\Carbon $deleted_at
* @property integer $user_id
* @property integer $account_type_id
* @property string $name
* @property boolean $active
* @property boolean $encrypted
* @property float $virtual_balance
* @property string $iban
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\AccountMeta[] $accountMeta
* @property-read \FireflyIII\Models\AccountType $accountType
* @property-read mixed $name_for_editform
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\PiggyBank[] $piggyBanks
* @property-read \Illuminate\Database\Eloquent\Collection|\FireflyIII\Models\Transaction[] $transactions
* @property-read \FireflyIII\User $user
* @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account accountTypeIn($types)
* @method static \Illuminate\Database\Query\Builder|\FireflyIII\Models\Account hasMetaValue($name, $value)
* @property string $startBalance
* @property string $endBalance
*
*/
class Account extends Model
{

View File

@ -20,4 +20,5 @@ use Zizaco\Entrust\EntrustRole;
*/
class Role extends EntrustRole
{
}

View File

@ -4,6 +4,11 @@ namespace FireflyIII\Providers;
use Illuminate\Support\ServiceProvider;
/**
* Class AppServiceProvider
*
* @package FireflyIII\Providers
*/
class AppServiceProvider extends ServiceProvider
{
/**

View File

@ -5,6 +5,11 @@ namespace FireflyIII\Providers;
use Illuminate\Contracts\Auth\Access\Gate as GateContract;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
/**
* Class AuthServiceProvider
*
* @package FireflyIII\Providers
*/
class AuthServiceProvider extends ServiceProvider
{
/**

View File

@ -4,6 +4,7 @@ namespace FireflyIII\Providers;
use FireflyIII\Models\Account;
use FireflyIII\Models\BudgetLimit;
use FireflyIII\Models\LimitRepetition;
use FireflyIII\Models\PiggyBank;
use FireflyIII\Models\PiggyBankRepetition;
use FireflyIII\Models\Transaction;
@ -14,6 +15,11 @@ use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvi
use Log;
use Navigation;
/**
* Class EventServiceProvider
*
* @package FireflyIII\Providers
*/
class EventServiceProvider extends ServiceProvider
{
/**

View File

@ -5,6 +5,11 @@ namespace FireflyIII\Providers;
use Illuminate\Routing\Router;
use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
/**
* Class RouteServiceProvider
*
* @package FireflyIII\Providers
*/
class RouteServiceProvider extends ServiceProvider
{
/**

View File

@ -235,4 +235,4 @@ class SingleCategoryRepository extends ComponentRepository implements SingleCate
}
}
}

View File

@ -119,4 +119,4 @@ interface SingleCategoryRepositoryInterface
* @return Category
*/
public function update(Category $category, array $data);
}
}

View File

@ -14,4 +14,4 @@ class Query
const SPENT = 1;
const EARNED = 2;
}
}

View File

@ -4,6 +4,11 @@ namespace FireflyIII;
use Illuminate\Foundation\Auth\User as Authenticatable;
/**
* Class User
*
* @package FireflyIII
*/
class User extends Authenticatable
{
/**

View File

@ -1,2 +1,2 @@
*
!.gitignore
!.gitignore

View File

@ -1,2 +1,2 @@
*
!.gitignore
!.gitignore