mai-locations.php

<?php

/**
 * Plugin Name:       Mai Locations
 * Plugin URI:        https://bizbudding.com
 * Description:       A custom post type with info/address/map fields to manage locations.
 * Version:           1.0.0
 * Requires at least: 6.4
 * Author:            BizBudding
 * Author URI:        https://bizbudding.com
 */

// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) exit;

// Must be at the top of the file.
use YahnisElsts\PluginUpdateChecker\v5\PucFactory;

/**
 * Main Mai_Locations_Plugin Class.
 *
 * @since 0.1.0
 */
final class Mai_Locations_Plugin {

	/**
	 * @var   Mai_Locations_Plugin The one true Mai_Locations_Plugin
	 * @since 0.1.0
	 */
	private static $instance;

	/**
	 * Main Mai_Locations_Plugin Instance.
	 *
	 * Insures that only one instance of Mai_Locations_Plugin exists in memory at any one
	 * time. Also prevents needing to define globals all over the place.
	 *
	 * @since   0.1.0
	 * @static  var array $instance
	 * @uses    Mai_Locations_Plugin::setup_constants() Setup the constants needed.
	 * @uses    Mai_Locations_Plugin::includes() Include the required files.
	 * @uses    Mai_Locations_Plugin::hooks() Activate, deactivate, etc.
	 * @see     Mai_Locations_Plugin()
	 * @return  object | Mai_Locations_Plugin The one true Mai_Locations_Plugin
	 */
	public static function instance() {
		if ( ! isset( self::$instance ) ) {
			// Setup the setup.
			self::$instance = new Mai_Locations_Plugin;
			// Methods.
			self::$instance->setup_constants();
			self::$instance->includes();
			self::$instance->hooks();
		}
		return self::$instance;
	}

	/**
	 * Throw error on object clone.
	 *
	 * The whole idea of the singleton design pattern is that there is a single
	 * object therefore, we don't want the object to be cloned.
	 *
	 * @since   0.1.0
	 * @access  protected
	 * @return  void
	 */
	function __clone() {
		// Cloning instances of the class is forbidden.
		_doing_it_wrong( __FUNCTION__, __( 'Cheatin&#8217; huh?', 'mai-locations' ), '1.0' );
	}

	/**
	 * Disable unserializing of the class.
	 *
	 * @since   0.1.0
	 * @access  protected
	 * @return  void
	 */
	function __wakeup() {
		// Unserializing instances of the class is forbidden.
		_doing_it_wrong( __FUNCTION__, __( 'Cheatin&#8217; huh?', 'mai-locations' ), '1.0' );
	}

	/**
	 * Setup plugin constants.
	 *
	 * @access  private
	 * @since   0.1.0
	 * @return  void
	 */
	private function setup_constants() {
		// Plugin version.
		if ( ! defined( 'MAI_LOCATIONS_VERSION' ) ) {
			define( 'MAI_LOCATIONS_VERSION', '1.0.0' );
		}

		// Plugin Folder Path.
		if ( ! defined( 'MAI_LOCATIONS_PLUGIN_DIR' ) ) {
			define( 'MAI_LOCATIONS_PLUGIN_DIR', plugin_dir_path( __FILE__ ) );
		}

		// Plugin Folder URL.
		if ( ! defined( 'MAI_LOCATIONS_PLUGIN_URL' ) ) {
			define( 'MAI_LOCATIONS_PLUGIN_URL', plugin_dir_url( __FILE__ ) );
		}

		// Plugin Root File.
		if ( ! defined( 'MAI_LOCATIONS_PLUGIN_FILE' ) ) {
			define( 'MAI_LOCATIONS_PLUGIN_FILE', __FILE__ );
		}

		// Plugin Base Name
		if ( ! defined( 'MAI_LOCATIONS_BASENAME' ) ) {
			define( 'MAI_LOCATIONS_BASENAME', dirname( plugin_basename( __FILE__ ) ) );
		}
	}

