Theme_Options_Container::is_valid_save() - Code Metrics - Inspection of "Merge branch 'rewrite/plugin-usage' into developme..." - htmlburger/carbon-fields - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( afe740...a74724 )

unknown

created 2017-07-17 13:13 UTC

Theme_Options_Container::is_valid_save() A

↳ Parent: Theme_Options_Container

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	0
dl	0
loc	7
ccs	0
cts	4
cp	0
crap	6
rs	9.4285
c	0
b	0
f	0

<?php

namespace Carbon_Fields\Container;

use Carbon_Fields\Datastore\Datastore;
use Carbon_Fields\Exception\Incorrect_Syntax_Exception;

/**
 * Theme options container class.
 */
class Theme_Options_Container extends Container {

	/**
	 * Array of registered page slugs to verify uniqueness with
	 *
	 * @var array
	 */
	protected static $registered_pages = array();

	/**
	 * Array of container settings
	 *
	 * @var array
	 */
	public $settings = array(
		'parent' => '',
		'file' => '',
		'icon' => '',
		'menu_position' => null,
		'menu_title' => null,
	);

	/**
	 * {@inheritDoc}
	 */
	public function __construct( $id, $title, $type, $condition_collection, $condition_translator ) {
		parent::__construct( $id, $title, $type, $condition_collection, $condition_translator );

		if ( ! $this->get_datastore() ) {
			$this->set_datastore( Datastore::make( 'theme_options' ), $this->has_default_datastore() );
		}

		if ( apply_filters( 'carbon_fields_' . $type . '_container_admin_only_access', true, $title ) ) {
			$this->where( 'current_user_capability', '=', 'manage_options' );
		}
	}

	/**
	 * Sanitize a title to a filename
	 *
	 * @param  string $title
	 * @param  string $extension
	 * @return string
	 */
	protected function title_to_filename( $title, $extension ) {
		$title = sanitize_file_name( $title );
		$title = strtolower( $title );
		$title = remove_accents( $title );
		$title = preg_replace( array(
			'~\s+~',
			'~[^\w\d-]+~u',
			'~-+~',
		), array(
			'-',
			'-',
			'-',
		), $title );
		return $title . $extension;
	}

	/**
	 * Attach container as a theme options page/subpage.
	 */
	public function init() {
		if ( ! $this->settings['file'] ) {
			$this->settings['file'] = $this->title_to_filename( 'crb_' . $this->get_id(), '.php' );
		}

		$registered = $this->register_page();
		if ( $registered ) {
			add_action( 'admin_menu', array( $this, '_attach' ) );
		}
	}

	/**
	 * Checks whether the current save request is valid
	 *
	 * @return bool
	 */
	public function is_valid_save() {
		if ( ! $this->verified_nonce_in_request() ) {
			return false;
		}

		return $this->is_valid_attach_for_object( null );
	}

	/**
	 * Perform save operation after successful is_valid_save() check.
	 * The call is propagated to all fields in the container.
	 *
	 * @param mixed $user_data
	 */
	public function save( $user_data = null ) {
		try {
			parent::save( $user_data );
		} catch ( Incorrect_Syntax_Exception $e ) {
			$this->errors[] = $e->getMessage();
		}

		do_action( 'carbon_fields_theme_options_container_saved', $user_data, $this );

		if ( ! headers_sent() ) {
			wp_redirect( add_query_arg( array( 'settings-updated' => 'true' ) ) );
		}
	}

	/**
	 * Get environment array for page request (in admin)
	 *
	 * @return array
	 */
	protected function get_environment_for_request() {
		return array();
	}

	/**
	 * Perform checks whether the container should be attached during the current request
	 *
	 * @return bool True if the container is allowed to be attached
	 */
	public function is_valid_attach_for_request() {
		return $this->static_conditions_pass();
	}

	/**
	 * Get environment array for object id
	 *
	 * @return array
	 */
	protected function get_environment_for_object( $object_id ) {
		return array();
	}

	/**
	 * Check container attachment rules against object id
	 *
	 * @param int $object_id
	 * @return bool
	 */
	public function is_valid_attach_for_object( $object_id = null ) {
		return $this->all_conditions_pass( intval( $object_id ) );
	}

