lightspeeddevelopment / lsx-health-plan

classes/class-admin.php

<?php
namespace lsx_health_plan\classes;

/**
 * LSX Health Plan Admin Class.
 *
 * @package lsx-health-plan
 */
class Admin {

	/**
	 * Holds class instance
	 *
	 * @since 1.0.0
	 *
	 * @var      object \lsx_health_plan\classes\Admin()
	 */
	protected static $instance = null;

	/**
	 * The post relation fields
	 *
	 * @var array
	 */
	public $connections = array();

	/**
	 * Stores the previous values needed to remove the post relations
	 *
	 * @var array
	 */
	public $previous_values = array();

	/**
	 * @var object \lsx_health_plan\classes\admin\Settings();
	 */
	public $settings;

	/**
	 * @var object \lsx_health_plan\classes\admin\Help_Page();
	 */
	public $help;

	/**
	 * Holds the settings page theme functions
	 *
	 * @var object \lsx_health_plan\classes\admin\Settings_Theme();
	 */
	public $settings_theme;

	/**
	 * Constructor
	 */
	public function __construct() {
		$this->load_classes();
		add_action( 'admin_menu', array( $this, 'order_menus' ), 200 );
		add_action( 'admin_enqueue_scripts', array( $this, 'assets' ) );
		add_filter( 'cmb2_override_meta_save', array( $this, 'save_previous_values' ), 20, 4 );
		add_filter( 'cmb2_override_meta_remove', array( $this, 'save_previous_values' ), 20, 4 );
		add_action( 'cmb2_save_field', array( $this, 'post_relations' ), 20, 4 );
		add_action( 'cmb2_save_field', array( $this, 'create_query_fields' ), 20, 4 );
		add_action( 'before_delete_post', array( $this, 'delete_post_meta_connections' ), 20, 1 );
		add_action( 'cmb2_save_post_fields', array( $this, 'extract_plan_fields' ), 10, 4 );

		//add_action( 'cmb2_save_post_fields', array( $this, 'debugger_for_cmb2' ), 10, 4 );

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

		// Customizer.
		add_filter( 'lsx_customizer_colour_selectors_body', array( $this, 'customizer_body_colours_handler' ), 15, 2 );
	}

	/**
	 * Return an instance of this class.
	 *
	 * @return object \lsx\member_directory\classes\Admin()    A single instance of this class.
	 */
	public static function get_instance() {
		// If the single instance hasn't been set, set it now.
		if ( null === self::$instance ) {
			self::$instance = new self();
		}
		return self::$instance;
	}

	/**
	 * Loads the admin subclasses
	 */
	private function load_classes() {
		require_once LSX_HEALTH_PLAN_PATH . 'classes/admin/class-settings.php';
		$this->settings = admin\Settings::get_instance();

		require_once LSX_HEALTH_PLAN_PATH . 'classes/admin/class-help-page.php';
		$this->help = admin\Help_Page::get_instance();

		require_once LSX_HEALTH_PLAN_PATH . 'classes/admin/class-settings-theme.php';
		$this->settings_theme = admin\Settings_Theme::get_instance();
	}

	/**
	 * Orders the HP menu Items
	 *
	 * @return void
	 */
	public function order_menus() {
		global $menu, $submenu;
		if ( ! empty( $submenu ) ) {
			$parent_check = array(
				'edit.php?post_type=plan',
				'edit.php?post_type=workout',
				'edit.php?post_type=meal',
			);
			foreach ( $submenu as $menu_id => $menu_values ) {
				if ( in_array( $menu_id, $parent_check ) ) {
					foreach ( $menu_values as $sub_menu_key => $sub_menu_values ) {
						switch ( $sub_menu_values[0] ) {

							case __( 'Add New', 'lsx-health-plan' ):
								unset( $submenu[ $menu_id ][ $sub_menu_key ] );
								break;

							case __( 'All', 'lsx-health-plan' ):
								$title = $sub_menu_values[0];
								// Check and change the label.
								switch ( $sub_menu_values[2] ) {
									case 'edit.php?post_type=meal':
										$title = esc_attr__( 'Meals', 'lsx-health-plan' );
										break;

									case 'edit.php?post_type=recipe':
										$title = esc_attr__( 'Recipes', 'lsx-health-plan' );
										break;

									case 'edit.php?post_type=workout':
										$title = esc_attr__( 'Workouts', 'lsx-health-plan' );
										break;

									case 'edit.php?post_type=plan':
										$title = esc_attr__( 'Plans', 'lsx-health-plan' );
										break;

									case 'edit.php?post_type=video':
										$title = esc_attr__( 'Videos', 'lsx-health-plan' );
										break;

									case 'edit.php?post_type=exercise':
										$title = esc_attr__( 'Exercises', 'lsx-health-plan' );
										break;

									case 'edit.php?post_type=tip':
										$title = esc_attr__( 'Tips', 'lsx-health-plan' );
										break;

									default:
										break;
								}
								$submenu[ $menu_id ][ $sub_menu_key ][0] = $title; // @codingStandardsIgnoreLine
								break;

							default:
								break;
						}
					}
				}
			}
		}
	}

