Initial Upload
This commit is contained in:
Matt Batchelder
766
lib/Controller/Tag.php
Normal file
766
lib/Controller/Tag.php
Normal file
@@ -0,0 +1,766 @@
|
||||
<?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\Controller;
|
||||
|
||||
use Slim\Http\Response as Response;
|
||||
use Slim\Http\ServerRequest as Request;
|
||||
use Xibo\Event\DisplayGroupLoadEvent;
|
||||
use Xibo\Event\TagAddEvent;
|
||||
use Xibo\Event\TagDeleteEvent;
|
||||
use Xibo\Event\TagEditEvent;
|
||||
use Xibo\Event\TriggerTaskEvent;
|
||||
use Xibo\Factory\CampaignFactory;
|
||||
use Xibo\Factory\DisplayFactory;
|
||||
use Xibo\Factory\DisplayGroupFactory;
|
||||
use Xibo\Factory\LayoutFactory;
|
||||
use Xibo\Factory\MediaFactory;
|
||||
use Xibo\Factory\PlaylistFactory;
|
||||
use Xibo\Factory\ScheduleFactory;
|
||||
use Xibo\Factory\TagFactory;
|
||||
use Xibo\Factory\UserFactory;
|
||||
use Xibo\Support\Exception\AccessDeniedException;
|
||||
use Xibo\Support\Exception\InvalidArgumentException;
|
||||
use Xibo\Support\Exception\NotFoundException;
|
||||
|
||||
/**
|
||||
* Class Tag
|
||||
* @package Xibo\Controller
|
||||
*/
|
||||
class Tag extends Base
|
||||
{
|
||||
/** @var CampaignFactory */
|
||||
private $campaignFactory;
|
||||
|
||||
/**
|
||||
* @var DisplayFactory
|
||||
*/
|
||||
private $displayFactory;
|
||||
|
||||
/**
|
||||
* @var DisplayGroupFactory
|
||||
*/
|
||||
private $displayGroupFactory;
|
||||
|
||||
/**
|
||||
* @var LayoutFactory
|
||||
*/
|
||||
private $layoutFactory;
|
||||
|
||||
/**
|
||||
* @var MediaFactory
|
||||
*/
|
||||
private $mediaFactory;
|
||||
|
||||
/** @var PlaylistFactory */
|
||||
private $playlistFactory;
|
||||
|
||||
/**
|
||||
* @var ScheduleFactory
|
||||
*/
|
||||
private $scheduleFactory;
|
||||
|
||||
/**
|
||||
* @var TagFactory
|
||||
*/
|
||||
private $tagFactory;
|
||||
|
||||
/** @var UserFactory */
|
||||
private $userFactory;
|
||||
|
||||
/**
|
||||
* Set common dependencies.
|
||||
* @param DisplayGroupFactory $displayGroupFactory
|
||||
* @param LayoutFactory $layoutFactory
|
||||
* @param TagFactory $tagFactory
|
||||
* @param UserFactory $userFactory
|
||||
* @param DisplayFactory $displayFactory
|
||||
* @param MediaFactory $mediaFactory
|
||||
* @param ScheduleFactory $scheduleFactory
|
||||
* @param CampaignFactory $campaignFactory
|
||||
* @param PlaylistFactory $playlistFactory
|
||||
*/
|
||||
public function __construct($displayGroupFactory, $layoutFactory, $tagFactory, $userFactory, $displayFactory, $mediaFactory, $scheduleFactory, $campaignFactory, $playlistFactory)
|
||||
{
|
||||
$this->displayGroupFactory = $displayGroupFactory;
|
||||
$this->layoutFactory = $layoutFactory;
|
||||
$this->tagFactory = $tagFactory;
|
||||
$this->userFactory = $userFactory;
|
||||
$this->displayFactory = $displayFactory;
|
||||
$this->mediaFactory = $mediaFactory;
|
||||
$this->scheduleFactory = $scheduleFactory;
|
||||
$this->campaignFactory = $campaignFactory;
|
||||
$this->playlistFactory = $playlistFactory;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Request $request
|
||||
* @param Response $response
|
||||
* @return \Psr\Http\Message\ResponseInterface|Response
|
||||
* @throws \Xibo\Support\Exception\ControllerNotImplemented
|
||||
* @throws \Xibo\Support\Exception\GeneralException
|
||||
*/
|
||||
public function displayPage(Request $request, Response $response)
|
||||
{
|
||||
$this->getState()->template = 'tag-page';
|
||||
$this->getState()->setData([
|
||||
'users' => $this->userFactory->query()
|
||||
]);
|
||||
|
||||
return $this->render($request, $response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tag Search
|
||||
*
|
||||
* @SWG\Get(
|
||||
* path="/tag",
|
||||
* operationId="tagSearch",
|
||||
* tags={"tags"},
|
||||
* summary="Search Tags",
|
||||
* description="Search for Tags viewable by this user",
|
||||
* @SWG\Parameter(
|
||||
* name="tagId",
|
||||
* in="query",
|
||||
* description="Filter by Tag Id",
|
||||
* type="integer",
|
||||
* required=false
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="tag",
|
||||
* in="query",
|
||||
* description="Filter by partial Tag",
|
||||
* type="string",
|
||||
* required=false
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="exactTag",
|
||||
* in="query",
|
||||
* description="Filter by exact Tag",
|
||||
* type="string",
|
||||
* required=false
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="isSystem",
|
||||
* in="query",
|
||||
* description="Filter by isSystem flag",
|
||||
* type="integer",
|
||||
* required=false
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="isRequired",
|
||||
* in="query",
|
||||
* description="Filter by isRequired flag",
|
||||
* type="integer",
|
||||
* required=false
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="haveOptions",
|
||||
* in="query",
|
||||
* description="Set to 1 to show only results that have options set",
|
||||
* type="integer",
|
||||
* required=false
|
||||
* ),
|
||||
* @SWG\Response(
|
||||
* response=200,
|
||||
* description="successful operation",
|
||||
* @SWG\Schema(
|
||||
* type="array",
|
||||
* @SWG\Items(ref="#/definitions/Tag")
|
||||
* )
|
||||
* )
|
||||
* )
|
||||
* @param Request $request
|
||||
* @param Response $response
|
||||
* @return \Psr\Http\Message\ResponseInterface|Response
|
||||
* @throws \Xibo\Support\Exception\ControllerNotImplemented
|
||||
* @throws \Xibo\Support\Exception\GeneralException
|
||||
*/
|
||||
function grid(Request $request, Response $response)
|
||||
{
|
||||
$sanitizedQueryParams = $this->getSanitizer($request->getQueryParams());
|
||||
|
||||
$filter = [
|
||||
'tagId' => $sanitizedQueryParams->getInt('tagId'),
|
||||
'tag' => $sanitizedQueryParams->getString('tag'),
|
||||
'useRegexForName' => $sanitizedQueryParams->getCheckbox('useRegexForName'),
|
||||
'isSystem' => $sanitizedQueryParams->getCheckbox('isSystem'),
|
||||
'isRequired' => $sanitizedQueryParams->getCheckbox('isRequired'),
|
||||
'haveOptions' => $sanitizedQueryParams->getCheckbox('haveOptions'),
|
||||
'allTags' => $sanitizedQueryParams->getInt('allTags'),
|
||||
'logicalOperatorName' => $sanitizedQueryParams->getString('logicalOperatorName'),
|
||||
];
|
||||
|
||||
$tags = $this->tagFactory->query($this->gridRenderSort($sanitizedQueryParams), $this->gridRenderFilter($filter, $sanitizedQueryParams));
|
||||
|
||||
foreach ($tags as $tag) {
|
||||
/* @var \Xibo\Entity\Tag $tag */
|
||||
|
||||
if ($this->isApi($request)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$tag->includeProperty('buttons');
|
||||
$tag->buttons = [];
|
||||
|
||||
|
||||
//Show buttons for non system tags
|
||||
if ($tag->isSystem === 0) {
|
||||
// Edit the Tag
|
||||
$tag->buttons[] = [
|
||||
'id' => 'tag_button_edit',
|
||||
'url' => $this->urlFor($request,'tag.edit.form', ['id' => $tag->tagId]),
|
||||
'text' => __('Edit')
|
||||
];
|
||||
|
||||
// Delete Tag
|
||||
$tag->buttons[] = [
|
||||
'id' => 'tag_button_delete',
|
||||
'url' => $this->urlFor($request,'tag.delete.form', ['id' => $tag->tagId]),
|
||||
'text' => __('Delete'),
|
||||
'multi-select' => true,
|
||||
'dataAttributes' => [
|
||||
['name' => 'commit-url', 'value' => $this->urlFor($request,'tag.delete', ['id' => $tag->tagId])],
|
||||
['name' => 'commit-method', 'value' => 'delete'],
|
||||
['name' => 'id', 'value' => 'tag_button_delete'],
|
||||
['name' => 'text', 'value' => __('Delete')],
|
||||
['name' => 'sort-group', 'value' => 1],
|
||||
['name' => 'rowtitle', 'value' => $tag->tag]
|
||||
]
|
||||
];
|
||||
}
|
||||
|
||||
$tag->buttons[] = [
|
||||
'id' => 'tag_button_usage',
|
||||
'url' => $this->urlFor($request, 'tag.usage.form', ['id' => $tag->tagId]),
|
||||
'text' => __('Usage')
|
||||
];
|
||||
}
|
||||
|
||||
$this->getState()->template = 'grid';
|
||||
$this->getState()->recordsTotal = $this->tagFactory->countLast();
|
||||
$this->getState()->setData($tags);
|
||||
|
||||
return $this->render($request, $response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tag Add Form
|
||||
* @param Request $request
|
||||
* @param Response $response
|
||||
* @return \Psr\Http\Message\ResponseInterface|Response
|
||||
* @throws \Xibo\Support\Exception\ControllerNotImplemented
|
||||
* @throws \Xibo\Support\Exception\GeneralException
|
||||
*/
|
||||
public function addForm(Request $request, Response $response)
|
||||
{
|
||||
$this->getState()->template = 'tag-form-add';
|
||||
return $this->render($request, $response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a Tag
|
||||
*
|
||||
* @SWG\Post(
|
||||
* path="/tag",
|
||||
* operationId="tagAdd",
|
||||
* tags={"tags"},
|
||||
* summary="Add a new Tag",
|
||||
* description="Add a new Tag",
|
||||
* @SWG\Parameter(
|
||||
* name="name",
|
||||
* in="formData",
|
||||
* description="Tag name",
|
||||
* type="string",
|
||||
* required=false
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="isRequired",
|
||||
* in="formData",
|
||||
* description="A flag indicating whether value selection on assignment is required",
|
||||
* type="integer",
|
||||
* required=false
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="options",
|
||||
* in="formData",
|
||||
* description="A comma separated string of Tag options",
|
||||
* type="string",
|
||||
* required=false
|
||||
* ),
|
||||
* @SWG\Response(
|
||||
* response=201,
|
||||
* description="successful operation",
|
||||
* @SWG\Schema(
|
||||
* type="array",
|
||||
* @SWG\Items(ref="#/definitions/Tag")
|
||||
* )
|
||||
* )
|
||||
* )
|
||||
* @param Request $request
|
||||
* @param Response $response
|
||||
* @return \Psr\Http\Message\ResponseInterface|Response
|
||||
* @throws AccessDeniedException
|
||||
* @throws \Xibo\Support\Exception\ControllerNotImplemented
|
||||
* @throws \Xibo\Support\Exception\DuplicateEntityException
|
||||
* @throws \Xibo\Support\Exception\GeneralException
|
||||
* @throws \Xibo\Support\Exception\InvalidArgumentException
|
||||
*/
|
||||
public function add(Request $request, Response $response)
|
||||
{
|
||||
if (!$this->getUser()->isSuperAdmin()) {
|
||||
throw new AccessDeniedException();
|
||||
}
|
||||
|
||||
$sanitizedParams = $this->getSanitizer($request->getParams());
|
||||
|
||||
$values = [];
|
||||
$tag = $this->tagFactory->create($sanitizedParams->getString('name'));
|
||||
$tag->options = [];
|
||||
$tag->isRequired = $sanitizedParams->getCheckbox('isRequired');
|
||||
$optionValues = $sanitizedParams->getString('options');
|
||||
|
||||
if ($optionValues != '') {
|
||||
$optionValuesArray = explode(',', $optionValues);
|
||||
foreach ($optionValuesArray as $options) {
|
||||
$values[] = $options;
|
||||
}
|
||||
$tag->options = json_encode($values);
|
||||
} else {
|
||||
$tag->options = null;
|
||||
}
|
||||
|
||||
$tag->save();
|
||||
|
||||
// dispatch Tag add event
|
||||
$event = new TagAddEvent($tag->tagId);
|
||||
$this->getDispatcher()->dispatch($event, $event::$NAME);
|
||||
|
||||
// Return
|
||||
$this->getState()->hydrate([
|
||||
'httpStatus' => 201,
|
||||
'message' => sprintf(__('Added %s'), $tag->tag),
|
||||
'id' => $tag->tagId,
|
||||
'data' => $tag
|
||||
]);
|
||||
|
||||
return $this->render($request, $response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Edit a Tag
|
||||
*
|
||||
* @SWG\Put(
|
||||
* path="/tag/{tagId}",
|
||||
* operationId="tagEdit",
|
||||
* tags={"tags"},
|
||||
* summary="Edit existing Tag",
|
||||
* description="Edit existing Tag",
|
||||
* @SWG\Parameter(
|
||||
* name="name",
|
||||
* in="formData",
|
||||
* description="Tag name",
|
||||
* type="string",
|
||||
* required=false
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="isRequired",
|
||||
* in="formData",
|
||||
* description="A flag indicating whether value selection on assignment is required",
|
||||
* type="integer",
|
||||
* required=false
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="options",
|
||||
* in="formData",
|
||||
* description="A comma separated string of Tag options",
|
||||
* type="string",
|
||||
* required=false
|
||||
* ),
|
||||
* @SWG\Response(
|
||||
* response=201,
|
||||
* description="successful operation",
|
||||
* @SWG\Schema(
|
||||
* type="array",
|
||||
* @SWG\Items(ref="#/definitions/Tag")
|
||||
* )
|
||||
* )
|
||||
* )
|
||||
*
|
||||
*
|
||||
* @param Request $request
|
||||
* @param Response $response
|
||||
* @param $id
|
||||
* @return \Psr\Http\Message\ResponseInterface|Response
|
||||
* @throws NotFoundException
|
||||
* @throws \Xibo\Support\Exception\ControllerNotImplemented
|
||||
* @throws \Xibo\Support\Exception\GeneralException
|
||||
*/
|
||||
public function editForm(Request $request, Response $response, $id)
|
||||
{
|
||||
$tag = $this->tagFactory->getById($id);
|
||||
$tagOptions = '';
|
||||
|
||||
if (isset($tag->options)) {
|
||||
$tagOptions = implode(',', json_decode($tag->options));
|
||||
}
|
||||
|
||||
$this->getState()->template = 'tag-form-edit';
|
||||
$this->getState()->setData([
|
||||
'tag' => $tag,
|
||||
'options' => $tagOptions,
|
||||
]);
|
||||
|
||||
return $this->render($request, $response);
|
||||
}
|
||||
|
||||
public function usageForm(Request $request, Response $response, $id)
|
||||
{
|
||||
$tag = $this->tagFactory->getById($id);
|
||||
|
||||
$this->getState()->template = 'tag-usage-form';
|
||||
$this->getState()->setData([
|
||||
'tag' => $tag
|
||||
]);
|
||||
|
||||
return $this->render($request, $response);
|
||||
}
|
||||
|
||||
public function usage(Request $request, Response $response, $id)
|
||||
{
|
||||
$sanitizedParams = $this->getSanitizer($request->getParams());
|
||||
$sanitizedQueryParams = $this->getSanitizer($request->getQueryParams());
|
||||
|
||||
$filter = [
|
||||
'tagId' => $id,
|
||||
];
|
||||
|
||||
$entries = $this->tagFactory->getAllLinks(
|
||||
$this->gridRenderSort($sanitizedParams),
|
||||
$this->gridRenderFilter($filter, $sanitizedQueryParams)
|
||||
);
|
||||
|
||||
$this->getState()->template = 'grid';
|
||||
$this->getState()->recordsTotal = $this->tagFactory->countLast();
|
||||
$this->getState()->setData($entries);
|
||||
|
||||
return $this->render($request, $response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Edit a Tag
|
||||
*
|
||||
* @param Request $request
|
||||
* @param Response $response
|
||||
* @param $id
|
||||
* @return \Psr\Http\Message\ResponseInterface|Response
|
||||
* @throws AccessDeniedException
|
||||
* @throws NotFoundException
|
||||
* @throws \Xibo\Support\Exception\ControllerNotImplemented
|
||||
* @throws \Xibo\Support\Exception\DuplicateEntityException
|
||||
* @throws \Xibo\Support\Exception\GeneralException
|
||||
* @throws \Xibo\Support\Exception\InvalidArgumentException
|
||||
*/
|
||||
public function edit(Request $request, Response $response, $id)
|
||||
{
|
||||
if (!$this->getUser()->isSuperAdmin()) {
|
||||
throw new AccessDeniedException();
|
||||
}
|
||||
|
||||
$sanitizedParams = $this->getSanitizer($request->getParams());
|
||||
$tag = $this->tagFactory->getById($id);
|
||||
|
||||
if ($tag->isSystem === 1) {
|
||||
throw new AccessDeniedException(__('Access denied System tags cannot be edited'));
|
||||
}
|
||||
|
||||
if(isset($tag->options)) {
|
||||
$tagOptionsCurrent = implode(',', json_decode($tag->options));
|
||||
$tagOptionsArrayCurrent = explode(',', $tagOptionsCurrent);
|
||||
}
|
||||
|
||||
$values = [];
|
||||
|
||||
$oldTag = $tag->tag;
|
||||
$tag->tag = $sanitizedParams->getString('name');
|
||||
$tag->isRequired = $sanitizedParams->getCheckbox('isRequired');
|
||||
$optionValues = $sanitizedParams->getString('options');
|
||||
|
||||
if ($optionValues != '') {
|
||||
$optionValuesArray = explode(',', $optionValues);
|
||||
foreach ($optionValuesArray as $option) {
|
||||
$values[] = trim($option);
|
||||
}
|
||||
$tag->options = json_encode($values);
|
||||
} else {
|
||||
$tag->options = null;
|
||||
}
|
||||
|
||||
// if option were changed, we need to compare the array of options before and after edit
|
||||
if($tag->hasPropertyChanged('options')) {
|
||||
|
||||
if (isset($tagOptionsArrayCurrent)) {
|
||||
|
||||
if(isset($tag->options)) {
|
||||
$tagOptions = implode(',', json_decode($tag->options));
|
||||
$tagOptionsArray = explode(',', $tagOptions);
|
||||
} else {
|
||||
$tagOptionsArray = [];
|
||||
}
|
||||
|
||||
// compare array of options before and after the Tag edit was made
|
||||
$tagValuesToRemove = array_diff($tagOptionsArrayCurrent, $tagOptionsArray);
|
||||
|
||||
// go through every element of the new array and set the value to null if removed value was assigned to one of the lktag tables
|
||||
$tag->updateTagValues($tagValuesToRemove);
|
||||
}
|
||||
}
|
||||
|
||||
$tag->save();
|
||||
|
||||
// dispatch Tag edit event
|
||||
$event = new TagEditEvent($tag->tagId, $oldTag, $tag->tag);
|
||||
$this->getDispatcher()->dispatch($event, $event::$NAME);
|
||||
|
||||
// Return
|
||||
$this->getState()->hydrate([
|
||||
'httpStatus' => 201,
|
||||
'message' => sprintf(__('Edited %s'), $tag->tag),
|
||||
'id' => $tag->tagId,
|
||||
'data' => $tag
|
||||
]);
|
||||
|
||||
return $this->render($request,$response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Shows the Delete Group Form
|
||||
* @param Request $request
|
||||
* @param Response $response
|
||||
* @param $id
|
||||
* @return \Psr\Http\Message\ResponseInterface|Response
|
||||
* @throws NotFoundException
|
||||
* @throws \Xibo\Support\Exception\ControllerNotImplemented
|
||||
* @throws \Xibo\Support\Exception\GeneralException
|
||||
*/
|
||||
function deleteForm(Request $request, Response $response, $id)
|
||||
{
|
||||
$tag = $this->tagFactory->getById($id);
|
||||
|
||||
$this->getState()->template = 'tag-form-delete';
|
||||
$this->getState()->setData([
|
||||
'tag' => $tag,
|
||||
]);
|
||||
|
||||
return $this->render($request, $response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete Tag
|
||||
*
|
||||
* @SWG\Delete(
|
||||
* path="/tag/{tagId}",
|
||||
* operationId="tagDelete",
|
||||
* tags={"tags"},
|
||||
* summary="Delete Tag",
|
||||
* description="Delete a Tag",
|
||||
* @SWG\Parameter(
|
||||
* name="tagId",
|
||||
* in="path",
|
||||
* description="The Tag ID to delete",
|
||||
* type="integer",
|
||||
* required=true
|
||||
* ),
|
||||
* @SWG\Response(
|
||||
* response=204,
|
||||
* description="successful operation"
|
||||
* )
|
||||
* )
|
||||
*
|
||||
* @param Request $request
|
||||
* @param Response $response
|
||||
* @param $id
|
||||
* @return \Psr\Http\Message\ResponseInterface|Response
|
||||
* @throws AccessDeniedException
|
||||
* @throws NotFoundException
|
||||
* @throws \Xibo\Support\Exception\ConfigurationException
|
||||
* @throws \Xibo\Support\Exception\ControllerNotImplemented
|
||||
* @throws \Xibo\Support\Exception\DuplicateEntityException
|
||||
* @throws \Xibo\Support\Exception\GeneralException
|
||||
* @throws \Xibo\Support\Exception\InvalidArgumentException
|
||||
*/
|
||||
public function delete(Request $request, Response $response, $id)
|
||||
{
|
||||
if (!$this->getUser()->isSuperAdmin()) {
|
||||
throw new AccessDeniedException();
|
||||
}
|
||||
|
||||
$tag = $this->tagFactory->getById($id);
|
||||
|
||||
if ($tag->isSystem === 1) {
|
||||
throw new AccessDeniedException(__('Access denied System tags cannot be deleted'));
|
||||
}
|
||||
|
||||
// Dispatch delete event, remove this tag links in all lktag tables.
|
||||
$event = new TagDeleteEvent($tag->tagId);
|
||||
$this->getDispatcher()->dispatch($event, $event::$NAME);
|
||||
// tag delete, remove the record from tag table
|
||||
$tag->delete();
|
||||
|
||||
// Return
|
||||
$this->getState()->hydrate([
|
||||
'httpStatus' => 204,
|
||||
'message' => sprintf(__('Deleted %s'), $tag->tag)
|
||||
]);
|
||||
|
||||
return $this->render($request, $response);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Request $request
|
||||
* @param Response $response
|
||||
* @return \Psr\Http\Message\ResponseInterface|Response
|
||||
* @throws \Xibo\Support\Exception\ControllerNotImplemented
|
||||
* @throws \Xibo\Support\Exception\GeneralException
|
||||
*/
|
||||
public function loadTagOptions(Request $request, Response $response)
|
||||
{
|
||||
$tagName = $this->getSanitizer($request->getParams())->getString('name');
|
||||
|
||||
try {
|
||||
$tag = $this->tagFactory->getByTag($tagName);
|
||||
} catch (NotFoundException $e) {
|
||||
// User provided new tag, which is fine
|
||||
$tag = null;
|
||||
}
|
||||
|
||||
$this->getState()->setData([
|
||||
'tag' => ($tag === null) ? null : $tag
|
||||
]);
|
||||
|
||||
return $this->render($request, $response);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Request $request
|
||||
* @param Response $response
|
||||
* @return \Psr\Http\Message\ResponseInterface|Response
|
||||
* @throws AccessDeniedException
|
||||
* @throws NotFoundException
|
||||
* @throws \Xibo\Support\Exception\ConfigurationException
|
||||
* @throws \Xibo\Support\Exception\ControllerNotImplemented
|
||||
* @throws \Xibo\Support\Exception\DuplicateEntityException
|
||||
* @throws \Xibo\Support\Exception\GeneralException
|
||||
* @throws \Xibo\Support\Exception\InvalidArgumentException
|
||||
*/
|
||||
public function editMultiple(Request $request, Response $response)
|
||||
{
|
||||
// Handle permissions
|
||||
if (!$this->getUser()->featureEnabled('tag.tagging')) {
|
||||
throw new AccessDeniedException();
|
||||
}
|
||||
|
||||
$sanitizedParams = $this->getSanitizer($request->getParams());
|
||||
|
||||
$targetType = $sanitizedParams->getString('targetType');
|
||||
$targetIds = $sanitizedParams->getString('targetIds');
|
||||
$tagsToAdd = $sanitizedParams->getString('addTags');
|
||||
$tagsToRemove = $sanitizedParams->getString('removeTags');
|
||||
|
||||
// check if we need to do anything first
|
||||
if ($tagsToAdd != '' || $tagsToRemove != '') {
|
||||
|
||||
// covert comma separated string of ids into array
|
||||
$targetIdsArray = explode(',', $targetIds);
|
||||
|
||||
// get tags to assign and unassign
|
||||
$tags = $this->tagFactory->tagsFromString($tagsToAdd);
|
||||
$untags = $this->tagFactory->tagsFromString($tagsToRemove);
|
||||
|
||||
// depending on the type we need different factory
|
||||
switch ($targetType){
|
||||
case 'layout':
|
||||
$entityFactory = $this->layoutFactory;
|
||||
break;
|
||||
case 'playlist':
|
||||
$entityFactory = $this->playlistFactory;
|
||||
break;
|
||||
case 'media':
|
||||
$entityFactory = $this->mediaFactory;
|
||||
break;
|
||||
case 'campaign':
|
||||
$entityFactory = $this->campaignFactory;
|
||||
break;
|
||||
case 'displayGroup':
|
||||
case 'display':
|
||||
$entityFactory = $this->displayGroupFactory;
|
||||
break;
|
||||
default:
|
||||
throw new InvalidArgumentException(__('Edit multiple tags is not supported on this item'), 'targetType');
|
||||
}
|
||||
|
||||
foreach ($targetIdsArray as $id) {
|
||||
// get the entity by provided id, for display we need different function
|
||||
$this->getLog()->debug('editMultiple: lookup using id: ' . $id . ' for type: ' . $targetType);
|
||||
if ($targetType === 'display') {
|
||||
$entity = $entityFactory->getDisplaySpecificByDisplayId($id);
|
||||
} else {
|
||||
$entity = $entityFactory->getById($id);
|
||||
}
|
||||
|
||||
if ($targetType === 'display' || $targetType === 'displaygroup') {
|
||||
$this->getDispatcher()->dispatch(new DisplayGroupLoadEvent($entity), DisplayGroupLoadEvent::$NAME);
|
||||
}
|
||||
|
||||
foreach ($untags as $untag) {
|
||||
$entity->unassignTag($untag);
|
||||
}
|
||||
|
||||
// go through tags and adjust assignments.
|
||||
foreach ($tags as $tag) {
|
||||
$entity->assignTag($tag);
|
||||
}
|
||||
|
||||
$entity->save(['isTagEdit' => true]);
|
||||
}
|
||||
|
||||
// Once we're done, and if we're a Display entity, we need to calculate the dynamic display groups
|
||||
if ($targetType === 'display') {
|
||||
// Background update.
|
||||
$this->getDispatcher()->dispatch(
|
||||
new TriggerTaskEvent('\Xibo\XTR\MaintenanceRegularTask', 'DYNAMIC_DISPLAY_GROUP_ASSESSED'),
|
||||
TriggerTaskEvent::$NAME
|
||||
);
|
||||
}
|
||||
} else {
|
||||
$this->getLog()->debug('Tags were not changed');
|
||||
}
|
||||
|
||||
// Return
|
||||
$this->getState()->hydrate([
|
||||
'httpStatus' => 204,
|
||||
'message' => __('Tags Edited')
|
||||
]);
|
||||
|
||||
return $this->render($request, $response);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user