Source: classes/controller/admin-scripts.php

  1. <?php
  3. namespace wpbuddy\rich_snippets;
  5. if ( ! defined( 'ABSPATH' ) ) {
  6. 	exit;
  7. } // Exit if accessed directly
  10. /**
  11.  * Class Admin_Scripts.
  12.  *
  13.  * Enqueues scripts and styles.
  14.  *
  15.  * @package wpbuddy\rich_snippets
  16.  *
  17.  * @since   2.0.0
  18.  */
  19. class Admin_Scripts_Controller {
  21. 	/**
  22. 	 * The instance.
  23. 	 *
  24. 	 * @var Admin_Scripts_Controller
  25. 	 *
  26. 	 * @since 2.0.0
  27. 	 */
  28. 	protected static $instance = null;
  31. 	/**
  32. 	 * If this instance has been initialized already.
  33. 	 *
  34. 	 * @var bool
  35. 	 */
  36. 	protected $initialized = false;
  38. 	/**
  39. 	 * Get the singleton instance.
  40. 	 *
  41. 	 * Creates a new instance of the class if it does not exists.
  42. 	 *
  43. 	 * @return   Admin_Scripts_Controller
  44. 	 *
  45. 	 * @since 2.0.0
  46. 	 */
  47. 	public static function instance() {
  49. 		if ( null === self::$instance ) {
  50. 			self::$instance = new self;
  51. 		}
  53. 		if ( ! self::$instance->initialized ) {
  54. 			self::$instance->init();
  55. 		}
  57. 		return self::$instance;
  58. 	}
  61. 	/**
  62. 	 * Magic function for cloning.
  63. 	 *
  64. 	 * Disallow cloning as this is a singleton class.
  65. 	 *
  66. 	 * @since 2.0.0
  67. 	 */
  68. 	protected function __clone() {
  69. 	}
  72. 	/**
  73. 	 * Magic method for setting upt the class.
  74. 	 *
  75. 	 * Disallow external instances.
  76. 	 *
  77. 	 * @since 2.0.0
  78. 	 */
  79. 	protected function __construct() {
  80. 	}
  83. 	/**
  84. 	 * Init and register.
  85. 	 *
  86. 	 * @since 2.2.0
  87. 	 */
  88. 	public function init() {
  90. 		if ( $this->initialized ) {
  91. 			return;
  92. 		}
  94. 		/**
  95. 		 * Register Styles
  96. 		 */
  98. 		wp_register_style(
  99. 			'wpb-rs-admin-snippets',
  100. 			plugins_url( 'css/admin-snippets.css', rich_snippets()->get_plugin_file() ),
  101. 			array(),
  102. 			filemtime( plugin_dir_path( rich_snippets()->get_plugin_file() ) . 'css/admin-snippets.css' )
  103. 		);
  105. 		wp_register_style(
  106. 			'wpb-rs-admin-errors',
  107. 			plugins_url( 'css/admin-errors.css', rich_snippets()->get_plugin_file() ),
  108. 			array( 'wpb-rs-admin-snippets' ),
  109. 			filemtime( plugin_dir_path( rich_snippets()->get_plugin_file() ) . 'css/admin-errors.css' )
  110. 		);
  112. 		wp_register_style(
  113. 			'wpb-rs-admin-posts',
  114. 			plugins_url( 'css/admin-posts.css', rich_snippets()->get_plugin_file() ),
  115. 			array( 'wpb-rs-admin-snippets' ),
  116. 			filemtime( plugin_dir_path( rich_snippets()->get_plugin_file() ) . 'css/admin-posts.css' )
  117. 		);
  120. 		/**
  121. 		 * Register scripts
  122. 		 */
  124. 		wp_register_script(
  125. 			'wpb-rs-admin-errors',
  126. 			plugins_url( 'js/admin-errors.js', rich_snippets()->get_plugin_file() ),
  127. 			array( 'jquery' ),
  128. 			filemtime( plugin_dir_path( rich_snippets()->get_plugin_file() ) . 'js/admin-errors.js' )
  129. 		);
  131. 		wp_register_script(
  132. 			'wpb-rs-admin-snippets',
  133. 			call_user_func( function () {
  134. 				if ( rich_snippets() instanceof \wpbuddy\rich_snippets\pro\Rich_Snippets_Plugin_Pro ) {
  135. 					return plugins_url( 'js/build/admin-snippets.js', rich_snippets()->get_plugin_file() );
  136. 				}
  138. 				return plugins_url( 'js/admin-snippets-free.js', rich_snippets()->get_plugin_file() );
  139. 			} ),
  140. 			array(
  141. 				'wpb-rs-fields',
  142. 				'wpb-rs-admin-errors',
  143. 				'jquery',
  144. 				'underscore',
  145. 			),
  146. 			Helper_Model::instance()->get_plugin_data( 'Version' ),
  147. 			true
  148. 		);
  150. 		wp_add_inline_script( 'wpb-rs-admin-snippets', 'var rich_snippets = {\'snippets\': []};', 'before' );
  152. 		wp_register_script(
  153. 			'wpb-rs-admin-posts',
  154. 			plugins_url( 'js/admin-posts.js', rich_snippets()->get_plugin_file() ),
  155. 			array( 'wpb-rs-admin-snippets', 'jquery' ),
  156. 			filemtime( plugin_dir_path( rich_snippets()->get_plugin_file() ) . 'js/admin-posts.js' )
  157. 		);
  159. 		wp_register_script(
  160. 			'wpb-rs-fields',
  161. 			plugins_url( 'js/fields.js', rich_snippets()->get_plugin_file() ),
  162. 			array( 'jquery' ),
  163. 			filemtime( plugin_dir_path( rich_snippets()->get_plugin_file() ) . 'js/fields.js' )
  164. 		);
  166. 		$this->initialized = true;
  167. 	}
  170. 	/**
  171. 	 * Enqueue snippet styles.
  172. 	 *
  173. 	 * @since 2.0.0
  174. 	 */
  175. 	public function enqueue_snippets_styles() {
  177. 		wp_enqueue_style( 'wpb-rs-admin-snippets' );
  179. 		wp_enqueue_style( 'wpb-rs-admin-errors' );
  181. 		/**
  182. 		 * Snippet Styles Action.
  183. 		 *
  184. 		 * Allows plugins to enqueue custom styles on the snippets screen.
  185. 		 *
  186. 		 * @hook  wpbuddy/rich_snippets/schemas/styles
  187. 		 *
  188. 		 * @since 2.0.0
  189. 		 */
  190. 		do_action( 'wpbuddy/rich_snippets/schemas/styles' );
  191. 	}
  194. 	/***
  195. 	 * Enqueue snippet scripts.
  196. 	 *
  197. 	 * @since 2.0.0
  198. 	 */
  199. 	public function enqueue_snippets_scripts() {
  201. 		$this->enqueue_script_snippets();
  202. 	}
  205. 	/**
  206. 	 * Enqueue snippets scripts.
  207. 	 *
  208. 	 * @since 2.0.0
  209. 	 */
  210. 	private function enqueue_script_snippets() {
  212. 		wp_enqueue_script( 'wpb-rs-admin-snippets' );
  214. 		wp_add_inline_script(
  215. 			'wpb-rs-admin-snippets',
  216. 			"var WPB_RS_ADMIN = " . \json_encode( $this->get_admin_snippets_script_data() ) . ";",
  217. 			'before'
  218. 		);
  220. 		wp_enqueue_script( 'wpb-rs-admin-errors' );
  221. 	}
  224. 	/**
  225. 	 * Enqueue scripts for singular posts.
  226. 	 *
  227. 	 * @since 2.0.0
  228. 	 */
  229. 	private function enqueue_scripts_posts() {
  231. 		wp_enqueue_script( 'wpb-rs-admin-posts' );
  233. 		wp_add_inline_script(
  234. 			'wpb-rs-admin-posts',
  235. 			"var WPB_RS_POSTS = " . \json_encode( $this->get_admin_posts_script_data() ) . ";",
  236. 			'before'
  237. 		);
  239. 	}
  242. 	/**
  243. 	 * Returns an object of data needed by admin snippet script.
  244. 	 *
  245. 	 * @return \stdClass
  246. 	 * @since 2.0.0
  247. 	 *
  248. 	 */
  249. 	private function get_admin_snippets_script_data(): \stdClass {
  251. 		global $post;
  253. 		$post_id = is_a( $post, 'WP_Post' ) ? $post->ID : 0;
  255. 		$o                 = new \stdClass();
  256. 		$o->nonce          = wp_create_nonce( 'wp_rest' );
  257. 		$o->rest_url       = untrailingslashit( rest_url( 'wpbuddy/rich_snippets/v1' ) );
  258. 		$o->i18n           = new \stdClass();
  259. 		$o->i18n->expand   = __( 'Expand all', 'rich-snippets-schema' );
  260. 		$o->i18n->collapse = __( 'Collapse all', 'rich-snippets-schema' );
  262. 		if ( ! empty( $post_id ) ) {
  263. 			$o->post_id = $post_id;
  264. 		}
  266. 		return $o;
  267. 	}
  270. 	/**
  271. 	 * Returns an object of data needed by admin posts script.
  272. 	 *
  273. 	 * @return \stdClass
  274. 	 * @since 2.0.0
  275. 	 *
  276. 	 */
  277. 	private function get_admin_posts_script_data(): \stdClass {
  279. 		global $post;
  281. 		$post_id = is_a( $post, 'WP_Post' ) ? $post->ID : 0;
  283. 		$o           = new \stdClass();
  284. 		$o->nonce    = wp_create_nonce( 'wp_rest' );
  285. 		$o->rest_url = untrailingslashit( rest_url( 'wpbuddy/rich_snippets/v1' ) );
  287. 		if ( ! empty( $post_id ) ) {
  288. 			$o->post_id = $post_id;
  289. 		}
  291. 		return $o;
  292. 	}
  294. 	/**
  295. 	 * Enqueue posts scripts.
  296. 	 *
  297. 	 * @since 2.0.0
  298. 	 */
  299. 	public function enqueue_posts_scripts() {
  301. 		$this->enqueue_scripts_posts();
  303. 		$this->enqueue_styles_posts();
  304. 	}
  307. 	/**
  308. 	 * Enqueue posts forms scripts.
  309. 	 *
  310. 	 * @since 2.2.0
  311. 	 */
  312. 	public function enqueue_posts_forms_scripts() {
  314. 		$this->enqueue_styles_posts_forms();
  315. 	}
  318. 	/**
  319. 	 * Enqueue CSS scripts for posts.
  320. 	 *
  321. 	 * @since 2.0.0
  322. 	 */
  323. 	private function enqueue_styles_posts() {
  325. 		wp_enqueue_style( 'wpb-rs-admin-posts' );
  327. 		/**
  328. 		 * Snippet Post Styles Action.
  329. 		 *
  330. 		 * Allows plugins to enqueue custom styles on the posts screen.
  331. 		 *
  332. 		 * @hook  wpbuddy/rich_snippets/posts/styles
  333. 		 *
  334. 		 * @since 2.0.0
  335. 		 */
  336. 		do_action( 'wpbuddy/rich_snippets/posts/styles' );
  337. 	}
  340. 	/**
  341. 	 * Enqueue CSS scripts for posts forms.
  342. 	 *
  343. 	 * @since 2.2.0
  344. 	 */
  345. 	private function enqueue_styles_posts_forms() {
  347. 		/**
  348. 		 * Snippet Styles Post Forms.
  349. 		 *
  350. 		 * Allows plugins to enqueue custom styles on the snippets post forms screen.
  351. 		 *
  352. 		 * @hook  wpbuddy/rich_snippets/posts_forms/styles
  353. 		 *
  354. 		 * @since 2.2.0
  355. 		 */
  356. 		do_action( 'wpbuddy/rich_snippets/posts_forms/styles' );
  357. 	}
  359. }