Code cleanup that (hopefully) matches style CI

This commit is contained in:
James Cole
2020-03-17 15:02:57 +01:00
parent 2b6c3fd743
commit 24129ab69c
21 changed files with 266 additions and 257 deletions

View File

@@ -112,10 +112,10 @@ class AccountFormRequest extends Request
'what' => 'in:' . $types,
'interest_period' => 'in:daily,monthly,yearly',
];
$rules = Location::requestRules($rules);
$rules = Location::requestRules($rules);
if ('liabilities' === $this->get('objectType')) {
$rules['opening_balance'] = ['numeric', 'required','max:1000000000'];
$rules['opening_balance'] = ['numeric', 'required', 'max:1000000000'];
$rules['opening_balance_date'] = 'date|required';
}

View File

@@ -51,7 +51,7 @@ class JournalLinkRequest extends Request
$return = [];
$linkType = $this->get('link_type');
$parts = explode('_', $linkType);
$return['link_type_id'] = (int)$parts[0];
$return['link_type_id'] = (int) $parts[0];
$return['transaction_journal_id'] = $this->integer('opposing');
$return['notes'] = $this->string('notes');
$return['direction'] = $parts[1];

View File

@@ -53,9 +53,9 @@ class RecurrenceFormRequest extends Request
/**
* Get the data required by the controller.
*
* @return array
* @throws FireflyException
*
* @return array
*/
public function getAll(): array
{
@@ -136,9 +136,9 @@ class RecurrenceFormRequest extends Request
/**
* The rules for this request.
*
* @return array
* @throws FireflyException
*
* @return array
*/
public function rules(): array
{
@@ -250,16 +250,16 @@ class RecurrenceFormRequest extends Request
default:
throw new FireflyException(sprintf('Cannot handle transaction type "%s"', $this->string('transaction_type'))); // @codeCoverageIgnore
case 'withdrawal':
$sourceId = (int)$data['source_id'];
$destinationId = (int)$data['withdrawal_destination_id'];
$sourceId = (int) $data['source_id'];
$destinationId = (int) $data['withdrawal_destination_id'];
break;
case 'deposit':
$sourceId = (int)$data['deposit_source_id'];
$destinationId = (int)$data['destination_id'];
$sourceId = (int) $data['deposit_source_id'];
$destinationId = (int) $data['destination_id'];
break;
case 'transfer':
$sourceId = (int)$data['source_id'];
$destinationId = (int)$data['destination_id'];
$sourceId = (int) $data['source_id'];
$destinationId = (int) $data['destination_id'];
break;
}
@@ -269,7 +269,7 @@ class RecurrenceFormRequest extends Request
// do something with result:
if (false === $validSource) {
$message = (string)trans('validation.generic_invalid_source');
$message = (string) trans('validation.generic_invalid_source');
$validator->errors()->add('source_id', $message);
$validator->errors()->add('deposit_source_id', $message);
@@ -280,7 +280,7 @@ class RecurrenceFormRequest extends Request
$validDestination = $accountValidator->validateDestination($destinationId, null);
// do something with result:
if (false === $validDestination) {
$message = (string)trans('validation.generic_invalid_destination');
$message = (string) trans('validation.generic_invalid_destination');
$validator->errors()->add('destination_id', $message);
$validator->errors()->add('withdrawal_destination_id', $message);

View File

@@ -62,7 +62,7 @@ class ReportFormRequest extends Request
$collection = new Collection;
if (is_array($set)) {
foreach ($set as $accountId) {
$account = $repository->findNull((int)$accountId);
$account = $repository->findNull((int) $accountId);
if (null !== $account) {
$collection->push($account);
}
@@ -85,7 +85,7 @@ class ReportFormRequest extends Request
$collection = new Collection;
if (is_array($set)) {
foreach ($set as $budgetId) {
$budget = $repository->findNull((int)$budgetId);
$budget = $repository->findNull((int) $budgetId);
if (null !== $budget) {
$collection->push($budget);
}
@@ -108,7 +108,7 @@ class ReportFormRequest extends Request
$collection = new Collection;
if (is_array($set)) {
foreach ($set as $categoryId) {
$category = $repository->findNull((int)$categoryId);
$category = $repository->findNull((int) $categoryId);
if (null !== $category) {
$collection->push($category);
}
@@ -118,18 +118,41 @@ class ReportFormRequest extends Request
return $collection;
}
/**
* Validate list of accounts which exist twice in system.
*
* @return Collection
*/
public function getDoubleList(): Collection
{
/** @var AccountRepositoryInterface $repository */
$repository = app(AccountRepositoryInterface::class);
$set = $this->get('double');
$collection = new Collection;
if (is_array($set)) {
foreach ($set as $accountId) {
$account = $repository->findNull((int) $accountId);
if (null !== $account) {
$collection->push($account);
}
}
}
return $collection;
}
/**
* Validate end date.
*
* @throws FireflyException
* @return Carbon
*
* @throws FireflyException
*/
public function getEndDate(): Carbon
{
$date = new Carbon;
$range = $this->get('daterange');
$parts = explode(' - ', (string)$range);
$parts = explode(' - ', (string) $range);
if (2 === count($parts)) {
try {
$date = new Carbon($parts[1]);
@@ -146,41 +169,18 @@ class ReportFormRequest extends Request
return $date;
}
/**
* Validate list of accounts which exist twice in system.
*
* @return Collection
*/
public function getDoubleList(): Collection
{
/** @var AccountRepositoryInterface $repository */
$repository = app(AccountRepositoryInterface::class);
$set = $this->get('double');
$collection = new Collection;
if (is_array($set)) {
foreach ($set as $accountId) {
$account = $repository->findNull((int)$accountId);
if (null !== $account) {
$collection->push($account);
}
}
}
return $collection;
}
/**
* Validate start date.
*
* @throws FireflyException
* @return Carbon
*
* @throws FireflyException
*/
public function getStartDate(): Carbon
{
$date = new Carbon;
$range = $this->get('daterange');
$parts = explode(' - ', (string)$range);
$parts = explode(' - ', (string) $range);
if (2 === count($parts)) {
try {
$date = new Carbon($parts[0]);
@@ -216,7 +216,7 @@ class ReportFormRequest extends Request
$collection->push($tag);
continue;
}
$tag = $repository->findNull((int)$tagTag);
$tag = $repository->findNull((int) $tagTag);
if (null !== $tag) {
$collection->push($tag);
continue;

View File

@@ -124,7 +124,7 @@ class Request extends FormRequest
return null;
}
return (float)$res;
return (float) $res;
}
/**
@@ -136,7 +136,7 @@ class Request extends FormRequest
*/
public function integer(string $field): int
{
return (int)$this->get($field);
return (int) $this->get($field);
}
/**
@@ -155,60 +155,7 @@ class Request extends FormRequest
return null;
}
return (int)$string;
}
/**
* Return integer value, or NULL when it's not set.
*
* @param string $field
*
* @return int|null
*/
public function nullableInteger(string $field): ?int
{
if (!$this->has($field)) {
return null;
}
$value = (string)$this->get($field);
if ('' === $value) {
return null;
}
return (int)$value;
}
/**
* Return string value, or NULL if empty.
*
* @param string $field
*
* @return string|null
*/
public function nullableString(string $field): ?string
{
if (!$this->has($field)) {
return null;
}
$res = trim(app('steam')->cleanString((string)($this->get($field) ?? '')));
if ('' === $res) {
return null;
}
return $res;
}
/**
* Return string value.
*
* @param string $field
*
* @return string
*/
public function string(string $field): string
{
return app('steam')->cleanString((string)($this->get($field) ?? ''));
return (int) $string;
}
/**
@@ -220,41 +167,7 @@ class Request extends FormRequest
*/
public function nlString(string $field): string
{
return app('steam')->nlCleanString((string)($this->get($field) ?? ''));
}
/**
* Return string value, but keep newlines, or NULL if empty.
*
* @param string $field
*
* @return string
*/
public function nullableNlString(string $field): ?string
{
if (!$this->has($field)) {
return null;
}
return app('steam')->nlCleanString((string)($this->get($field) ?? ''));
}
/**
* Parse and clean a string.
*
* @param string|null $string
*
* @return string|null
*/
public function stringFromValue(?string $string): ?string
{
if (null === $string) {
return null;
}
$result = app('steam')->cleanString($string);
return '' === $result ? null : $result;
return app('steam')->nlCleanString((string) ($this->get($field) ?? ''));
}
/**
@@ -276,59 +189,90 @@ class Request extends FormRequest
}
/**
* Return date or NULL.
* Return integer value, or NULL when it's not set.
*
* @param string $field
*
* @return Carbon|null
* @return int|null
*/
protected function date(string $field): ?Carbon
public function nullableInteger(string $field): ?int
{
$result = null;
try {
$result = $this->get($field) ? new Carbon($this->get($field)) : null;
} catch (Exception $e) {
Log::debug(sprintf('Exception when parsing date. Not interesting: %s', $e->getMessage()));
if (!$this->has($field)) {
return null;
}
return $result;
$value = (string) $this->get($field);
if ('' === $value) {
return null;
}
return (int) $value;
}
/**
* Return date time or NULL.
* Return string value, but keep newlines, or NULL if empty.
*
* @param string $field
*
* @return Carbon|null
* @return string
*/
protected function dateTime(string $field): ?Carbon
public function nullableNlString(string $field): ?string
{
if (null === $this->get($field)) {
return null;
}
$value = (string)$this->get($field);
if (10 === strlen($value)) {
// probably a date format.
try {
$result = Carbon::createFromFormat('Y-m-d', $value);
} catch (InvalidDateException $e) {
Log::error(sprintf('"%s" is not a valid date: %s', $value, $e->getMessage()));
return null;
}
return $result;
}
// is an atom string, I hope?
try {
$result = Carbon::parse($value);
} catch (InvalidDateException $e) {
Log::error(sprintf('"%s" is not a valid date or time: %s', $value, $e->getMessage()));
if (!$this->has($field)) {
return null;
}
return $result;
return app('steam')->nlCleanString((string) ($this->get($field) ?? ''));
}
/**
* Return string value, or NULL if empty.
*
* @param string $field
*
* @return string|null
*/
public function nullableString(string $field): ?string
{
if (!$this->has($field)) {
return null;
}
$res = trim(app('steam')->cleanString((string) ($this->get($field) ?? '')));
if ('' === $res) {
return null;
}
return $res;
}
/**
* Return string value.
*
* @param string $field
*
* @return string
*/
public function string(string $field): string
{
return app('steam')->cleanString((string) ($this->get($field) ?? ''));
}
/**
* Parse and clean a string.
*
* @param string|null $string
*
* @return string|null
*/
public function stringFromValue(?string $string): ?string
{
if (null === $string) {
return null;
}
$result = app('steam')->cleanString($string);
return '' === $result ? null : $result;
}
/**
@@ -374,9 +318,9 @@ class Request extends FormRequest
) {
Log::debug('Method is PUT and all fields present.');
$data['update_location'] = true;
$data['longitude'] = $this->nullableString($longitudeKey);
$data['latitude'] = $this->nullableString($latitudeKey);
$data['zoom_level'] = $this->nullableString($zoomLevelKey);
$data['longitude'] = $this->nullableString($longitudeKey);
$data['latitude'] = $this->nullableString($latitudeKey);
$data['zoom_level'] = $this->nullableString($zoomLevelKey);
}
if (null === $data['longitude'] || null === $data['latitude'] || null === $data['zoom_level']) {
Log::debug('One of the fields is NULL, wont save.');
@@ -389,6 +333,61 @@ class Request extends FormRequest
return $data;
}
/**
* Return date or NULL.
*
* @param string $field
*
* @return Carbon|null
*/
protected function date(string $field): ?Carbon
{
$result = null;
try {
$result = $this->get($field) ? new Carbon($this->get($field)) : null;
} catch (Exception $e) {
Log::debug(sprintf('Exception when parsing date. Not interesting: %s', $e->getMessage()));
}
return $result;
}
/**
* Return date time or NULL.
*
* @param string $field
*
* @return Carbon|null
*/
protected function dateTime(string $field): ?Carbon
{
if (null === $this->get($field)) {
return null;
}
$value = (string) $this->get($field);
if (10 === strlen($value)) {
// probably a date format.
try {
$result = Carbon::createFromFormat('Y-m-d', $value);
} catch (InvalidDateException $e) {
Log::error(sprintf('"%s" is not a valid date: %s', $value, $e->getMessage()));
return null;
}
return $result;
}
// is an atom string, I hope?
try {
$result = Carbon::parse($value);
} catch (InvalidDateException $e) {
Log::error(sprintf('"%s" is not a valid date or time: %s', $value, $e->getMessage()));
return null;
}
return $result;
}
/**
* @param Validator $validator
@@ -398,27 +397,27 @@ class Request extends FormRequest
$data = $validator->getData();
$type = $data['auto_budget_type'] ?? '';
$amount = $data['auto_budget_amount'] ?? '';
$period = (string)($data['auto_budget_period'] ?? '');
$period = (string) ($data['auto_budget_period'] ?? '');
$currencyId = $data['auto_budget_currency_id'] ?? '';
$currencyCode = $data['auto_budget_currency_code'] ?? '';
if (is_numeric($type)) {
$type = (int)$type;
$type = (int) $type;
}
if (0 === $type || 'none' === $type || '' === $type) {
return;
}
// basic float check:
if ('' === $amount) {
$validator->errors()->add('auto_budget_amount', (string)trans('validation.amount_required_for_auto_budget'));
$validator->errors()->add('auto_budget_amount', (string) trans('validation.amount_required_for_auto_budget'));
}
if (1 !== bccomp((string)$amount, '0')) {
$validator->errors()->add('auto_budget_amount', (string)trans('validation.auto_budget_amount_positive'));
if (1 !== bccomp((string) $amount, '0')) {
$validator->errors()->add('auto_budget_amount', (string) trans('validation.auto_budget_amount_positive'));
}
if ('' === $period) {
$validator->errors()->add('auto_budget_period', (string)trans('validation.auto_budget_period_mandatory'));
$validator->errors()->add('auto_budget_period', (string) trans('validation.auto_budget_period_mandatory'));
}
if ('' === $currencyCode && '' === $currencyId) {
$validator->errors()->add('auto_budget_amount', (string)trans('validation.require_currency_info'));
$validator->errors()->add('auto_budget_amount', (string) trans('validation.require_currency_info'));
}
}

View File

@@ -116,7 +116,7 @@ class RuleFormRequest extends Request
$return[] = [
'type' => $action['type'] ?? 'invalid',
'value' => $action['value'] ?? '',
'stop_processing' => 1 === (int)$stopProcessing,
'stop_processing' => 1 === (int) $stopProcessing,
];
}
}
@@ -137,7 +137,7 @@ class RuleFormRequest extends Request
$return[] = [
'type' => $trigger['type'] ?? 'invalid',
'value' => $trigger['value'] ?? '',
'stop_processing' => 1 === (int)$stopProcessing,
'stop_processing' => 1 === (int) $stopProcessing,
];
}
}

View File

@@ -53,6 +53,7 @@ class TagFormRequest extends Request
'date' => $this->date('date'),
'description' => $this->string('description'),
];
return $this->appendLocationData($data, 'location');
}
@@ -74,12 +75,13 @@ class TagFormRequest extends Request
$tagRule = 'required|min:1|uniqueObjectForUser:tags,tag,' . $tag->id;
}
$rules= [
$rules = [
'tag' => $tagRule,
'id' => $idRule,
'description' => 'min:1|nullable',
'date' => 'date|nullable',
];
return Location::requestRules($rules);
}
}