Initial Upload

lib/Widget/Compatibility/CountDownWidgetCompatibility.php

@@ -0,0 +1,71 @@
+<?php
+/*
+ * Copyright (C) 2023 Xibo Signage Ltd
+ *
+ * Xibo - Digital Signage - https://xibosignage.com
+ *
+ * This file is part of Xibo.
+ *
+ * Xibo 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
+ * any later version.
+ *
+ * Xibo 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 Xibo.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace Xibo\Widget\Compatibility;
+
+use Xibo\Entity\Widget;
+use Xibo\Widget\Provider\WidgetCompatibilityInterface;
+use Xibo\Widget\Provider\WidgetCompatibilityTrait;
+
+/**
+ * Convert widget from an old schema to a new schema
+ */
+class CountDownWidgetCompatibility implements WidgetCompatibilityInterface
+{
+    use WidgetCompatibilityTrait;
+
+    /** @inheritdoc
+     */
+    public function upgradeWidget(Widget $widget, int $fromSchema, int $toSchema): bool
+    {
+        $this->getLog()->debug('upgradeWidget: ' . $widget->getId() . ' from: ' . $fromSchema . ' to: ' . $toSchema);
+
+        $countdownType = $widget->getOptionValue('countdownType', 1);
+        $overrideTemplate = $widget->getOptionValue('overrideTemplate', 0);
+
+        // Old countdown had countdownType.
+        if ($overrideTemplate == 1) {
+            $widget->type = 'countdown-custom';
+        } else {
+            $widget->type = match ($countdownType) {
+                2 => 'countdown-clock',
+                3 => 'countdown-table',
+                4 => 'countdown-days',
+                default => 'countdown-text',
+            };
+        }
+
+        // If overriden, we need to tranlate the legacy options to the new values
+        if ($overrideTemplate == 1) {
+            $widget->changeOption('widgetOriginalWidth', 'widgetDesignWidth');
+            $widget->changeOption('widgetOriginalHeight', 'widgetDesignHeight');
+            $widget->removeOption('templateId');
+        }
+
+        return true;
+    }
+
+    public function saveTemplate(string $template, string $fileName): bool
+    {
+        return false;
+    }
+}