Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPML\Utils;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Class DebugBackTrace

[5] Fix | Delete

[6] Fix | Delete

* @package WPML\Utils

[7] Fix | Delete

[8] Fix | Delete

class DebugBackTrace {

[9] Fix | Delete

[10] Fix | Delete

/** @var array */

[11] Fix | Delete

private $debug_backtrace = [];

[12] Fix | Delete

[13] Fix | Delete

/** @var int */

[14] Fix | Delete

private $limit;

[15] Fix | Delete

[16] Fix | Delete

/** @var bool */

[17] Fix | Delete

private $provide_object;

[18] Fix | Delete

[19] Fix | Delete

/** @var bool */

[20] Fix | Delete

private $ignore_args;

[21] Fix | Delete

[22] Fix | Delete

/** @var string */

[23] Fix | Delete

private $debug_backtrace_function;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* DebugBackTrace constructor.

[27] Fix | Delete

[28] Fix | Delete

* @param int $limit

[29] Fix | Delete

* @param bool $provide_object

[30] Fix | Delete

* @param bool $ignore_args

[31] Fix | Delete

* @param null $debug_backtrace_function

[32] Fix | Delete

[33] Fix | Delete

public function __construct(

[34] Fix | Delete

$limit = 0,

[35] Fix | Delete

$provide_object = false,

[36] Fix | Delete

$ignore_args = true,

[37] Fix | Delete

$debug_backtrace_function = null

[38] Fix | Delete

) {

[39] Fix | Delete

if ( ! $debug_backtrace_function ) {

[40] Fix | Delete

$debug_backtrace_function = 'debug_backtrace';

[41] Fix | Delete

}

[42] Fix | Delete

$this->limit = $limit;

[43] Fix | Delete

$this->provide_object = $provide_object;

[44] Fix | Delete

$this->ignore_args = $ignore_args;

[45] Fix | Delete

$this->debug_backtrace_function = $debug_backtrace_function;

[46] Fix | Delete

}

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* @param array $functions

[50] Fix | Delete

* @param bool $refresh

[51] Fix | Delete

[52] Fix | Delete

* @return bool

[53] Fix | Delete

[54] Fix | Delete

public function are_functions_in_call_stack( array $functions, $refresh = true ) {

[55] Fix | Delete

if ( empty( $this->debug_backtrace ) || $refresh ) {

[56] Fix | Delete

$this->get_backtrace();

[57] Fix | Delete

}

[58] Fix | Delete

[59] Fix | Delete

$found = false;

[60] Fix | Delete

foreach ( $this->debug_backtrace as $frame ) {

[61] Fix | Delete

if ( isset( $frame['class'] ) ) {

[62] Fix | Delete

$frame_function = [ $frame['class'], $frame['function'] ];

[63] Fix | Delete

} else {

[64] Fix | Delete

$frame_function = $frame['function'];

[65] Fix | Delete

}

[66] Fix | Delete

if ( in_array( $frame_function, $functions, true ) ) {

[67] Fix | Delete

$found = true;

[68] Fix | Delete

break;

[69] Fix | Delete

}

[70] Fix | Delete

}

[71] Fix | Delete

return $found;

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* @param string $function_name

[76] Fix | Delete

* @param bool $refresh

[77] Fix | Delete

[78] Fix | Delete

* @return bool

[79] Fix | Delete

[80] Fix | Delete

public function is_function_in_call_stack( $function_name, $refresh = true ) {

[81] Fix | Delete

return $this->are_functions_in_call_stack( [ $function_name ], $refresh );

[82] Fix | Delete

}

[83] Fix | Delete

[84] Fix | Delete

/**

[85] Fix | Delete

* @param string $function_name

[86] Fix | Delete

* @param bool $refresh

[87] Fix | Delete

[88] Fix | Delete

* @return int

[89] Fix | Delete

[90] Fix | Delete

public function count_function_in_call_stack( $function_name, $refresh = true ) {

[91] Fix | Delete

if ( empty( $this->debug_backtrace ) || $refresh ) {

[92] Fix | Delete

$this->get_backtrace();

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

$count = 0;

[96] Fix | Delete

foreach ( $this->debug_backtrace as $frame ) {

[97] Fix | Delete

if ( ! isset( $frame['class'] ) && $frame['function'] === $function_name ) {

[98] Fix | Delete

$count ++;

[99] Fix | Delete

}

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

return $count;

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

/**

[106] Fix | Delete

* @param string $class_name

[107] Fix | Delete

* @param string $function_name

[108] Fix | Delete

* @param bool $refresh

[109] Fix | Delete

[110] Fix | Delete

* @return bool

[111] Fix | Delete

[112] Fix | Delete

public function is_class_function_in_call_stack( $class_name, $function_name, $refresh = true ) {

[113] Fix | Delete

return $this->are_functions_in_call_stack( [ [ $class_name, $function_name ] ], $refresh );

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

/**

[117] Fix | Delete

* @return array

[118] Fix | Delete

[119] Fix | Delete

public function get_backtrace() {

[120] Fix | Delete

$options = false;

[121] Fix | Delete

[122] Fix | Delete

// As of 5.3.6, 'options' parameter is a bit mask for the following options.

[123] Fix | Delete

if ( $this->provide_object ) {

[124] Fix | Delete

$options |= DEBUG_BACKTRACE_PROVIDE_OBJECT;

[125] Fix | Delete

}

[126] Fix | Delete

if ( $this->ignore_args ) {

[127] Fix | Delete

$options |= DEBUG_BACKTRACE_IGNORE_ARGS;

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

$actual_limit = 0 === $this->limit ? 0 : $this->limit + 4;

[131] Fix | Delete

$this->debug_backtrace = (array) call_user_func_array(

[132] Fix | Delete

$this->debug_backtrace_function,

[133] Fix | Delete

[

[134] Fix | Delete

$options,

[135] Fix | Delete

$actual_limit,

[136] Fix | Delete

]

[137] Fix | Delete

); // Add one item to include the current frame.

[138] Fix | Delete

[139] Fix | Delete

$this->remove_frames_for_this_class();

[140] Fix | Delete

[141] Fix | Delete

return $this->debug_backtrace;

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

private function remove_frames_for_this_class() {

[145] Fix | Delete

/**

[146] Fix | Delete

* We cannot rely on number of frames to remove.

[147] Fix | Delete

* php 5.6 and 7+ provides different call stacks.

[148] Fix | Delete

* php 5.6 adds call_user_func_array from get_backtrace()

[149] Fix | Delete

[150] Fix | Delete

do {

[151] Fix | Delete

$found = false;

[152] Fix | Delete

[153] Fix | Delete

if ( ! isset( $this->debug_backtrace[0] ) ) {

[154] Fix | Delete

break;

[155] Fix | Delete

}

[156] Fix | Delete

$frame = $this->debug_backtrace[0];

[157] Fix | Delete

[158] Fix | Delete

if (

[159] Fix | Delete

( isset( $frame['file'] ) && __FILE__ === $frame['file'] )

[160] Fix | Delete

|| ( isset( $frame['class'] ) && self::class === $frame['class'] )

[161] Fix | Delete

) {

[162] Fix | Delete

$found = true;

[163] Fix | Delete

$this->remove_last_frame();

[164] Fix | Delete

}

[165] Fix | Delete

} while ( $found );

[166] Fix | Delete

[167] Fix | Delete

$this->remove_last_frame(); // Remove frame with the function called this class.

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

public function remove_last_frame() {

[171] Fix | Delete

if ( $this->debug_backtrace ) {

[172] Fix | Delete

array_shift( $this->debug_backtrace );

[173] Fix | Delete

}

[174] Fix | Delete

}

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete