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

@@ -31,6 +31,8 @@ use FireflyIII\Rules\UniqueIban;
class AccountFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -40,6 +42,8 @@ class AccountFormRequest extends Request
}
/**
* Get all data.
*
* @return array
*/
public function getAccountData(): array
@@ -64,6 +68,8 @@ class AccountFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests;
/**
* @codeCoverageIgnore
* Class AttachmentFormRequest.
*
* @codeCoverageIgnore
*/
class AttachmentFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -38,6 +41,8 @@ class AttachmentFormRequest extends Request
}
/**
* Returns the data required by the controller.
*
* @return array
*/
public function getAttachmentData(): array
@@ -49,6 +54,8 @@ class AttachmentFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -28,6 +28,8 @@ namespace FireflyIII\Http\Requests;
class BillFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -37,6 +39,8 @@ class BillFormRequest extends Request
}
/**
* Returns the data required by the controller.
*
* @return array
*/
public function getBillData(): array
@@ -55,6 +59,8 @@ class BillFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -25,12 +25,15 @@ namespace FireflyIII\Http\Requests;
use FireflyIII\Repositories\Budget\BudgetRepositoryInterface;
/**
* @codeCoverageIgnore
* Class BudgetFormRequest.
*
* @codeCoverageIgnore
*/
class BudgetFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -39,6 +42,8 @@ class BudgetFormRequest extends Request
}
/**
* Returns the data required by the controller.
*
* @return array
*/
public function getBudgetData(): array
@@ -50,6 +55,8 @@ class BudgetFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests;
/**
* @codeCoverageIgnore
* Class BudgetIncomeRequest.
*
* @codeCoverageIgnore
*/
class BudgetIncomeRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -38,6 +41,8 @@ class BudgetIncomeRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -28,6 +28,8 @@ namespace FireflyIII\Http\Requests;
class BulkEditJournalRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -37,6 +39,8 @@ class BulkEditJournalRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -30,6 +30,8 @@ use FireflyIII\Repositories\Category\CategoryRepositoryInterface;
class CategoryFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -39,6 +41,8 @@ class CategoryFormRequest extends Request
}
/**
* Get information for the controller.
*
* @return array
*/
public function getCategoryData(): array
@@ -49,6 +53,8 @@ class CategoryFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests;
/**
* @codeCoverageIgnore
* Class ConfigurationRequest.
*
* @codeCoverageIgnore
*/
class ConfigurationRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -38,6 +41,8 @@ class ConfigurationRequest extends Request
}
/**
* Returns the data required by the controller.
*
* @return array
*/
public function getConfigurationData(): array
@@ -49,6 +54,8 @@ class ConfigurationRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -28,6 +28,8 @@ namespace FireflyIII\Http\Requests;
class CurrencyFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -37,6 +39,8 @@ class CurrencyFormRequest extends Request
}
/**
* Returns the data required by the controller.
*
* @return array
*/
public function getCurrencyData(): array
@@ -50,6 +54,8 @@ class CurrencyFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests;
/**
* @codeCoverageIgnore
* Class DeleteAccountFormRequest.
*
* @codeCoverageIgnore
*/
class DeleteAccountFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -38,6 +41,8 @@ class DeleteAccountFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests;
/**
* @codeCoverageIgnore
* Class EmailFormRequest.
*
* @codeCoverageIgnore
*/
class EmailFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -38,6 +41,8 @@ class EmailFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -30,6 +30,8 @@ use Carbon\Carbon;
class ExportFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -39,6 +41,8 @@ class ExportFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -33,6 +33,8 @@ use Log;
class JournalFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -140,8 +142,9 @@ class JournalFormRequest extends Request
}
/**
* @return array
* Rules for this request.
*
* @return array
* @throws FireflyException
*/
public function rules(): array
@@ -234,6 +237,8 @@ class JournalFormRequest extends Request
}
/**
* Check if amounts are valid.
*
* @param Validator $validator
*/
private function validNativeAmount(Validator $validator): void
@@ -257,6 +262,8 @@ class JournalFormRequest extends Request
}
/**
* Check if deposit amount is valid.
*
* @param Validator $validator
*
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
@@ -274,6 +281,8 @@ class JournalFormRequest extends Request
}
/**
* Check if transfer amount is valid.
*
* @param Validator $validator
*
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
@@ -299,6 +308,8 @@ class JournalFormRequest extends Request
}
/**
* Check if withdrawal amount is valid.
*
* @param Validator $validator
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/

View File

@@ -31,6 +31,8 @@ use FireflyIII\Models\LinkType;
class JournalLinkRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -40,6 +42,8 @@ class JournalLinkRequest extends Request
}
/**
* Returns the data required by the controller.
*
* @return array
*/
public function getLinkInfo(): array
@@ -59,6 +63,8 @@ class JournalLinkRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -28,6 +28,8 @@ namespace FireflyIII\Http\Requests;
class LinkTypeFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -37,6 +39,8 @@ class LinkTypeFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests;
/**
* @codeCoverageIgnore
* Class MassDeleteJournalRequest.
*
* @codeCoverageIgnore
*/
class MassDeleteJournalRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -38,6 +41,8 @@ class MassDeleteJournalRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests;
/**
* @codeCoverageIgnore
* Class MassEditJournalRequest.
*
* @codeCoverageIgnore
*/
class MassEditJournalRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -38,6 +41,8 @@ class MassEditJournalRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests;
/**
* @codeCoverageIgnore
* Class NewUserFormRequest.
*
* @codeCoverageIgnore
*/
class NewUserFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -38,6 +41,8 @@ class NewUserFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -28,6 +28,8 @@ namespace FireflyIII\Http\Requests;
class PiggyBankFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -37,6 +39,8 @@ class PiggyBankFormRequest extends Request
}
/**
* Returns the data required by the controller.
*
* @return array
*/
public function getPiggyBankData(): array
@@ -52,6 +56,8 @@ class PiggyBankFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests;
/**
* @codeCoverageIgnore
* Class ProfileFormRequest.
*
* @codeCoverageIgnore
*/
class ProfileFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -38,6 +41,8 @@ class ProfileFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -32,6 +32,8 @@ use Log;
class ReconciliationStoreRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -41,6 +43,8 @@ class ReconciliationStoreRequest extends Request
}
/**
* Returns the data required by the controller.
*
* @return array
*/
public function getAll(): array
@@ -64,6 +68,8 @@ class ReconciliationStoreRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -28,6 +28,8 @@ namespace FireflyIII\Http\Requests;
class ReconciliationUpdateRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -53,6 +55,8 @@ class ReconciliationUpdateRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -37,6 +37,8 @@ class RecurrenceFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -46,6 +48,8 @@ class RecurrenceFormRequest extends Request
}
/**
* Get the data required by the controller.
*
* @return array
* @throws FireflyException
*
@@ -133,6 +137,8 @@ class RecurrenceFormRequest extends Request
}
/**
* The rules for this request.
*
* @return array
* @throws FireflyException
*
@@ -228,6 +234,8 @@ class RecurrenceFormRequest extends Request
}
/**
* Parses repetition data.
*
* @return array
*
* @SuppressWarnings(PHPMD.CyclomaticComplexity)

View File

@@ -38,6 +38,8 @@ use Log;
class ReportFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -47,6 +49,8 @@ class ReportFormRequest extends Request
}
/**
* Validate list of accounts.
*
* @return Collection
*/
public function getAccountList(): Collection
@@ -69,6 +73,8 @@ class ReportFormRequest extends Request
}
/**
* Validate list of budgets.
*
* @return Collection
*/
public function getBudgetList(): Collection
@@ -90,6 +96,8 @@ class ReportFormRequest extends Request
}
/**
* Validate list of categories.
*
* @return Collection
*/
public function getCategoryList(): Collection
@@ -111,6 +119,8 @@ class ReportFormRequest extends Request
}
/**
* Validate end date.
*
* @return Carbon
*
* @throws FireflyException
@@ -137,6 +147,8 @@ class ReportFormRequest extends Request
}
/**
* Validate list of expense accounts.
*
* @return Collection
*/
public function getExpenseList(): Collection
@@ -159,6 +171,8 @@ class ReportFormRequest extends Request
}
/**
* Validate start date.
*
* @return Carbon
*
* @throws FireflyException
@@ -184,6 +198,8 @@ class ReportFormRequest extends Request
}
/**
* Validate list of tags.
*
* @return Collection
*/
public function getTagList(): Collection
@@ -205,6 +221,8 @@ class ReportFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -33,6 +33,8 @@ use Illuminate\Foundation\Http\FormRequest;
class Request extends FormRequest
{
/**
* Return a boolean value.
*
* @param string $field
*
* @return bool
@@ -50,6 +52,8 @@ class Request extends FormRequest
}
/**
* Return floating value.
*
* @param string $field
*
* @return float
@@ -60,6 +64,8 @@ class Request extends FormRequest
}
/**
* Return integer value.
*
* @param string $field
*
* @return int
@@ -70,6 +76,8 @@ class Request extends FormRequest
}
/**
* Return string value.
*
* @param string $field
*
* @return string
@@ -133,6 +141,8 @@ class Request extends FormRequest
}
/**
* Return date or NULL.
*
* @param string $field
*
* @return Carbon|null

View File

@@ -30,6 +30,8 @@ use FireflyIII\Repositories\Rule\RuleRepositoryInterface;
class RuleFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -39,6 +41,8 @@ class RuleFormRequest extends Request
}
/**
* Get all data for controller.
*
* @return array
*
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
@@ -89,6 +93,8 @@ class RuleFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -30,6 +30,8 @@ use FireflyIII\Repositories\RuleGroup\RuleGroupRepositoryInterface;
class RuleGroupFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -39,6 +41,8 @@ class RuleGroupFormRequest extends Request
}
/**
* Get all data for controller.
*
* @return array
*/
public function getRuleGroupData(): array
@@ -50,6 +54,8 @@ class RuleGroupFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -25,12 +25,15 @@ namespace FireflyIII\Http\Requests;
use Carbon\Carbon;
/**
* @codeCoverageIgnore
* Class ExportFormRequest.
*
* @codeCoverageIgnore
*/
class SelectTransactionsRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -40,6 +43,8 @@ class SelectTransactionsRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -30,6 +30,8 @@ use Illuminate\Validation\Validator;
class SplitJournalFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -39,6 +41,8 @@ class SplitJournalFormRequest extends Request
}
/**
* Get all info for the controller.
*
* @return array
*
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
@@ -107,6 +111,8 @@ class SplitJournalFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array
@@ -149,6 +155,8 @@ class SplitJournalFormRequest extends Request
}
/**
* Verify that source and destination are not the same.
*
* @param Validator $validator
*
* @SuppressWarnings(PHPMD.CyclomaticComplexity)

View File

@@ -30,6 +30,8 @@ use FireflyIII\Repositories\Tag\TagRepositoryInterface;
class TagFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -39,6 +41,8 @@ class TagFormRequest extends Request
}
/**
* Get all data for controller.
*
* @return array
*/
public function collectTagData(): array
@@ -66,6 +70,8 @@ class TagFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests;
/**
* @codeCoverageIgnore
* Class RuleFormRequest.
*
* @codeCoverageIgnore
*/
class TestRuleFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -38,6 +41,8 @@ class TestRuleFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests;
/**
* @codeCoverageIgnore
* Class TokenFormRequest.
*
* @codeCoverageIgnore
*/
class TokenFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -38,6 +41,8 @@ class TokenFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests;
/**
* @codeCoverageIgnore
* Class UserFormRequest.
*
* @codeCoverageIgnore
*/
class UserFormRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -38,6 +41,8 @@ class UserFormRequest extends Request
}
/**
* Get data for controller.
*
* @return array
*/
public function getUserData(): array
@@ -51,6 +56,8 @@ class UserFormRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array

View File

@@ -23,12 +23,15 @@ declare(strict_types=1);
namespace FireflyIII\Http\Requests;
/**
* @codeCoverageIgnore
* Class UserRegistrationRequest.
*
* @codeCoverageIgnore
*/
class UserRegistrationRequest extends Request
{
/**
* Verify the request.
*
* @return bool
*/
public function authorize(): bool
@@ -38,6 +41,8 @@ class UserRegistrationRequest extends Request
}
/**
* Rules for this request.
*
* @return array
*/
public function rules(): array