wireframe.php

<?php
/**
 * Bootstrap file for Wireframe plugins.
 *
 * PHP version 5.6.0
 *
 * @package   Wireframe_Plugin
 * @author    MixaTheme, Tada Burke
 * @version   0.1.0 Wireframe_Plugin
 * @copyright 2016 MixaTheme
 * @license   GPL-2.0+
 * @see       https://mixatheme.com
 * @see       https://github.com/mixatheme/Wireframe
 * @see       https://developer.wordpress.org/plugins/intro/
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this software. If not, see <http://www.gnu.org/licenses/>.
 *
 * Table of Contents:
 *
 *    § 01. Namespaces
 *    § 02. Access
 *    § 03. Functions
 *    § 04. Autoload
 *    § 05. Container
 *    § 06. Configs
 *    § 07. Services
 *    § 08. Wireframe
 *    § 09. Housekeeping
 *    § 10. Hooks
 *
 * (New sections are separated by lines.)
 */

/**
 * § 01. Namespaces.
 * =============================================================================
 *
 * @since 5.3.0 PHP
 * @since 0.1.0 Wireframe
 * @since 0.1.0 Wireframe_Plugin
 */
namespace MixaTheme\Wireframe\Plugin;

/**
 * § 02. Access.
 * =============================================================================
 *
 * No direct access to this file.
 *
 * @since 0.1.0 Wireframe
 * @since 0.1.0 Wireframe_Plugin
 */
defined( 'ABSPATH' ) or die();

/**
 * § 03. Functions: Load helper functions.
 * =============================================================================
 *
 * Loads helper functions and callbacks. These functions should load before your
 * classes, so they become available to your objects. Once you get the hang of
 * Wireframe_Plugin, these files can probably be merged to save on file count.
 *
 * @since 0.1.0 Wireframe
 * @since 0.1.0 Wireframe_Plugin
 */
require_once WIREFRAME_PLUGIN_FUNC . 'helpers.php';
require_once WIREFRAME_PLUGIN_FUNC . 'admin.php';

/**
 * § 04. Objects.
 * =============================================================================
 *
 * Option #1: Use `require_once()` to load your class dependencies 1-by-1.
 *            This is the default option because some Developers don't use Composer.
 *
 * Option #2: Autoload class dependencies via Composer's `composer.json` file.
 *            If you add new class files, you must re-compile `composer.json`.
 *            This is the preferred option for loading your objects.
 *
 * Autoload Example:
 *
 *            require_once WIREFRAME_PLUGIN_DEV . 'vendor/autoload.php';
 *
 * PRO-TIP: To re-compile the autoloader in CLI, replace all the require_once()
 * lines below with the `Autoload Example` above, `cd` to the directory where the
 * `composer.json` file is located, then execute: composer dump-autoload -o
 *
 * PRO-TIP: For completeness, the default Wireframe_Plugin is packaged with
 * multiple objects. You most likely do not need all these files.
 *
 * @since 0.1.0 Wireframe
 * @since 0.1.0 Wireframe_Plugin
 * @since 1.1.2 Composer
 * @see   composer.json
 * @see   https://getcomposer.org
 *
 * @internal CLI: composer update
 * @internal CLI: composer dump-autoload -o
 * @internal WPCS expects a lowercase filename (PSR-2, PSR-4 invalid).
 */
require_once WIREFRAME_PLUGIN_OBJECTS . 'core/core-module-abstract.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'core/core-container-interface.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'core/core-container.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'core/core-enqueue-interface.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'core/core-enqueue.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'core/core-language-interface.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'core/core-language.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'core/core-plugin-interface.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'core/core-plugin.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/notices/module-notices-interface.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/notices/module-notices.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/admin/module-admin-interface.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/admin/module-admin.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/cpt/module-cpt-interface.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/cpt/module-cpt.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/dbtables/module-dbtables-interface.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/dbtables/module-dbtables.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/options/module-options-interface.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/options/module-options.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/settings/module-settings-interface.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/settings/module-settings.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/shortcode/module-shortcode-interface.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/shortcode/module-shortcode.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/taxonomy/module-taxonomy-interface.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/taxonomy/module-taxonomy.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/ui/module-ui-interface.php';
require_once WIREFRAME_PLUGIN_OBJECTS . 'module/ui/module-ui.php';

