Theme_Options_Container::set_icon() - Code Metrics - htmlburger/carbon-fields - Measure and Improve Code Quality continuously with Scrutinizer

Theme_Options_Container::set_icon() A
last analyzed 2021-04-22 13:52 UTC

↳ Parent: Theme_Options_Container

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0
ccs	0
cts	3
cp	0
crap	2

<?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 ) ) {
			$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() {
		$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_' . $this->type . '_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->get_page_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->get_page_file(),
			array( $this, 'render' )
		);

		$page_hook = get_plugin_page_hookname( $this->get_page_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->get_page_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/' . $this->type . '.php';
	}

	/**
	 * Register the page while making sure it is unique.
	 *
	 * @return boolean
	 */
	protected function register_page() {
		$file = $this->get_page_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'] = $parent->get_page_file();
			return $this;
		}

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

	/**
	 * Get the theme options file name of this container.
	 *
	 * @return string
	 */
	public function get_page_file() {
		if ( ! empty( $this->settings['file'] ) ) {
			return $this->settings['file'];
		}
		return $this->title_to_filename( 'crb_' . $this->get_id(), '.php' );
	}

	/**
	 * 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 ) {
		0 ignored issues – show Duplication introduced 2017-07-31 11:57 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
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, $this ) ) {
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		$registered = $this->register_page();
76		if ( $registered ) {
77		add_action( 'admin_menu', array( $this, '_attach' ) );
78		}
79		}
80
81		/**
82		* Checks whether the current save request is valid
83		*
84		* @return bool
85		*/
86		public function is_valid_save() {
87		if ( ! $this->verified_nonce_in_request() ) {
88		return false;
89		}
90
91		return $this->is_valid_attach_for_object( null );
92		}
93
94		/**
95		* Perform save operation after successful is_valid_save() check.
96		* The call is propagated to all fields in the container.
97		*
98		* @param mixed $user_data
99		*/
100		public function save( $user_data = null ) {
101		try {
102		parent::save( $user_data );
103		} catch ( Incorrect_Syntax_Exception $e ) {
104		$this->errors[] = $e->getMessage();
105		}
106
107		do_action( 'carbon_fields_' . $this->type . '_container_saved', $user_data, $this );
108
109		if ( ! headers_sent() ) {
110		wp_redirect( add_query_arg( array( 'settings-updated' => 'true' ) ) );
111		}
112		}
113
114		/**
115		* Get environment array for page request (in admin)
116		*
117		* @return array
118		*/
119		protected function get_environment_for_request() {
120		return array();
121		}
122
123		/**
124		* Perform checks whether the container should be attached during the current request
125		*
126		* @return bool True if the container is allowed to be attached
127		*/
128		public function is_valid_attach_for_request() {
129		return $this->static_conditions_pass();
130		}
131
132		/**
133		* Get environment array for object id
134		*
135		* @return array
136		*/
137		protected function get_environment_for_object( $object_id ) {
138		return array();
139		}
140
141		/**
142		* Check container attachment rules against object id
143		*
144		* @param int $object_id
145		* @return bool
146		*/
147		public function is_valid_attach_for_object( $object_id = null ) {
148		return $this->all_conditions_pass( intval( $object_id ) );
149		}
150
151		/**
152		* Add theme options container pages.
153		* Hook the container saving action.
154		*/
155		public function attach() {
156		// use the "read" capability because conditions will handle actual access and save capability checking
157		// before the attach() method is called
158
159		// Add menu page
160		if ( ! $this->settings['parent'] ) {
161		add_menu_page(
162		$this->title,
163		$this->settings['menu_title'] ? $this->settings['menu_title'] : $this->title,
164		'read',
165		$this->get_page_file(),
166		array( $this, 'render' ),
167		$this->settings['icon'],
168		$this->settings['menu_position']
169		);
170		}
171
172		add_submenu_page(
173		$this->settings['parent'],
174		$this->title,
175		$this->settings['menu_title'] ? $this->settings['menu_title'] : $this->title,
176		'read',
177		$this->get_page_file(),
178		array( $this, 'render' )
179		);
180
181		$page_hook = get_plugin_page_hookname( $this->get_page_file(), '' );
182		add_action( 'load-' . $page_hook, array( $this, '_save' ) );
183		}
184
185		/**
186		* Whether this container is currently viewed.
187		*
188		* @return boolean
189		*/
190		public function should_activate() {
191		$input = stripslashes_deep( $_GET );
192		$request_page = isset( $input['page'] ) ? $input['page'] : '';
193		if ( ! empty( $request_page ) && $request_page === $this->get_page_file() ) {
194		return true;
195		}
196
197		return false;
198		}
199
200		/**
201		* Output the container markup
202		*/
203		public function render() {
204		$input = stripslashes_deep( $_GET );
205		$request_settings_updated = isset( $input['settings-updated'] ) ? $input['settings-updated'] : '';
206		if ( $request_settings_updated === 'true' ) {
207		$this->notifications[] = __( 'Settings saved.', 'carbon-fields' );
208		}
209
210		include \Carbon_Fields\DIR . '/templates/Container/' . $this->type . '.php';
211		}
212
213		/**
214		* Register the page while making sure it is unique.
215		*
216		* @return boolean
217		*/
218		protected function register_page() {
219		$file = $this->get_page_file();
220		$parent = $this->settings['parent'];
221
222		if ( ! $parent ) {
223		// Register top level page
224		if ( isset( static::$registered_pages[ $file ] ) ) {
225		Incorrect_Syntax_Exception::raise( 'Page "' . $file . '" already registered' );
226		return false;
227		}
228
229		static::$registered_pages[ $file ] = array();
230		return true;
231		}
232
233		// Register sub-page
234		if ( ! isset( static::$registered_pages[ $parent ] ) ) {
235		static::$registered_pages[ $parent ] = array();
236		}
237
238		if ( in_array( $file, static::$registered_pages[ $parent ] ) ) {
239		Incorrect_Syntax_Exception::raise( 'Page "' . $file . '" with parent "' . $parent . '" is already registered. Please set a name for the container.' );
240		return false;
241		}
242
243		static::$registered_pages[ $parent ][] = $file;
244		return true;
245		}
246
247		/**
248		* Change the parent theme options page of this container
249		*
250		* @param string\|Theme_Options_Container $parent
251		* @return Container $this
252		*/
253		public function set_page_parent( $parent ) {
254		if ( is_a( $parent, get_class() ) ) {
255		$this->settings['parent'] = $parent->get_page_file();
256		return $this;
257		}
258
259		$this->settings['parent'] = $parent;
260		return $this;
261		}
262
263		/**
264		* Get the theme options file name of this container.
265		*
266		* @return string
267		*/
268		public function get_page_file() {
269		if ( ! empty( $this->settings['file'] ) ) {
270		return $this->settings['file'];
271		}
272		return $this->title_to_filename( 'crb_' . $this->get_id(), '.php' );
273		}
274
275		/**
276		* Set the theme options file name of this container.
277		*
278		* @param string $file
279		* @return Container $this
280		*/
281		public function set_page_file( $file ) {
282		$this->settings['file'] = $file;
283		return $this;
284		}
285
286		/**
287		* Set the title of this container in the administration menu.
288		*
289		* @param string $title
290		* @return Container $this
291		*/
292		public function set_page_menu_title( $title ) {
293		$this->settings['menu_title'] = $title;
294		return $this;
295		}
296
297		/**
298		* Alias of the set_page_menu_position() method for backwards compatibility
299		*
300		* @param integer $position
301		* @return Container $this
302		*/
303		public function set_page_position( $position ) {
304		return $this->set_page_menu_position( $position );
305		}
306
307		/**
308		* Set the page position of this container in the administration menu.
309		*
310		* @param integer $position
311		* @return Container $this
312		*/
313		public function set_page_menu_position( $position ) {
314		$this->settings['menu_position'] = $position;
315		return $this;
316		}
317
318		/**
319		* Set the icon of this theme options page.
320		* Applicable only for parent theme option pages.
321		*
322		* @param string $icon
323		* @return Container $this
324		*/
325		public function set_icon( $icon ) {
326		$this->settings['icon'] = $icon;
327		return $this;
328		}
329		}
330

htmlburger / carbon-fields

Theme_Options_Container::set_icon() A last analyzed 2021-04-22 13:52 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Theme_Options_Container::set_icon() A
last analyzed 2021-04-22 13:52 UTC