46 lines
1.2 KiB
PHP
46 lines
1.2 KiB
PHP
<?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\Service;
|
|
|
|
use Xibo\Entity\HelpLink;
|
|
|
|
/**
|
|
* Return help links for a page.
|
|
* @package Xibo\Service
|
|
*/
|
|
interface HelpServiceInterface
|
|
{
|
|
/**
|
|
* Get the landing page
|
|
* @return string
|
|
*/
|
|
public function getLandingPage(): string;
|
|
|
|
/**
|
|
* Get links for page
|
|
* @param string $pageName The page name to return links for
|
|
* @return HelpLink[]
|
|
*/
|
|
public function getLinksForPage(string $pageName): array;
|
|
}
|