Loggable.php

Go to the documentation of this file.

<?php

namespace Elgg\Traits;

use Elgg\Application;
use Elgg\Logger;
use Psr\Log\LoggerInterface;

trait Loggable {

    private $logger;

    public function setLogger(?LoggerInterface $logger = null) {
        $this->logger = $logger;
    }

    public function getLogger() {

        if ($this->logger) {
            return $this->logger;
        } else if (Application::$_instance) {
            return Application::$_instance->internal_services->logger;
        }

        // Application hasn't been bootstrapped
        return Logger::factory();
    }

    public function log($level, $message, array $context = []) {
        if ($message instanceof \Throwable) {
            $context['exception'] = $message;
        }

        // PSR interface is void, but Monolog returns a boolean
        $logged = $this->getLogger()->log($level, $message, $context);
        return $logged ?? true;
    }
    
    public function logDeprecatedMessage(string $message, string $version): void {
        $this->getLogger()->warning("Deprecated in {$version}: {$message}");
    }
}