generator-chisel 1.0.0 → 2.0.0-alpha.1

package/lib/commands/create/creators/app/chisel-starter-theme/classes/AcfBlocks.php

@@ -0,0 +1,190 @@
+<?php
+
+namespace Chisel;
+
+use Timber\Timber;
+use Chisel\ChiselCache;
+
+/**
+ * ACF blocks related functionalities.
+ *
+ * @package Chisel
+ */
+class AcfBlocks extends RegisterBlocks implements Instance {
+
+	/**
+	 * Blocks twig file base path.
+	 *
+	 * @var string
+	 */
+	protected $blocks_twig_base_path;
+
+	/**
+	 * Class constructor.
+	 */
+	private function __construct() {
+		$this->set_properties();
+
+		parent::__construct( 'acf' );
+
+		$this->action_hooks();
+		$this->filter_hooks();
+	}
+
+	/**
+	 * Set properties.
+	 */
+	public function set_properties() {
+		$this->blocks_twig_base_path = 'src/blocks-acf/';
+	}
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks() {
+		add_action( 'acf/init', array( $this, 'register_blocks' ) );
+	}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks() {
+		add_filter( 'timber/locations', array( $this, 'tiwg_files_locations' ) );
+		add_filter( 'acf/settings/load_json', array( $this, 'load_acf_field_group' ) );
+		add_filter( 'acf/settings/save_json', array( $this, 'save_acf_field_group' ) );
+	}
+
+	/**
+	 * Register ACF blocks and their assets.
+	 */
+	public function register_blocks() {
+		$this->register_custom_blocks();
+	}
+
+	/**
+	 * Add custom Twig files locations.
+	 *
+	 * @param array $locations The locations.
+	 * @return array
+	 */
+	public function tiwg_files_locations( $locations ) {
+		if ( ! is_array( $this->blocks ) || ! $this->blocks ) {
+			return $locations;
+		}
+
+		foreach ( $this->blocks as $block ) {
+			$locations[] = array( $this->blocks_path_src . '/' . $block . '/' );
+		}
+
+		return $locations;
+	}
+
+	/**
+	 * Load ACF field group.
+	 *
+	 * @param array $paths The paths.
+	 * @return array
+	 */
+	public function load_acf_field_group( $paths ) {
+		if ( ! is_array( $this->blocks ) || ! $this->blocks ) {
+			return;
+		}
+
+		foreach ( $this->blocks as $block ) {
+			$paths[] = $this->blocks_path_src . '/' . $block . '/acf-json';
+		}
+
+		return $paths;
+	}
+
+	/**
+	 * Save ACF field group.
+	 *
+	 * @param string $path The path.
+	 * @return string
+	 */
+	public function save_acf_field_group( $path ) {
+
+		$action    = isset( $_REQUEST['action'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['action'] ) ) : ''; // phpcs:ignore
+		$post_type = isset( $_REQUEST['post_type'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ) : ''; // phpcs:ignore
+
+		if ( $action === 'editpost' && $post_type === 'acf-field-group' ) {
+			$location = isset( $_REQUEST['acf_field_group']['location'] ) ? $_REQUEST['acf_field_group']['location'] : array(); // phpcs:ignore
+
+			foreach ( $location as $group ) {
+				foreach ( $group as $rules ) {
+					if ( sanitize_text_field( $rules['param'] ) === 'block' && sanitize_text_field( $rules['operator'] ) === '==' ) {
+						$block_name = explode( '/', sanitize_text_field( $rules['value'] ) )[1];
+
+						if ( ! $block_name ) {
+							return $path;
+						}
+
+						return $this->blocks_path_src . '/' . $block_name . '/acf-json';
+					}
+				}
+			}
+		}
+
+		return $path;
+	}
+
+	/**
+	 * Render ACF block.
+	 *
+	 * @param array  $block The block.
+	 * @param string $content The content.
+	 * @param bool   $is_preview Is preview.
+	 * @param int    $post_id The post ID.
+	 *
+	 * @return void
+	 */
+	public static function acf_block_render( $block, $content = '', $is_preview = false, $post_id = 0 ) {
+		$context = Timber::context();
+
+		$block_slug = str_replace( 'chisel/', '', $block['name'] );
+
+		$slug                  = 'b-' . $block_slug;
+		$context['block']      = $block;
+		$context['post_id']    = $post_id;
+		$context['slug']       = $slug;
+		$context['is_preview'] = $is_preview;
+		$context['fields']     = get_fields();
+		$classes               = array_merge(
+			array( $slug ),
+			isset( $block['className'] ) ? array( $block['className'] ) : array(),
+			$is_preview ? array( 'is-preview' ) : array(),
+			$block['supports']['align'] ? array( 'align' . $context['block']['align'] ) : array(),
+		);
+
+		$context['block']['class_names'] = $classes;
+		$context['block']['block_id']    = isset( $block['anchor'] ) ? $block['anchor'] : $block['id'];
+
+		// allow to use filters to manipulate the output.
+		$context = apply_filters( 'chisel_timber_acf_blocks_data', $context );
+		$context = apply_filters( 'chisel_timber_acf_blocks_data_' . $slug, $context );
+		$context = apply_filters( 'chisel_timber_acf_blocks_data_' . $block['id'], $context );
+
+		$context['wrapper_attributes'] = get_block_wrapper_attributes(
+			array(
+				'id'    => $context['block']['block_id'],
+				'class' => implode( ' ', $context['block']['class_names'] ),
+			)
+		);
+
+		Timber::render( self::get_instance()->blocks_twig_base_path . $block_slug . '/' . $block_slug . '.twig', $context, ChiselCache::expiry() );
+	}
+
+	/**
+	 * Get the instance of the class.
+	 */
+	public static function get_instance() {
+		static $instance = null;
+
+		if ( null === $instance ) {
+			$instance = new self();
+		}
+
+		return $instance;
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/classes/AcfSync.php

@@ -0,0 +1,230 @@
+<?php
+
+namespace Chisel;
+
+/**
+ * ACF related functionalities.
+ *
+ * @package Chisel
+ */
+class AcfSync extends \ACF_Admin_Internal_Post_Type_List implements Instance {
+
+	/**
+	 * The acf groups post type.
+	 *
+	 * @var string
+	 */
+	public $post_type = 'acf-field-group';
+
+	/**
+	 * The acf groups sync data.
+	 *
+	 * @var array
+	 */
+	public $sync = array();
+
+	/**
+	 * The acf group single post id.
+	 *
+	 * @var null|int
+	 */
+	protected $post_id = null;
+
+	/**
+	 * The key of acf field group to sync.
+	 *
+	 * @var null|string
+	 */
+	protected $single_post_key = null;
+
+	/**
+	 * The acf groups sync page url.
+	 *
+	 * @var string
+	 */
+	protected $sync_page_url = '';
+
+	/**
+	 * ACF section current page
+	 *
+	 * @var string
+	 */
+	public $view = '';
+
+
+	/**
+	 * Class constructor.
+	 */
+	private function __construct() {
+		$this->action_hooks();
+		$this->filter_hooks();
+	}
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks() {
+		add_action( 'admin_notices', array( $this, 'acf_sync_notice' ) );
+		add_action( 'init', array( $this, 'set_properties' ) );
+
+		add_filter( 'chisel_admin_styles', array( $this, 'load_plugin_scripts' ) );
+		add_filter( 'chisel_admin_scripts', array( $this, 'load_plugin_scripts' ) );
+	}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks() {
+	}
+
+	/**
+	 * Set properties.
+	 */
+	public function set_properties() {
+		if ( wp_doing_ajax() || wp_doing_cron() ) {
+			return;
+		}
+
+		// Stop if parent method doesn't exist.
+		if ( ! method_exists( $this, 'setup_sync' ) ) {
+			return;
+		}
+
+		global $pagenow;
+		$this->view = acf_request_arg( 'post_status', '' );
+
+		if ( $pagenow === 'edit.php' && isset( $_GET['post_type'] ) && sanitize_text_field( wp_unslash( $_GET['post_type'] ) ) === $this->post_type ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+			$this->view = 'all';
+		}
+
+		if ( $pagenow === 'post.php' && isset( $_GET['post'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+			$post_id   = absint( $_GET['post'] ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+			$post_type = get_post_type( $post_id );
+
+			if ( $post_type === $this->post_type ) {
+				$this->post_id = $post_id;
+				$this->view    = 'single';
+			}
+		}
+
+		if ( ! $this->view ) {
+			return;
+		}
+
+		// Check for unsynced fields groups. Call a parent method.
+		$this->setup_sync();
+
+		if ( $this->view === 'single' && $this->sync ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+			foreach ( $this->sync as $key => $field_group ) {
+				if ( $field_group['ID'] === $this->post_id ) {
+					$this->single_post_key = $key;
+
+					break;
+				}
+			}
+		}
+
+		$this->sync_page_url = add_query_arg(
+			array(
+				'post_type'   => $this->post_type,
+				'post_status' => 'sync',
+			),
+			admin_url( 'edit.php' )
+		);
+	}
+
+	/**
+	 * Enqueue plugin scripts
+	 *
+	 * @param array $scripts
+	 *
+	 * @return array
+	 */
+	public function load_plugin_scripts( $scripts ) {
+		$scripts['acf-sync'] = array();
+
+		return $scripts;
+	}
+
+	/**
+	 * Check if sync notice needs to be displayed.
+	 *
+	 * @return void
+	 */
+	public function acf_sync_notice() {
+		if ( $this->post_id && $this->single_post_key ) { // We're on a single page.
+			$this->display_modal_notice();
+		} elseif ( $this->sync ) {
+			$this->display_admin_notice();
+		}
+	}
+
+	/**
+	 * Display ACF sync admin notice.
+	 *
+	 * @return void
+	 */
+	protected function display_admin_notice() {
+		?>
+		<div class="error">
+			<p><?php esc_html_e( 'You have unsynced ACF fields.', 'chisel' ); ?> <a href="<?php echo esc_url( $this->sync_page_url ); ?>"><?php esc_html_e( ' View fields available for sync', 'chisel' ); ?></a></p>
+		</div>
+		<?php
+	}
+
+	/**
+	 * Display ACF sync modal notice.
+	 *
+	 * @return void
+	 */
+	protected function display_modal_notice() {
+		$url = $this->get_admin_url( '&acfsync=' . $this->single_post_key . '&_wpnonce=' . wp_create_nonce( 'bulk-posts' ) );
+		?>
+		<div class="xfive-acf-sync-modal js-xfive-acf-sync-modal is-open" role="dialog">
+			<div class="xfive-acf-sync-modal__box">
+				<div class="xfive-acf-sync-modal__content">
+					<div class="xfive-acf-sync-modal__icon">
+						<svg aria-hidden="true" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 20 20">
+							<path stroke="#d63638" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M10 11V6m0 8h.01M19 10a9 9 0 1 1-18 0 9 9 0 0 1 18 0Z"></path>
+						</svg>
+					</div>
+
+					<h3>
+						<?php esc_html_e( 'The field group you are editing has not been synced with your local acf json file.', 'chisel' ); ?>
+						<?php esc_html_e( 'Making any changes will overwrite the local json file and result in losing data.', 'chisel' ); ?>
+						<?php esc_html_e( 'This is irreversible.', 'chisel' ); ?>
+					</h3>
+
+					<div class="xfive-acf-sync-modal__actions">
+						<a href="<?php echo esc_url( $this->sync_page_url ); ?>" class="acf-btn"><?php esc_html_e( 'View changes', 'chisel' ); ?></a>
+						<a href="<?php echo esc_url( $url ); ?>" class="acf-btn"><?php esc_html_e( 'Sync data', 'chisel' ); ?></a>
+						<button type="button" class="acf-btn acf-btn-secondary js-xfive-acf-sync-modal-close"><?php esc_html_e( 'Ignore', 'chisel' ); ?></button>
+					</div>
+				</div>
+			</div>
+		</div>
+		<?php
+	}
+
+	/**
+	 *  Check if the sync notice scripts should be loaded.
+	 *
+	 * @return bool
+	 */
+	public static function load_scripts() {
+		return self::get_instance()->post_id && self::get_instance()->single_post_key;
+	}
+
+	/**
+	 * Get the instance of the class.
+	 */
+	public static function get_instance() {
+		static $instance = null;
+
+		if ( null === $instance ) {
+			$instance = new self();
+		}
+
+		return $instance;
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/classes/Ajax.php

@@ -0,0 +1,161 @@
+<?php
+
+namespace Chisel;
+
+use Chisel\AjaxEnpoints;
+
+/**
+ * Custom Ajax class based on REST API.
+ *
+ * @package Chisel
+ */
+class Ajax extends \WP_REST_Controller implements Instance {
+
+	/**
+	 * Ajax custom route namespace.
+	 *
+	 * @var string
+	 */
+	const ROUTE_NAMESPACE = 'chisel/v2';
+
+	/**
+	 * Ajax custom route base.
+	 *
+	 * @var string
+	 */
+	const ROUTE_BASE = 'ajax';
+
+	/**
+	 * Ajax custom routes.
+	 *
+	 * @var array
+	 */
+	protected $routes = array();
+
+	/**
+	 * Class constructor.
+	 */
+	private function __construct() {
+		$this->set_properties();
+		$this->action_hooks();
+		$this->filter_hooks();
+	}
+
+	/**
+	 * Set properties.
+	 */
+	public function set_properties() {
+		$this->routes = apply_filters(
+			'chisel_ajax_routes',
+			array(
+				'load-more' => array(),
+			)
+		);
+	}
+
+	/**
+	 * Register action hooks.
+	 */
+	public function action_hooks() {
+		add_action( 'rest_api_init', array( $this, 'register_endpoints' ) );
+	}
+
+	/**
+	 * Register filter hooks.
+	 */
+	public function filter_hooks() {}
+
+	/**
+	 * Register endpoints
+	 *
+	 * @return void
+	 */
+	public function register_endpoints() {
+		foreach ( $this->routes as $route_name => $route_params ) {
+			$route   = sprintf( self::ROUTE_BASE . '/%s/', $route_name );
+			$methods = isset( $route_params['methods'] ) ? $route_params['methods'] : array( 'POST' );
+
+			register_rest_route(
+				self::ROUTE_NAMESPACE,
+				$route,
+				array(
+					'methods'             => $methods,
+					'callback'            => array( $this, 'callback' ),
+					'permission_callback' => array( $this, 'permissions_check' ),
+					'args'                => $this->get_endpoint_args_for_item_schema( true ),
+				)
+			);
+		}
+	}
+
+	/**
+	 * Create dynamic route callback
+	 *
+	 * @param \WP_REST_Request $request WP_REST_Request.
+	 *
+	 * @return callable
+	 */
+	public function callback( $request ) {
+			$route       = $request->get_route();
+			$route_parts = explode( '/', $route );
+			$callback    = str_replace( '-', '_', end( $route_parts ) );
+
+			$ajax_endpoints = new AjaxEnpoints();
+
+		if ( method_exists( $ajax_endpoints, $callback ) ) {
+			if ( ! defined( 'DOING_AJAX' ) ) {
+				define( 'DOING_AJAX', true );
+			}
+
+			if ( ! defined( 'DOING_CHISEL_AJAX' ) ) {
+				define( 'DOING_CHISEL_AJAX', true );
+			}
+
+			return call_user_func( array( $ajax_endpoints, $callback ), $request );
+		}
+	}
+
+	/**
+	 * Check ajax request permissions.
+	 *
+	 * @param \WP_REST_Request $request WP_REST_Request.
+	 *
+	 * @return boolean
+	 */
+	public function permissions_check( $request ) {
+		return true;
+	}
+
+	/**
+	 * Get custom ajax endpint
+	 *
+	 * @return string
+	 */
+	public static function get_ajax_endpoint_url() {
+		return sprintf( '%s/wp-json/%s/%s', esc_url( get_bloginfo( 'url' ) ), self::ROUTE_NAMESPACE, self::ROUTE_BASE );
+	}
+
+	/**
+	 * Decode json string from ajax request
+	 *
+	 * @param string $value
+	 *
+	 * @return array
+	 */
+	public static function ajax_json_decode( $value ) {
+		return (array) json_decode( stripslashes( $value ) );
+	}
+
+	/**
+	 * Get the instance of the class.
+	 */
+	public static function get_instance() {
+		static $instance = null;
+
+		if ( null === $instance ) {
+			$instance = new self();
+		}
+
+		return $instance;
+	}
+}

package/lib/commands/create/creators/app/chisel-starter-theme/classes/AjaxEnpoints.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace Chisel;
+
+use Timber\Timber;
+use Chisel\ChiselCache;
+
+/**
+ * Custom Ajax enpoints callbacks
+ *
+ * @package Chisel
+ */
+class AjaxEnpoints {
+
+	/**
+	 * Ajax call for load more feature.
+	 *
+	 * @param \WP_REST_Request $request WP_REST_Request.
+	 *
+	 * @return json
+	 */
+	public function load_more( $request ) {
+		if ( ! $request ) {
+			return $this->error( 'No request data' );
+		}
+
+		$data = $this->get_data( $request );
+
+		$post_type = sanitize_text_field( $data['post_type'] );
+		$per_page  = absint( $data['per_page'] );
+		$page      = absint( $data['page'] );
+
+		$response = '';
+
+		$posts = Timber::get_posts(
+			array(
+				'post_type'      => $post_type,
+				'posts_per_page' => $per_page,
+				'paged'          => $page,
+			)
+		);
+
+		$templates = array( 'components/post-item.twig', 'components/' . $post_type . '-item.twig' );
+
+		if ( $post_type === 'product' ) {
+			array_unshift( $templates, 'woocommerce/content-product.twig' );
+		}
+
+		if ( $posts ) {
+			foreach ( $posts as $post ) {
+				$response .= Timber::compile( $templates, array( 'post' => $post ), ChiselCache::expiry() );
+			}
+		}
+
+		return $this->success( $response );
+	}
+
+	/**
+	 * Get data from request.
+	 *
+	 * @param \WP_REST_Request $request WP_REST_Request.
+	 *
+	 * @return array
+	 */
+	protected function get_data( $request ) {
+		return $request->get_body_params();
+	}
+
+	/**
+	 * This function will return a success response.
+	 *
+	 * @param array $data
+	 *
+	 * @return \WP_REST_Response
+	 */
+	protected function success( $data = array() ) {
+		return new \WP_REST_Response(
+			array(
+				'error'   => 0,
+				'message' => 'ok',
+				'data'    => $data,
+			),
+			200
+		);
+	}
+
+	/**
+	 * This function will return an error response.
+	 *
+	 * @param string $message
+	 *
+	 * @return \WP_REST_Response
+	 */
+	protected function error( $message ) {
+		return new \WP_REST_Response(
+			array(
+				'error'   => 1,
+				'message' => $message,
+			),
+			400
+		);
+	}
+}