Admin::validateSettings() - Code Metrics - goblindegook/wp-cas-server - Measure and Improve Code Quality continuously with Scrutinizer

Admin::validateSettings() A
last analyzed 2016-02-14 04:42 UTC

↳ Parent: Admin

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	7
rs	9.4285
cc	1
eloc	4
nc	1
nop	1

<?php
/**
 * Implements the Cassava plugin's administration interface components.
 *
 * @version 1.0.1
 * @since   1.0.0
 */

namespace Cassava;

/**
 * Plugin administration class.
 *
 * @since 1.0.0
 */
class Admin {

	/**
	 * Instantiates the admin panel object.
	 *
	 * @uses \add_action()
	 */
	public function __construct () {
		\add_action( 'admin_init', array( $this, 'admin_init' ) );
		\add_action( 'admin_menu', array( $this, 'admin_menu' ) );
	}

	/**
	 * Initializes the admin panel and registers settings fields.
	 *
	 * Triggered by the `admin_init` action.
	 *
	 * @uses \add_action()
	 */
	public function admin_init() {
		$this->savePermalinks();
		$this->addSettings();

		\add_action( 'admin_notices', array( $this, 'admin_notices' ) );
	}

	/**
	 * Register the menu entry for the plugin's settings page.
	 *
	 * @since 1.1.0
	 *
	 * @uses \__()
	 * @uses \add_options_page()
	 */
	public function admin_menu() {
		\add_options_page(
			__( 'Cassava CAS Server', 'wp-cas-server' ),
			__( 'Cassava CAS Server', 'wp-cas-server' ),
			'manage_options',
			Plugin::SLUG,
			array( $this, 'pageSettings' )
		);
	}

	/**
	 * Presents admin notices.
	 *
	 * Triggered by the `admin_notices` action.
	 *
	 * @uses \current_user_can()
	 * @uses \is_ssl()
	 *
	 * @uses ::adminNoticeNoSSL()
	 *
	 * @SuppressWarnings(CamelCaseMethodName)
	 */
	public function admin_notices() {
		if ( ! \is_ssl() && \current_user_can( 'install_plugins' ) ) {
			$this->adminNoticeNoSSL();
		}
	}

	/**
	 * Nags the user with an administration notice explaining that the plugin will only
	 * work if HTTP
	 */
	protected function adminNoticeNoSSL() {
		?>
		<div class="update-nag">
			<?php _e( 'Cassava CAS Server requires that this site be configured for HTTPS. For more information, contact your system administrator or hosting provider.', 'wp-cas-server' ); ?>
		</div>
		<?php
	}

	/**
	 * Updates the CAS server endpoint when saving permalinks.
	 *
	 * @uses \is_admin()
	 * @uses \sanitize_text_field()
	 */
	protected function savePermalinks() {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		if ( ! \is_admin() ) {
			return;
		}

		$option = Options::KEY . '_endpoint_slug';

		if ( false
			|| isset( $_POST['permalink_structure'] )
			|| isset( $_POST['category_base'] )
			|| isset( $_POST[ $option ] )
		) {
			Options::set( 'endpoint_slug', trim( \sanitize_text_field( $_POST[ $option ] ) ) );
		}
	}

	/**
	 * Register plugin settings.
	 *
	 * @uses \add_settings_field()
	 * @uses \add_settings_section()
	 * @uses \register_setting()
	 *
	 * @since   1.0.0
	 */
	protected function addSettings() {
		\register_setting(
			Plugin::SLUG,
			Options::KEY,
			array( $this, 'validateSettings' )
		);

		// Default plugin settings:

		\add_settings_section( 'default', '', false, Plugin::SLUG );

		\add_settings_field(
			'attributes',
			__( 'User Attributes To Return', 'wp-cas-server' ),
			array( $this, 'fieldUserAttributes' ),
			Plugin::SLUG
		);

		// Permalink settings:

		\add_settings_field(
			Options::KEY . '_endpoint_slug',
			__( 'CAS server base', 'wp-cas-server' ),
			array( $this, 'fieldPermalinksEndpointSlug' ),
			'permalink',
			'optional'
		);

	}

	/**
	 * Validates and updates CAS server plugin settings.
	 *
	 * @param  array $input Unvalidated input arguments when settings are updated.
	 *
	 * @return array        Validated plugin settings to be saved in the database.
	 *
	 * @since 1.1.0
	 */
	public function validateSettings( $input ) {
		$options = Options::getAll();

		$options['attributes'] = (array) $input['attributes'];

		return $options;
	}

