firefly-iii/app/TransactionRules/Actions/PrependNotes.php

<?php

/**
 * PrependNotes.php
 * Copyright (c) 2019 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/>.
 */

declare(strict_types=1);

namespace FireflyIII\TransactionRules\Actions;

use FireflyIII\Events\TriggeredAuditLog;
use FireflyIII\Models\Note;
use FireflyIII\Models\RuleAction;
use FireflyIII\Models\TransactionJournal;
use FireflyIII\TransactionRules\Expressions\ActionExpressionEvaluator;
use Illuminate\Support\Facades\Log;

/**
 * Class PrependNotes.
 */
class PrependNotes implements ActionInterface
{
    private RuleAction                $action;
    private ActionExpressionEvaluator $evaluator;

    /**
     * TriggerInterface constructor.
     *
     * @param RuleAction $action
     */
    public function __construct(RuleAction $action, ActionExpressionEvaluator $evaluator)
    {
        $this->action = $action;
        $this->evaluator = $evaluator;
    }

    /**
     * @inheritDoc
     */
    public function actOnArray(array $journal): bool
    {
        $actionValue = $this->evaluator->evaluate($journal);

        $dbNote = Note::where('noteable_id', (int)$journal['transaction_journal_id'])
            ->where('noteable_type', TransactionJournal::class)
            ->first(['notes.*']);
        if (null === $dbNote) {
            $dbNote                = new Note();
            $dbNote->noteable_id   = (int)$journal['transaction_journal_id'];
            $dbNote->noteable_type = TransactionJournal::class;
            $dbNote->text          = '';
        }
        $before = $dbNote->text;
        Log::debug(sprintf('RuleAction PrependNotes prepended "%s" to "%s".', $actionValue, $dbNote->text));
        $text         = sprintf('%s%s', $actionValue, $dbNote->text);
        $dbNote->text = $text;
        $dbNote->save();

        // journal
        /** @var TransactionJournal $object */
        $object = TransactionJournal::where('user_id', $journal['user_id'])->find($journal['transaction_journal_id']);

        // audit log
        event(new TriggeredAuditLog($this->action->rule, $object, 'update_notes', $before, $text));

        return true;
    }
}