Files

630 lines
20 KiB
PHP
Raw Permalink Normal View History

2025-12-02 10:32:59 -05:00
<?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\Factory\FolderFactory;
use Xibo\Factory\MenuBoardFactory;
use Xibo\Factory\UserFactory;
use Xibo\Support\Exception\AccessDeniedException;
use Xibo\Support\Exception\GeneralException;
use Xibo\Support\Exception\InvalidArgumentException;
use Xibo\Support\Exception\NotFoundException;
/**
* Menu Board Controller
*/
class MenuBoard extends Base
{
/**
* Set common dependencies.
* @param MenuBoardFactory $menuBoardFactory
* @param FolderFactory $folderFactory
*/
public function __construct(
private readonly MenuBoardFactory $menuBoardFactory,
private readonly FolderFactory $folderFactory
) {
}
/**
* Displays the Menu Board Page
* @param Request $request
* @param Response $response
* @return \Psr\Http\Message\ResponseInterface|Response
* @throws GeneralException
* @throws \Xibo\Support\Exception\ControllerNotImplemented
*/
public function displayPage(Request $request, Response $response)
{
// Call to render the template
$this->getState()->template = 'menuboard-page';
return $this->render($request, $response);
}
/**
* Returns a Grid of Menu Boards
*
* @SWG\Get(
* path="/menuboards",
* operationId="menuBoardSearch",
* tags={"menuBoard"},
* summary="Search Menu Boards",
* description="Search all Menu Boards this user has access to",
* @SWG\Parameter(
* name="menuId",
* in="query",
* description="Filter by Menu board Id",
* type="integer",
* required=false
* ),
* @SWG\Parameter(
* name="userId",
* in="query",
* description="Filter by Owner Id",
* type="integer",
* required=false
* ),
* @SWG\Parameter(
* name="folderId",
* in="query",
* description="Filter by Folder Id",
* type="integer",
* required=false
* ),
* @SWG\Parameter(
* name="name",
* in="query",
* description="Filter by name",
* type="string",
* required=false
* ),
* @SWG\Parameter(
* name="code",
* in="query",
* description="Filter by code",
* type="string",
* required=false
* ),
* @SWG\Response(
* response=200,
* description="successful operation",
* @SWG\Schema(
* type="array",
* @SWG\Items(ref="#/definitions/MenuBoard")
* )
* )
* )
* @param Request $request
* @param Response $response
* @return \Psr\Http\Message\ResponseInterface|Response
* @throws GeneralException
*/
public function grid(Request $request, Response $response): Response
{
$parsedParams = $this->getSanitizer($request->getQueryParams());
$filter = [
'menuId' => $parsedParams->getInt('menuId'),
'userId' => $parsedParams->getInt('userId'),
'name' => $parsedParams->getString('name'),
'code' => $parsedParams->getString('code'),
'folderId' => $parsedParams->getInt('folderId'),
'logicalOperatorName' => $parsedParams->getString('logicalOperatorName'),
];
$menuBoards = $this->menuBoardFactory->query(
$this->gridRenderSort($parsedParams),
$this->gridRenderFilter($filter, $parsedParams)
);
foreach ($menuBoards as $menuBoard) {
if ($this->isApi($request)) {
continue;
}
$menuBoard->includeProperty('buttons');
$menuBoard->buttons = [];
if ($this->getUser()->featureEnabled('menuBoard.modify') && $this->getUser()->checkEditable($menuBoard)) {
$menuBoard->buttons[] = [
'id' => 'menuBoard_button_viewcategories',
'url' => $this->urlFor($request, 'menuBoard.category.view', ['id' => $menuBoard->menuId]),
'class' => 'XiboRedirectButton',
'text' => __('View Categories')
];
$menuBoard->buttons[] = [
'id' => 'menuBoard_edit_button',
'url' => $this->urlFor($request, 'menuBoard.edit.form', ['id' => $menuBoard->menuId]),
'text' => __('Edit')
];
if ($this->getUser()->featureEnabled('folder.view')) {
// Select Folder
$menuBoard->buttons[] = [
'id' => 'menuBoard_button_selectfolder',
'url' => $this->urlFor($request, 'menuBoard.selectfolder.form', ['id' => $menuBoard->menuId]),
'text' => __('Select Folder'),
'multi-select' => true,
'dataAttributes' => [
[
'name' => 'commit-url',
'value' => $this->urlFor($request, 'menuBoard.selectfolder', ['id' => $menuBoard->menuId])
],
['name' => 'commit-method', 'value' => 'put'],
['name' => 'id', 'value' => 'menuBoard_button_selectfolder'],
['name' => 'text', 'value' => __('Move to Folder')],
['name' => 'rowtitle', 'value' => $menuBoard->name],
['name' => 'form-callback', 'value' => 'moveFolderMultiSelectFormOpen']
]
];
}
}
if ($this->getUser()->featureEnabled('menuBoard.modify') && $this->getUser()->checkPermissionsModifyable($menuBoard)) {
$menuBoard->buttons[] = ['divider' => true];
// Share button
$menuBoard->buttons[] = [
'id' => 'menuBoard_button_permissions',
'url' => $this->urlFor($request, 'user.permissions.form', ['entity' => 'MenuBoard', 'id' => $menuBoard->menuId]),
'text' => __('Share'),
'dataAttributes' => [
[
'name' => 'commit-url',
'value' => $this->urlFor($request, 'user.permissions.multi', ['entity' => 'MenuBoard', 'id' => $menuBoard->menuId])
],
['name' => 'commit-method', 'value' => 'post'],
['name' => 'id', 'value' => 'menuBoard_button_permissions'],
['name' => 'text', 'value' => __('Share')],
['name' => 'rowtitle', 'value' => $menuBoard->name],
['name' => 'sort-group', 'value' => 2],
['name' => 'custom-handler', 'value' => 'XiboMultiSelectPermissionsFormOpen'],
[
'name' => 'custom-handler-url',
'value' => $this->urlFor($request, 'user.permissions.multi.form', ['entity' => 'MenuBoard'])
],
['name' => 'content-id-name', 'value' => 'menuId']
]
];
}
if ($this->getUser()->featureEnabled('menuBoard.modify')
&& $this->getUser()->checkDeleteable($menuBoard)
) {
$menuBoard->buttons[] = ['divider' => true];
$menuBoard->buttons[] = [
'id' => 'menuBoard_delete_button',
'url' => $this->urlFor($request, 'menuBoard.delete.form', ['id' => $menuBoard->menuId]),
'text' => __('Delete')
];
}
}
$this->getState()->template = 'grid';
$this->getState()->recordsTotal = $this->menuBoardFactory->countLast();
$this->getState()->setData($menuBoards);
return $this->render($request, $response);
}
/**
* Menu Board Add Form
* @param Request $request
* @param Response $response
* @return \Psr\Http\Message\ResponseInterface|Response
* @throws GeneralException
*/
public function addForm(Request $request, Response $response): Response
{
$this->getState()->template = 'menuboard-form-add';
return $this->render($request, $response);
}
/**
* Add a new Menu Board
*
* @SWG\Post(
* path="/menuboard",
* operationId="menuBoardAdd",
* tags={"menuBoard"},
* summary="Add Menu Board",
* description="Add a new Menu Board",
* @SWG\Parameter(
* name="name",
* in="formData",
* description="Menu Board name",
* type="string",
* required=true
* ),
* @SWG\Parameter(
* name="description",
* in="formData",
* description="Menu Board description",
* type="string",
* required=false
* ),
* @SWG\Parameter(
* name="code",
* in="formData",
* description="Menu Board code identifier",
* type="string",
* required=false
* ),
* @SWG\Parameter(
* name="folderId",
* in="formData",
* description="Menu Board Folder Id",
* type="integer",
* required=false
* ),
* @SWG\Response(
* response=201,
* description="successful operation",
* @SWG\Schema(ref="#/definitions/MenuBoard"),
* @SWG\Header(
* header="Location",
* description="Location of the new record",
* type="string"
* )
* )
* )
* @param Request $request
* @param Response $response
* @return \Psr\Http\Message\ResponseInterface|Response
* @throws GeneralException
* @throws \Xibo\Support\Exception\InvalidArgumentException
*/
public function add(Request $request, Response $response): Response
{
$sanitizedParams = $this->getSanitizer($request->getParams());
$name = $sanitizedParams->getString('name');
$description = $sanitizedParams->getString('description');
$code = $sanitizedParams->getString('code');
$folderId = $sanitizedParams->getInt('folderId');
if ($folderId === 1) {
$this->checkRootFolderAllowSave();
}
if (empty($folderId) || !$this->getUser()->featureEnabled('folder.view')) {
$folderId = $this->getUser()->homeFolderId;
}
$folder = $this->folderFactory->getById($folderId, 0);
$menuBoard = $this->menuBoardFactory->create($name, $description, $code);
$menuBoard->folderId = $folder->getId();
$menuBoard->permissionsFolderId = $folder->getPermissionFolderIdOrThis();
$menuBoard->save();
// Return
$this->getState()->hydrate([
'message' => __('Added Menu Board'),
'httpStatus' => 201,
'id' => $menuBoard->menuId,
'data' => $menuBoard,
]);
return $this->render($request, $response);
}
/**
* @param Request $request
* @param Response $response
* @param int $id
* @return Response
* @throws GeneralException
* @throws \Xibo\Support\Exception\ControllerNotImplemented
*/
public function editForm(Request $request, Response $response, $id): Response
{
$menuBoard = $this->menuBoardFactory->getById($id);
if (!$this->getUser()->checkEditable($menuBoard)) {
throw new AccessDeniedException();
}
$this->getState()->template = 'menuboard-form-edit';
$this->getState()->setData([
'menuBoard' => $menuBoard
]);
return $this->render($request, $response);
}
/**
* @SWG\Put(
* path="/menuboard/{menuId}",
* operationId="menuBoardEdit",
* tags={"menuBoard"},
* summary="Edit Menu Board",
* description="Edit existing Menu Board",
* @SWG\Parameter(
* name="menuId",
* in="path",
* description="The Menu Board ID to Edit",
* type="integer",
* required=true
* ),
* @SWG\Parameter(
* name="name",
* in="formData",
* description="Menu Board name",
* type="string",
* required=true
* ),
* @SWG\Parameter(
* name="description",
* in="formData",
* description="Menu Board description",
* type="string",
* required=false
* ),
* @SWG\Parameter(
* name="code",
* in="formData",
* description="Menu Board code identifier",
* type="string",
* required=false
* ),
* @SWG\Parameter(
* name="folderId",
* in="formData",
* description="Menu Board Folder Id",
* type="integer",
* required=false
* ),
* @SWG\Response(
* response=204,
* description="successful operation"
* )
* )
*
* @param Request $request
* @param Response $response
* @param int $id
* @return Response
* @throws AccessDeniedException
* @throws GeneralException
* @throws InvalidArgumentException
* @throws NotFoundException
*/
public function edit(Request $request, Response $response, $id): Response
{
$menuBoard = $this->menuBoardFactory->getById($id);
if (!$this->getUser()->checkEditable($menuBoard)) {
throw new AccessDeniedException();
}
$sanitizedParams = $this->getSanitizer($request->getParams());
$menuBoard->name = $sanitizedParams->getString('name');
$menuBoard->description = $sanitizedParams->getString('description');
$menuBoard->code = $sanitizedParams->getString('code');
$menuBoard->folderId = $sanitizedParams->getInt('folderId', ['default' => $menuBoard->folderId]);
if ($menuBoard->hasPropertyChanged('folderId')) {
if ($menuBoard->folderId === 1) {
$this->checkRootFolderAllowSave();
}
$folder = $this->folderFactory->getById($menuBoard->folderId);
$menuBoard->permissionsFolderId = ($folder->getPermissionFolderId() == null) ? $folder->id : $folder->getPermissionFolderId();
}
$menuBoard->save();
// Success
$this->getState()->hydrate([
'httpStatus' => 200,
'message' => sprintf(__('Edited %s'), $menuBoard->name),
'id' => $menuBoard->menuId,
'data' => $menuBoard
]);
return $this->render($request, $response);
}
/**
*
* @param Request $request
* @param Response $response
* @param int $id
* @return Response
* @throws GeneralException
* @throws \Xibo\Support\Exception\ControllerNotImplemented
*/
public function deleteForm(Request $request, Response $response, $id): Response
{
$menuBoard = $this->menuBoardFactory->getById($id);
if (!$this->getUser()->checkDeleteable($menuBoard)) {
throw new AccessDeniedException();
}
$this->getState()->template = 'menuboard-form-delete';
$this->getState()->setData([
'menuBoard' => $menuBoard
]);
return $this->render($request, $response);
}
/**
* @SWG\Delete(
* path="/menuboard/{menuId}",
* operationId="menuBoardDelete",
* tags={"menuBoard"},
* summary="Delete Menu Board",
* description="Delete existing Menu Board",
* @SWG\Parameter(
* name="menuId",
* in="path",
* description="The Menu Board ID to Delete",
* type="integer",
* required=true
* ),
* @SWG\Response(
* response=204,
* description="successful operation"
* )
* )
*
* @param Request $request
* @param Response $response
* @param $id
* @return Response
* @throws AccessDeniedException
* @throws GeneralException
* @throws InvalidArgumentException
* @throws NotFoundException
*/
public function delete(Request $request, Response $response, $id): Response
{
$menuBoard = $this->menuBoardFactory->getById($id);
if (!$this->getUser()->checkDeleteable($menuBoard)) {
throw new AccessDeniedException();
}
// Issue the delete
$menuBoard->delete();
// Success
$this->getState()->hydrate([
'httpStatus' => 204,
'message' => sprintf(__('Deleted %s'), $menuBoard->name)
]);
return $this->render($request, $response);
}
/**
* Select Folder Form
* @param Request $request
* @param Response $response
* @param int $id
* @return \Psr\Http\Message\ResponseInterface|Response
* @throws AccessDeniedException
* @throws GeneralException
* @throws NotFoundException
* @throws \Xibo\Support\Exception\ControllerNotImplemented
*/
public function selectFolderForm(Request $request, Response $response, $id)
{
// Get the Menu Board
$menuBoard = $this->menuBoardFactory->getById($id);
// Check Permissions
if (!$this->getUser()->checkEditable($menuBoard)) {
throw new AccessDeniedException();
}
$data = [
'menuBoard' => $menuBoard
];
$this->getState()->template = 'menuboard-form-selectfolder';
$this->getState()->setData($data);
return $this->render($request, $response);
}
/**
* @SWG\Put(
* path="/menuboard/{id}/selectfolder",
* operationId="menuBoardSelectFolder",
* tags={"menuBoard"},
* summary="Menu Board Select folder",
* description="Select Folder for Menu Board",
* @SWG\Parameter(
* name="menuId",
* in="path",
* description="The Menu Board ID",
* type="integer",
* required=true
* ),
* @SWG\Parameter(
* name="folderId",
* in="formData",
* description="Folder ID to which this object should be assigned to",
* type="integer",
* required=true
* ),
* @SWG\Response(
* response=200,
* description="successful operation",
* @SWG\Schema(ref="#/definitions/MenuBoard")
* )
* )
*
* @param Request $request
* @param Response $response
* @param int $id
* @return \Psr\Http\Message\ResponseInterface|Response
* @throws AccessDeniedException
* @throws GeneralException
* @throws InvalidArgumentException
* @throws NotFoundException
* @throws \Xibo\Support\Exception\ControllerNotImplemented
*/
public function selectFolder(Request $request, Response $response, $id)
{
// Get the Menu Board
$menuBoard = $this->menuBoardFactory->getById($id);
// Check Permissions
if (!$this->getUser()->checkEditable($menuBoard)) {
throw new AccessDeniedException();
}
$folderId = $this->getSanitizer($request->getParams())->getInt('folderId');
if ($folderId === 1) {
$this->checkRootFolderAllowSave();
}
$menuBoard->folderId = $folderId;
$folder = $this->folderFactory->getById($menuBoard->folderId);
$menuBoard->permissionsFolderId = ($folder->getPermissionFolderId() == null) ? $folder->id : $folder->getPermissionFolderId();
// Save
$menuBoard->save();
// Return
$this->getState()->hydrate([
'httpStatus' => 204,
'message' => sprintf(__('Menu Board %s moved to Folder %s'), $menuBoard->name, $folder->text)
]);
return $this->render($request, $response);
}
}