plugin.php

<?php
/**
 * Boilerplate
 *
 * Plugin core class, do not namespace.
 *
 * @package    Boilerplate
 * @subpackage Core
 * @since      1.0.0
 */

// Stop if accessed directly.
if ( ! defined( 'BLUDIT' ) ) {
	die( 'You are not allowed direct access to this file.' );
}

// Access namespaced functions.
use function Boilerplate\{
	site,
	url,
	lang,
	page
};

class Boilerplate extends Plugin {

	/**
	 * Constructor method
	 *
	 * @since  1.0.0
	 * @access public
	 * @return self
	 */
	public function __construct() {

		// Run parent constructor.
		parent :: __construct();

		// Include functionality.
		if ( $this->installed() ) {
			$this->get_files();
		}
	}

	/**
	 * Prepare plugin for installation
	 *
	 * @since  1.0.0
	 * @access public
	 * @return void
	 */
	public function prepare() {
		$this->get_files();
	}

	/**
	 * Include functionality
	 *
	 * @since  1.0.0
	 * @access public
	 * @return void
	 */
	public function get_files() {

		// Plugin path.
		$path = $this->phpPath();

		// Get plugin functions.
		foreach ( glob( $path . 'includes/*.php' ) as $filename ) {
			require_once $filename;
		}
	}

	/**
	 * Initiate plugin
	 *
	 * @since  1.0.0
	 * @access public
	 * @return void
	 */
	public function init() {

		$this->dbFields = [
			'option_one' => true,
			'option_two' => 5,
		];

		// Array of custom hooks.
		$this->customHooks = [
			'hook_one',
			'hook_two'
		];

		if ( ! $this->installed() ) {
			$Tmp = new dbJSON( $this->filenameDb );
			$this->db = $Tmp->db;
			$this->prepare();
		}
	}

	/**
	 * Install plugin
	 *
	 * Essentially the same as the parent method
	 * except that it allows for array field values.
	 *
	 * This is implemented to handle multi-checkbox
	 * and radio button fields.
	 *
	 * @since  1.0.0
	 * @access public
	 * @param  integer $position
	 * @return boolean Return true if the installation is successful.
	 */
	public function install( $position = 1 ) {

		// Create plugin directory for the database.
		mkdir( PATH_PLUGINS_DATABASES . $this->directoryName, DIR_PERMISSIONS, true );

		$this->dbFields['position'] = $position;

		// Sanitize default values to store in the file.
		foreach ( $this->dbFields as $key => $value ) {

			if ( is_array( $value ) ) {
				$array_fields = [];
				foreach ( $value as $array_field ) {
					if ( is_int( $array_field ) ) {
						$array_field = Sanitize :: int( $array_field );
					} elseif ( is_string( $array_field ) ) {
						$array_field = Sanitize :: html( $array_field );
					}
					$array_fields[] = $array_field;
				}
				$value = $array_fields;
			} elseif ( is_int( $value ) ) {
				$value = Sanitize :: int( $value );
			} else {
				$value = Sanitize :: html( $value );
			}

			settype( $value, gettype( $this->dbFields[$key] ) );
			$this->db[$key] = $value;
		}

		$storage = PATH_CONTENT . $this->storage_root . DS;
		if ( ! file_exists( $storage ) ) {
			Filesystem :: mkdir( $storage, true );
		}

		// Create the database.
		return $this->save();
	}

	/**
	 * Admin settings form
	 *
	 * @since  1.0.0
	 * @access public
	 * @return string Returns the markup of the form.
	 */
	public function form() {

		$html  = '';
		ob_start();
		include( $this->phpPath() . '/views/page-form.php' );
		$html .= ob_get_clean();

		return $html;
	}

	/**
	 * Form post
	 *
	 * The form `$_POST` method.
	 *
	 * Essentially the same as the parent method
	 * except that it allows for array field values.
	 *
	 * This is implemented to handle multi-checkbox
	 * and radio button fields.
	 *
	 * @since  1.0.0
	 * @access public
	 * @return void
	 */
	public function post() {

		$args = $_POST;

		foreach ( $this->dbFields as $field => $value ) {
			if ( isset( $args[$field] ) ) {

				// Array fields.
				if ( is_array( $args[$field] ) ) {
					$array_fields = [];
					foreach ( $args[$field] as $array_field ) {
						if ( is_int( $array_field ) ) {
							$array_field = Sanitize :: int( $array_field );
						} elseif ( is_string( $array_field ) ) {
							$array_field = Sanitize :: html( $array_field );
						}
						$array_fields[] = $array_field;
					}
					$value = $array_fields;

				// Integer fields.
				} elseif ( is_int( $args[$field] ) ) {
					$value = Sanitize :: int( $args[$field] );

				// String fields.
				} else {
					$value = Sanitize :: html( $args[$field] );
				}

				// Convert true/false strings to boolean.
				if ( 'false' === $value ) {
					$value = false;
				} elseif ( 'true' === $value ) {
					$value = true;
				}

				settype( $value, gettype( $value ) );
				$this->db[$field] = $value;
			}
		}
		return $this->save();
	}