	/**
	 * Add theme options container pages.
	 * Hook the container saving action.
	 */
	public function attach() {
		// use the "read" capability because conditions will handle actual access and save capability checking
		// before the attach() method is called

		// Add menu page
		if ( ! $this->settings['parent'] ) {
			add_menu_page(
				$this->title,
				$this->settings['menu_title'] ? $this->settings['menu_title'] : $this->title,
				'read',
				$this->settings['file'],
				array( $this, 'render' ),
				$this->settings['icon'],
				$this->settings['menu_position']
			);
		}

		add_submenu_page(
			$this->settings['parent'],
			$this->title,
			$this->settings['menu_title'] ? $this->settings['menu_title'] : $this->title,
			'read',
			$this->settings['file'],
			array( $this, 'render' )
		);

		$page_hook = get_plugin_page_hookname( $this->settings['file'], '' );
		add_action( 'load-' . $page_hook, array( $this, '_save' ) );
	}

	/**
	 * Whether this container is currently viewed.
	 *
	 * @return boolean
	 */
	public function should_activate() {
		$input = stripslashes_deep( $_GET );
		$request_page = isset( $input['page'] ) ? $input['page'] : '';
		if ( ! empty( $request_page ) && $request_page === $this->settings['file'] ) {
			return true;
		}

		return false;
	}

	/**
	 * Output the container markup
	 */
	public function render() {
		$input = stripslashes_deep( $_GET );
		$request_settings_updated = isset( $input['settings-updated'] ) ? $input['settings-updated'] : '';
		if ( $request_settings_updated === 'true' ) {
			$this->notifications[] = __( 'Settings saved.', 'carbon-fields' );
		}

		include \Carbon_Fields\DIR . '/templates/Container/theme_options.php';
	}

	/**
	 * Register the page while making sure it is unique.
	 *
	 * @return boolean
	 */
	protected function register_page() {
		$file = $this->settings['file'];
		$parent = $this->settings['parent'];

		if ( ! $parent ) {
			// Register top level page
			if ( isset( static::$registered_pages[ $file ] ) ) {
				Incorrect_Syntax_Exception::raise( 'Page "' . $file . '" already registered' );
				return false;
			}

			static::$registered_pages[ $file ] = array();
			return true;
		}

		// Register sub-page
		if ( ! isset( static::$registered_pages[ $parent ] ) ) {
			static::$registered_pages[ $parent ] = array();
		}

		if ( in_array( $file, static::$registered_pages[ $parent ] ) ) {
			Incorrect_Syntax_Exception::raise( 'Page "' . $file . '" with parent "' . $parent . '" is already registered. Please set a name for the container.' );
			return false;
		}

		static::$registered_pages[ $parent ][] = $file;
		return true;
	}

	/**
	 * Change the parent theme options page of this container
	 *
	 * @param  string|Theme_Options_Container $parent
	 * @return Container                      $this
	 */
	public function set_page_parent( $parent ) {
		if ( is_a( $parent, get_class() ) ) {
			$this->settings['parent'] = $this->title_to_filename( 'crb_' . $parent->get_id(), '.php' );
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
			return $this;
		}

		$this->settings['parent'] = $parent;
		return $this;
	}

	/**
	 * Set the theme options file name of this container.
	 *
	 * @param  string    $file
	 * @return Container $this
	 */
	public function set_page_file( $file ) {
		$this->settings['file'] = $file;
		return $this;
	}

	/**
	 * Set the title of this container in the administration menu.
	 *
	 * @param  string    $title
	 * @return Container $this
	 */
	public function set_page_menu_title( $title ) {
		$this->settings['menu_title'] = $title;
		return $this;
	}

	/**
	 * Alias of the set_page_menu_position() method for backwards compatibility
	 *
	 * @param  integer   $position
	 * @return Container $this
	 */
	public function set_page_position( $position ) {
		return $this->set_page_menu_position( $position );
	}

	/**
	 * Set the page position of this container in the administration menu.
	 *
	 * @param  integer   $position
	 * @return Container $this
	 */
	public function set_page_menu_position( $position ) {
		$this->settings['menu_position'] = $position;
		return $this;
	}

	/**
	 * Set the icon of this theme options page.
	 * Applicable only for parent theme option pages.
	 *
	 * @param  string    $icon
	 * @return Container $this
	 */
	public function set_icon( $icon ) {
		$this->settings['icon'] = $icon;
		return $this;
	}
}


