芝麻web文件管理V1.00

编辑当前文件:/home/mgatv524/public_html/mctv/lib/Widget/ModuleInterface.php

<?php
/**
 * Copyright (C) 2020 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;

use Carbon\Carbon;
use Slim\Http\Response as Response;
use Slim\Http\ServerRequest as Request;
use Xibo\Support\Exception\GeneralException;
use Xibo\Factory\ModuleFactory;

/**
 * Interface ModuleInterface
 * @package Xibo\Widget
 */
interface ModuleInterface
{
    /**
     * Add Widget
     * @param \Slim\Http\ServerRequest $request
     * @param \Slim\Http\Response $response
     * @return Response
     * @throws GeneralException
     */
    public function add(Request $request, Response $response): Response;

/**
     * Edit Widget
     * @param \Slim\Http\ServerRequest $request
     * @param \Slim\Http\Response $response
     * @return \Slim\Http\Response
     * @throws GeneralException
     */
    public function edit(Request $request, Response $response): Response;

/**
     * Delete Widget
     * @param \Slim\Http\ServerRequest $request
     * @param \Slim\Http\Response $response
     * @return Response
     */
    public function delete(Request $request, Response $response): Response;

/**
     * Module Settings
     * @param \Slim\Http\ServerRequest $request
     * @param \Slim\Http\Response $response
     * @throws GeneralException
     * @return \Slim\Http\Response
     */
    public function settings(Request $request, Response $response): Response;

/**
     * Download
     * @param Request $request
     * @param Response $response
     * @return Response
     */
    public function download(Request $request, Response $response): Response;

/**
     * Return the name of the media as input by the user
     * @return string
     */
    public function getName();

/**
     * @param $setting
     * @param null $default
     * @return string
     */
    public function getSetting($setting, $default = NULL);

/**
     * Get dynamic content for a specified tab
     * @param string $tab
     * @return mixed
     */
    public function getTab($tab);

/**
     * Preview this module
     * @param $width
     * @param $height
     * @param int $scaleOverride
     * @return mixed
     */
    public function preview($width, $height, $scaleOverride = 0);

/**
     * Is the Module Valid?
     * @return int (1 = Yes, 2 = Player Dependent)
     * @throws GeneralException
     */
    public function isValid();

/**
     * Install or Upgrade this module
     *    Expects $this->codeSchemaVersion to be set by the module.
     * @param ModuleFactory $moduleFactory
     */
    public function installOrUpdate($moduleFactory);

/**
     * Install module
     * @return mixed
     */
    public function installModule();

/**
     * Get the Modified Date of this Widget
     * @param int $displayId The displayId, or 0 for preview
     * @return Carbon the date this widgets was modified
     */
    public function getModifiedDate($displayId);

/**
     * Get the Cache Date for this Widget using the cache key
     * @param int $displayId The displayId we're requesting for, or 0 for preview
     * @return Carbon
     */
    public function getCacheDate($displayId);

/**
     * Set the Cache Date using the cache key
     * @param int $displayId The displayId we're requesting for, or 0 for preview
     */
    public function setCacheDate($displayId);

/**
     * Get Cache Key
     * @param int $displayId The displayId we're requesting for, or 0 for preview
     * @return string
     */
    public function getCacheKey($displayId);

/**
     * Get the lock key for this widget.
     * should return the most unique lock key required to prevent concurrent access
     * normally the default is fine, unless the module fetches some external images
     * @return string
     */
    public function getLockKey();

/**
     * Get Cache Duration
     * @return int the number of seconds the widget should be cached.
     */
    public function getCacheDuration();

/**
     * Is the Cache for this Module display specific, or can we assume that if we've calculated the
     * cache for 1 display, we've calculated for all.
     * this should reflect the cacheKey
     * @return bool
     */
    public function isCacheDisplaySpecific();

/**
     * Get Resource or Cache
     * @param int $displayId The displayId we're requesting for, or 0 for preview
     * @return string
     * @throws GeneralException
     */
    public function getResourceOrCache($displayId);

/**
     * Get Resource
     * @param int $displayId The displayId we're requesting for, or 0 for preview
     * @return string|false
     * @throws GeneralException
     */
    public function getResource($displayId = 0);

/**
     * Check if status message is not empty
     * @return bool
     */
    public function hasStatusMessage();

/**
     * Gets the Module status message
     * @return string
     */
    public function getStatusMessage();

/**
     * Check if this Module has a thumbnail
     * @return bool
     */
    public function hasThumbnail();
}