Various PSR12 code cleanup

This commit is contained in:
James Cole
2022-12-29 19:42:26 +01:00
parent dbf3e76ecc
commit 6cfdc58cb1
415 changed files with 7462 additions and 6874 deletions

View File

@@ -1,4 +1,5 @@
<?php
/**
* RuleRepository.php
* Copyright (c) 2019 james@firefly-iii.org
@@ -44,15 +45,7 @@ class RuleRepository implements RuleRepositoryInterface
private $user;
/**
* @return int
*/
public function count(): int
{
return $this->user->rules()->count();
}
/**
* @param Rule $rule
* @param Rule $rule
*
* @return bool
* @throws Exception
@@ -76,7 +69,7 @@ class RuleRepository implements RuleRepositoryInterface
public function duplicate(Rule $rule): Rule
{
$newRule = $rule->replicate();
$newRule->title = (string) trans('firefly.rule_copy_of', ['title' => $rule->title]);
$newRule->title = (string)trans('firefly.rule_copy_of', ['title' => $rule->title]);
$newRule->save();
// replicate all triggers
@@ -98,16 +91,6 @@ class RuleRepository implements RuleRepositoryInterface
return $newRule;
}
/**
* @param int $ruleId
*
* @return Rule|null
*/
public function find(int $ruleId): ?Rule
{
return $this->user->rules()->find($ruleId);
}
/**
* Get all the users rules.
*
@@ -129,17 +112,17 @@ class RuleRepository implements RuleRepositoryInterface
}
/**
* @param RuleGroup $ruleGroup
* @param RuleGroup $ruleGroup
*
* @return int
*/
public function getHighestOrderInRuleGroup(RuleGroup $ruleGroup): int
{
return (int) $ruleGroup->rules()->max('order');
return (int)$ruleGroup->rules()->max('order');
}
/**
* @param Rule $rule
* @param Rule $rule
*
* @return string
*
@@ -149,14 +132,22 @@ class RuleRepository implements RuleRepositoryInterface
{
$count = $rule->ruleTriggers()->count();
if (0 === $count) {
throw new FireflyException('Rules should have more than zero triggers, rule #' . $rule->id . ' has none!');
throw new FireflyException('Rules should have more than zero triggers, rule #'.$rule->id.' has none!');
}
return $rule->ruleTriggers()->where('trigger_type', 'user_action')->first()->trigger_value;
}
/**
* @param Rule $rule
* @return int
*/
public function count(): int
{
return $this->user->rules()->count();
}
/**
* @param Rule $rule
*
* @return Collection
*/
@@ -166,7 +157,7 @@ class RuleRepository implements RuleRepositoryInterface
}
/**
* @param Rule $rule
* @param Rule $rule
*
* @return Collection
*/
@@ -268,15 +259,7 @@ class RuleRepository implements RuleRepositoryInterface
}
/**
* @param User $user
*/
public function setUser(User $user): void
{
$this->user = $user;
}
/**
* @param array $data
* @param array $data
*
* @return Rule
* @throws FireflyException
@@ -330,8 +313,18 @@ class RuleRepository implements RuleRepositoryInterface
}
/**
* @param string $moment
* @param Rule $rule
* @param int $ruleId
*
* @return Rule|null
*/
public function find(int $ruleId): ?Rule
{
return $this->user->rules()->find($ruleId);
}
/**
* @param string $moment
* @param Rule $rule
*/
private function setRuleTrigger(string $moment, Rule $rule): void
{
@@ -354,7 +347,7 @@ class RuleRepository implements RuleRepositoryInterface
}
/**
* @param RuleGroup $ruleGroup
* @param RuleGroup $ruleGroup
*
* @return bool
*/
@@ -367,13 +360,21 @@ class RuleRepository implements RuleRepositoryInterface
return true;
}
/**
* @param User $user
*/
public function setUser(User $user): void
{
$this->user = $user;
}
/**
* @inheritDoc
*/
public function setOrder(Rule $rule, int $newOrder): void
{
$oldOrder = (int) $rule->order;
$groupId = (int) $rule->rule_group_id;
$oldOrder = (int)$rule->order;
$groupId = (int)$rule->rule_group_id;
$maxOrder = $this->maxOrder($rule->ruleGroup);
$newOrder = $newOrder > $maxOrder ? $maxOrder + 1 : $newOrder;
Log::debug(sprintf('New order will be %d', $newOrder));
@@ -408,12 +409,12 @@ class RuleRepository implements RuleRepositoryInterface
*/
public function maxOrder(RuleGroup $ruleGroup): int
{
return (int) $ruleGroup->rules()->max('order');
return (int)$ruleGroup->rules()->max('order');
}
/**
* @param Rule $rule
* @param array $data
* @param Rule $rule
* @param array $data
*
* @return void
*/
@@ -442,8 +443,8 @@ class RuleRepository implements RuleRepositoryInterface
}
/**
* @param Rule $rule
* @param array $values
* @param Rule $rule
* @param array $values
*
* @return RuleTrigger
*/
@@ -462,8 +463,8 @@ class RuleRepository implements RuleRepositoryInterface
}
/**
* @param Rule $rule
* @param array $data
* @param Rule $rule
* @param array $data
*
* @return void
*/
@@ -487,8 +488,8 @@ class RuleRepository implements RuleRepositoryInterface
}
/**
* @param Rule $rule
* @param array $values
* @param Rule $rule
* @param array $values
*
* @return RuleAction
*/
@@ -507,8 +508,8 @@ class RuleRepository implements RuleRepositoryInterface
}
/**
* @param Rule $rule
* @param array $data
* @param Rule $rule
* @param array $data
*
* @return Rule
*/
@@ -534,7 +535,7 @@ class RuleRepository implements RuleRepositoryInterface
// update the order:
$this->resetRuleOrder($group);
if (array_key_exists('order', $data)) {
$this->moveRule($rule, $group, (int) $data['order']);
$this->moveRule($rule, $group, (int)$data['order']);
}

