mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-02-25 18:45:27 -06:00
84 lines
2.8 KiB
PHP
84 lines
2.8 KiB
PHP
<?php
|
|
declare(strict_types=1);
|
|
/*
|
|
* AppendNotesToDescription.php
|
|
* Copyright (c) 2022 james@firefly-iii.org
|
|
*
|
|
* This file is part of Firefly III (https://github.com/firefly-iii).
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
namespace FireflyIII\TransactionRules\Actions;
|
|
|
|
use FireflyIII\Events\TriggeredAuditLog;
|
|
use FireflyIII\Models\Note;
|
|
use FireflyIII\Models\RuleAction;
|
|
use FireflyIII\Models\TransactionJournal;
|
|
use FireflyIII\Support\Request\ConvertsDataTypes;
|
|
use Illuminate\Support\Facades\Log;
|
|
|
|
/**
|
|
* Class AppendNotesToDescription
|
|
*/
|
|
class AppendNotesToDescription implements ActionInterface
|
|
{
|
|
use ConvertsDataTypes;
|
|
|
|
private RuleAction $action;
|
|
|
|
/**
|
|
* TriggerInterface constructor.
|
|
*
|
|
* @param RuleAction $action
|
|
*/
|
|
public function __construct(RuleAction $action)
|
|
{
|
|
$this->action = $action;
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
public function actOnArray(array $journal): bool
|
|
{
|
|
Log::debug('Now in AppendNotesToDescription');
|
|
/** @var TransactionJournal $journal */
|
|
$journal = TransactionJournal::where('user_id', $journal['user_id'])->find($journal['transaction_journal_id']);
|
|
if (null === $journal) {
|
|
Log::error(sprintf('No journal #%d belongs to user #%d.', $journal['transaction_journal_id'], $journal['user_id']));
|
|
return false;
|
|
}
|
|
$note = $journal->notes()->first();
|
|
if (null === $note) {
|
|
Log::debug('Journal has no notes.');
|
|
$note = new Note;
|
|
$note->noteable()->associate($journal);
|
|
$note->text = '';
|
|
}
|
|
// only append if there is something to append
|
|
if ('' !== $note->text) {
|
|
$before = $journal->description;
|
|
$journal->description = trim(sprintf("%s %s", $journal->description, (string) $this->clearString($note->text, false)));
|
|
$journal->save();
|
|
Log::debug(sprintf('Journal description is updated to "%s".', $journal->description));
|
|
|
|
event(new TriggeredAuditLog($this->action->rule, $journal, 'update_description', $before, $journal->description));
|
|
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
}
|