1		<?php
2
3		namespace Carbon_Fields\Container;
4
5		use Carbon_Fields\Datastore\Datastore;
6		use Carbon_Fields\Exception\Incorrect_Syntax_Exception;
7
8		/**
9		* Theme options container class.
10		*/
11		class Theme_Options_Container extends Container {
12
13		/**
14		* Array of registered page slugs to verify uniqueness with
15		*
16		* @var array
17		*/
18		protected static $registered_pages = array();
19
20		/**
21		* Array of container settings
22		*
23		* @var array
24		*/
25		public $settings = array(
26		'parent' => '',
27		'file' => '',
28		'icon' => '',
29		'menu_position' => null,
30		'menu_title' => null,
31		);
32
33		/**
34		* {@inheritDoc}
35		*/
36	View Code Duplication	public function __construct( $id, $title, $type, $condition_collection, $condition_translator ) {
37		parent::__construct( $id, $title, $type, $condition_collection, $condition_translator );
38
39		if ( ! $this->get_datastore() ) {
40		$this->set_datastore( Datastore::make( 'theme_options' ), $this->has_default_datastore() );
41		}
42
43		if ( apply_filters( 'carbon_fields_' . $type . '_container_admin_only_access', true, $title ) ) {
44		$this->where( 'current_user_capability', '=', 'manage_options' );
45		}
46		}
47
48		/**
49		* Sanitize a title to a filename
50		*
51		* @param string $title
52		* @param string $extension
53		* @return string
54		*/
55		protected function title_to_filename( $title, $extension ) {
56		$title = sanitize_file_name( $title );
57		$title = strtolower( $title );
58		$title = remove_accents( $title );
59		$title = preg_replace( array(
60		'~\s+~',
61		'~[^\w\d-]+~u',
62		'~-+~',
63		), array(
64		'-',
65		'-',
66		'-',
67		), $title );
68		return $title . $extension;
69		}
70
71		/**
72		* Attach container as a theme options page/subpage.
73		*/
74		public function init() {
75		if ( ! $this->settings['file'] ) {
76		$this->settings['file'] = $this->title_to_filename( 'crb_' . $this->get_id(), '.php' );
77		}
78
79		$registered = $this->register_page();
80		if ( $registered ) {
81		add_action( 'admin_menu', array( $this, '_attach' ) );
82		}
83		}
84
85		/**
86		* Checks whether the current save request is valid
87		*
88		* @return bool
89		*/
90		public function is_valid_save() {
91		if ( ! $this->verified_nonce_in_request() ) {
92		return false;
93		}
94
95		return $this->is_valid_attach_for_object( null );
96		}
97
98		/**
99		* Perform save operation after successful is_valid_save() check.
100		* The call is propagated to all fields in the container.
101		*
102		* @param mixed $user_data
103		*/
104		public function save( $user_data = null ) {
105		try {
106		parent::save( $user_data );
107		} catch ( Incorrect_Syntax_Exception $e ) {
108		$this->errors[] = $e->getMessage();
109		}
110
111		do_action( 'carbon_fields_theme_options_container_saved', $user_data, $this );
112
113		if ( ! headers_sent() ) {
114		wp_redirect( add_query_arg( array( 'settings-updated' => 'true' ) ) );
115		}
116		}
117
118		/**
119		* Get environment array for page request (in admin)
120		*
121		* @return array
122		*/
123		protected function get_environment_for_request() {
124		return array();
125		}
126
127		/**
128		* Perform checks whether the container should be attached during the current request
129		*
130		* @return bool True if the container is allowed to be attached
131		*/
132		public function is_valid_attach_for_request() {
133		return $this->static_conditions_pass();
134		}
135
136		/**
137		* Get environment array for object id
138		*
139		* @return array
140		*/
141		protected function get_environment_for_object( $object_id ) {
142		return array();
143		}
144
145		/**
146		* Check container attachment rules against object id
147		*
148		* @param int $object_id
149		* @return bool
150		*/
151		public function is_valid_attach_for_object( $object_id = null ) {
152		return $this->all_conditions_pass( intval( $object_id ) );
153		}
154
155		/**
156		* Add theme options container pages.
157		* Hook the container saving action.
158		*/
159		public function attach() {
160		// use the "read" capability because conditions will handle actual access and save capability checking
161		// before the attach() method is called
162
163		// Add menu page
164		if ( ! $this->settings['parent'] ) {
165		add_menu_page(
166		$this->title,
167		$this->settings['menu_title'] ? $this->settings['menu_title'] : $this->title,
168		'read',
169		$this->settings['file'],
170		array( $this, 'render' ),
171		$this->settings['icon'],
172		$this->settings['menu_position']
173		);
174		}
175
176		add_submenu_page(
177		$this->settings['parent'],
178		$this->title,
179		$this->settings['menu_title'] ? $this->settings['menu_title'] : $this->title,
180		'read',
181		$this->settings['file'],
182		array( $this, 'render' )
183		);
184
185		$page_hook = get_plugin_page_hookname( $this->settings['file'], '' );
186		add_action( 'load-' . $page_hook, array( $this, '_save' ) );
187		}
188
189		/**
190		* Whether this container is currently viewed.
191		*
192		* @return boolean
193		*/
194		public function should_activate() {
195		$input = stripslashes_deep( $_GET );
196		$request_page = isset( $input['page'] ) ? $input['page'] : '';
197		if ( ! empty( $request_page ) && $request_page === $this->settings['file'] ) {
198		return true;
199		}
200
201		return false;
202		}
203
204		/**
205		* Output the container markup
206		*/
207		public function render() {
208		$input = stripslashes_deep( $_GET );
209		$request_settings_updated = isset( $input['settings-updated'] ) ? $input['settings-updated'] : '';
210		if ( $request_settings_updated === 'true' ) {
211		$this->notifications[] = __( 'Settings saved.', 'carbon-fields' );
212		}
213
214		include \Carbon_Fields\DIR . '/templates/Container/theme_options.php';
215		}
216
217		/**
218		* Register the page while making sure it is unique.
219		*
220		* @return boolean
221		*/
222		protected function register_page() {
223		$file = $this->settings['file'];
224		$parent = $this->settings['parent'];
225
226		if ( ! $parent ) {
227		// Register top level page
228		if ( isset( static::$registered_pages[ $file ] ) ) {
229		Incorrect_Syntax_Exception::raise( 'Page "' . $file . '" already registered' );
230		return false;
231		}
232
233		static::$registered_pages[ $file ] = array();
234		return true;
235		}
236
237		// Register sub-page
238		if ( ! isset( static::$registered_pages[ $parent ] ) ) {
239		static::$registered_pages[ $parent ] = array();
240		}
241
242		if ( in_array( $file, static::$registered_pages[ $parent ] ) ) {
243		Incorrect_Syntax_Exception::raise( 'Page "' . $file . '" with parent "' . $parent . '" is already registered. Please set a name for the container.' );
244		return false;
245		}
246
247		static::$registered_pages[ $parent ][] = $file;
248		return true;
249		}
250
251		/**
252		* Change the parent theme options page of this container
253		*
254		* @param string\|Theme_Options_Container $parent
255		* @return Container $this
256		*/
257		public function set_page_parent( $parent ) {
258		if ( is_a( $parent, get_class() ) ) {
259		$this->settings['parent'] = $this->title_to_filename( 'crb_' . $parent->get_id(), '.php' );
		0 ignored issues – show Bug introduced 2017-07-17 09:21 UTC by Report Bug Copy Issue Report It seems like `$parent` is not always an object, but can also be of type `string`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
260		return $this;
261		}
262
263		$this->settings['parent'] = $parent;
264		return $this;
265		}
266
267		/**
268		* Set the theme options file name of this container.
269		*
270		* @param string $file
271		* @return Container $this
272		*/
273		public function set_page_file( $file ) {
274		$this->settings['file'] = $file;
275		return $this;
276		}
277
278		/**
279		* Set the title of this container in the administration menu.
280		*
281		* @param string $title
282		* @return Container $this
283		*/
284		public function set_page_menu_title( $title ) {
285		$this->settings['menu_title'] = $title;
286		return $this;
287		}
288
289		/**
290		* Alias of the set_page_menu_position() method for backwards compatibility
291		*
292		* @param integer $position
293		* @return Container $this
294		*/
295		public function set_page_position( $position ) {
296		return $this->set_page_menu_position( $position );
297		}
298
299		/**
300		* Set the page position of this container in the administration menu.
301		*
302		* @param integer $position
303		* @return Container $this
304		*/
305		public function set_page_menu_position( $position ) {
306		$this->settings['menu_position'] = $position;
307		return $this;
308		}
309
310		/**
311		* Set the icon of this theme options page.
312		* Applicable only for parent theme option pages.
313		*
314		* @param string $icon
315		* @return Container $this
316		*/
317		public function set_icon( $icon ) {
318		$this->settings['icon'] = $icon;
319		return $this;
320		}
321		}
322

htmlburger / carbon-fields

Push — master ( afe740...a74724 )

Theme_Options_Container::is_valid_save() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like