	/**
	 * Display the configuration field for the CAS endpoint.
	 *
	 * @uses \esc_attr()
	 *
	 * @since 1.0.0
	 */
	public function fieldPermalinksEndpointSlug() {
		$option   = Options::KEY . '_endpoint_slug';
		$endpoint = Options::get( 'endpoint_slug' );
		?>
		<input id="<?php echo $option; ?>" name="<?php echo $option; ?>"
			type="text" class="regular-text code"
			value="<?php if ( isset( $endpoint ) ) echo \esc_attr( $endpoint ); ?>"
			placeholder="<?php echo Plugin::ENDPOINT_SLUG; ?>" />
		<?php
	}

	/**
	 * Displays the CAS server settings page in the dashboard.
	 *
	 * @uses \_e()
	 * @uses \do_settings_sections()
	 * @uses \settings_fields()
	 * @uses \submit_button()
	 *
	 * @since 1.1.0
	 */
	public function pageSettings() {
		?>
		<div class="wrap">
			<h2><?php \_e( 'Cassava CAS Server Settings', 'wp-cas-server' ); ?></h2>

			<p><?php \_e( 'Configuration panel for the Central Authentication Service provided by this site.', 'wp-cas-server' ); ?></p>

			<form action="options.php" method="POST">
				<?php \do_settings_sections( Plugin::SLUG ); ?>
				<?php \settings_fields( Plugin::SLUG ); ?>
				<?php \submit_button(); ?>
			</form>
		</div>
		<?php
	}

	/**
	 * Display the configuration fieldset for the user attributs to return on successful
	 * requests.
	 *
	 * Checked attributes for the authenticated user will be returned on successful
	 * `/validateService` request responses inside an optional `<cas:attributes></cas:attributes>`
	 * tag.
	 *
	 * @uses \_e()
	 * @uses \apply_filters()
	 *
	 * @since 1.1.0
	 */
	public function fieldUserAttributes() {
		$user       = \wp_get_current_user();
		$attributes = Options::get( 'attributes' );

		$attributeOptions = array(
			'first_name'   => __( 'First Name', 'wp-cas-server' ),
			'last_name'    => __( 'Last Name', 'wp-cas-server' ),
			'display_name' => __( 'Public Name', 'wp-cas-server' ),
			'user_email'   => __( 'Email', 'wp-cas-server' ),
			'user_url'     => __( 'Website', 'wp-cas-server' ),
		);

		/**
		 * Allows developers to change the list of user attributes that appear in the dashboard for
		 * an administrator to set to return on successful validation requests.
		 *
		 * Options are stored in an associative array, with user attribute slugs as array keys and
		 * option labels as array values.
		 *
		 * These settings are valid only for CAS 2.0 validation requests.
		 *
		 * @param  array $attributeOptions Attribute options an administrator can set on the dashboard.
		 *
		 * @return array                   Attribute options to display.
		 *
		 * @since 1.1.0
		 */
		$attributeOptions = \apply_filters( 'cas_server_settings_user_attribute_options', $attributeOptions );
		?>

		<fieldset>
		<legend class="screen-reader-text"><?php _e( 'User Attributes', 'wp-cas-server' ); ?></legend>
			<?php foreach ( $attributeOptions as $value => $label ) : ?>
			<label>
				<input id="<?php echo Options::KEY . '-attribute-' . $value ?>"
				name="<?php echo Options::KEY ?>[attributes][]"
				type="checkbox" <?php if (in_array( $value, $attributes )) echo "checked"; ?>
				value="<?php echo $value ?>">
				<span><?php echo $label ?></span>
				<?php if ( $user->get( $value ) ) : ?>
				<span class="description"><?php
					printf( __( '(e.g. %s)', 'wp-cas-server' ), implode( ',', (array) $user->get( $value ) ) );
				?></span>
				<?php endif; ?>
			</label><br>
			<?php endforeach; ?>
			<p class="description"><?php
				_e( 'Checked attributes are disclosed on successful validation requests (CAS 2.0 only).', 'wp-cas-server' );
			?></p>
		</fieldset>
		<?php
	}
}