	/**
	 * Include required files.
	 *
	 * @access  private
	 * @since   0.1.0
	 * @return  void
	 */
	private function includes() {
		// Dependencies.
		require_once __DIR__ . '/vendor/autoload.php';

		// Includes.
		foreach ( glob( MAI_LOCATIONS_PLUGIN_DIR . 'includes/' . '*.php' ) as $file ) { include $file; }

		// Classes.
		include_once __DIR__ . '/classes/class-block-bindings.php';
		include_once __DIR__ . '/classes/class-geo-query.php';
		include_once __DIR__ . '/classes/class-location-fields.php';
		include_once __DIR__ . '/classes/class-location-form.php'; // Must be before create/edit.
		include_once __DIR__ . '/classes/class-location-form-edit.php';
		include_once __DIR__ . '/classes/class-location-form-listener.php';
		include_once __DIR__ . '/classes/class-location-form-submit.php';
		include_once __DIR__ . '/classes/class-location-import.php';
		include_once __DIR__ . '/classes/class-locations-cli.php';
		include_once __DIR__ . '/classes/class-locations-scripts.php';
		include_once __DIR__ . '/classes/class-locations-table.php';
		include_once __DIR__ . '/classes/class-locations-queries.php';
		include_once __DIR__ . '/classes/class-settings.php';
		include_once __DIR__ . '/classes/class-upgrade.php';
		include_once __DIR__ . '/classes/class-woocommerce-account-tabs.php';

		// Blocks.
		include_once __DIR__ . '/blocks/location-address-search/block.php';
		include_once __DIR__ . '/blocks/location-count/block.php';
		include_once __DIR__ . '/blocks/location-filter/block.php';
		include_once __DIR__ . '/blocks/location-filter-clear/block.php';
		include_once __DIR__ . '/blocks/location-filter-submit/block.php';
		include_once __DIR__ . '/blocks/location-filters/block.php';
		include_once __DIR__ . '/blocks/location-map/block.php';
		include_once __DIR__ . '/blocks/location-submission/block.php';
		include_once __DIR__ . '/blocks/location-table/block.php';

		// Instantiate classes.
		new Mai_Locations_Block_Bindings;
		new Mai_Locations_Location_Fields;
		new Mai_Locations_Location_Form_Listener;
		new Mai_Locations_Location_Import;
		new Mai_Locations_Scripts;
		new Mai_Locations_Queries;
		new Mai_Locations_Upgrade;

		// Instantiate blocks.
		new Mai_Locations_Address_Search_Block;
		new Mai_Locations_Count_Block;
		new Mai_Locations_Filter_Block;
		new Mai_Locations_Filter_Clear_Block;
		new Mai_Locations_Filter_Submit_Block;
		new Mai_Locations_Filters_Block;
		new Mai_Locations_Submission_Block;
		new Mai_Locations_Table_Block;
		new Mai_Locations_Map_Block;

		// Disabled for now. The menu item(s) need to be conditionally added.
		// We need to think this through more.
		// add_action( 'plugins_loaded', 'mailocations_woocommerce_account_tab' );
		/**
		 * Adds locations table to WooCommerce account menu.
		 *
		 * @since TBD
		 *
		 * @return void
		 */
		function mailocations_woocommerce_account_tab() {
			if ( ! class_exists( 'WooCommerce' ) ) {
				return;
			}

			new Mai_Locations_WooCommerce_Account_Tabs;
		}
	}

	/**
	 * Run the hooks.
	 *
	 * @since   0.1.0
	 * @return  void
	 */
	function hooks() {
		add_action( 'plugins_loaded',         [ $this, 'updater' ] );
		add_action( 'init',                   [ $this, 'register_content_types' ], 4 ); // Before ACF's priority of 5, so the post type is available.
		add_action( 'save_post',              [ $this, 'save_post' ], 10, 3 );
		add_filter( 'genesis_noposts_text',   [ $this, 'no_results_text' ] );

		register_activation_hook( __FILE__, [ $this, 'activate' ] );
		register_deactivation_hook( __FILE__, 'flush_rewrite_rules' );
	}

