<?PHP
#
#   FILE:  PluginUpgrade_2_0_1.php (Rules plugin)
#
#   A plugin upgrade file for the Metavus digital collections platform
#   Copyright 2024 Edward Almasy and Internet Scout Research Group
#   http://metavus.net
#
# @scout:phpstan

namespace Metavus\Plugins\Rules;
use ScoutLib\PluginUpgrade;

/**
 * Class for upgrading the Rules plugin to version 2.0.1.
 */
class PluginUpgrade_2_0_1 extends PluginUpgrade
{
    # ---- PUBLIC INTERFACE --------------------------------------------------

    /**
     * Perform actions necessary to upgrade plugin to version 2.0.1.
     * @return null|string Return NULL if upgrade succeeeded, or string
     *      containing error message if upgrade failed.
     */
    public function performUpgrade()
    {
        $RFactory = new RuleFactory();
        foreach ($RFactory->getItems() as $RuleId => $Rule) {
            if ($Rule->action() == Rule::ACTION_SENDEMAIL) {
                $ActionParams = $Rule->actionParameters();
                if (!array_key_exists("ConfirmBeforeSending", $ActionParams)) {
                    $ActionParams["ConfirmBeforeSending"] = false;
                    $Rule->actionParameters($ActionParams);
                }
            }
        }
        return null;
    }

    # ---- PRIVATE INTERFACE -------------------------------------------------
}
