nextcloud/apps/theming/lib/ITheme.php
Joas Schilling aa5f037af7
chore: apply changes from Nextcloud coding standards 1.1.1
Signed-off-by: Joas Schilling <coding@schilljs.com>
Signed-off-by: Benjamin Gaussorgues <benjamin.gaussorgues@nextcloud.com>
2023-11-23 10:36:13 +01:00

101 lines
2.1 KiB
PHP

<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2022 John Molakvoæ <skjnldsv@protonmail.com>
*
* @author John Molakvoæ <skjnldsv@protonmail.com>
*
* @license GNU AGPL version 3 or any later version
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/
namespace OCA\Theming;
/**
* Interface ITheme
*
* @since 25.0.0
*/
interface ITheme {
public const TYPE_THEME = 1;
public const TYPE_FONT = 2;
/**
* Unique theme id
* Will be used to search for ID.png in the img folder
*
* @since 25.0.0
*/
public function getId(): string;
/**
* Theme type
* TYPE_THEME or TYPE_FONT
*
* @since 25.0.0
*/
public function getType(): int;
/**
* The theme translated title
*
* @since 25.0.0
*/
public function getTitle(): string;
/**
* The theme enable checkbox translated label
*
* @since 25.0.0
*/
public function getEnableLabel(): string;
/**
* The theme translated description
*
* @since 25.0.0
*/
public function getDescription(): string;
/**
* Get the media query triggering this theme
* Optional, ignored if falsy
*
* @return string
* @since 25.0.0
*/
public function getMediaQuery(): string;
/**
* Return the list of changed css variables
*
* @return array
* @since 25.0.0
*/
public function getCSSVariables(): array;
/**
* Return the custom css necessary for that app
* ⚠️ Warning, should be used slightly.
* Theoretically, editing the variables should be enough.
*
* @return string
* @since 25.0.0
*/
public function getCustomCss(): string;
}