	/**
	 * Setup the updater.
	 *
	 * composer require yahnis-elsts/plugin-update-checker
	 *
	 * @since 0.1.0
	 *
	 * @uses https://github.com/YahnisElsts/plugin-update-checker/
	 *
	 * @return void
	 */
	function updater() {
		// Bail if plugin updater is not loaded.
		if ( ! class_exists( 'YahnisElsts\PluginUpdateChecker\v5\PucFactory' ) ) {
			return;
		}

		// Setup the updater.
		$updater = PucFactory::buildUpdateChecker( 'https://github.com/maithemewp/mai-locations/', __FILE__, 'mai-locations' );

		// Maybe set github api token.
		if ( defined( 'MAI_GITHUB_API_TOKEN' ) ) {
			$updater->setAuthentication( MAI_GITHUB_API_TOKEN );
		}

		// Add icons for Dashboard > Updates screen.
		if ( function_exists( 'mai_get_updater_icons' ) && $icons = mai_get_updater_icons() ) {
			$updater->addResultFilter(
				function ( $info ) use ( $icons ) {
					$info->icons = $icons;
					return $info;
				}
			);
		}
	}

	/**
	 * Register content types.
	 *
	 * @since 0.1.0
	 *
	 * @return  void
	 */
	function register_content_types() {

		/***********************
		 *  Custom Post Types  *
		 ***********************/

		$plural   = mailocations_get_plural();
		$singular = mailocations_get_singular();
		$base     = mailocations_get_base();

		/**
		 * Registers custom post type.
		 *
		 * @return void
		 */
		register_post_type( 'mai_location', apply_filters( 'mai_location_post_type_args',
			[
				'exclude_from_search' => false,
				'has_archive'         => true,
				'hierarchical'        => false,
				'labels'              => [
					'name'               => $plural,
					'singular_name'      => $singular,
					'menu_name'          => $plural,
					'name_admin_bar'     => $singular,
					'add_new'            => __( 'Add New', 'mai-user-post' ),
					'add_new_item'       => __( 'Add New', 'mai-user-post' ),
					'new_item'           => __( 'New', 'mai-user-post' ) . ' ' . $singular,
					'edit_item'          => __( 'Edit', 'mai-user-post' ) . ' ' . $singular,
					'view_item'          => __( 'View', 'mai-user-post' ) . ' ' . $singular,
					'all_items'          => __( 'All', 'mai-user-post' ) . ' ' . $plural,
					'search_items'       => __( 'Search', 'mai-user-post' ) . ' ' . $plural,
					'parent_item_colon'  => __( 'Parent', 'mai-user-post' ) . ' ' . $plural,
					'not_found'          => __( 'No', 'mai-user-post' ) . ' ' . $plural . ' ' . __( 'found', 'mai-user-post' ),
					'not_found_in_trash' => __( 'No', 'mai-user-post' ) . ' ' . $plural . ' ' . __( 'found in trash', 'mai-user-post' ),
				],
				'menu_icon'          => 'dashicons-location',
				'public'             => true,
				'publicly_queryable' => true,
				'show_in_menu'       => true,
				'show_in_nav_menus'  => true,
				'show_in_rest'       => true,
				'show_ui'            => true,
				'rewrite'            => [ 'slug' => $base, 'with_front' => false ],
				'supports'           => [ 'title', 'editor', 'excerpt', 'author', 'thumbnail', 'page-attributes', 'mai-locations', 'genesis-cpt-archives-settings', 'mai-archive-settings', 'mai-single-settings' ],
				'taxonomies'         => [ 'mai_location_cat' ],
			]
		) );

		/***********************
		 *  Custom Taxonomies  *
		 ***********************/

		$cat_plural   = apply_filters( 'mailocations_taxonomy_plural', sprintf( '%s %s', $singular, __( 'Categories', 'mai-locations' ) ) );
		$cat_singular = apply_filters( 'mailocations_taxonomy_singular', sprintf( '%s %s', $singular, __( 'Category', 'mai-locations' ) ) );
		$cat_base     = mailocations_get_option( 'category_base' );
		$cat_base     = apply_filters( 'mailocations_taxonomy_base', $cat_base );
		$cat_base     = $cat_base ? sanitize_title_with_dashes( $cat_base ) : 'location-category';

		/**
		 * Registers custom taxonomy.
		 *
		 * @return void
		 */
		register_taxonomy( 'mai_location_cat', [ 'mai_location' ], apply_filters( 'mai_location_cat_args',
			[
				'hierarchical' => true,
				'labels'       => [
					'name'          => $cat_plural,
					'singular_name' => $cat_singular,
					'menu_name'     => $cat_plural,
				],
				'meta_box_cb'                => false,
				'public'                     => true,
				'show_admin_column'          => true,
				'show_in_nav_menus'          => true,
				'show_in_rest'               => true,
				'show_tagcloud'              => true,
				'show_ui'                    => true,
				'rewrite'                    => [ 'slug' => $cat_base, 'with_front' => false ],
			]
		) );
	}

