EmailLog\Core\UI\Setting\EmailLogSetting

Complexity

Total Complexity

13

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes	3
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	render()	0	5	1
A	initialize()	0	7	1
A	get_fields()	0	20	2
B	sanitize()	0	15	5
A	render_allowed_user_roles_settings()	0	21	3
A	render_remove_on_uninstall_settings()	0	7	1

<?php
namespace EmailLog\Core\UI\Setting;
use EmailLog\Core\UI\Setting\SettingField;

/**
 * Class EmailLogSetting
 * @package EmailLog\Core\UI\Setting
 *
 * All Email Log Core settings are handled.
 *
 * @since 2.1.0
 */
class EmailLogSetting extends Setting {

	/**
	 * Implement `initialize()` method.
	 */
	protected function initialize() {
		$this->section->id          = 'email-log';
		$this->section->title       = __( 'Email Log Settings', 'email-log' );
		$this->section->option_name = 'el_email_log_core';

		$this->load();
	}

	public function get_fields() {
		$fields = array();

		$email_log_fields = array(
			'allowed_user_roles'  => __( 'Allowed User Roles', 'email-log' ),
			'remove_on_uninstall' => __( 'Remove Data on Uninstall?', 'email-log' ),
		);

		foreach ( $email_log_fields as $field_id => $label ) {
			$field           = new SettingField();
			$field->id       = $field_id;
			$field->title    = $label;
			$field->args     = array( 'id' => $field_id );
			$field->callback = array( $this,'render_' . $field_id . '_settings' );

			$fields[] = $field;
		}

		return $fields;
	}

	public function render() {
	?>
		<p><?php _e( 'Email Log Settings lets you control who can view Email Logs and lets you keep the Email Logs when you delete the plugin.', 'email-log' ); ?></p>
	<?php
	}

	/**
	 * Implement `sanitize()` method.
	 *
	 * @param mixed $values {@inheritDoc}
	 *
	 * @return mixed $values {@inheritDoc}
	 */
	public function sanitize( $values ) {
		if ( ! is_array( $values ) ) {
			return array();
		}

		// TODO: Dissect sanitization methods to have separate methods for each field.
		foreach ( $values as $key => $value ) {
			if ( $key === 'allowed_user_roles' ) {
				$values[ $key ] = array_map( 'sanitize_text_field', $values[ $key ] );
			} elseif ( $key === 'remove_on_uninstall' ) {
				$values[ $key ] = sanitize_text_field( $value );
			}
		}
		return $values;
	}

	/**
	 * Renders the Email Log `Allowed User Roles` settings.
	 *
	 * @param array $args
	 */
	public function render_allowed_user_roles_settings( $args ) {
		$option          = $this->get_value();
		$available_roles = get_editable_roles();
		foreach( $available_roles as $role ) {
			if ( trim( $role['name'] ) === 'Administrator' ) {
				?>
				<p><input type="checkbox" name="<?php echo esc_attr( $this->section->option_name . '[' . $args['id'] . '][]' ); ?>" value="<?php echo trim( $role['name'] ); ?>" checked="checked" /> <?php echo trim( $role['name'] ); ?>
				</p>
				<?php
			} else {
				?>
				<p><input type="checkbox" name="<?php echo esc_attr( $this->section->option_name . '[' . $args['id'] . '][]' ); ?>" value="<?php echo trim( $role['name'] ); ?>" <?php \EmailLog\Util\checked_array( $option[ $args['id'] ], trim( $role['name'] ) ); ?> /> <?php echo trim( $role['name'] ); ?>
				</p>
				<?php
			}
		}
		?>
		<p><?php _e( '<small><strong>Note:</strong> Users with the above <strong>User Roles</strong> can view Email Logs. The default User Role is \'<strong>administrator</strong>\'.</small>', 'email-log' ); ?>
		<?php _e( '<small>Administrator role cannot be disabled.</small>', 'email-log' ); ?></p>
		<?php
	}

	/**
	 * Renders the Email Log `Remove Data on Uninstall?` settings.
	 *
	 * @param array $args
	 */
	public function render_remove_on_uninstall_settings( $args ) {
		$option          = $this->get_value();
?>
		<input type="checkbox" name="<?php echo esc_attr( $this->section->option_name . '[' . $args['id'] . ']' ); ?>" value="true" <?php checked( 'true', $option[ $args['id'] ] ); ?> /> <?php _e( 'Check this box if you would like to completely remove all of its data when the plugin is deleted.', 'email-log' ) ?>
		<p><?php _e( '<small><strong>Note:</strong> You can also export the Email Logs using our <a href="https://wpemaillog.com/addons/export-logs/" rel="noopener noreferrer" target="_blank">Export Logs</a> add-on.</small>', 'email-log' ); ?></p>
<?php
	}
}