display-featured-image-genesis/includes/settings/class-displayfeaturedimagegenesis-settings.php

<?php

/**
 * Class Display_Featured_Image_Genesis_Settings
 * @package   DisplayFeaturedImageGenesis
 * @copyright 2017 Robin Cornett
 */
class Display_Featured_Image_Genesis_Settings extends Display_Featured_Image_Genesis_Helper {

	/**
	 * The common plugin class.
	 * @var $common \Display_Featured_Image_Genesis_Common
	 */
	protected $common;

	/**
	 * The plugin admin page.
	 * @var $page string
	 */
	protected $page = 'displayfeaturedimagegenesis';

	/**
	 * The plugin setting.
	 * @var $setting array
	 */
	protected $setting;

	/**
	 * The plugin settings fields.
	 * @var $fields array
	 */
	protected $fields;

	/**
	 * add a submenu page under Appearance
	 * @since  1.4.0
	 */
	public function do_submenu_page() {

		$this->common  = new Display_Featured_Image_Genesis_Common();
		$this->setting = $this->get_display_setting();

		add_theme_page(
			__( 'Display Featured Image for Genesis', 'display-featured-image-genesis' ),
			__( 'Display Featured Image for Genesis', 'display-featured-image-genesis' ),
			'manage_options',
			$this->page,
			array( $this, 'do_settings_form' )
		);

		add_action( 'admin_init', array( $this, 'register_settings' ) );
		add_action( "load-appearance_page_{$this->page}", array( $this, 'build_settings_page' ) );
	}

	/**
	 * Build out the settings page sections/fields.
	 */
	public function build_settings_page() {
		include_once plugin_dir_path( __FILE__ ) . 'class-displayfeaturedimagegenesis-settings-define.php';
		$definitions  = new Display_Featured_Image_Genesis_Settings_Define();
		$sections     = $definitions->register_sections();
		$this->fields = $definitions->register_fields();
		$this->add_sections( $sections );
		$this->add_fields( $this->fields, $sections );
	}

	/**
	 * create settings form
	 *
	 * @since  1.4.0
	 */
	public function do_settings_form() {
		$page_title = get_admin_page_title();
		echo '<div class="wrap">';
			printf( '<h1>%s</h1>', esc_attr( $page_title ) );
			$this->check_and_maybe_update_terms();
			$active_tab = $this->get_active_tab();
			echo $this->do_tabs( $active_tab );
			echo '<form action="options.php" method="post">';
				settings_fields( $this->page );
				do_settings_sections( $this->page . '_' . $active_tab );
				wp_nonce_field( $this->page . '_save-settings', $this->page . '_nonce', false );
				submit_button();
				settings_errors();
			echo '</form>';
		echo '</div>';
	}

	/**
	 * Check if term images need to be updated because they were added before WP 4.4 and this plugin 2.4.
	 * @since 2.6.1
	 */
	protected function check_and_maybe_update_terms() {
		if ( ! function_exists( 'get_term_meta' ) ) {
			return;
		}
		if ( $this->terms_have_been_updated() ) {
			return;
		}
		$previous_user = get_option( 'displayfeaturedimagegenesis', false );
		if ( ! $previous_user ) {
			update_option( 'displayfeaturedimagegenesis_updatedterms', true );

			return;
		}

		include_once plugin_dir_path( __FILE__ ) . 'class-displayfeaturedimagegenesis-settings-terms.php';
		$terms = new Display_Featured_Image_Genesis_Settings_Terms();
		$terms->maybe_update_terms();
	}

	/**
	 * Output tabs.
	 *
	 * @param $active_tab
	 *
	 * @return string
	 * @since 2.5.0
	 */
	protected function do_tabs( $active_tab ) {
		$tabs    = $this->define_tabs();
		$output  = '<div class="nav-tab-wrapper">';
		$output .= sprintf( '<h2 id="settings-tabs" class="screen-reader-text">%s</h2>', __( 'Settings Tabs', 'display-featured-image-genesis' ) );
		$output .= '<ul>';
		foreach ( $tabs as $tab ) {
			$class   = $active_tab === $tab['id'] ? ' nav-tab-active' : '';
			$output .= sprintf( '<li><a href="themes.php?page=%s&tab=%s" class="nav-tab%s">%s</a></li>', $this->page, $tab['id'], $class, $tab['tab'] );
		}
		$output .= '</ul>';
		$output .= '</div>';

		return $output;
	}

	/**
	 * Settings for options screen
	 *
	 * @since 1.1.0
	 */
	public function register_settings() {
		register_setting( 'displayfeaturedimagegenesis', 'displayfeaturedimagegenesis', array(
			$this,
			'do_validation_things',
		) );
	}

	/**
	 * Define tabs for the settings page.
	 * @return array
	 * @since 2.6.0
	 */
	protected function define_tabs() {
		return array(
			'main'     => array(
				'id'  => 'main',
				'tab' => __( 'Main', 'display-featured-image-genesis' ),
			),
			'style'    => array(
				'id'  => 'style',
				'tab' => __( 'Backstretch Output', 'display-featured-image-genesis' ),
			),
			'cpt'      => array(
				'id'  => 'cpt',
				'tab' => __( 'Content Types', 'display-featured-image-genesis' ),
			),
			'advanced' => array(
				'id'  => 'advanced',
				'tab' => __( 'Advanced', 'display-featured-image-genesis' ),
			),
		);
	}

