1	<?php
2
3	declare(strict_types=1);
4
5	namespace PeServer\Core\Log;
6
7	/**
8	* ログ出力インターフェイス。
9	*
10	* !!注意!! PSR-3 には準拠していない。
11	*/
12	interface ILogger
13	{
14	#region define
15
16	/** レベル: トレース */
17	public const LOG_LEVEL_TRACE = 1;
18	/** レベル: デバッグ */
19	public const LOG_LEVEL_DEBUG = 2;
20	/** レベル: 情報 */
21	public const LOG_LEVEL_INFORMATION = 3;
22	/** レベル: 警告 */
23	public const LOG_LEVEL_WARNING = 4;
24	/** レベル: エラー */
25	public const LOG_LEVEL_ERROR = 5;
26
27	#endregion
28
29	#region function
30
31	/**
32	* ログ出力。
33	*
34	* アプリケーション層で呼び出すことはない。
35	*
36	* @param int $level ログレベル。
37	* @phpstan-param self::LOG_LEVEL_* $level ログレベル。
38	* @param int $traceIndex 現在フレーム数。
39	* @phpstan-param non-negative-int $traceIndex
40	* @param mixed $message メッセージかオブジェクト。
41	* @phpstan-param LogMessageAlias $message
42	* @param mixed ...$parameters パラメータ（可変個）。$messageが文字列の場合はプレースホルダー {\d} に対して置き換え処理が行われるがその場合は所謂0始まり・抜けなしの配列を想定している。
43	* @return void
44	*/
45	public function log(int $level, int $traceIndex, $message, ...$parameters): void;
46	/**
47	* トレース
48	*
49	* @param mixed $message メッセージかオブジェクト。
50	* @phpstan-param LogMessageAlias $message
51	* @param mixed ...$parameters パラメータ（可変個）。$messageが文字列の場合はプレースホルダー {\d} に対して置き換え処理が行われるがその場合は所謂0始まり・抜けなしの配列を想定している。
52	* @return void
53	*/
54	public function trace($message, ...$parameters): void;
55	/**
56	* デバッグ
57	*
58	* @param mixed $message メッセージかオブジェクト。
59	* @phpstan-param LogMessageAlias $message
60	* @param mixed ...$parameters パラメータ（可変個）。$messageが文字列の場合はプレースホルダー {\d} に対して置き換え処理が行われるがその場合は所謂0始まり・抜けなしの配列を想定している。
61	* @return void
62	*/
63	public function debug($message, ...$parameters): void;
64	/**
65	* 情報
66	*
67	* @param mixed $message メッセージかオブジェクト。
68	* @phpstan-param LogMessageAlias $message
69	* @param mixed ...$parameters パラメータ（可変個）。$messageが文字列の場合はプレースホルダー {\d} に対して置き換え処理が行われるがその場合は所謂0始まり・抜けなしの配列を想定している。
70	* @return void
71	*/
72	public function info($message, ...$parameters): void;
73	/**
74	* 警告
75	*
76	* @param mixed $message メッセージかオブジェクト。
77	* @phpstan-param LogMessageAlias $message
78	* @param mixed ...$parameters パラメータ（可変個）。$messageが文字列の場合はプレースホルダー {\d} に対して置き換え処理が行われるがその場合は所謂0始まり・抜けなしの配列を想定している。
79	* @return void
80	*/
81	public function warn($message, ...$parameters): void;
82	/**
83	* エラー
84	*
85	* @param mixed $message メッセージかオブジェクト。
86	* @phpstan-param LogMessageAlias $message
87	* @param mixed ...$parameters パラメータ（可変個）。$messageが文字列の場合はプレースホルダー {\d} に対して置き換え処理が行われるがその場合は所謂0始まり・抜けなしの配列を想定している。
88	* @return void
89	*/
90	public function error($message, ...$parameters): void;
91
92	#endregion
93	}