MainLogger Class Reference

Public Member Functions
	setSendMsg ($b)
	getMessages ()
	__construct ($logFile, $logDebug=false)
	emergency ($message, $name="EMERGENCY")
	alert ($message, $name="ALERT")
	critical ($message, $name="CRITICAL")
	error ($message, $name="ERROR")
	warning ($message, $name="WARNING")
	notice ($message, $name="NOTICE")
	info ($message, $name="INFO")
	debug ($message, $name="DEBUG")
	setLogDebug ($logDebug)
	logException (\Throwable $e, $trace=null)
	log ($level, $message)
	shutdown ()
	run ()
	setWrite ($write)
	setConsoleCallback ($callback)
Public Member Functions inherited from AttachableThreadedLogger
	addAttachment (\ThreadedLoggerAttachment $attachment)
	removeAttachment (\ThreadedLoggerAttachment $attachment)
	removeAttachments ()
	getAttachments ()
Public Member Functions inherited from Thread
	getCreatorId ()
	getThreadId ()
	isJoined ()
	isStarted ()
	join ()
	start (int $options=PTHREADS_INHERIT_ALL)
Public Member Functions inherited from Threaded
	chunk ($size, bool $preserve=false)
	count ()
	isRunning ()
	isTerminated ()
	merge ($from, $overwrite=true)
	notify ()
	notifyOne ()
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	pop ()
	run ()
	shift ()
	synchronized (\Closure $function, $args=null)
	wait ($timeout)
	getRefCount ()
	addRef ()
	delRef ()
	isGarbage ()
Public Member Functions inherited from Logger
	emergency ($message)
	alert ($message)
	critical ($message)
	error ($message)
	warning ($message)
	notice ($message)
	info ($message)
	debug ($message)

Static Public Member Functions
static	getLogger ()
Static Public Member Functions inherited from Thread
static	getCurrentThread ()
static	getCurrentThreadId ()
Static Public Member Functions inherited from Threaded
static	extend ($obj)

Data Fields
	$shouldSendMsg = ""
	$shouldRecordMsg = false

Static Public Attributes
static	$logger = null

Protected Member Functions
	send ($message, $level, $prefix, $color)

Protected Attributes
	$logFile
	$logStream
	$shutdown
	$logDebug
	$write = false
Protected Attributes inherited from AttachableThreadedLogger
	$attachment = null

Constructor & Destructor Documentation

__construct()

__construct	(		$logFile,
			$logDebug = false
	)

Parameters

string	$logFile
bool	$logDebug

Exceptions

                                                            {
        if(static::$logger instanceof MainLogger){
            throw new \RuntimeException("MainLogger has been already created");
        }
        static::$logger = $this;
        touch($logFile);
        $this->logFile = $logFile;
        $this->logDebug = (bool) $logDebug;
        $this->logStream = new \Threaded;
        $this->start();
    }

Member Function Documentation

alert()

alert	(		$message,
			$name = "ALERT"
	)

Parameters

string	$message
string	$name

                                                    {
        $this->send($message, \LogLevel::ALERT, $name, TextFormat::RED);
    }

critical()

critical	(		$message,
			$name = "CRITICAL"
	)

Parameters

string	$message
string	$name

                                                          {
        $this->send($message, \LogLevel::CRITICAL, $name, TextFormat::RED);
    }

debug()

debug	(		$message,
			$name = "DEBUG"
	)

Parameters

string	$message
string	$name

                                                    {
        if($this->logDebug === false){
            return;
        }
        $this->send($message, \LogLevel::DEBUG, $name, TextFormat::GRAY);
    }

emergency()

emergency	(		$message,
			$name = "EMERGENCY"
	)

Parameters

string	$message
string	$name

                                                            {
        $this->send($message, \LogLevel::EMERGENCY, $name, TextFormat::RED);
    }

error()

error	(		$message,
			$name = "ERROR"
	)

Parameters

string	$message
string	$name

                                                    {
        $this->send($message, \LogLevel::ERROR, $name, TextFormat::DARK_RED);
    }

