<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* A facade to allow deprecating an entire class. Calling instance or static

[2] Fix | Delete

* functions on the facade triggers a deprecation notice before calling the

[3] Fix | Delete

* underlying function.

[4] Fix | Delete

*

[5] Fix | Delete

* Use it by extending DeprecatedClassFacade in your facade class, setting the

[6] Fix | Delete

* static $facade_over_classname string to the name of the class to build

[7] Fix | Delete

* a facade over, and setting the static $deprecated_in_version to the version

[8] Fix | Delete

* that the class was deprecated in. Eg.:

[9] Fix | Delete

*

[10] Fix | Delete

* class DeprecatedGoose extends DeprecatedClassFacade {

[11] Fix | Delete

* static $facade_over_classname = 'Goose';

[12] Fix | Delete

* static $deprecated_in_version = '1.7.0';

[13] Fix | Delete

* }

[14] Fix | Delete

*/

[15] Fix | Delete

[16] Fix | Delete

namespace Automattic\WooCommerce\Admin;

[17] Fix | Delete

[18] Fix | Delete

defined( 'ABSPATH' ) || exit;

[19] Fix | Delete

[20] Fix | Delete

// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* A facade to allow deprecating an entire class.

[24] Fix | Delete

*/

[25] Fix | Delete

class DeprecatedClassFacade {

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* The instance that this facade covers over.

[29] Fix | Delete

*

[30] Fix | Delete

* @var object

[31] Fix | Delete

*/

[32] Fix | Delete

protected $instance;

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* The name of the non-deprecated class that this facade covers.

[36] Fix | Delete

*

[37] Fix | Delete

* @var string

[38] Fix | Delete

*/

[39] Fix | Delete

protected static $facade_over_classname = '';

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* The version that this class was deprecated in.

[43] Fix | Delete

*

[44] Fix | Delete

* @var string

[45] Fix | Delete

*/

[46] Fix | Delete

protected static $deprecated_in_version = '';

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* Static array of logged messages.

[50] Fix | Delete

*

[51] Fix | Delete

* @var array

[52] Fix | Delete

*/

[53] Fix | Delete

private static $logged_messages = array();

[54] Fix | Delete

[55] Fix | Delete

/**

[56] Fix | Delete

* Constructor.

[57] Fix | Delete

*/

[58] Fix | Delete

public function __construct() {

[59] Fix | Delete

if ( '' !== static::$facade_over_classname ) {

[60] Fix | Delete

$this->instance = new static::$facade_over_classname();

[61] Fix | Delete

}

[62] Fix | Delete

}

[63] Fix | Delete

[64] Fix | Delete

/**

[65] Fix | Delete

* Log a deprecation to the error log.

[66] Fix | Delete

*

[67] Fix | Delete

* @param string $function The name of the deprecated function being called.

[68] Fix | Delete

*/

[69] Fix | Delete

private static function log_deprecation( $function ) {

[70] Fix | Delete

$message = sprintf(

[71] Fix | Delete

'%1$s is deprecated since version %2$s! Use %3$s instead.',

[72] Fix | Delete

static::class . '::' . $function,

[73] Fix | Delete

static::$deprecated_in_version,

[74] Fix | Delete

static::$facade_over_classname . '::' . $function

[75] Fix | Delete

);

[76] Fix | Delete

[77] Fix | Delete

if ( '' !== static::$facade_over_classname ) {

[78] Fix | Delete

$message = $message . sprintf(

[79] Fix | Delete

' Use %s instead.',

[80] Fix | Delete

static::$facade_over_classname . '::' . $function

[81] Fix | Delete

);

[82] Fix | Delete

}

[83] Fix | Delete

[84] Fix | Delete

// Only log when the message has not been logged before.

[85] Fix | Delete

if ( ! in_array( $message, self::$logged_messages, true ) ) {

[86] Fix | Delete

error_log( $message ); // phpcs:ignore

[87] Fix | Delete

self::$logged_messages[] = $message;

[88] Fix | Delete

}

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

/**

[92] Fix | Delete

* Executes when calling any function on an instance of this class.

[93] Fix | Delete

*

[94] Fix | Delete

* @param string $name The name of the function being called.

[95] Fix | Delete

* @param array $arguments An array of the arguments to the function call.

[96] Fix | Delete

*/

[97] Fix | Delete

public function __call( $name, $arguments ) {

[98] Fix | Delete

self::log_deprecation( $name );

[99] Fix | Delete

[100] Fix | Delete

if ( ! isset( $this->instance ) ) {

[101] Fix | Delete

return;

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

return call_user_func_array(

[105] Fix | Delete

array(

[106] Fix | Delete

$this->instance,

[107] Fix | Delete

$name,

[108] Fix | Delete

),

[109] Fix | Delete

$arguments

[110] Fix | Delete

);

[111] Fix | Delete

}

[112] Fix | Delete

[113] Fix | Delete

/**

[114] Fix | Delete

* Executes when calling any static function on this class.

[115] Fix | Delete

*

[116] Fix | Delete

* @param string $name The name of the function being called.

[117] Fix | Delete

* @param array $arguments An array of the arguments to the function call.

[118] Fix | Delete

*/

[119] Fix | Delete

public static function __callStatic( $name, $arguments ) {

[120] Fix | Delete

self::log_deprecation( $name );

[121] Fix | Delete

[122] Fix | Delete

if ( '' === static::$facade_over_classname ) {

[123] Fix | Delete

return;

[124] Fix | Delete

}

[125] Fix | Delete

[126] Fix | Delete

return call_user_func_array(

[127] Fix | Delete

array(

[128] Fix | Delete

static::$facade_over_classname,

[129] Fix | Delete

$name,

[130] Fix | Delete

),

[131] Fix | Delete

$arguments

[132] Fix | Delete

);

[133] Fix | Delete

}

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete