BD_Base_Page::__construct() - Code Metrics - Inspection of "Replace deprecated functions" - sudar/bulk-delete - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 160-fix/replace-deprecated-fun... ( 64667b )

unknown

created 2018-01-25 17:19 UTC

BD_Base_Page::__construct() A

↳ Parent: BD_Base_Page

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	2
rs	10
c	0
b	0
f	0

<?php
/**
 * Base class for all Pages.
 *
 * @since   5.5.4
 *
 * @author  Sudar
 *
 * @package BulkDelete\Base\Page
 */
defined( 'ABSPATH' ) || exit; // Exit if accessed directly

/**
 * Base class for Pages.
 *
 * @abstract
 *
 * @since 5.5.4
 */
abstract class BD_Base_Page {
	/**
	 * @var string Page Slug.
	 */
	protected $page_slug;

	/**
	 * @var string Menu action.
	 */
	protected $menu_action = 'bd_after_primary_menus';

	/**
	 * @var string Minimum capability needed for viewing this page.
	 */
	protected $capability = 'manage_options';

	// TODO: Remove property after confirming on `class-bd-settings-page.php` file.
	/**
	 * @var bool Whether sidebar is needed or not.
	 */
	protected $render_sidebar = false;

	/**
	 * @var string The screen variable for this page.
	 */
	protected $screen;

	/**
	 * @var array Labels used in this page.
	 */
	protected $label = array();

	/**
	 * @var array Messages shown to the user.
	 */
	protected $messages = array();

	/**
	 * @var array Actions used in this page.
	 */
	protected $actions = array();

	/**
	 * Initialize and setup variables.
	 *
	 * @since 5.5.4
	 * @abstract
	 *
	 * @return void
	 */
	abstract protected function initialize();

	/**
	 * Render body content.
	 *
	 * @since 5.5.4
	 * @abstract
	 *
	 * @return void
	 */
	abstract protected function render_body();

	/**
	 * Use `factory()` method to create instance of this class.
	 * Don't create instances directly.
	 *
	 * @since 5.5.4
	 * @see factory()
	 */
	public function __construct() {
		$this->setup();
	}

	/**
	 * Setup the module.
	 *
	 * @since 5.5.4
	 */
	protected function setup() {
		$this->initialize();
		$this->setup_hooks();
	}

	/**
	 * Setup hooks.
	 *
	 * @since 5.5.4
	 */
	protected function setup_hooks() {
		add_action( $this->menu_action, array( $this, 'add_menu' ) );
		add_action( "bd_admin_footer_for_{$this->page_slug}", array( $this, 'modify_admin_footer' ) );

		add_filter( 'bd_action_nonce_check', array( $this, 'nonce_check' ), 10, 2 );
		add_filter( 'bd_admin_help_tabs', array( $this, 'render_help_tab' ), 10, 2 );
	}

	/**
	 * Add menu.
	 *
	 * @since 5.5.4
	 */
	public function add_menu() {
		$this->screen = add_submenu_page(
			Bulk_Delete::POSTS_PAGE_SLUG,
			$this->label['page_title'],
			$this->label['menu_title'],
			$this->capability,
			$this->page_slug,
			array( $this, 'render_page' )
		);
	}

	/**
	 * Check for nonce before executing the action.
	 *
	 * @since 5.5.4
	 *
	 * @param bool   $result The current result.
	 * @param string $action Action name.
	 */
	public function nonce_check( $result, $action ) {
		if ( in_array( $action, $this->actions ) ) {
			if ( check_admin_referer( "bd-{$this->page_slug}", "bd-{$this->page_slug}-nonce" ) ) {
				return true;
			}
		}

		return $result;
	}

	/**
	 * Modify help tabs for the current page.
	 *
	 * @since 5.5.4
	 *
	 * @param array  $help_tabs Current list of help tabs.
	 * @param string $screen    Current screen name.
	 *
	 * @return array Modified list of help tabs.
	 */
	public function render_help_tab( $help_tabs, $screen ) {
		if ( $this->screen == $screen ) {
			$help_tabs = $this->add_help_tab( $help_tabs );
		}

		return $help_tabs;
	}

	/**
	 * Add help tabs.
	 * Help tabs can be added by overriding this function in the child class.
	 *
	 * @since 5.5.4
	 *
	 * @param array $help_tabs Current list of help tabs.
	 *
	 * @return array List of help tabs.
	 */
	protected function add_help_tab( $help_tabs ) {
		return $help_tabs;
	}

	/**
	 * Render the page.
	 *
	 * @since 5.5.4
	 */
	public function render_page() {
?>
		<div class="wrap">
			<h2><?php echo $this->label['page_title'];?></h2>
			<?php settings_errors(); ?>

			<form method = "post">
			<?php $this->render_nonce_fields(); ?>

			<div id = "poststuff">
				<div id="post-body" class="metabox-holder columns-1">

					<?php $this->render_header(); ?>

					<div id="postbox-container-2" class="postbox-container">
						<?php $this->render_body(); ?>
					</div> <!-- #postbox-container-2 -->

				</div> <!-- #post-body -->
			</div><!-- #poststuff -->
			</form>
		</div><!-- .wrap -->
<?php
		$this->render_footer();
	}

	/**
	 * Print nonce fields.
	 *
	 * @since 5.5.4
	 */
	protected function render_nonce_fields() {
		wp_nonce_field( "bd-{$this->page_slug}", "bd-{$this->page_slug}-nonce" );
	}

	/**
	 * Render header for the page.
	 *
	 * If sidebar is enabled, then it is rendered as well.
	 *
	 * @since 5.5.4
	 */
	protected function render_header() {
?>
		<div class="notice notice-warning">
			<p><strong><?php echo $this->messages['warning_message']; ?></strong></p>
		</div>
<?php
	}

	/**
	 * Render footer.
	 *
	 * @since 5.5.4
	 */
	protected function render_footer() {
		/**
		 * Runs just before displaying the footer text in the admin page.
		 *
		 * This action is primarily for adding extra content in the footer of admin page.
		 *
		 * @since 5.5.4
		 */
		do_action( "bd_admin_footer_for_{$this->page_slug}" );
	}

	/**
	 * Modify admin footer in Bulk Delete plugin pages.
	 */
	public function modify_admin_footer() {
		add_filter( 'admin_footer_text', 'bd_add_rating_link' );
	}

	/**
	 * Getter for screen.
	 *
	 * @return string Current value of screen
	 */
	public function get_screen() {
		return $this->screen;
	}

	/**
	 * Getter for page_slug.
	 *
	 * @return string Current value of page_slug
	 */
	public function get_page_slug() {
		return $this->page_slug;
	}
}
?>


1			<?php
2			/**
3			* Base class for all Pages.
4			*
5			* @since 5.5.4
6			*
7			* @author Sudar
8			*
9			* @package BulkDelete\Base\Page
10			*/
11			defined( 'ABSPATH' ) \|\| exit; // Exit if accessed directly
12
13			/**
14			* Base class for Pages.
15			*
16			* @abstract
17			*
18			* @since 5.5.4
19			*/
20			abstract class BD_Base_Page {
21			/**
22			* @var string Page Slug.
23			*/
24			protected $page_slug;
25
26			/**
27			* @var string Menu action.
28			*/
29			protected $menu_action = 'bd_after_primary_menus';
30
31			/**
32			* @var string Minimum capability needed for viewing this page.
33			*/
34			protected $capability = 'manage_options';
35
36			// TODO: Remove property after confirming on `class-bd-settings-page.php` file.
37			/**
38			* @var bool Whether sidebar is needed or not.
39			*/
40			protected $render_sidebar = false;
41
42			/**
43			* @var string The screen variable for this page.
44			*/
45			protected $screen;
46
47			/**
48			* @var array Labels used in this page.
49			*/
50			protected $label = array();
51
52			/**
53			* @var array Messages shown to the user.
54			*/
55			protected $messages = array();
56
57			/**
58			* @var array Actions used in this page.
59			*/
60			protected $actions = array();
61
62			/**
63			* Initialize and setup variables.
64			*
65			* @since 5.5.4
66			* @abstract
67			*
68			* @return void
69			*/
70			abstract protected function initialize();
71
72			/**
73			* Render body content.
74			*
75			* @since 5.5.4
76			* @abstract
77			*
78			* @return void
79			*/
80			abstract protected function render_body();
81
82			/**
83			* Use `factory()` method to create instance of this class.
84			* Don't create instances directly.
85			*
86			* @since 5.5.4
87			* @see factory()
88			*/
89			public function __construct() {
90			$this->setup();
91			}
92
93			/**
94			* Setup the module.
95			*
96			* @since 5.5.4
97			*/
98			protected function setup() {
99			$this->initialize();
100			$this->setup_hooks();
101			}
102
103			/**
104			* Setup hooks.
105			*
106			* @since 5.5.4
107			*/
108			protected function setup_hooks() {
109			add_action( $this->menu_action, array( $this, 'add_menu' ) );
110			add_action( "bd_admin_footer_for_{$this->page_slug}", array( $this, 'modify_admin_footer' ) );
111
112			add_filter( 'bd_action_nonce_check', array( $this, 'nonce_check' ), 10, 2 );
113			add_filter( 'bd_admin_help_tabs', array( $this, 'render_help_tab' ), 10, 2 );
114			}
115
116			/**
117			* Add menu.
118			*
119			* @since 5.5.4
120			*/
121			public function add_menu() {
122			$this->screen = add_submenu_page(
123			Bulk_Delete::POSTS_PAGE_SLUG,
124			$this->label['page_title'],
125			$this->label['menu_title'],
126			$this->capability,
127			$this->page_slug,
128			array( $this, 'render_page' )
129			);
130			}
131
132			/**
133			* Check for nonce before executing the action.
134			*
135			* @since 5.5.4
136			*
137			* @param bool $result The current result.
138			* @param string $action Action name.
139			*/
140			public function nonce_check( $result, $action ) {
141			if ( in_array( $action, $this->actions ) ) {
142			if ( check_admin_referer( "bd-{$this->page_slug}", "bd-{$this->page_slug}-nonce" ) ) {
143			return true;
144			}
145			}
146
147			return $result;
148			}
149
150			/**
151			* Modify help tabs for the current page.
152			*
153			* @since 5.5.4
154			*
155			* @param array $help_tabs Current list of help tabs.
156			* @param string $screen Current screen name.
157			*
158			* @return array Modified list of help tabs.
159			*/
160			public function render_help_tab( $help_tabs, $screen ) {
161			if ( $this->screen == $screen ) {
162			$help_tabs = $this->add_help_tab( $help_tabs );
163			}
164
165			return $help_tabs;
166			}
167
168			/**
169			* Add help tabs.
170			* Help tabs can be added by overriding this function in the child class.
171			*
172			* @since 5.5.4
173			*
174			* @param array $help_tabs Current list of help tabs.
175			*
176			* @return array List of help tabs.
177			*/
178			protected function add_help_tab( $help_tabs ) {
179			return $help_tabs;
180			}
181
182			/**
183			* Render the page.
184			*
185			* @since 5.5.4
186			*/
187			public function render_page() {
188			?>
189			<div class="wrap">
190			<h2><?php echo $this->label['page_title'];?></h2>
191			<?php settings_errors(); ?>
192
193			<form method = "post">
194			<?php $this->render_nonce_fields(); ?>
195
196			<div id = "poststuff">
197			<div id="post-body" class="metabox-holder columns-1">
198
199			<?php $this->render_header(); ?>
200
201			<div id="postbox-container-2" class="postbox-container">
202			<?php $this->render_body(); ?>
203			</div> <!-- #postbox-container-2 -->
204
205			</div> <!-- #post-body -->
206			</div><!-- #poststuff -->
207			</form>
208			</div><!-- .wrap -->
209			<?php
210			$this->render_footer();
211			}
212
213			/**
214			* Print nonce fields.
215			*
216			* @since 5.5.4
217			*/
218			protected function render_nonce_fields() {
219			wp_nonce_field( "bd-{$this->page_slug}", "bd-{$this->page_slug}-nonce" );
220			}
221
222			/**
223			* Render header for the page.
224			*
225			* If sidebar is enabled, then it is rendered as well.
226			*
227			* @since 5.5.4
228			*/
229			protected function render_header() {
230			?>
231			<div class="notice notice-warning">
232			<p><strong><?php echo $this->messages['warning_message']; ?></strong></p>
233			</div>
234			<?php
235			}
236
237			/**
238			* Render footer.
239			*
240			* @since 5.5.4
241			*/
242			protected function render_footer() {
243			/**
244			* Runs just before displaying the footer text in the admin page.
245			*
246			* This action is primarily for adding extra content in the footer of admin page.
247			*
248			* @since 5.5.4
249			*/
250			do_action( "bd_admin_footer_for_{$this->page_slug}" );
251			}
252
253			/**
254			* Modify admin footer in Bulk Delete plugin pages.
255			*/
256			public function modify_admin_footer() {
257			add_filter( 'admin_footer_text', 'bd_add_rating_link' );
258			}
259
260			/**
261			* Getter for screen.
262			*
263			* @return string Current value of screen
264			*/
265			public function get_screen() {
266			return $this->screen;
267			}
268
269			/**
270			* Getter for page_slug.
271			*
272			* @return string Current value of page_slug
273			*/
274			public function get_page_slug() {
275			return $this->page_slug;
276			}
277			}
278			?>
279

sudar / bulk-delete

Push — 160-fix/replace-deprecated-fun... ( 64667b )

BD_Base_Page::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like