	/**
	 * Undocumented function
	 *
	 * @return void
	 */
	public function assets() {
		wp_enqueue_script( 'media-upload' );
		wp_enqueue_script( 'thickbox' );
		wp_enqueue_style( 'thickbox' );

		wp_enqueue_script( 'lsx-health-plan-admin', LSX_HEALTH_PLAN_URL . 'assets/js/lsx-health-plan-admin.min.js', array( 'jquery' ), LSX_HEALTH_PLAN_VER, true );
		wp_enqueue_style( 'lsx-health-plan-admin', LSX_HEALTH_PLAN_URL . 'assets/css/lsx-health-plan-admin.css', array(), LSX_HEALTH_PLAN_VER );
	}

	/**
	 * Returns the registered connections.
	 *
	 * @return void
	 */
	public function get_connections() {
		return apply_filters( 'lsx_health_plan_connections', $this->connections );
	}

	/**
	 * Saves the previous values before they are overwritten by the new ones.
	 *
	 * @param [type] $value_to_save

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

	 * @param [type] $a
	 * @param [type] $args
	 * @param [type] $cmb2
	 * @return void
	 */
	public function save_previous_values( $value_to_save, $a, $args, $cmb2 ) {
		if ( isset( $cmb2->data_to_save['ID'] ) ) {
			$connections = $this->get_connections();
			$post_type   = get_post_type( $cmb2->data_to_save['ID'] );
			if ( isset( $connections[ $post_type ] ) && array_key_exists( $a['field_id'], $connections[ $post_type ] ) ) {
				// Get the previous values if the field, so we can run through them and remove the current ID from them later.
				$this->previous_values = get_post_meta( $a['id'], $a['field_id'], true );

It seems like get_post_meta($a['id'], $a['field_id'], true) can also be of type false or string. However, the property $previous_values is declared as type array. Maybe add an additional type check?

			}
		}
		return $value_to_save;
	}

	/**
	 * Sets up the "post relations"
	 *
	 * @return    void
	 */
	public function post_relations( $field_id, $updated, $action, $cmb2 ) {
		// If the connections are empty then skip this function.
		$connections = $this->get_connections();
		if ( empty( $connections ) ) {
			return;
		}

		// If the field has been updated.
		if ( isset( $cmb2->data_to_save['ID'] ) ) {
			$post_type = get_post_type( $cmb2->data_to_save['ID'] );
			if ( isset( $connections[ $post_type ] ) && array_key_exists( $field_id, $connections[ $post_type ] ) ) {
				$saved_values = get_post_meta( $cmb2->data_to_save['ID'], $field_id, true );

				if ( 'updated' === $action ) {
					$this->add_connected_posts( $saved_values, $cmb2->data_to_save['ID'], $connections[ $post_type ][ $field_id ] );
					// Check if any posts have been removed.
					if ( count( $this->previous_values ) > count( $saved_values ) ) {

It seems like $saved_values can also be of type false and null and string; however, parameter $value of count() does only seem to accept Countable|array, maybe add an additional type check?

						$posts_to_remove = array_diff( $this->previous_values, $saved_values );

It seems like $saved_values can also be of type false and null and string; however, parameter $excludes of array_diff() does only seem to accept array, maybe add an additional type check?

						if ( ! empty( $posts_to_remove ) ) {
							$this->remove_connected_posts( $posts_to_remove, $cmb2->data_to_save['ID'], $connections[ $post_type ][ $field_id ] );
						}
					}
				} else if ( 'removed' === $action && ! empty( $this->previous_values ) ) {
					$this->remove_connected_posts( $this->previous_values, $cmb2->data_to_save['ID'], $connections[ $post_type ][ $field_id ] );
				}
			}
		}
	}