	/**
	 * Minified asset
	 *
	 * Gets minified CSS and JavaScript files or
	 * non-minified if in debug mode.
	 *
	 * @since  1.0.0
	 * @access public
	 * @return string Returns the `.min` suffix or empty.
	 */
	public function minify() {

		$suffix = '.min';
		if ( defined( 'DEBUG_MODE' ) && DEBUG_MODE ) {
			$suffix = '';
		}
		return $suffix;
	}

	/**
	 * Admin controller
	 *
	 * Change the text of the `<title>` tag.
	 *
	 * @since  1.0.0
	 * @access public
	 * @global array $layout
	 * @return string Returns the head content.
	 */
	public function adminController() {

		// Access global variables.
		global $layout;

		// Title separator.
		$sep = ' | ';

		if ( isset( $_GET['page'] ) && 'dummy' == $_GET['page'] ) {
			$layout['title'] = lang()->get( 'Dummy Page' ) . "{$sep}" . site()->title();
		} else {
			$layout['title'] = lang()->get( 'Plugin Boilerplate Guide' ) . "{$sep}" . site()->title();
		}
	}

	/**
	 * Admin scripts & styles
	 *
	 * @since  1.0.0
	 * @access public
	 * @return string Returns the head content.
	 */
	public function adminHead() {

		$assets = '';

		// Load only for this plugin's pages.
		if ( str_contains( url()->slug(), $this->className() ) ) :

			$assets .= '<script type="text/javascript" src="' . $this->domainPath() . "assets/js/backend{$this->minify()}.js?version=" . $this->getMetadata( 'version' ) . '"></script>' . PHP_EOL;

			$assets .= '<link rel="stylesheet" type="text/css" href="' . $this->domainPath() . "assets/css/backend{$this->minify()}.css?version=" . $this->getMetadata( 'version' ) . '" />' . PHP_EOL;
		endif;

		return $assets;
	}

	/**
	 * Admin info pages
	 *
	 * @since  1.0.0
	 * @access public
	 * @return string Returns the markup of the page.
	 */
	public function adminView() {

		$html  = '';
		ob_start();
		include( $this->phpPath() . '/views/page-guide.php' );
		$html .= ob_get_clean();

		return $html;
	}

	/**
	 * Sidebar link
	 *
	 * Link to the options screen in the admin sidebar menu.
	 *
	 * @since  1.0.0
	 * @access public
	 * @return mixed
	 */
	public function adminSidebar() {

		// Check user role.
		if ( ! checkRole( [ 'admin' ], false ) ) {
			return;
		}

		$url  = HTML_PATH_ADMIN_ROOT . 'configure-plugin/' . $this->className();
		$html = sprintf(
			'<a class="nav-link" href="%s"><span class="fa fa-code"></span>%s</a>',
			$url,
			lang()->get( 'Boilerplate' )
		);
		return $html;
	}

	/**
	 * Login scripts & styles
	 *
	 * @since  1.0.0
	 * @access public
	 * @return string
	 */
	public function loginHead() {

		$assets = '<script type="text/javascript" src="' . $this->domainPath() . "assets/js/login{$this->minify()}.js?version=" . $this->getMetadata( 'version' ) . '"></script>' . PHP_EOL;
		$assets = '<link rel="stylesheet" type="text/css" href="' . $this->domainPath() . "assets/css/login{$this->minify()}.css?version=" . $this->getMetadata( 'version' ) . '" />' . PHP_EOL;

		return $assets;
	}

	/**
	 * Head section
	 *
	 * @since  1.0.0
	 * @access public
	 * @return string Returns the head content.
	 */
	public function siteHead() {

		$assets = '<script type="text/javascript" src="' . $this->domainPath() . "assets/js/frontend{$this->minify()}.js?version=" . $this->getMetadata( 'version' ) . '"></script>' . PHP_EOL;

		$assets .= '<link rel="stylesheet" type="text/css" href="' . $this->domainPath() . "assets/css/frontend{$this->minify()}.css?version=" . $this->getMetadata( 'version' ) . '" />' . PHP_EOL;

		return $assets;
	}

	/**
	 * Sidebar list
	 *
	 * @since  1.0.0
	 * @access public
	 * @return string Returns the sidebar markup.
	 */
	public function siteSidebar() {

		$html  = '';
		ob_start();
		include( $this->phpPath() . '/views/site-sidebar.php' );
		$html .= ob_get_clean();

		return $html;
	}

	/**
	 * Hook one
	 *
	 * @since  1.0.0
	 * @access public
	 * @return void
	 */
	public function hook_one() {
		// Utilize the custom `hook_one` hook.
	}

	/**
	 * Hook two
	 *
	 * @since  1.0.0
	 * @access public
	 * @return void
	 */
	public function hook_two() {
		// Utilize the custom `hook_two` hook.
	}

	/**
	 * Option return functions
	 *
	 * @since  1.0.0
	 * @access public
	 */

	// @return boolean
	public function option_one() {
		return $this->getValue( 'option_one' );
	}

	// @return integer
	public function option_two() {
		return $this->getValue( 'option_two' );
	}
}