Pods_Templates_Auto_Template_Settings

Complexity

Total Complexity

36

Size/Duplication

Total Lines	362
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes	1
Bugs	1	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
D	options()	0	117	9
A	__construct()	0	23	1
A	init()	0	8	2
A	tab()	0	7	1
A	front_end()	0	14	4
A	reset()	0	7	2
A	reseter()	0	8	2
C	archive_test()	0	24	7
B	archive_warning()	0	25	5
A	get_template_titles()	0	17	3

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 13 and the first side effect is on line 3.

if ( class_exists( 'Pods_PFAT' ) ) {
	return;
}

/**
 * Class Pods_Templates_Auto_Template_Settings
 *
 * This class replaced Pods_PFAT class
 *
 * @since 2.5.5
 */
class Pods_Templates_Auto_Template_Settings {

	/**
	 * Front end class object
	 *
	 * @since 2.5.5
	 *
	 * @var Pods_Templates_Auto_Template_Front_End
	 */
	private $front_end_class;

	/**
	 * Holds instance of this class
	 *
	 * @var Pods_Templates_Auto_Template_Settings
	 */
	private  $instance;

	/**
	 * Constructor for the Pods_PFAT class
	 *
	 * Sets up all the appropriate hooks and actions
	 * within the plugin.
	 *
	 * @since 2.5.5
	 */
	public function __construct() {


		//Add option tab for post types
		add_filter( 'pods_admin_setup_edit_tabs_post_type', array( $this, 'tab' ), 11, 3 );

		//add the same tab for taxonomies
		add_filter( 'pods_admin_setup_edit_tabs_taxonomy', array( $this, 'tab' ), 11, 3 );

		//Add options to the new tab
		add_filter( 'pods_admin_setup_edit_options', array( $this, 'options' ), 12, 2 );


		//Include and init front-end class
		add_action( 'init', array( $this, 'front_end' ), 25 );

		//Delete transients when Pods settings are updated.
		add_action( 'update_option', array( $this, 'reset' ), 21, 3 );

		//admin notice for archives without archives
		add_action( 'admin_notices', array( $this, 'archive_warning' ) );

	}

	/**
	 * Initializes the class
	 *
	 * @since 2.5.5
	 */
	public function init() {
		if ( ! is_null( $this->instance ) ) {
			$this->instance = new self;
		}

		return $this->instance;

	}



	/**
	 * The Frontier Auto Display option tab.
	 *
	 * @param array $tabs
	 * @param array $pod
	 * @param array $addtl_args
	 *
	 * @return array
	 *
	 * @since 2.5.5
	 */
	function tab( $tabs, $pod, $addtl_args ) {

The parameter $pod is not used and could be removed.

The parameter $addtl_args is not used and could be removed.

It is generally recommended to explicitly declare the visibility for methods.

		$tabs[ 'pods-pfat' ] = __( 'Auto Template Options', 'pods' );

		return $tabs;

	}