	/**
	 * Section description
	 *
	 * @since 1.1.0
	 */
	public function main_section_description() {
		return __( 'Use these settings to modify the plugin behavior throughout your site. Check the Help tab for more information. ', 'display-featured-image-genesis' );
	}

	/**
	 * Style section description
	 */
	public function style_section_description() {
		return __( 'These settings modify the output style/methods for the backstretch image.', 'display-featured-image-genesis' );
	}

	/**
	 * Section description
	 *
	 * @since 1.1.0
	 */
	public function cpt_section_description() {
		$description = __( 'Optional: set a custom image for search results and 404 (no results found) pages.', 'display-featured-image-genesis' );
		$post_types  = $this->get_content_types();
		unset( $post_types['post'] );
		if ( $post_types ) {
			$description .= __( ' Additionally, since you have custom post types with archives, you might like to set a featured image for each of them.', 'display-featured-image-genesis' );
		}

		return $description;
	}

	/**
	 * Description for the advanced settings section/tab.
	 *
	 * @return string
	 */
	public function advanced_section_description() {
		return __( 'Optionally, change the hook location and priority of the featured image output. Use with caution. Note: this will change the hook/priority of the featured image sitewide. If you need to make changes based on content type, check the readme for code examples.', 'display-featured-image-genesis' );
	}

	/**
	 * Default image uploader
	 *
	 * @since  1.2.1
	 *
	 * @param $args
	 */
	public function set_default_image( $args ) {

		$id   = $this->setting[ $args['id'] ] ? $this->setting[ $args['id'] ] : '';
		$name = $this->page . '[' . $args['id'] . ']';
		if ( ! empty( $id ) ) {
			echo wp_kses_post( $this->render_image_preview( $id, $args['id'] ) );
		}
		$this->render_buttons( $id, $name );
		$this->do_description( $args );
	}

	/**
	 * Custom Post Type image uploader
	 *
	 * @since  2.0.0
	 *
	 * @param $args
	 */
	public function set_cpt_image( $args ) {

		$this->do_image_buttons( $args );

		if ( empty( $id ) || in_array( $args['id'], array( 'search', 'fourohfour', 'post' ), true ) ) {
			return;
		}

		$this->do_cpt_description( $args );
	}

	/**
	 * Print the featured image preview and buttons.
	 *
	 * @param $args
	 */
	protected function do_image_buttons( $args ) {
		$show_on_front = get_option( 'show_on_front' );
		$posts_page    = get_option( 'page_for_posts' );
		if ( 'page' === $show_on_front && $posts_page && 'post' === $args['id'] ) {
			$link = get_edit_post_link( $posts_page );
			/* translators: the link is to edit the posts page. */
			printf( wp_kses_post( __( 'You may set a fallback image for Posts on your <a href="%s">posts page</a>.', 'display-featured-image-genesis' ) ), esc_url( $link ) );
			return;
		}
		$id   = isset( $this->setting['post_type'][ $args['id'] ] ) && $this->setting['post_type'][ $args['id'] ] ? $this->setting['post_type'][ $args['id'] ] : '';
		$name = $this->page . '[post_type][' . esc_attr( $args['id'] ) . ']';
		if ( $id ) {
			echo wp_kses_post( $this->render_image_preview( $id, $args['id'] ) );
		}
		$this->render_buttons( $id, $name );
	}

	/**
	 * Print the CPT description.
	 *
	 * @param $args
	 */
	protected function do_cpt_description( $args ) {
		$archive_link = get_post_type_archive_link( $args['id'] );
		if ( ! $archive_link ) {
			return;
		}
		/* translators: placeholder is the post type name. */
		$description = sprintf( __( 'View your <a href="%1$s" target="_blank">%2$s</a> archive.', 'display-featured-image-genesis' ),
			esc_url( $archive_link ),
			esc_attr( $args['title'] )
		);
		printf( '<p class="description">%s</p>', wp_kses_post( $description ) );
	}

	/**
	 * validate all inputs
	 *
	 * @param $new_value array
	 *
	 * @return array
	 *
	 * @since  1.4.0
	 */
	public function do_validation_things( $new_value ) {

		$action = $this->page . '_save-settings';
		$nonce  = $this->page . '_nonce';
		// If the user doesn't have permission to save, then display an error message
		if ( ! $this->user_can_save( $action, $nonce ) ) {
			wp_die( esc_attr__( 'Something unexpected happened. Please try again.', 'display-featured-image-genesis' ) );
		}

		check_admin_referer( $action, $nonce );
		$new_value = array_merge( $this->setting, $new_value );

		foreach ( array( 'define', 'validate' ) as $file ) {
			include_once plugin_dir_path( __FILE__ ) . "class-displayfeaturedimagegenesis-settings-{$file}.php";
		}
		$definitions = new Display_Featured_Image_Genesis_Settings_Define();
		$validation  = new Display_Featured_Image_Genesis_Settings_Validate( $definitions->register_fields(), $this->setting );

		return $validation->validate( $new_value );
	}

	/**
	 * Check whether terms need to be updated
	 * @return boolean true if on 4.4 and wp_options for terms exist; false otherwise
	 *
	 * @since 2.4.0
	 */
	protected function terms_have_been_updated() {
		$updated = get_option( $this->page . '_updatedterms', false );

		return (bool) $updated;
	}
}