mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2024-11-23 01:16:46 -06:00
70 lines
1.7 KiB
PHP
70 lines
1.7 KiB
PHP
<?php
|
|
/**
|
|
* ClearNotes.php
|
|
* Copyright (c) 2017 thegrumpydictator@gmail.com
|
|
*
|
|
* This file is part of Firefly III.
|
|
*
|
|
* Firefly III is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Firefly III 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\TransactionRules\Actions;
|
|
|
|
use FireflyIII\Models\Note;
|
|
use FireflyIII\Models\RuleAction;
|
|
use FireflyIII\Models\TransactionJournal;
|
|
use Log;
|
|
|
|
/**
|
|
* Class ClearNotes.
|
|
*/
|
|
class ClearNotes implements ActionInterface
|
|
{
|
|
/** @var RuleAction The rule action */
|
|
private $action;
|
|
|
|
/**
|
|
* TriggerInterface constructor.
|
|
*
|
|
* @param RuleAction $action
|
|
*/
|
|
public function __construct(RuleAction $action)
|
|
{
|
|
$this->action = $action;
|
|
}
|
|
|
|
/**
|
|
* Remove notes
|
|
*
|
|
* @param TransactionJournal $journal
|
|
*
|
|
* @return bool
|
|
*
|
|
* @throws \Exception
|
|
*/
|
|
public function act(TransactionJournal $journal): bool
|
|
{
|
|
Log::debug(sprintf('RuleAction ClearNotes removed all notes.'));
|
|
$notes = $journal->notes()->get();
|
|
/** @var Note $note */
|
|
foreach ($notes as $note) {
|
|
$note->delete();
|
|
}
|
|
$journal->touch();
|
|
|
|
return true;
|
|
}
|
|
}
|