DeprecationService.php

Go to the documentation of this file.

<?php

namespace Elgg;

use Psr\Log\LoggerInterface;

class DeprecationService {

    use Loggable;

    public function __construct(LoggerInterface $logger) {
        $this->logger = $logger;
    }

    public function sendNotice($msg, $dep_version, $backtrace_level = 1) {

        $msg = "Deprecated in $dep_version: $msg Called from ";

        // Get a file and line number for the log. Skip over the function that
        // sent this notice and see who called the deprecated function itself.
        $stack = [];
        $backtrace = debug_backtrace();
        // never show this call.
        array_shift($backtrace);
        $i = count($backtrace);

        foreach ($backtrace as $trace) {
            if (empty($trace['file'])) {
                // file/line not set for Closures
                $stack[] = "[#$i] unknown";
            } else {
                $stack[] = "[#$i] {$trace['file']}:{$trace['line']}";
            }

            $i--;

            if ($backtrace_level > 0) {
                if ($backtrace_level <= 1) {
                    break;
                }
                $backtrace_level--;
            }
        }

        $msg .= implode(PHP_EOL . " -> ", $stack);

        $this->logger->warning($msg);

        return true;
    }
}