GeminiLabs\Pollux\Settings

Complexity

Total Complexity

27

Size/Duplication

Total Lines	234
Duplicated Lines	5.56 %

Coupling/Cohesion

Components	2
Dependencies	3

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	16	2
A	addPage()	0	12	1
A	addSubmitMetaBox()	0	11	1
A	filterInstruction()	0	4	1
A	filterRedirectOnSave()	0	11	3
A	register()	0	12	3
A	registerSetting()	0	4	1
A	onSave()	0	5	1
A	renderFooterScript()	0	8	1
A	renderPage()	0	8	1
A	renderSubmitMetaBox()	0	13	1
A	reset()	0	12	4
A	getInstructions()	0	6	1
A	normalize()	13	13	2
A	normalizeFieldName()	0	8	2
A	normalizeId()	0	6	2

<?php

namespace GeminiLabs\Pollux;

use GeminiLabs\Pollux\Application;
use GeminiLabs\Pollux\MetaBox;
use GeminiLabs\Pollux\SettingsMetaBox;

class Settings extends MetaBox
{
	const CONDITIONS = [
		'hook', 'is_plugin_active', 'is_plugin_inactive',
	];

	/**
	 * @var string
	 */
	CONST ID = 'pollux-settings';

	/**
	 * @var string
	 */
	public $hook;

	/**
	 * {@inheritdoc}
	 */
	public function init()
	{
		// @todo: run GateKeeper here instead to check dependencies and capability

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

		if( !is_plugin_active( 'meta-box/meta-box.php' ))return;

		$this->normalize();

		add_action( 'admin_menu',                             [$this, 'addPage'] );
		add_action( 'pollux/settings/init',                   [$this, 'addSubmitMetaBox'] );
		add_filter( 'pollux/settings/instruction',            [$this, 'filterInstruction'], 10, 3 );
		add_filter( 'wp_redirect',                            [$this, 'filterRedirectOnSave'] );
		add_action( 'current_screen',                         [$this, 'register'] );
		add_action( 'admin_menu',                             [$this, 'registerSetting'] );
		add_action( 'pollux/settings/init',                   [$this, 'reset'] );
		add_action( 'admin_footer-toplevel_page_' . static::ID, [$this, 'renderFooterScript'] );
	}

	/**
	 * @return void
	 */
	public function addPage()
	{
		$this->hook = call_user_func_array( 'add_menu_page', apply_filters( 'pollux/settings/page', [
			__( 'Site Settings', 'pollux' ),
			__( 'Site Settings', 'pollux' ),
			'edit_theme_options',
			static::ID,
			[$this, 'renderPage'],
			'dashicons-screenoptions',
			1313
		]));
	}

	/**
	 * @return void
	 */
	public function addSubmitMetaBox()
	{
		call_user_func_array( 'add_meta_box', apply_filters( 'pollux/settings/metabox/submit', [
			'submitdiv',
			__( 'Save Settings', 'pollux' ),
			[ $this, 'renderSubmitMetaBox'],
			$this->hook,
			'side',
			'high',
		]));
	}

	/**
	 * @param string $instruction
	 * @param string $fieldId
	 * @param string $metaboxId
	 * @return string
	 */
	public function filterInstruction( $instruction, $fieldId, $metaboxId )
	{
		return sprintf( "SiteMeta::get('%s', '%s');", $metaboxId, $fieldId );
	}

	/**
	 * @param string $location
	 * @return string
	 */
	public function filterRedirectOnSave( $location )
	{
		if( strpos( $location, 'settings-updated=true' ) === false
			|| strpos( $location, sprintf( 'page=%s', static::ID )) === false ) {
			return $location;
		}
		return add_query_arg([
			'page' => static::ID,
			'settings-updated' => 'true',
		], admin_url( 'admin.php' ));
	}

