Initial Upload

2025-12-02 10:32:59 -05:00
commit 05ce0da296
2240 changed files with 467811 additions and 0 deletions
--- a/lib/Entity/TagLinkTrait.php
+++ b/lib/Entity/TagLinkTrait.php
@@ -0,0 +1,180 @@
+<?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\Entity;
+
+use Xibo\Support\Exception\NotFoundException;
+
+/**
+ * Class TagLinkTrait
+ * @package Xibo\Entity
+ */
+trait TagLinkTrait
+{
+    /**
+     * Does the Entity have the provided tag?
+     * @param $searchTag
+     * @return bool
+     * @throws NotFoundException
+     */
+    public function hasTag($searchTag)
+    {
+        foreach ($this->tags as $tag) {
+            if ($tag->tag == $searchTag) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Assign Tag
+     * @param TagLink $tag
+     * @return $this
+     */
+    public function assignTag(TagLink $tag)
+    {
+        $this->linkTags[] = $tag;
+        $this->tags[] = $tag;
+
+        return $this;
+    }
+
+    /**
+     * Unassign tag
+     * @param TagLink $tag
+     * @return $this
+     */
+    public function unassignTag(TagLink $tag)
+    {
+        $this->unlinkTags[] = $tag;
+
+        foreach ($this->tags as $key => $currentTag) {
+            if ($currentTag->tagId === $tag->tagId) {
+                array_splice($this->tags, $key, 1);
+            }
+        }
+
+        return $this;
+    }
+
+    /**
+     * Link
+     */
+    public function linkTagToEntity($table, $column, $entityId, $tagId, $value)
+    {
+        $this->getLog()->debug(sprintf('Linking %s %d, to tagId %d', $column, $entityId, $tagId));
+
+        $this->getStore()->update('INSERT INTO `' . $table .'` (`tagId`, `'.$column.'`, `value`) VALUES (:tagId, :entityId, :value) ON DUPLICATE KEY UPDATE '.$column.' = :entityId, `value` = :value', [
+            'tagId' => $tagId,
+            'entityId' => $entityId,
+            'value' => $value
+        ]);
+    }
+
+    /**
+     * Unlink
+     */
+    public function unlinkTagFromEntity($table, $column, $entityId, $tagId)
+    {
+        $this->getLog()->debug(sprintf('Unlinking %s %d, from tagId %d', $column, $entityId, $tagId));
+
+        $this->getStore()->update('DELETE FROM `'.$table.'` WHERE tagId = :tagId AND `'.$column.'` = :entityId', [
+            'tagId' => $tagId,
+            'entityId' => $entityId
+        ]);
+    }
+
+    /**
+     * Unlink all Tags from Entity
+     */
+    public function unlinkAllTagsFromEntity($table, $column, $entityId)
+    {
+        $this->getLog()->debug(sprintf('Unlinking all Tags from %s %d', $column, $entityId));
+
+        $this->getStore()->update('DELETE FROM `'.$table.'` WHERE `'.$column.'` = :entityId', [
+            'entityId' => $entityId
+        ]);
+    }
+
+    /**
+     * @param TagLink[] $tags
+     */
+    public function updateTagLinks($tags = [])
+    {
+        if ($this->tags != $tags) {
+            $this->unlinkTags = array_udiff($this->tags, $tags, function ($a, $b) {
+                /* @var TagLink $a */
+                /* @var TagLink $b */
+                return $a->tagId - $b->tagId;
+            });
+
+            $this->getLog()->debug(sprintf('Tags to be removed: %s', json_encode($this->unlinkTags)));
+
+            // see what we need to add
+            $this->linkTags = array_udiff($tags, $this->tags, function ($a, $b) {
+                /* @var TagLink $a */
+                /* @var TagLink $b */
+                if ($a->value !== $b->value && $a->tagId === $b->tagId) {
+                    return -1;
+                } else {
+                    return $a->tagId - $b->tagId;
+                }
+            });
+
+            // Replace the arrays
+            $this->tags = $tags;
+
+            $this->getLog()->debug(sprintf('Tags to be added: %s', json_encode($this->linkTags)));
+
+            $this->getLog()->debug(sprintf('Tags remaining: %s', json_encode($this->tags)));
+        } else {
+            $this->getLog()->debug('Tags were not changed');
+        }
+    }
+
+    /**
+     * Convert TagLink array into a string for use on forms.
+     * @return string
+     */
+    public function getTagString()
+    {
+        $tagsString = '';
+
+        if (empty($this->tags)) {
+            return $tagsString;
+        }
+
+        $i = 1;
+        foreach ($this->tags as $tagLink) {
+            /** @var TagLink $tagLink */
+            if ($i > 1) {
+                $tagsString .= ',';
+            }
+            $tagsString .= $tagLink->tag . (($tagLink->value) ? '|' . $tagLink->value : '');
+            $i++;
+        }
+
+        return $tagsString;
+    }
+}