	/**
	 * Adds options for this plugin under the Frontier Auto Template tab.
	 *
	 * @param array $options
	 * @param array $pod
	 *
	 * @return array
	 *
	 * @since 2.5.5
	 *
	 */
	function options( $options, $pod ) {

It is generally recommended to explicitly declare the visibility for methods.

		//check if it's a post type pod and add fields for that.
		if ( $pod['type'] === 'post_type' )  {
			$options[ 'pods-pfat' ] = array (
				'pfat_enable'  => array (
					'label'             => __( 'Enable Automatic Pods Templates for this Pod?', 'pods' ),
					'help'              => __( 'When enabled you can specify the names of Pods Templates to be used to display items in this Pod in the front-end.', 'pods' ),
					'type'              => 'boolean',
					'default'           => false,
					'dependency'        => true,
					'boolean_yes_label' => ''
				),
				'pfat_single'  => array (
					'label'      => __( 'Single item view template', 'pods' ),
					'help'       => __( 'Name of Pods template to use for single item view.', 'pods' ),
					'type'       => 'text',
					'default'    => false,
					'depends-on' => array ( 'pfat_enable' => true )
				),
				'pfat_append_single'  => array (
					'label'      => __( 'Single Template Location', 'pods' ),
					'help'       => __( 'Whether the template will go before, after or in place of the post content.', 'pods' ),
					'depends-on' => array ( 'pfat_enable' => true ),
				),
				'pfat_archive' => array (
					'label'      => __( 'Archive view template', 'pods' ),
					'help'       => __( 'Name of Pods template to use for use in this Pods archive pages.', 'pods' ),
					'type'       => 'text',
					'default'    => false,
					'depends-on' => array ( 'pfat_enable' => true )
				),
				'pfat_append_archive'  => array (
					'label'      => __( 'Archive Template Location', 'pods' ),
					'help'       => __( 'Whether the template will go before, after or in place of the post content.', 'pods' ),
					'depends-on' => array ( 'pfat_enable' => true ),
				),
			);
		}

		//check if it's a taxonomy Pod, if so add fields for that
		if ( $pod['type'] === 'taxonomy' ) {
			$options[ 'pods-pfat' ] = array (
				'pfat_enable'  => array (
					'label'             => __( 'Enable Automatic Pods Templates for this Pod?', 'pods' ),
					'help'              => __( 'When enabled you can specify the names of a Pods Template to be used to display items in this Pod in the front-end.', 'pods' ),
					'type'              => 'boolean',
					'default'           => false,
					'dependency'        => true,
					'boolean_yes_label' => ''
				),
				'pfat_archive'  => array (
					'label'      => __( 'Taxonomy Template', 'pods' ),
					'help'       => __( 'Name of Pods template to use for this taxonomy.', 'pods' ),
					'type'       => 'text',
					'default'    => false,
					'depends-on' => array ( 'pfat_enable' => true )
				),
				'pfat_append_archive'  => array (
					'label'      => __( 'Template Location', 'pods' ),
					'help'       => __( 'Whether the template will go before, after or in place of the post content.', 'pods' ),
					'depends-on' => array ( 'pfat_enable' => true ),
				),
			);
		}

		if ( isset( $options[ 'pods-pfat' ] ) ) {

			//field options pick values
			$pick = array (
				'type'               => 'pick',
				'pick_format_type'   => 'single',
				'pick_format_single' => 'dropdown',
				'default'            => 'true',
			);

			//get template titles
			$titles = $this->get_template_titles();

			if ( !empty( $titles ) ) {
				foreach ( $pick as $k => $v ) {
					$options[ 'pods-pfat' ][ 'pfat_single' ][ $k ] = $v;

					$options[ 'pods-pfat' ][ 'pfat_archive' ][ $k ] = $v;

				}

				$options[ 'pods-pfat' ][ 'pfat_archive' ][ 'data' ] = array( null => __('No Archive view template', 'pods') ) + ( array_combine( $this->get_template_titles(), $this->get_template_titles() ) );
				$options[ 'pods-pfat' ][ 'pfat_single' ][ 'data' ] = array_combine( $this->get_template_titles(), $this->get_template_titles() );
			}

			//Add data to $pick for template location
			unset( $pick['data']);
			$location_data =  array (
				'append'  => __( 'After', 'pods' ),
				'prepend' => __( 'Before', 'pods' ),
				'replace' => __( 'Replace', 'pods' ),
			);
			$pick['data'] = $location_data;

			//add location options to fields without type set.
			foreach ( $options[ 'pods-pfat' ] as $k => $option ) {
				if ( !isset( $option[ 'type' ] ) ) {
					$options[ 'pods-pfat' ][ $k ] = array_merge( $option, $pick );
				}

			}

			//remove single from taxonomy
			if( 'taxonomy' === $pod['type'] ){
				unset( $options[ 'pods-pfat' ][ 'pfat_single' ] );
			}

		}

		return $options;

	}

