DeprecationService.php

Go to the documentation of this file.

<?php
namespace Elgg;

class DeprecationService {

    protected $session;

    protected $logger;

    public function __construct(\ElggSession $session, Logger $logger) {
        $this->session = $session;
        $this->logger = $logger;
    }

    function sendNotice($msg, $dep_version, $backtrace_level = 1) {
        if (!$dep_version) {
            return false;
        }

        $elgg_version = elgg_get_version(true);
        $elgg_version_arr = explode('.', $elgg_version);
        $elgg_major_version = (int)$elgg_version_arr[0];
        $elgg_minor_version = (int)$elgg_version_arr[1];

        $dep_version_arr = explode('.', (string)$dep_version);
        $dep_major_version = (int)$dep_version_arr[0];
        $dep_minor_version = (int)$dep_version_arr[1];

        $msg = "Deprecated in $dep_major_version.$dep_minor_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 = array();
        $backtrace = debug_backtrace();
        // never show this call.
        array_shift($backtrace);
        $i = count($backtrace);

        foreach ($backtrace as $trace) {
            $stack[] = "[#$i] {$trace['file']}:{$trace['line']}";
            $i--;

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

        $msg .= implode("<br /> -> ", $stack);

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

        return true;
    }
}