1			<?php
2			/**
3			* Implements the Cassava plugin's administration interface components.
4			*
5			* @version 1.0.1
6			* @since 1.0.0
7			*/
8
9			namespace Cassava;
10
11			/**
12			* Plugin administration class.
13			*
14			* @since 1.0.0
15			*/
16			class Admin {
17
18			/**
19			* Instantiates the admin panel object.
20			*
21			* @uses \add_action()
22			*/
23			public function __construct () {
24			\add_action( 'admin_init', array( $this, 'admin_init' ) );
25			\add_action( 'admin_menu', array( $this, 'admin_menu' ) );
26			}
27
28			/**
29			* Initializes the admin panel and registers settings fields.
30			*
31			* Triggered by the `admin_init` action.
32			*
33			* @uses \add_action()
34			*/
35			public function admin_init() {
36			$this->savePermalinks();
37			$this->addSettings();
38
39			\add_action( 'admin_notices', array( $this, 'admin_notices' ) );
40			}
41
42			/**
43			* Register the menu entry for the plugin's settings page.
44			*
45			* @since 1.1.0
46			*
47			* @uses \__()
48			* @uses \add_options_page()
49			*/
50			public function admin_menu() {
51			\add_options_page(
52			__( 'Cassava CAS Server', 'wp-cas-server' ),
53			__( 'Cassava CAS Server', 'wp-cas-server' ),
54			'manage_options',
55			Plugin::SLUG,
56			array( $this, 'pageSettings' )
57			);
58			}
59
60			/**
61			* Presents admin notices.
62			*
63			* Triggered by the `admin_notices` action.
64			*
65			* @uses \current_user_can()
66			* @uses \is_ssl()
67			*
68			* @uses ::adminNoticeNoSSL()
69			*
70			* @SuppressWarnings(CamelCaseMethodName)
71			*/
72			public function admin_notices() {
73			if ( ! \is_ssl() && \current_user_can( 'install_plugins' ) ) {
74			$this->adminNoticeNoSSL();
75			}
76			}
77
78			/**
79			* Nags the user with an administration notice explaining that the plugin will only
80			* work if HTTP
81			*/
82			protected function adminNoticeNoSSL() {
83			?>
84			<div class="update-nag">
85			<?php _e( 'Cassava CAS Server requires that this site be configured for HTTPS. For more information, contact your system administrator or hosting provider.', 'wp-cas-server' ); ?>
86			</div>
87			<?php
88			}
89
90			/**
91			* Updates the CAS server endpoint when saving permalinks.
92			*
93			* @uses \is_admin()
94			* @uses \sanitize_text_field()
95			*/
96			protected function savePermalinks() {
			0 ignored issues – show Coding Style introduced 2016-02-12 15:58 UTC by Report Bug Copy Issue Report `savePermalinks` uses the super-global variable `$_POST` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
97			if ( ! \is_admin() ) {
98			return;
99			}
100
101			$option = Options::KEY . '_endpoint_slug';
102
103			if ( false
104			\|\| isset( $_POST['permalink_structure'] )
105			\|\| isset( $_POST['category_base'] )
106			\|\| isset( $_POST[ $option ] )
107			) {
108			Options::set( 'endpoint_slug', trim( \sanitize_text_field( $_POST[ $option ] ) ) );
109			}
110			}
111
112			/**
113			* Register plugin settings.
114			*
115			* @uses \add_settings_field()
116			* @uses \add_settings_section()
117			* @uses \register_setting()
118			*
119			* @since 1.0.0
120			*/
121			protected function addSettings() {
122			\register_setting(
123			Plugin::SLUG,
124			Options::KEY,
125			array( $this, 'validateSettings' )
126			);
127
128			// Default plugin settings:
129
130			\add_settings_section( 'default', '', false, Plugin::SLUG );
131
132			\add_settings_field(
133			'attributes',
134			__( 'User Attributes To Return', 'wp-cas-server' ),
135			array( $this, 'fieldUserAttributes' ),
136			Plugin::SLUG
137			);
138
139			// Permalink settings:
140
141			\add_settings_field(
142			Options::KEY . '_endpoint_slug',
143			__( 'CAS server base', 'wp-cas-server' ),
144			array( $this, 'fieldPermalinksEndpointSlug' ),
145			'permalink',
146			'optional'
147			);
148
149			}
150
151			/**
152			* Validates and updates CAS server plugin settings.
153			*
154			* @param array $input Unvalidated input arguments when settings are updated.
155			*
156			* @return array Validated plugin settings to be saved in the database.
157			*
158			* @since 1.1.0
159			*/
160			public function validateSettings( $input ) {
161			$options = Options::getAll();
162
163			$options['attributes'] = (array) $input['attributes'];
164
165			return $options;
166			}
167
168			/**
169			* Display the configuration field for the CAS endpoint.
170			*
171			* @uses \esc_attr()
172			*
173			* @since 1.0.0
174			*/
175			public function fieldPermalinksEndpointSlug() {
176			$option = Options::KEY . '_endpoint_slug';
177			$endpoint = Options::get( 'endpoint_slug' );
178			?>
179			<input id="<?php echo $option; ?>" name="<?php echo $option; ?>"
180			type="text" class="regular-text code"
181			value="<?php if ( isset( $endpoint ) ) echo \esc_attr( $endpoint ); ?>"
182			placeholder="<?php echo Plugin::ENDPOINT_SLUG; ?>" />
183			<?php
184			}
185
186			/**
187			* Displays the CAS server settings page in the dashboard.
188			*
189			* @uses \_e()
190			* @uses \do_settings_sections()
191			* @uses \settings_fields()
192			* @uses \submit_button()
193			*
194			* @since 1.1.0
195			*/
196			public function pageSettings() {
197			?>
198			<div class="wrap">
199			<h2><?php \_e( 'Cassava CAS Server Settings', 'wp-cas-server' ); ?></h2>
200
201			<p><?php \_e( 'Configuration panel for the Central Authentication Service provided by this site.', 'wp-cas-server' ); ?></p>
202
203			<form action="options.php" method="POST">
204			<?php \do_settings_sections( Plugin::SLUG ); ?>
205			<?php \settings_fields( Plugin::SLUG ); ?>
206			<?php \submit_button(); ?>
207			</form>
208			</div>
209			<?php
210			}
211
212			/**
213			* Display the configuration fieldset for the user attributs to return on successful
214			* requests.
215			*
216			* Checked attributes for the authenticated user will be returned on successful
217			* `/validateService` request responses inside an optional `<cas:attributes></cas:attributes>`
218			* tag.
219			*
220			* @uses \_e()
221			* @uses \apply_filters()
222			*
223			* @since 1.1.0
224			*/
225			public function fieldUserAttributes() {
226			$user = \wp_get_current_user();
227			$attributes = Options::get( 'attributes' );
228
229			$attributeOptions = array(
230			'first_name' => __( 'First Name', 'wp-cas-server' ),
231			'last_name' => __( 'Last Name', 'wp-cas-server' ),
232			'display_name' => __( 'Public Name', 'wp-cas-server' ),
233			'user_email' => __( 'Email', 'wp-cas-server' ),
234			'user_url' => __( 'Website', 'wp-cas-server' ),
235			);
236
237			/**
238			* Allows developers to change the list of user attributes that appear in the dashboard for
239			* an administrator to set to return on successful validation requests.
240			*
241			* Options are stored in an associative array, with user attribute slugs as array keys and
242			* option labels as array values.
243			*
244			* These settings are valid only for CAS 2.0 validation requests.
245			*
246			* @param array $attributeOptions Attribute options an administrator can set on the dashboard.
247			*
248			* @return array Attribute options to display.
249			*
250			* @since 1.1.0
251			*/
252			$attributeOptions = \apply_filters( 'cas_server_settings_user_attribute_options', $attributeOptions );
253			?>
254
255			<fieldset>
256			<legend class="screen-reader-text"><?php _e( 'User Attributes', 'wp-cas-server' ); ?></legend>
257			<?php foreach ( $attributeOptions as $value => $label ) : ?>
258			<label>
259			<input id="<?php echo Options::KEY . '-attribute-' . $value ?>"
260			name="<?php echo Options::KEY ?>[attributes][]"
261			type="checkbox" <?php if (in_array( $value, $attributes )) echo "checked"; ?>
262			value="<?php echo $value ?>">
263			<span><?php echo $label ?></span>
264			<?php if ( $user->get( $value ) ) : ?>
265			<span class="description"><?php
266			printf( __( '(e.g. %s)', 'wp-cas-server' ), implode( ',', (array) $user->get( $value ) ) );
267			?></span>
268			<?php endif; ?>
269			</label><br>
270			<?php endforeach; ?>
271			<p class="description"><?php
272			_e( 'Checked attributes are disclosed on successful validation requests (CAS 2.0 only).', 'wp-cas-server' );
273			?></p>
274			</fieldset>
275			<?php
276			}
277			}
278

goblindegook / wp-cas-server

Admin::validateSettings() A last analyzed 2016-02-14 04:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Admin::validateSettings() A
last analyzed 2016-02-14 04:42 UTC