0
0
mirror of https://github.com/nextcloud/server.git synced 2024-12-29 00:18:42 +00:00
nextcloud_server/lib/public/SetupCheck/ISetupCheck.php
Andy Scherzinger dae7c159f7
chore: Add SPDX header
Signed-off-by: Andy Scherzinger <info@andy-scherzinger.de>
2024-05-24 13:11:22 +02:00

37 lines
794 B
PHP

<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OCP\SetupCheck;
/**
* This interface needs to be implemented if you want to provide custom
* setup checks in your application. The results of these checks will them
* be displayed in the admin overview.
*
* @since 28.0.0
*/
interface ISetupCheck {
/**
* @since 28.0.0
* @return string Category id, one of security/system/accounts, or a custom one which will be merged in system
*/
public function getCategory(): string;
/**
* @since 28.0.0
* @return string Translated name to display to the user
*/
public function getName(): string;
/**
* @since 28.0.0
*/
public function run(): SetupResult;
}