	/**
	 * Flushes transients any time a location is saved or updated.
	 *
	 * @since TBD
	 *
	 * @param int     $post_id
	 * @param WP_Post $post
	 * @param bool    $update
	 *
	 * @return void
	 */
	function save_post( $post_id, $post, $update ) {
		// Bail if autosaving.
		if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
			return;
		}

		// Bail if this is an autosave.
		if ( wp_is_post_autosave( $post_id ) ) {
			return;
		}

		// Bail if this is a revision.
		if ( wp_is_post_revision( $post_id ) ) {
			return;
		}

		// Get post types that support locations.
		$post_types = mailocations_get_location_post_types();

		// Bail if not a location.
		if ( ! isset( $post_types[ $post->post_type ] ) ) {
			return;
		}

		// TODO: Only flush if any address/locations fields were update.

		// Flush transients.
		mailocations_delete_transients();
	}

	/**
	 * Filter the no posts text.
	 *
	 * @since TBD
	 *
	 * @param string $text
	 *
	 * @return string
	 */
	function no_results_text( $text ) {
		global $wp_query;

		// Get post types that support locations.
		$post_types = mailocations_get_location_post_types();
		$post_type  = $wp_query->get( 'post_type' );

		// Bail if not for locations.
		if ( ! $wp_query || ! $post_type || ! isset( $post_types[ $post_type ] ) ) {
			return $text;
		}

		// Set text.
		$text = sprintf( '%s %s %s',
			__( 'Sorry, no', 'mai-locations' ),
			strtolower( $post_types[ $post_type ]['plural'] ),
			__( 'found.', 'mai-locations' ),
		);

		// If filtering.
		if ( mailocations_is_filtered_locations() ) {
			$text .= ' ' . __( 'Please adjust your search criteria and try again.', 'mai-locations' );
		}

		return $text;
	}

	/**
	 * Plugin activation.
	 *
	 * @return void
	 */
	function activate() {
		$this->register_content_types();
		flush_rewrite_rules();
	}
}

/**
 * The main function for that returns Mai_Locations_Plugin
 *
 * The main function responsible for returning the one true Mai_Locations_Plugin
 * Instance to functions everywhere.
 *
 * Use this function like you would a global variable, except without needing
 * to declare the global.
 *
 * Example: <?php $plugin = Mai_Locations_Plugin(); ?>
 *
 * @since 0.1.0
 *
 * @return object|Mai_Locations_Plugin The one true Mai_Locations_Plugin Instance.
 */
function mai_locations_plugin() {
	return Mai_Locations_Plugin::instance();
}

// Get Mai_Locations_Plugin Running.
mai_locations_plugin();