server/lib/public/Support/CrashReport/IRegistry.php
Christoph Wurst d3a244f9d9
Allow crash reporters to catpture any message
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2019-05-09 14:06:44 +02:00

76 lines
1.8 KiB
PHP

<?php
declare(strict_types=1);
/**
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
*
* @license GNU AGPL version 3 or any later version
*
* This program 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 (at your option) any later version.
*
* 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/>.
*
*/
namespace OCP\Support\CrashReport;
use Exception;
use Throwable;
/**
* @since 13.0.0
*/
interface IRegistry {
/**
* Register a reporter instance
*
* @param IReporter $reporter
*
* @since 13.0.0
*/
public function register(IReporter $reporter): void;
/**
* Delegate breadcrumb collection to all registered reporters
*
* @param string $message
* @param string $category
* @param array $context
*
* @since 15.0.0
*/
public function delegateBreadcrumb(string $message, string $category, array $context = []): void;
/**
* Delegate crash reporting to all registered reporters
*
* @param Exception|Throwable $exception
* @param array $context
*
* @since 13.0.0
*/
public function delegateReport($exception, array $context = []);
/**
* Delegate a message to all reporters that implement IMessageReporter
*
* @param string $message
* @param array $context
*
* @return void
*
* @since 17.0.0
*/
public function delegateMessage(string $message, array $context = []): void;
}