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

<?php
/**
 * ActionInterface.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\Models\RuleAction;

/**
 * Interface ActionInterface.
 */
interface ActionInterface
{
    /**
     * ActionInterface constructor.
     *
     * @param RuleAction $action
     */
    public function __construct(RuleAction $action);

    /**
     * Execute the action on an array. Returns "true" if the action was a success and the action
     * was applied. Returns false if otherwise.
     *
     * @param array $journal
     *
     * @return bool
     */
    public function actOnArray(array $journal): bool;
}