	/**
	 * Include/ init the front end class on the front end only
	 *
	 * @param bool	$load_in_admin Optional. Whether to load in admin. Default is false.
	 *
	 * @return Pods_PFAT_Frontend
	 *
	 * @since 2.5.5
	 */
	function front_end( $load_in_admin = false ) {

It is generally recommended to explicitly declare the visibility for methods.

		if ( !is_admin() || $load_in_admin ) {
			include_once( dirname( __FILE__ ) . '/Pods_Templates_Auto_Template_Front_End.php' );

			// Only instantiate if we haven't already
			if ( is_null( $this->front_end_class ) ) {
				$this->front_end_class = new Pods_Templates_Auto_Template_Front_End();
			}

			return $this->front_end_class;
		}

	}

	/**
	 * Reset the transients for front-end class when Pods are saved.
	 *
	 * @uses update_option hook
	 *
	 * @param string $option
	 * @param mixed $old_value
	 * @param mixed $value
	 *
	 * @since 2.5.5
	 */
	function reset( $option, $old_value, $value ) {

The parameter $old_value is not used and could be removed.

The parameter $value is not used and could be removed.

It is generally recommended to explicitly declare the visibility for methods.

		if ( $option === '_transient_pods_flush_rewrites' ) {
			$this->reseter();
		}

	}


	/**
	 * Delete transients that stores the settings.
	 *
	 * @since 2.5.5
	 */
	function reseter() {

It is generally recommended to explicitly declare the visibility for methods.

		$keys = array( 'pods_pfat_the_pods', 'pods_pfat_auto_pods', 'pods_pfat_archive_test' );
		foreach( $keys as $key ) {
			pods_transient_clear( $key );
		}

	}

	/**
	 * Test if archive is set for post types that don't have archives.
	 *
	 * @return bool|mixed|null|void
	 *
	 * @since 2.4.5
	 */
	function archive_test() {

It is generally recommended to explicitly declare the visibility for methods.

		//try to get cached results of this method
		$key = 'pods_pfat_archive_test';
		$archive_test = pods_transient_get( $key );

		if ( $archive_test === false ) {
			$front = $this->front_end( true );
			$auto_pods = $front->auto_pods();

			foreach ( $auto_pods as $name => $pod ) {
				if ( ! $pod[ 'has_archive' ] && $pod[ 'archive' ] && $pod[ 'type' ] !== 'taxonomy' && ! in_array( $name, array( 'post', 'page', 'attachment' ) ) ) {
					$archive_test[ $pod[ 'label' ] ] = 'fail';
				}

			}

			pods_transient_set( $key, $archive_test );

		}

		return $archive_test;

	}

	/**
	 * Throw admin warnings for post types that have archive templates set, but don't support archives
	 *
	 * @since 2.4.5
	 */
	function archive_warning() {

It is generally recommended to explicitly declare the visibility for methods.

		//create $page variable to check if we are on pods admin page
		$page = pods_v( 'page','get', false, true );

		//check if we are on Pods Admin page
		if ( $page === 'pods' ) {
			$archive_test = $this->archive_test();
			if ( is_array( $archive_test ) ) {
				foreach ( $archive_test as $label => $test ) {
					if ( $test === 'fail' ) {
						echo sprintf( '<div id="message" class="error"><p>%s</p></div>',
							sprintf(
								__( 'The Pods post type %1$s has an archive template set to be displayed using Pods auto template, but the Pod does not have an archive. You can enable post type archives in the "Advanced Options" tab.', 'pfat' ),
								$label )
						);
					}

				}

			}

		}

	}

	/**
	 * Get titles of all Pods Templates
	 *
	 * @return string[] Array of template names
	 *
	 * @since 2.4.5
	 */
	public function get_template_titles() {

		static $template_titles;

		if ( empty( $template_titles ) ) {
            $all_templates = (array) pods_api()->load_templates( array() );

			$template_titles = array();

            foreach ( $all_templates as $template ) {
                $template_titles[] = $template['name'];
            }
		}

		return $template_titles;

	}


}