SuiteCRM-Core/core/backend/SystemConfig/Service/SystemConfigProviderInterface.php
2025-09-08 11:29:33 +01:00

69 lines
2.2 KiB
PHP

<?php
/**
* SuiteCRM is a customer relationship management program developed by SuiteCRM Ltd.
* Copyright (C) 2021 SuiteCRM Ltd.
*
* This program 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 with the addition of the following permission added
* to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
* IN WHICH THE COPYRIGHT IS OWNED BY SUITECRM, SUITECRM DISCLAIMS THE
* WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* In accordance with Section 7(b) of the GNU Affero General Public License
* version 3, these Appropriate Legal Notices must retain the display of the
* "Supercharged by SuiteCRM" logo. If the display of the logos is not reasonably
* feasible for technical reasons, the Appropriate Legal Notices must display
* the words "Supercharged by SuiteCRM".
*/
namespace App\SystemConfig\Service;
use App\Engine\Model\Feedback;
use App\SystemConfig\Entity\SystemConfig;
interface SystemConfigProviderInterface
{
/**
* Get all exposed system configs
* @return array
*/
public function getAllSystemConfigs(): array;
/**
* Get system config
* @param string $configKey
* @param bool $filterNonExposed
* @return SystemConfig|null
*/
public function getSystemConfig(string $configKey, bool $filterNonExposed = false): ?SystemConfig;
/**
* Get legacy config array
* @return array|null
*/
public function getConfigs(): ?array;
/**
* Get legacy config defaults
* @return array|null
*/
public function getConfigDefaults(): ?array;
/**
* Get system config
* @param array $config
* @return Feedback
*/
public function updateSystemConfig(array $config): Feedback;
}