getLogger()

static getLogger ( )

static

Returns

MainLogger

                                      {
        return static::$logger;
    }

getMessages()

getMessages

(

)

Returns

string

                                 {
        $msg = $this->shouldSendMsg;
        $this->shouldSendMsg = "";
        $this->lastGet = time();
        return $msg;
    }

info()

info	(		$message,
			$name = "INFO"
	)

Parameters

string	$message
string	$name

                                                  {
        $this->send($message, \LogLevel::INFO, $name, TextFormat::WHITE);
    }

log()

log	(		$level,
			$message
	)

Parameters

mixed	$level
string	$message

Implements Logger.

                                         {
        switch($level){
            case LogLevel::EMERGENCY:
                $this->emergency($message);
                break;
            case LogLevel::ALERT:
                $this->alert($message);
                break;
            case LogLevel::CRITICAL:
                $this->critical($message);
                break;
            case LogLevel::ERROR:
                $this->error($message);
                break;
            case LogLevel::WARNING:
                $this->warning($message);
                break;
            case LogLevel::NOTICE:
                $this->notice($message);
                break;
            case LogLevel::INFO:
                $this->info($message);
                break;
            case LogLevel::DEBUG:
                $this->debug($message);
                break;
        }
    }

logException()

logException	(	\Throwable	$e,
			$trace = null
	)

Parameters

\Throwable	$e
null	$trace

Implements Logger.

                                                              {
        if($trace === null){
            $trace = $e->getTrace();
        }
        $errstr = $e->getMessage();
        $errfile = $e->getFile();
        $errno = $e->getCode();
        $errline = $e->getLine();

        $errorConversion = [
            0 => "EXCEPTION",
            E_ERROR => "E_ERROR",
            E_WARNING => "E_WARNING",
            E_PARSE => "E_PARSE",
            E_NOTICE => "E_NOTICE",
            E_CORE_ERROR => "E_CORE_ERROR",
            E_CORE_WARNING => "E_CORE_WARNING",
            E_COMPILE_ERROR => "E_COMPILE_ERROR",
            E_COMPILE_WARNING => "E_COMPILE_WARNING",
            E_USER_ERROR => "E_USER_ERROR",
            E_USER_WARNING => "E_USER_WARNING",
            E_USER_NOTICE => "E_USER_NOTICE",
            E_STRICT => "E_STRICT",
            E_RECOVERABLE_ERROR => "E_RECOVERABLE_ERROR",
            E_DEPRECATED => "E_DEPRECATED",
            E_USER_DEPRECATED => "E_USER_DEPRECATED",
        ];
        if($errno === 0){
            $type = LogLevel::CRITICAL;
        }else{
            $type = ($errno === E_ERROR or $errno === E_USER_ERROR) ? LogLevel::ERROR : (($errno === E_USER_WARNING or $errno === E_WARNING) ? LogLevel::WARNING : LogLevel::NOTICE);
        }
        $errno = isset($errorConversion[$errno]) ? $errorConversion[$errno] : $errno;
        if(($pos = strpos($errstr, "\n")) !== false){
            $errstr = substr($errstr, 0, $pos);
        }
        $errfile = \pocketmine\cleanPath($errfile);
        $this->log($type, get_class($e) . ": \"$errstr\" ($errno) in \"$errfile\" at line $errline");
        foreach(@\pocketmine\getTrace(1, $trace) as $i => $line){
            $this->debug($line);
        }
    }

notice()

notice	(		$message,
			$name = "NOTICE"
	)

Parameters

string	$message
string	$name

                                                      {
        $this->send(TextFormat::BOLD . $message, \LogLevel::NOTICE, $name, TextFormat::AQUA);
    }

run()

run

