summaryrefslogtreecommitdiffstats
path: root/lib/SimpleSAML/Logger/LoggingHandlerInterface.php
blob: c7b00eb01a125423972f195eeff8530471b80496 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<?php

namespace SimpleSAML\Logger;

/**
 * The interface that must be implemented by any log handler.
 *
 * @author Jaime Perez Crespo, UNINETT AS.
 * @package SimpleSAMLphp
 */

interface LoggingHandlerInterface
{

    /**
     * Constructor for log handlers. It must accept receiving a \SimpleSAML_Configuration object.
     *
     * @param \SimpleSAML_Configuration $config The configuration to use in this log handler.
     */
    public function __construct(\SimpleSAML_Configuration $config);


    /**
     * Log a message to its destination.
     *
     * @param int $level The log level.
     * @param string $string The message to log.
     */
    public function log($level, $string);


    /**
     * Set the format desired for the logs.
     *
     * @param string $format The format used for logs.
     */
    public function setLogFormat($format);
}