	/**
	 * @return void
	 */
	public function register( $metaboxes = [] )
	{
		if( get_current_screen()->id != $this->hook )return;
		foreach( parent::register() as $metabox ) {
			new SettingsMetaBox( $metabox );
		}
		add_screen_option( 'layout_columns', [
			'max' => 2,
			'default' => 2,
		]);
		do_action( 'pollux/settings/init' );
	}

	/**
	 * @return void
	 */
	public function registerSetting()
	{
		register_setting( static::ID, static::ID, [$this, 'onSave'] );
	}

	public function onSave( $settings )

The return type could not be reliably inferred; please add a @return annotation.

	{
		// error_log( print_r( $settings, 1 ));

54% of this comment could be valid code. Did you maybe forget this after debugging?

		return $settings;
	}

	/**
	 * @return void
	 */
	public function renderFooterScript()
	{
		$this->render( 'settings/script', [
			'confirm' => __( 'Are you sure want to do this?', 'pollux' ),
			'hook' => $this->hook,
			'id' => static::ID,
		]);
	}

	/**
	 * @return void
	 */
	public function renderPage()
	{
		$this->render( 'settings/index', [
			'columns' => get_current_screen()->get_columns(),
			'id' => static::ID,
			'title' => __( 'Site Settings', 'pollux' ),
		]);
	}

	/**
	 * @return void
	 */
	public function renderSubmitMetaBox()
	{
		$query = [
			'_wpnonce' => wp_create_nonce( $this->hook ),
			'action' => 'reset',
			'page' => static::ID,
		];
		$this->render( 'settings/submit', [
			'reset' => __( 'Reset Settings', 'pollux' ),
			'reset_url' => esc_url( add_query_arg( $query, admin_url( 'admin.php' ))),
			'submit' => get_submit_button( __( 'Save', 'pollux' ), 'primary', 'submit', false ),
		]);
	}

	/**
	 * @return void
	 */
	public function reset()
	{
		if( filter_input( INPUT_GET, 'page' ) !== static::ID
			|| filter_input( INPUT_GET, 'action' ) !== 'reset'
		)return;
		if( wp_verify_nonce( filter_input( INPUT_GET, '_wpnonce' ), $this->hook )) {
			delete_option( static::ID );
			// @todo: now trigger save to restore defaults

Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.

			return add_settings_error( static::ID, 'reset', __( 'Settings reset to defaults.', 'pollux' ), 'updated' );
		}
		add_settings_error( static::ID, 'reset', __( 'Failed to reset settings. Please refresh the page and try again.', 'pollux' ));
	}

	/**
	 * @return array
	 */
	protected function getInstructions()
	{
		return array_filter( $this->metaboxes, function( $metabox ) {
			return $this->verifyMetaBoxCondition( $metabox['condition'] );
		});
	}

	/**
	 * {@inheritdoc}
	 */
	protected function normalize()

This method seems to be duplicated in your project.

	{
		$this->metaboxes = [];
		foreach( $this->app->config['settings'] as $id => $metabox ) {
			$defaults = [
				'condition' => [],
				'fields' => [],
				'id' => $id,
				'slug' => $id,
			];
			$this->metaboxes[] = $this->normalizeThis( $metabox, $defaults, $id );
		}
	}

	/**
	 * @param string $name
	 * @param string $parentId
	 * @return string
	 */
	protected function normalizeFieldName( $name, array $data, $parentId )
	{
		if( !empty( $name )) {
			return $name;
		}
		$name = str_replace( sprintf( '%s-%s-', static::ID, $parentId ), '', $data['id'] );
		return sprintf( '%s[%s][%s]', static::ID, $parentId, $name );
	}

	/**
	 * @param string $id
	 * @param string $parentId
	 * @return string
	 */
	protected function normalizeId( $id, array $data, $parentId )
	{
		return $parentId == $id
			? sprintf( '%s-%s', static::ID, $id )
			: sprintf( '%s-%s-%s', static::ID, $parentId, $id );
	}
}