View File

@@ -1,4 +1,5 @@
<?php
/**
* RuleRepositoryInterface.php
* Copyright (c) 2019 james@firefly-iii.org
@@ -40,21 +41,21 @@ interface RuleRepositoryInterface
public function count(): int;
/**
* @param Rule $rule
* @param Rule $rule
*
* @return bool
*/
public function destroy(Rule $rule): bool;
/**
* @param Rule $rule
* @param Rule $rule
*
* @return Rule
*/
public function duplicate(Rule $rule): Rule;
/**
* @param int $ruleId
* @param int $ruleId
*
* @return Rule|null
*/
@@ -73,28 +74,28 @@ interface RuleRepositoryInterface
public function getFirstRuleGroup(): RuleGroup;
/**
* @param RuleGroup $ruleGroup
* @param RuleGroup $ruleGroup
*
* @return int
*/
public function getHighestOrderInRuleGroup(RuleGroup $ruleGroup): int;
/**
* @param Rule $rule
* @param Rule $rule
*
* @return string
*/
public function getPrimaryTrigger(Rule $rule): string;
/**
* @param Rule $rule
* @param Rule $rule
*
* @return Collection
*/
public function getRuleActions(Rule $rule): Collection;
/**
* @param Rule $rule
* @param Rule $rule
*
* @return Collection
*/
@@ -103,7 +104,7 @@ interface RuleRepositoryInterface
/**
* Return search query for rule.
*
* @param Rule $rule
* @param Rule $rule
*
* @return string
*/
@@ -124,73 +125,73 @@ interface RuleRepositoryInterface
public function getUpdateRules(): Collection;
/**
* @param RuleGroup $ruleGroup
* @param RuleGroup $ruleGroup
*
* @return int
*/
public function maxOrder(RuleGroup $ruleGroup): int;
/**
* @param Rule $rule
* @param RuleGroup $ruleGroup
* @param int $order
* @param Rule $rule
* @param RuleGroup $ruleGroup
* @param int $order
*
* @return Rule
*/
public function moveRule(Rule $rule, RuleGroup $ruleGroup, int $order): Rule;
/**
* @param RuleGroup $ruleGroup
* @param RuleGroup $ruleGroup
*
* @return bool
*/
public function resetRuleOrder(RuleGroup $ruleGroup): bool;
/**
* @param string $query
* @param int $limit
* @param string $query
* @param int $limit
*
* @return Collection
*/
public function searchRule(string $query, int $limit): Collection;
/**
* @param Rule $rule
* @param int $newOrder
* @param Rule $rule
* @param int $newOrder
*/
public function setOrder(Rule $rule, int $newOrder): void;
/**
* @param User $user
* @param User $user
*/
public function setUser(User $user);
/**
* @param array $data
* @param array $data
*
* @return Rule
*/
public function store(array $data): Rule;
/**
* @param Rule $rule
* @param array $values
* @param Rule $rule
* @param array $values
*
* @return RuleAction
*/
public function storeAction(Rule $rule, array $values): RuleAction;
/**
* @param Rule $rule
* @param array $values
* @param Rule $rule
* @param array $values
*
* @return RuleTrigger
*/
public function storeTrigger(Rule $rule, array $values): RuleTrigger;
/**
* @param Rule $rule
* @param array $data
* @param Rule $rule
* @param array $data
*
* @return Rule
*/