Initial Upload

lib/Widget/Compatibility/ClockWidgetCompatibility.php

@@ -0,0 +1,66 @@
+<?php
+/*
+ * Copyright (C) 2024 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 ClockWidgetCompatibility 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);
+
+        // The old clock widget had a `clockTypeId` option which determines the template
+        // we must make a choice here.
+        $widget->type = match ($widget->getOptionValue('clockTypeId', 1)) {
+            2 => 'clock-digital',
+            3 => 'clock-flip',
+            default => 'clock-analogue',
+        };
+
+        // in v3 this option used to ba called theme, now it is themeId
+        if ($widget->type === 'clock-analogue') {
+            $widget->setOptionValue('themeId', 'attrib', $widget->getOptionValue('theme', 1));
+        }
+
+        // We don't need the old options anymore
+        $widget->removeOption('clockTypeId');
+        $widget->removeOption('theme');
+
+        return true;
+    }
+
+    public function saveTemplate(string $template, string $fileName): bool
+    {
+        return false;
+    }
+}