Skip to content

Commit e7e2dea

Browse files
aristatharistath
committed
Add a Deprecations class
1 parent b221940 commit e7e2dea

3 files changed

Lines changed: 141 additions & 100 deletions

File tree

‎autoload.php‎

Lines changed: 9 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
* @package Progress_Planner
66
*/
77

8+
use Progress_Planner\Utils\Deprecations;
9+
10+
// Require the Deprecations class.
11+
require_once PROGRESS_PLANNER_DIR . '/classes/utils/class-deprecations.php';
12+
813
spl_autoload_register(
914
/**
1015
* Autoload classes.
@@ -19,86 +24,17 @@ function ( $class_name ) {
1924
}
2025

2126
// Deprecated classes.
22-
$deprecated = [
23-
'Progress_Planner\Activity' => [ 'Progress_Planner\Activities\Activity', '1.1.1' ],
24-
'Progress_Planner\Query' => [ 'Progress_Planner\Activities\Query', '1.1.1' ],
25-
'Progress_Planner\Date' => [ 'Progress_Planner\Utils\Date', '1.1.1' ],
26-
'Progress_Planner\Cache' => [ 'Progress_Planner\Utils\Cache', '1.1.1' ],
27-
'Progress_Planner\Widgets\Activity_Scores' => [ 'Progress_Planner\Admin\Widgets\Activity_Scores', '1.1.1' ],
28-
'Progress_Planner\Widgets\Badge_Streak' => [ 'Progress_Planner\Admin\Widgets\Badge_Streak', '1.1.1' ],
29-
'Progress_Planner\Widgets\Challenge' => [ 'Progress_Planner\Admin\Widgets\Challenge', '1.1.1' ],
30-
'Progress_Planner\Widgets\Latest_Badge' => [ 'Progress_Planner\Admin\Widgets\Latest_Badge', '1.1.1' ],
31-
'Progress_Planner\Widgets\Published_Content' => [ 'Progress_Planner\Admin\Widgets\Published_Content', '1.1.1' ],
32-
'Progress_Planner\Widgets\Todo' => [ 'Progress_Planner\Admin\Widgets\Todo', '1.1.1' ],
33-
'Progress_Planner\Widgets\Whats_New' => [ 'Progress_Planner\Admin\Widgets\Whats_New', '1.1.1' ],
34-
'Progress_Planner\Widgets\Widget' => [ 'Progress_Planner\Admin\Widgets\Widget', '1.1.1' ],
35-
'Progress_Planner\Rest_API_Stats' => [ 'Progress_Planner\Rest\Stats', '1.1.1' ],
36-
'Progress_Planner\Rest_API_Tasks' => [ 'Progress_Planner\Rest\Tasks', '1.1.1' ],
37-
'Progress_Planner\Data_Collector\Base_Data_Collector' => [ 'Progress_Planner\Suggested_Tasks\Data_Collector\Base_Data_Collector', '1.1.1' ],
38-
'Progress_Planner\Data_Collector\Data_Collector_Manager' => [ 'Progress_Planner\Suggested_Tasks\Data_Collector\Data_Collector_Manager', '1.1.1' ],
39-
'Progress_Planner\Data_Collector\Hello_World' => [ 'Progress_Planner\Suggested_Tasks\Data_Collector\Hello_World', '1.1.1' ],
40-
'Progress_Planner\Data_Collector\Inactive_Plugins' => [ 'Progress_Planner\Suggested_Tasks\Data_Collector\Inactive_Plugins', '1.1.1' ],
41-
'Progress_Planner\Data_Collector\Last_Published_Post' => [ 'Progress_Planner\Suggested_Tasks\Data_Collector\Last_Published_Post', '1.1.1' ],
42-
'Progress_Planner\Data_Collector\Post_Author' => [ 'Progress_Planner\Suggested_Tasks\Data_Collector\Post_Author', '1.1.1' ],
43-
'Progress_Planner\Data_Collector\Sample_Page' => [ 'Progress_Planner\Suggested_Tasks\Data_Collector\Sample_Page', '1.1.1' ],
44-
'Progress_Planner\Data_Collector\Uncategorized_Category' => [ 'Progress_Planner\Suggested_Tasks\Data_Collector\Uncategorized_Category', '1.1.1' ],
45-
'Progress_Planner\Chart' => [ 'Progress_Planner\UI\Chart', '1.1.1' ],
46-
'Progress_Planner\Popover' => [ 'Progress_Planner\UI\Popover', '1.1.1' ],
47-
'Progress_Planner\Debug_Tools' => [ 'Progress_Planner\Utils\Debug_Tools', '1.1.1' ],
48-
'Progress_Planner\Onboard' => [ 'Progress_Planner\Utils\Onboard', '1.1.1' ],
49-
'Progress_Planner\Playground' => [ 'Progress_Planner\Utils\Playground', '1.1.1' ],
50-
51-
'Progress_Planner\Admin\Widgets\Published_Content' => [ 'Progress_Planner\Admin\Widgets\Content_Activity', '1.3.0' ],
52-
53-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Task_Local' => [ 'Progress_Planner\Suggested_Tasks\Task', '1.4.0' ],
54-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\Local_Tasks_Interface' => [ 'Progress_Planner\Suggested_Tasks\Tasks_Interface', '1.4.0' ],
55-
'Progress_Planner\Suggested_Tasks\Local_Tasks_Manager' => [ 'Progress_Planner\Suggested_Tasks\Tasks_Manager', '1.4.0' ],
56-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Local_Task_Factory' => [ 'Progress_Planner\Suggested_Tasks\Task_Factory', '1.4.0' ],
57-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\One_Time' => [ 'Progress_Planner\Suggested_Tasks\Providers\Task', '1.4.0' ],
58-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\Repetitive' => [ 'Progress_Planner\Suggested_Tasks\Providers\Repetitive', '1.4.0' ],
59-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\Local_Tasks' => [ 'Progress_Planner\Suggested_Tasks\Providers\Tasks', '1.4.0' ],
60-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\User' => [ 'Progress_Planner\Suggested_Tasks\Providers\User', '1.4.0' ],
61-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\Integrations\Yoast\Add_Yoast_Providers' => [ 'Progress_Planner\Suggested_Tasks\Providers\Integrations\Yoast\Add_Yoast_Providers', '1.4.0' ],
62-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\Integrations\Yoast\Archive_Author' => [ 'Progress_Planner\Suggested_Tasks\Providers\Integrations\Yoast\Archive_Author', '1.4.0' ],
63-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\Integrations\Yoast\Archive_Date' => [ 'Progress_Planner\Suggested_Tasks\Providers\Integrations\Yoast\Archive_Date', '1.4.0' ],
64-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\Integrations\Yoast\Archive_Format' => [ 'Progress_Planner\Suggested_Tasks\Providers\Integrations\Yoast\Archive_Format', '1.4.0' ],
65-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\Integrations\Yoast\Crawl_Settings_Emoji_Scripts' => [ 'Progress_Planner\Suggested_Tasks\Providers\Integrations\Yoast\Crawl_Settings_Emoji_Scripts', '1.4.0' ],
66-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\Integrations\Yoast\Crawl_Settings_Feed_Authors' => [ 'Progress_Planner\Suggested_Tasks\Providers\Integrations\Yoast\Crawl_Settings_Feed_Authors', '1.4.0' ],
67-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\Integrations\Yoast\Crawl_Settings_Feed_Global_Comments' => [ 'Progress_Planner\Suggested_Tasks\Providers\Integrations\Yoast\Crawl_Settings_Feed_Global_Comments', '1.4.0' ],
68-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\Integrations\Yoast\Media_Pages' => [ 'Progress_Planner\Suggested_Tasks\Providers\Integrations\Yoast\Media_Pages', '1.4.0' ],
69-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\Integrations\Yoast\Organization_Logo' => [ 'Progress_Planner\Suggested_Tasks\Providers\Integrations\Yoast\Organization_Logo', '1.4.0' ],
70-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\Integrations\Yoast\Yoast_Provider' => [ 'Progress_Planner\Suggested_Tasks\Providers\Integrations\Yoast\Yoast_Provider', '1.4.0' ],
71-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\One_Time\Blog_Description' => [ 'Progress_Planner\Suggested_Tasks\Providers\Blog_Description', '1.4.0' ],
72-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\One_Time\Debug_Display' => [ 'Progress_Planner\Suggested_Tasks\Providers\Debug_Display', '1.4.0' ],
73-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\One_Time\Disable_Comments' => [ 'Progress_Planner\Suggested_Tasks\Providers\Disable_Comments', '1.4.0' ],
74-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\One_Time\Hello_World' => [ 'Progress_Planner\Suggested_Tasks\Providers\Hello_World', '1.4.0' ],
75-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\One_Time\Permalink_Structure' => [ 'Progress_Planner\Suggested_Tasks\Providers\Permalink_Structure', '1.4.0' ],
76-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\One_Time\Php_Version' => [ 'Progress_Planner\Suggested_Tasks\Providers\Php_Version', '1.4.0' ],
77-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\One_Time\Remove_Inactive_Plugins' => [ 'Progress_Planner\Suggested_Tasks\Providers\Remove_Inactive_Plugins', '1.4.0' ],
78-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\One_Time\Rename_Uncategorized_Category' => [ 'Progress_Planner\Suggested_Tasks\Providers\Rename_Uncategorized_Category', '1.4.0' ],
79-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\One_Time\Sample_Page' => [ 'Progress_Planner\Suggested_Tasks\Providers\Sample_Page', '1.4.0' ],
80-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\One_Time\Search_Engine_Visibility' => [ 'Progress_Planner\Suggested_Tasks\Providers\Search_Engine_Visibility', '1.4.0' ],
81-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\One_Time\Set_Valuable_Post_Types' => [ 'Progress_Planner\Suggested_Tasks\Providers\Set_Valuable_Post_Types', '1.4.0' ],
82-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\One_Time\Settings_Saved' => [ 'Progress_Planner\Suggested_Tasks\Providers\Settings_Saved', '1.4.0' ],
83-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\One_Time\Site_Icon' => [ 'Progress_Planner\Suggested_Tasks\Providers\Site_Icon', '1.4.0' ],
84-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\Repetitive\Core_Update' => [ 'Progress_Planner\Suggested_Tasks\Providers\Core_Update', '1.4.0' ],
85-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\Repetitive\Create' => [ 'Progress_Planner\Suggested_Tasks\Providers\Repetitive\Create', '1.4.0' ],
86-
'Progress_Planner\Suggested_Tasks\Local_Tasks\Providers\Repetitive\Review' => [ 'Progress_Planner\Suggested_Tasks\Providers\Repetitive\Review', '1.4.0' ],
87-
'Progress_Planner\Suggested_Tasks\Remote_Tasks\Remote_Task_Factory' => [ 'Progress_Planner\Suggested_Tasks\Task_Factory', '1.4.0' ],
88-
'Progress_Planner\Suggested_Tasks\Remote_Tasks\Remote_Task' => [ 'Progress_Planner\Suggested_Tasks\Task', '1.4.0' ],
89-
];
90-
91-
if ( isset( $deprecated[ $class_name ] ) ) {
27+
if ( isset( Deprecations::CLASSES[ $class_name ] ) ) {
9228
\trigger_error( // phpcs:ignore
9329
sprintf(
9430
'Class %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.',
9531
\esc_html( $class_name ),
96-
\esc_html( $deprecated[ $class_name ][1] ),
97-
\esc_html( $deprecated[ $class_name ][0] )
32+
\esc_html( Deprecations::CLASSES[ $class_name ][1] ),
33+
\esc_html( Deprecations::CLASSES[ $class_name ][0] )
9834
),
9935
E_USER_DEPRECATED
10036
);
101-
class_alias( $deprecated[ $class_name ][0], $class_name );
37+
class_alias( Deprecations::CLASSES[ $class_name ][0], $class_name );
10238
}
10339

10440
$class_name = \str_replace( $prefix, '', $class_name );

‎classes/class-base.php‎

Lines changed: 10 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
namespace Progress_Planner;
99

10+
use Progress_Planner\Utils\Deprecations;
11+
1012
/**
1113
* Main plugin class.
1214
*
@@ -37,6 +39,7 @@
3739
* @method \Progress_Planner\Plugin_Migrations get_plugin_migrations()
3840
* @method \Progress_Planner\Suggested_Tasks get_suggested_tasks()
3941
* @method \Progress_Planner\Suggested_Tasks_DB get_suggested_tasks_db()
42+
* @method \Progress_Planner\Utils\Deprecations get_utils__deprecations()
4043
*/
4144
class Base {
4245

@@ -176,34 +179,14 @@ public function __call( $name, $arguments ) {
176179
}
177180

178181
// Backwards-compatibility.
179-
$deprecated = [
180-
'get_query' => [ 'get_activities__query', '1.1.1' ],
181-
'get_date' => [ 'get_utils__date', '1.1.1' ],
182-
'get_widgets__suggested_tasks' => [ 'get_admin__widgets__suggested_tasks', '1.1.1' ],
183-
'get_widgets__activity_scores' => [ 'get_admin__widgets__activity_scores', '1.1.1' ],
184-
'get_widgets__todo' => [ 'get_admin__widgets__todo', '1.1.1' ],
185-
'get_widgets__challenge' => [ 'get_admin__widgets__challenge', '1.1.1' ],
186-
'get_widgets__latest_badge' => [ 'get_admin__widgets__latest_badge', '1.1.1' ],
187-
'get_widgets__badge_streak' => [ 'get_admin__widgets__badge_streak', '1.1.1' ],
188-
'get_widgets__published_content' => [ 'get_admin__widgets__published_content', '1.1.1' ],
189-
'get_widgets__whats_new' => [ 'get_admin__widgets__whats_new', '1.1.1' ],
190-
'get_onboard' => [ 'get_utils__onboard', '1.1.1' ],
191-
'get_cache' => [ 'get_utils__cache', '1.1.1' ],
192-
'get_rest_api_stats' => [ 'get_rest__stats', '1.1.1' ],
193-
'get_rest_api_tasks' => [ 'get_rest__tasks', '1.1.1' ],
194-
'get_data_collector__data_collector_manager' => [ 'get_suggested_tasks__data_collector__data_collector_manager', '1.1.1' ],
195-
'get_debug_tools' => [ 'get_utils__debug_tools', '1.1.1' ],
196-
'get_playground' => [ 'get_utils__playground', '1.1.1' ],
197-
'get_chart' => [ 'get_ui__chart', '1.1.1' ],
198-
'get_popover' => [ 'get_ui__popover', '1.1.1' ],
199-
200-
'get_admin__widgets__published_content' => [ 'get_admin__widgets__content_activity', '1.3.0' ],
201-
];
202-
203-
if ( isset( $deprecated[ $name ] ) ) {
182+
if ( isset( Deprecations::BASE_METHODS[ $name ] ) ) {
204183
// Deprecated method.
205-
\_deprecated_function( \esc_html( $name ), \esc_html( $deprecated[ $name ][1] ), \esc_html( $deprecated[ $name ][0] ) );
206-
return $this->{$deprecated[ $name ][0]}();
184+
\_deprecated_function(
185+
\esc_html( $name ),
186+
\esc_html( Deprecations::BASE_METHODS[ $name ][1] ),
187+
\esc_html( Deprecations::BASE_METHODS[ $name ][0] )
188+
);
189+
return $this->{Deprecations::BASE_METHODS[ $name ][0]}();
207190
}
208191
}
209192

0 commit comments

Comments
 (0)