	/**
	 * Updates the connected posts witht he current post ID
	 *
	 * @param [type] $values

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

	 * @param [type] $current_id
	 * @param [type] $connected_key
	 * @return void
	 */
	public function add_connected_posts( $values, $current_id, $connected_key ) {
		foreach ( $values as $value ) {
			$current_post_array = get_post_meta( $value, $connected_key, true );
			$previous_values    = $current_post_array;

			if ( ! empty( $current_post_array ) ) {
				$current_post_array = array_map( 'strval', $current_post_array );

It seems like $current_post_array can also be of type string; however, parameter $array of array_map() does only seem to accept array, maybe add an additional type check?

				array_unique( $current_post_array );
			}

			// If the current connected post has no saved connections then we create it.
			if ( false === $current_post_array || empty( $current_post_array ) ) {
				$current_post_array = array( $current_id );
			} elseif ( ! in_array( (string) $current_id, $current_post_array, true ) ) {

It seems like $current_post_array can also be of type string; however, parameter $haystack of in_array() does only seem to accept array, maybe add an additional type check?

				$current_post_array[] = $current_id;
			}

			// Check if the values are empty, if not update them.
			if ( ! empty( $current_post_array ) ) {
				update_post_meta( $value, $connected_key, $current_post_array, $previous_values );
			}
		}
	}

	/**
	 * Removes the post ID from the connected posts.
	 *
	 * @param [type] $values

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

	 * @param [type] $current_ID
	 * @param [type] $connected_key
	 * @return void
	 */
	public function remove_connected_posts( $values, $current_ID, $connected_key ) {
		foreach ( $values as $value ) {
			$current_post_array = get_post_meta( $value, $connected_key, true );
			$new_array          = array();
			// Loop through only if the current ID has been saved against the post.
			if ( in_array( $current_ID, $current_post_array, false ) ) {

It seems like $current_post_array can also be of type false and null and string; however, parameter $haystack of in_array() does only seem to accept array, maybe add an additional type check?

				// Loop through all the connected saved IDS.
				foreach ( $current_post_array as $cpa ) {
					if ( (int) $cpa !== (int) $current_ID ) {
						$new_array[] = $cpa;
					}
				}
				if ( ! empty( $new_array ) ) {
					$new_array = array_unique( $new_array );
					delete_post_meta( $value, $connected_key );
					add_post_meta( $value, $connected_key, $new_array, true );
				} else {
					delete_post_meta( $value, $connected_key );
				}
			}
		}
	}

	/**
	 * Runs on 'before_delete_post' to run through and remove this post ID from its connected values.
	 *
	 * @param string $item_id
	 * @return void
	 */
	public function delete_post_meta_connections( $item_id = '' ) {
		if ( '' !== $item_id ) {
			$post_type   = get_post_type( $item_id );

$item_id of type string is incompatible with the type WP_Post|integer|null expected by parameter $post of get_post_type().

			$connections = $this->get_connections();
			if ( isset( $connections[ $post_type ] ) && ! empty( $connections[ $post_type ] ) && is_array( $connections[ $post_type ] ) ) {
				foreach ( $connections[ $post_type ] as $this_key => $connected_key ) {
					$this->delete_connected_items( $item_id, $this_key, $connected_key );
				}
			}
		}
	}

	/**
	 * This function will remvoe the post id fomr its connected posts.
	 *
	 * @param string $item_id
	 * @param string $this_key
	 * @param string $connected_key
	 * @return void
	 */
	public function delete_connected_items( $item_id = '', $this_key, $connected_key ) {
		if ( '' !== $item_id ) {
			$connected_items = get_post_meta( $item_id, $this_key, true );

$item_id of type string is incompatible with the type integer expected by parameter $post_id of get_post_meta().

			if ( ! empty( $connected_items ) ) {
				foreach ( $connected_items as $con_id ) {
					// Get the connected item array from the connected item.
					$their_connections = get_post_meta( $con_id, $connected_key, true );
					if ( ! empty( $their_connections ) ) {
						$new_connections = $their_connections;
						// Run through the array and remove the post to be deleteds ID.
						foreach ( $their_connections as $ckey => $cvalue ) {
							if ( (int) $item_id === (int) $cvalue ) {
								unset( $new_connections[ $ckey ] );
							}
						}
						// Now we save the field.
						update_post_meta( $con_id, $connected_key, $new_connections, $their_connections );
					}
				}
			}
		}
	}