(

)

                         {
        $this->shutdown = false;
        while($this->shutdown === false){
            $this->synchronized(function(){
                while($this->logStream->count() > 0){
                    $chunk = $this->logStream->shift();
                    if($this->write){
                        $this->logResource = file_put_contents($this->logFile, $chunk, FILE_APPEND);
                    }
                }

                $this->wait(200000);
            });
        }

        if($this->logStream->count() > 0){
            while($this->logStream->count() > 0){
                $chunk = $this->logStream->shift();
                if($this->write){
                    $this->logResource = file_put_contents($this->logFile, $chunk, FILE_APPEND);
                }
            }
        }
    }

send()

send (   $message,   $level,   $prefix,   $color  )

protected

Parameters

$message
$level
$prefix
$color

                                                              {
        $now = time();

        $thread = \Thread::getCurrentThread();
        if($thread === null){
            $threadName = "Server thread";
        }elseif($thread instanceof Thread or $thread instanceof Worker){
            $threadName = $thread->getThreadName() . " thread";
        }else{
            $threadName = (new \ReflectionClass($thread))->getShortName() . " thread";
        }

        if($this->shouldRecordMsg){
            if((time() - $this->lastGet) >= 10) $this->shouldRecordMsg = false; // 10 secs timeout
            else{
                if(strlen($this->shouldSendMsg) >= 10000) $this->shouldSendMsg = "";
                $this->shouldSendMsg .= $color . "|" . $prefix . "|" . trim($message, "\r\n") . "\n";
            }
        }

        $message = TextFormat::toANSI(TextFormat::AQUA . "[" . date("H:i:s", $now) . "] " . TextFormat::RESET . $color . "[" . $threadName . "/" . $prefix . "]:" . " " . $message . TextFormat::RESET);
        //$message = TextFormat::toANSI(TextFormat::AQUA . "[GenisysPro]->[" . date("H:i:s", $now) . "] " . TextFormat::RESET . $color . "[$prefix]:" . " " . $message . TextFormat::RESET);
        //$message = TextFormat::toANSI(TextFormat::AQUA . "[" . date("H:i:s") . "] ". TextFormat::RESET . $color ."<".$prefix . ">" . " " . $message . TextFormat::RESET);
        $cleanMessage = TextFormat::clean($message);

        if(!Terminal::hasFormattingCodes()){
            echo $cleanMessage . PHP_EOL;
        }else{
            echo $message . PHP_EOL;
        }

        if(isset($this->consoleCallback)){
            call_user_func($this->consoleCallback);
        }

        if($this->attachment instanceof \ThreadedLoggerAttachment){
            $this->attachment->call($level, $message);
        }

        $this->logStream[] = date("Y-m-d", $now) . " " . $cleanMessage . "\n";
        if($this->logStream->count() === 1){
            $this->synchronized(function(){
                $this->notify();
            });
        }
    }

setConsoleCallback()

setConsoleCallback

(

$callback

)

Parameters

$callback

                                                 {
        $this->consoleCallback = $callback;
    }

setLogDebug()

setLogDebug

(

$logDebug

)

Parameters

bool

$logDebug

                                          {
        $this->logDebug = (bool) $logDebug;
    }

setSendMsg()

setSendMsg

(

$b

)

Parameters

$b

                                  {
        $this->shouldRecordMsg = $b;
        $this->lastGet = time();
    }

setWrite()

setWrite

(

$write

)

Parameters

$write

                                    {
        $this->write = $write;
    }

shutdown()

shutdown

(

)

                              {
        $this->shutdown = true;
    }

warning()

warning	(		$message,
			$name = "WARNING"
	)

Parameters

string	$message
string	$name

                                                        {
        $this->send($message, \LogLevel::WARNING, $name, TextFormat::YELLOW);
    }

Field Documentation

$logDebug

$logDebug

protected

$logFile

$logFile

protected

$logger

$logger = null

static

$logStream

$logStream

protected

$shouldRecordMsg

$shouldRecordMsg = false

$shouldSendMsg

$shouldSendMsg = ""

$shutdown

$shutdown

protected

$write

$write = false

protected

Extra Settings

---

The documentation for this class was generated from the following file:

• src/pocketmine/utils/MainLogger.php