/**
 * Check if the `Core_Plugin` class exists then configure Wireframe_Plugin defaults.
 *
 * Security Note: If you save any data to your WordPress Database, you should
 * validate and/or sanitize untrusted data before entering into the database.
 * All untrusted data should be escaped before output.
 *
 * @since 0.1.0 Wireframe
 * @since 0.1.0 Wireframe_Plugin
 */
if ( class_exists( 'MixaTheme\Wireframe\Plugin\Core_Plugin' ) ) :
	/**
	 * § 05. Container.
	 * =========================================================================
	 *
	 * Wireframe Plugin needs to wire objects to the Core_Container::$storage array.
	 *
	 * @since 0.1.0 Wireframe
	 * @since 0.1.0 Wireframe_Plugin
	 * @see   object   Core_Container
	 * @var   callable $wireframe_plugin_container
	 */
	$wireframe_plugin_container = new Core_Container();

	/**
	 * § 06. Configs.
	 * =========================================================================
	 *
	 * Option #1: Load config data for passing arrays into plugin objects.
	 *
	 * Option #2: You can set properties for objects inside an object closure
	 *            (see `Closure` section below). If you wish to set your config
	 *            data inside closures, then you don't need to require files.
	 *
	 * Data files are located in: `wireframe_dev/wireframe/config/`
	 *
	 * PRO-TIP: For completeness, the default Wireframe_Plugin is packaged with
	 * multiple config files. You most likely do not need all these.
	 *
	 * @since 0.1.0 Wireframe
	 * @since 0.1.0 Wireframe_Plugin
	 */
	require_once trailingslashit( WIREFRAME_PLUGIN_DIR . 'wireframe_cfg' ) . 'cfg-language.php';
	require_once trailingslashit( WIREFRAME_PLUGIN_DIR . 'wireframe_cfg' ) . 'cfg-notices.php';
	require_once trailingslashit( WIREFRAME_PLUGIN_DIR . 'wireframe_cfg' ) . 'cfg-admin.php';
	require_once trailingslashit( WIREFRAME_PLUGIN_DIR . 'wireframe_cfg' ) . 'cfg-dbtables.php';
	require_once trailingslashit( WIREFRAME_PLUGIN_DIR . 'wireframe_cfg' ) . 'cfg-cpt.php';
	require_once trailingslashit( WIREFRAME_PLUGIN_DIR . 'wireframe_cfg' ) . 'cfg-taxonomy.php';
	require_once trailingslashit( WIREFRAME_PLUGIN_DIR . 'wireframe_cfg' ) . 'cfg-shortcode.php';
	require_once trailingslashit( WIREFRAME_PLUGIN_DIR . 'wireframe_cfg' ) . 'cfg-options.php';
	require_once trailingslashit( WIREFRAME_PLUGIN_DIR . 'wireframe_cfg' ) . 'cfg-settings.php';
	require_once trailingslashit( WIREFRAME_PLUGIN_DIR . 'wireframe_cfg' ) . 'cfg-ui.php';

	/**
	 * § 07. Services: Language.
	 * =========================================================================
	 *
	 * This closure registers a service with the Core_Container::$storage array,
	 * and instantiates a new Core_Language object with config data passed-in.
	 *
	 * @since  0.1.0 Wireframe_Theme
	 * @see    wireframe_plugin_cfg_language()
	 * @return object Core_Language( @param array|callable Config data. )
	 */
	$wireframe_plugin_container->language = function () {
		return new Core_Language( wireframe_plugin_cfg_language() );
	};

	/**
	 * § 07. Services: Admin.
	 *
	 * This closure registers a service with the Core_Container::$storage array,
	 * and instantiates a new Module_Admin object with config data passed-in.
	 *
	 * @since  0.1.0 Wireframe_Theme
	 * @see    wireframe_plugin_cfg_admin()
	 * @return object Module_Admin( @param array|callable Config data. )
	 */
	$wireframe_plugin_container->admin = function () {
		return new Module_Admin( wireframe_plugin_cfg_admin() );
	};

	/**
	 * § 07. Services: Notices.
	 * =========================================================================
	 *
	 * This closure registers a service with the Core_Container::$storage array,
	 * and instantiates a new Module_Notices object with config data passed-in.
	 *
	 * @since  0.1.0 Wireframe_Theme
	 * @see    wireframe_plugin_cfg_notices()
	 * @return object Module_Notices( @param array|callable Config data. )
	 */
	$wireframe_plugin_container->notices = function () {
		return new Module_Notices( wireframe_plugin_cfg_notices() );
	};

	/**
	 * § 07. Services: CPT.
	 *
	 * This closure registers a service with the Core_Container::$storage array,
	 * and instantiates a new Module_CPT object with config data passed-in.
	 *
	 * @since  0.1.0 Wireframe_Theme
	 * @see    wireframe_plugin_cfg_cpt()
	 * @return object Module_Admin( @param array|callable Config data. )
	 */
	$wireframe_plugin_container->cpt = function () {
		return new Module_CPT( wireframe_plugin_cfg_cpt() );
	};

	/**
	 * § 07. Services: Taxonomy.
	 *
	 * This closure registers a service with the Core_Container::$storage array,
	 * and instantiates a new Module_Taxonomy object with config data passed-in.
	 *
	 * @since  0.1.0 Wireframe_Theme
	 * @see    wireframe_plugin_cfg_taxonomy()
	 * @return object Module_Taxonomy( @param array|callable Config data. )
	 */
	$wireframe_plugin_container->taxonomy = function () {
		return new Module_Taxonomy( wireframe_plugin_cfg_taxonomy() );
	};

	/**
	 * § 07. Services: Shortcode.
	 *
	 * This closure registers a service with the Core_Container::$storage array,
	 * and instantiates a new Module_Shortcode object with config data passed-in.
	 *
	 * @since  0.1.0 Wireframe_Theme
	 * @see    wireframe_plugin_cfg_shortcode()
	 * @return object Module_Shortcode( @param array|callable Config data. )
	 */
	$wireframe_plugin_container->shortcode = function () {
		return new Module_Shortcode( wireframe_plugin_cfg_shortcode() );
	};

	/**
	 * § 07. Services: Options.
	 *
	 * This closure registers a service with the Core_Container::$storage array,
	 * and instantiates a new Module_Options object with config data passed-in.
	 *
	 * @since  0.1.0 Wireframe_Theme
	 * @see    wireframe_plugin_cfg_options()
	 * @return object Module_Options( @param array|callable Config data. )
	 */
	$wireframe_plugin_container->options = function () {
		return new Module_Options( wireframe_plugin_cfg_options() );
	};

	/**
	 * § 07. Services: Settings.
	 *
	 * This closure registers a service with the Core_Container::$storage array,
	 * and instantiates a new Module_Settings object with config data passed-in.
	 *
	 * @since  0.1.0 Wireframe_Theme
	 * @see    wireframe_plugin_cfg_settings()
	 * @return object Module_Settings( @param array|callable Config data. )
	 */
	$wireframe_plugin_container->settings = function () {
		return new Module_Settings( wireframe_plugin_cfg_settings() );
	};

	/**
	 * § 07. Services: UI.
	 *
	 * This closure registers a service with the Core_Container::$storage array,
	 * and instantiates a new Module_UI object with config data passed-in.
	 *
	 * @since  0.1.0 Wireframe_Theme
	 * @see    wireframe_plugin_cfg_ui()
	 * @return object Module_UI( @param array|callable Config data. )
	 */
	$wireframe_plugin_container->ui = function () {
		return new Module_UI( wireframe_plugin_cfg_ui() );
	};

	/**
	 * § 07. Services: DBTables.
	 *
	 * This closure registers a service with the Core_Container::$storage array,
	 * and instantiates a new Module_DBTables object with config data passed-in.
	 *
	 * @since  0.1.0 Wireframe_Theme
	 * @see    wireframe_plugin_cfg_dbtables()
	 * @return object Module_DBTables( @param array|callable Config data. )
	 */
	$wireframe_plugin_container->dbtables = function () {
		return new Module_DBTables( wireframe_plugin_cfg_dbtables() );
	};

	/**
	 * § 08. Wireframe is alive!
	 * =========================================================================
	 *
	 * Instantiates the base `Core_Plugin` object, then wires together the default
	 * services you added to the `$wireframe_plugin_container` object (above).
	 *
	 * Option #1: You can re-declare which objects your plugin wires via the
	 *            _construct() method in the `Core_Plugin` class. Then, DI only
	 *            the objects you need. We started you off with common objects.
	 *
	 * Option #2: You can entirely swap-out the `Core_Plugin` class with your
	 *            own custom class, or make the `Core_Plugin` class abstract,
	 *            then extend it.
	 *
	 * Option #3: You can also register multiple services and DI them into the
	 *            Core_Plugin object (requires object parameters). Checkout our
	 *            Wireframe_Theme example: @see https://github.com/mixatheme/wireframe-theme
	 *
	 * @since  0.1.0 Wireframe
	 * @since  0.1.0 Wireframe_Plugin
	 * @var    object $wireframe_plugin
	 * @return object Core_Plugin(
	 *         @param object Core_Language    DI the required language.
	 *         @param object Module_Admin     DI the required Admin pages.
	 *         @param object Module_Notices   DI the optional notices.
	 *         @param object Module_DBTables  DI the optional database tables.
	 *         @param object Module_CPT       DI the optional post types
	 *         @param object Module_Taxonomy  DI the optional taxonomy.
	 *         @param object Module_Shortcode DI the optional shortcodes.
	 *         @param object Module_Options   DI the optional options.
	 *         @param object Module_Settings  DI the optional settings.
	 *         @param object Module_UI        DI the optional styles & scripts.
	 * )
	 */
	$wireframe_plugin = new Core_Plugin(
		$wireframe_plugin_container->language,
		$wireframe_plugin_container->admin,
		$wireframe_plugin_container->notices,
		$wireframe_plugin_container->cpt,
		$wireframe_plugin_container->taxonomy,
		$wireframe_plugin_container->shortcode,
		$wireframe_plugin_container->options,
		$wireframe_plugin_container->settings,
		$wireframe_plugin_container->ui,
		$wireframe_plugin_container->dbtables
	);

	/**
	 * § 09. Housekeeping.
	 * =========================================================================
	 *
	 * Check if Wireframe_Plugin is properly initialized. You can perform any clean-up
	 * tasks here, or simply output a warning if `$wireframe_plugin` fails. Also note:
	 * your plugin files should now have access to objects beyond this point.
	 *
	 * Example object usage:
	 *
	 * 		$myplugin  = $wireframe_plugin;
	 * 		$lang_obj  = $myplugin->language();
	 * 		$lang_path = $myplugin->language()->get_path();
	 *
	 * @since 0.1.0 Wireframe
	 * @since 0.1.0 Wireframe_Plugin
	 * @see   functions-notices.php
	 */
	if ( ! isset( $wireframe_plugin ) ) {

		// Init failed. Hook a failure notice.
		add_action( 'admin_notices', array( $wireframe_plugin_container->notices, 'error_init' ), 10, 0 );

	}

	/**
	 * § 10. Hooks.
	 * =====================================================================
	 *
	 * Init success! Continue processing. Run any hooks you need.
	 *
	 * Note: Many objects are not required to be wired (hooked) when instantiated.
	 * In your config data file(s), you can set the `$wired` value to true or false.
	 * If false, you can de-couple any hooks and declare them here (below).
	 * If $wired = true, then those objects will fire hooks onload.
	 *
	 * Data files are located in: `wireframe_dev/wireframe/config/`
	 *
	 * Examples:
	 *
	 * 		register_activation_hook( __FILE__, array( $wireframe_plugin, 'activate' ) );
	 * 		register_deactivation_hook( __FILE__, array( $wireframe_plugin, 'deactivate' ) );
	 * 		register_uninstall_hook( __FILE__, $wireframe_plugin, 'uninstall' );
	 *
	 * @since 0.1.0 Wireframe
	 * @since 0.1.0 Wireframe_Plugin
	 * @see   object $wireframe_plugin Instance of Core_Plugin.
	 */
	register_deactivation_hook( __FILE__, array( $wireframe_plugin, 'deactivate' ) );

endif; // Thanks for using MixaTheme products!