	/**
	 * Saves the serialized post ids in singular custom fields so they are easily queried using WP_Query
	 *
	 * @return    void
	 */
	public function create_query_fields( $field_id, $updated, $action, $cmb2 ) {
		// If the connections are empty then skip this function.
		$search_fields = array(
			'plan_product',
		);
		if ( ! in_array( $field_id, $search_fields ) ) {
			return;
		}

		// If the field has been updated.
		if ( isset( $cmb2->data_to_save['ID'] ) && isset( $cmb2->data_to_save[ $field_id . '_results' ] ) && ! empty( $cmb2->data_to_save[ $field_id . '_results' ] ) ) {
			delete_post_meta( $cmb2->data_to_save['ID'], '_' . $field_id . '_id' );
			foreach ( $cmb2->data_to_save[ $field_id . '_results' ] as $temp ) {
				add_post_meta( $cmb2->data_to_save['ID'], '_' . $field_id . '_id', $temp, false );
			}
		}
	}

	/**
	 * Extract the plan fields so they save to an indexable array.
	 *
	 * @param [type] $object_id

The doc comment [type] at position 0 could not be parsed: Unknown type name '[' at position 0 in [type].

	 * @param [type] $cmb_id
	 * @param [type] $updated
	 * @param [type] $cmb2
	 * @return void
	 */
	public function extract_plan_fields( $object_id, $cmb_id, $updated, $cmb2 ) {
		if ( 'plan_sections_metabox' === $cmb_id ) {
			// Check if our fields are available, and cycle through them.
			if ( isset( $cmb2->data_to_save['plan_sections'] ) && ! empty( $cmb2->data_to_save['plan_sections'] ) ) {
				$fields_to_save = array();
				// Run through each row of fields.
				foreach ( $cmb2->data_to_save['plan_sections'] as $field_index => $fields ) {
					// Run through each field in that section.
					foreach ( $fields as $field_key => $field_value ) {
						$stored_values_key = 'plan_sections_' . $field_index . '_' . $field_key . '_store';
						if ( isset( $cmb2->data_to_save[ $stored_values_key ] ) && ! empty( $cmb2->data_to_save[ $stored_values_key ] ) ) {
							$stored_values = $cmb2->data_to_save[ $stored_values_key ];
							$stored_values = explode( ',', $stored_values );
							foreach ( $stored_values as $id_to_save ) {
								$fields_to_save[ $field_key ][] = $id_to_save;
							}
						}
					}
				}
				$this->save_field_array( $object_id, $fields_to_save );
			}
		}
	}

	/**
	 * Runs through the supplied array and saved the fields to the current Object.
	 *
	 * @param integer $object_id
	 * @param array   $fields_to_save
	 * @return void
	 */
	public function save_field_array( $object_id = 0, $fields_to_save = array() ) {

		// Run through the fields and save the meta items.
		if ( ! empty( $fields_to_save ) ) {
			foreach ( $fields_to_save as $field_key => $field_values ) {
				delete_post_meta( $object_id, $field_key );

				$field_values = array_unique( $field_values );
				foreach ( $field_values as $field_value ) {
					add_post_meta( $object_id, $field_key, $field_value, false );
				}
			}
		}
	}

	public function debugger_for_cmb2( $object_id, $cmb_id, $updated, $cmb2 ) {
		if ( 'workout_section_6_metabox' === $cmb_id ) {
			die();
		}
	}

	/**
	 * Handle body colours that might be change by LSX Customizer.
	 */
	public function customizer_body_colours_handler( $css, $colors ) {
		$css .= '
			@import "' . LSX_HEALTH_PLAN_PATH . '/assets/css/scss/partials/customizer-health-plan-body-colours";

			/**
			 * LSX Customizer - Body (LSX Health Plan)
			 */
			@include customizer-health-plan-body-colours (
				$bg: 		' . $colors['background_color'] . ',
				$breaker: 	' . $colors['body_line_color'] . ',
				$color:    	' . $colors['body_text_color'] . ',
				$link:    	' . $colors['body_link_color'] . ',
				$hover:    	' . $colors['body_link_hover_color'] . ',
				$small:    	' . $colors['body_text_small_color'] . '
			);
		';

		return $css;
	}
}