File: /home/posscale/subdomains/xibo/lib/Controller/Resolution.php
<?php
/*
* Xibo - Digital Signage - http://www.xibo.org.uk
* Copyright (C) 2009-2014 Daniel Garner
*
* 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 baseDAO;
use Kit;
use Xibo\Exception\AccessDeniedException;
use Xibo\Factory\ResolutionFactory;
use Xibo\Helper\Form;
use Xibo\Service\ConfigServiceInterface;
use Xibo\Service\DateServiceInterface;
use Xibo\Service\LogServiceInterface;
use Xibo\Service\SanitizerServiceInterface;
/**
* Class Resolution
* @package Xibo\Controller
*/
class Resolution extends Base
{
/**
* @var ResolutionFactory
*/
private $resolutionFactory;
/**
* Set common dependencies.
* @param LogServiceInterface $log
* @param SanitizerServiceInterface $sanitizerService
* @param \Xibo\Helper\ApplicationState $state
* @param \Xibo\Entity\User $user
* @param \Xibo\Service\HelpServiceInterface $help
* @param DateServiceInterface $date
* @param ConfigServiceInterface $config
* @param ResolutionFactory $resolutionFactory
*/
public function __construct($log, $sanitizerService, $state, $user, $help, $date, $config, $resolutionFactory)
{
$this->setCommonDependencies($log, $sanitizerService, $state, $user, $help, $date, $config);
$this->resolutionFactory = $resolutionFactory;
}
/**
* Display the Resolution Page
*/
function displayPage()
{
$this->getState()->template = 'resolution-page';
}
/**
* Resolution Grid
*
* @SWG\Get(
* path="/resolution",
* operationId="resolutionSearch",
* tags={"resolution"},
* summary="Resolution Search",
* description="Search Resolutions this user has access to",
* @SWG\Parameter(
* name="resolutionId",
* in="formData",
* description="Filter by Resolution Id",
* type="integer",
* required=false
* ),
* @SWG\Parameter(
* name="resolution",
* in="formData",
* description="Filter by Resolution Name",
* type="string",
* required=false
* ),
* @SWG\Parameter(
* name="enabled",
* in="formData",
* description="Filter by Enabled",
* type="integer",
* required=false
* ),
* @SWG\Response(
* response=200,
* description="successful operation",
* @SWG\Schema(
* type="array",
* @SWG\Items(ref="#/definitions/Resolution")
* )
* )
* )
*/
function grid()
{
// Show enabled
$filter = [
'enabled' => $this->getSanitizer()->getInt('enabled', -1),
'resolutionId' => $this->getSanitizer()->getInt('resolutionId'),
'resolution' => $this->getSanitizer()->getString('resolution')
];
$resolutions = $this->resolutionFactory->query($this->gridRenderSort(), $this->gridRenderFilter($filter));
foreach ($resolutions as $resolution) {
/* @var \Xibo\Entity\Resolution $resolution */
if ($this->isApi())
break;
$resolution->includeProperty('buttons');
if ($this->getUser()->checkEditable($resolution)) {
// Edit Button
$resolution->buttons[] = array(
'id' => 'resolution_button_edit',
'url' => $this->urlFor('resolution.edit.form', ['id' => $resolution->resolutionId]),
'text' => __('Edit')
);
}
if ($this->getUser()->checkDeleteable($resolution)) {
// Delete Button
$resolution->buttons[] = array(
'id' => 'resolution_button_delete',
'url' => $this->urlFor('resolution.delete.form', ['id' => $resolution->resolutionId]),
'text' => __('Delete')
);
}
}
$this->getState()->template = 'grid';
$this->getState()->setData($resolutions);
$this->getState()->recordsTotal = $this->resolutionFactory->countLast();
}
/**
* Resolution Add
*/
function addForm()
{
$this->getState()->template = 'resolution-form-add';
$this->getState()->setData([
'help' => $this->getHelp()->link('Resolution', 'Add')
]);
}
/**
* Resolution Edit Form
* @param int $resolutionId
*/
function editForm($resolutionId)
{
$resolution = $this->resolutionFactory->getById($resolutionId);
if (!$this->getUser()->checkEditable($resolution))
throw new AccessDeniedException();
$this->getState()->template = 'resolution-form-edit';
$this->getState()->setData([
'resolution' => $resolution,
'help' => $this->getHelp()->link('Resolution', 'Edit')
]);
}
/**
* Resolution Delete Form
* @param int $resolutionId
*/
function deleteForm($resolutionId)
{
$resolution = $this->resolutionFactory->getById($resolutionId);
if (!$this->getUser()->checkEditable($resolution))
throw new AccessDeniedException();
$this->getState()->template = 'resolution-form-delete';
$this->getState()->setData([
'resolution' => $resolution,
'help' => $this->getHelp()->link('Resolution', 'Delete')
]);
}
/**
* Add Resolution
*
* @SWG\Post(
* path="/resolution",
* operationId="resolutionAdd",
* tags={"resolution"},
* summary="Add Resolution",
* description="Add new Resolution",
* @SWG\Parameter(
* name="resolution",
* in="formData",
* description="A name for the Resolution",
* type="string",
* required=true
* ),
* @SWG\Parameter(
* name="width",
* in="formData",
* description="The Display Width of the Resolution",
* type="integer",
* required=true
* ),
* @SWG\Parameter(
* name="height",
* in="formData",
* description="The Display Height of the Resolution",
* type="integer",
* required=true
* ),
* @SWG\Response(
* response=201,
* description="successful operation",
* @SWG\Schema(ref="#/definitions/Resolution"),
* @SWG\Header(
* header="Location",
* description="Location of the new record",
* type="string"
* )
* )
* )
*/
function add()
{
/* @var \Xibo\Entity\Resolution $resolution */
$resolution = $this->resolutionFactory->create($this->getSanitizer()->getString('resolution'),
$this->getSanitizer()->getInt('width'),
$this->getSanitizer()->getInt('height'));
$resolution->userId = $this->getUser()->userId;
$resolution->save();
// Return
$this->getState()->hydrate([
'httpStatus' => 201,
'message' => sprintf(__('Added %s'), $resolution->resolution),
'id' => $resolution->resolutionId,
'data' => $resolution
]);
}
/**
* Edit Resolution
* @param int $resolutionId
*
* @SWG\Put(
* path="/resolution/{resolutionId}",
* operationId="resolutionEdit",
* tags={"resolution"},
* summary="Edit Resolution",
* description="Edit new Resolution",
* @SWG\Parameter(
* name="resolutionId",
* in="path",
* description="The Resolution ID to Edit",
* type="integer",
* required=true
* ),
* @SWG\Parameter(
* name="resolution",
* in="formData",
* description="A name for the Resolution",
* type="string",
* required=true
* ),
* @SWG\Parameter(
* name="width",
* in="formData",
* description="The Display Width of the Resolution",
* type="integer",
* required=true
* ),
* @SWG\Parameter(
* name="height",
* in="formData",
* description="The Display Height of the Resolution",
* type="integer",
* required=true
* ),
* @SWG\Response(
* response=200,
* description="successful operation",
* @SWG\Schema(ref="#/definitions/Resolution")
* )
* )
*/
function edit($resolutionId)
{
$resolution = $this->resolutionFactory->getById($resolutionId);
if (!$this->getUser()->checkEditable($resolution))
throw new AccessDeniedException();
$resolution->resolution = $this->getSanitizer()->getString('resolution');
$resolution->width = $this->getSanitizer()->getInt('width');
$resolution->height = $this->getSanitizer()->getInt('height');
$resolution->enabled = $this->getSanitizer()->getCheckbox('enabled');
$resolution->save();
// Return
$this->getState()->hydrate([
'message' => sprintf(__('Edited %s'), $resolution->resolution),
'id' => $resolution->resolutionId,
'data' => $resolution
]);
}
/**
* Delete Resolution
* @param int $resolutionId
*
* @SWG\Delete(
* path="/resolution/{resolutionId}",
* operationId="resolutionDelete",
* tags={"resolution"},
* summary="Delete Resolution",
* description="Delete Resolution",
* @SWG\Parameter(
* name="resolutionId",
* in="path",
* description="The Resolution ID to Delete",
* type="integer",
* required=true
* ),
* @SWG\Response(
* response=204,
* description="successful operation"
* )
* )
*/
function delete($resolutionId)
{
$resolution = $this->resolutionFactory->getById($resolutionId);
if (!$this->getUser()->checkDeleteable($resolution))
throw new AccessDeniedException();
$resolution->delete();
// Return
$this->getState()->hydrate([
'message' => sprintf(__('Deleted %s'), $resolution->resolution),
]);
}
}