Initial Upload

lib/Widget/Provider/WidgetProviderTrait.php

@@ -0,0 +1,67 @@
+<?php
+/*
+ * Copyright (C) 2023 Xibo Signage Ltd
+ *
+ * Xibo - Digital Signage - http://www.xibo.org.uk
+ *
+ * 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\Provider;
+
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+
+/**
+ * A trait to set common objects on a Widget Provider Interface
+ */
+trait WidgetProviderTrait
+{
+    private $log;
+    private $dispatcher;
+
+    public function getLog(): LoggerInterface
+    {
+        if ($this->log === null) {
+            $this->log = new NullLogger();
+        }
+        return $this->log;
+    }
+
+    public function setLog(LoggerInterface $logger): WidgetProviderInterface
+    {
+        $this->log = $logger;
+        return $this;
+    }
+
+    /** @inheritDoc */
+    public function getDispatcher(): EventDispatcherInterface
+    {
+        if ($this->dispatcher === null) {
+            $this->dispatcher = new EventDispatcher();
+        }
+        return $this->dispatcher;
+    }
+
+    /** @inheritDoc */
+    public function setDispatcher(EventDispatcherInterface $dispatcher): WidgetProviderInterface
+    {
+        $this->dispatcher = $dispatcher;
+        return $this;
+    }
+}