class-gf-gutenberg.php

<?php

// If Gravity Forms cannot be found, exit.
if ( ! class_exists( 'GFForms' ) ) {
	die();
}

// Load Add-On Framework.
GFForms::include_addon_framework();

/**
 * Gutenberg integration using the Add-On Framework.
 *
 * @see GFAddOn
 */
class GF_Gutenberg extends GFAddOn {

	/**
	 * Contains an instance of this class, if available.
	 *
	 * @since  1.0
	 * @access private
	 * @var    GF_Gutenberg $_instance If available, contains an instance of this class.
	 */
	private static $_instance = null;

	/**
	 * Defines the version of the Gutenberg Add-On.
	 *
	 * @since  1.0
	 * @access protected
	 * @var    string $_version Contains the version, defined in gutenberg.php
	 */
	protected $_version = GF_GUTENBERG_VERSION;

	/**
	 * Defines the minimum Gravity Forms version required.
	 *
	 * @since  1.0
	 * @access protected
	 * @var    string $_min_gravityforms_version The minimum version required.
	 */
	protected $_min_gravityforms_version = '2.2';

	/**
	 * Defines the plugin slug.
	 *
	 * @since  1.0
	 * @access protected
	 * @var    string $_slug The slug used for this plugin.
	 */
	protected $_slug = 'gravityformsgutenberg';

	/**
	 * Defines the main plugin file.
	 *
	 * @since  1.0
	 * @access protected
	 * @var    string $_path The path to the main plugin file, relative to the plugins folder.
	 */
	protected $_path = 'gravityformsgutenberg/gutenberg.php';

	/**
	 * Defines the full path to this class file.
	 *
	 * @since  1.0
	 * @access protected
	 * @var    string $_full_path The full path.
	 */
	protected $_full_path = __FILE__;

	/**
	 * Defines the URL where this Add-On can be found.
	 *
	 * @since  1.0
	 * @access protected
	 * @var    string The URL of the Add-On.
	 */
	protected $_url = 'http://www.gravityforms.com';

	/**
	 * Defines the title of this Add-On.
	 *
	 * @since  1.0
	 * @access protected
	 * @var    string $_title The title of the Add-On.
	 */
	protected $_title = 'Gravity Forms Gutenberg Add-On';

	/**
	 * Defines the short title of the Add-On.
	 *
	 * @since  1.0
	 * @access protected
	 * @var    string $_short_title The short title.
	 */
	protected $_short_title = 'Gutenberg';

	/**
	 * Defines if Add-On should use Gravity Forms servers for update data.
	 *
	 * @since  1.0
	 * @access protected
	 * @var    bool
	 */
	protected $_enable_rg_autoupgrade = true;

	/**
	 * Get instance of this class.
	 *
	 * @since  1.0
	 * @access public
	 * @static
	 *
	 * @return GF_Gutenberg
	 */
	public static function get_instance() {

		if ( null === self::$_instance ) {
			self::$_instance = new self;
		}

		return self::$_instance;

	}

	/**
	 * Register needed hooks.
	 *
	 * @since  1.0-dev-1
	 * @access public
	 */
	public function init() {

		parent::init();

		// Register block.
		register_block_type( 'gravityforms/block', array(
			'render_callback' => array( $this, 'render_block' ),
		) );

		// Enqueue scripts.
		add_action( 'enqueue_block_editor_assets', array( $this, 'enqueue_block_assets' ) );

		// Register preview block route.
		add_action( 'rest_api_init', array( $this, 'register_preview_route' ) );

	}





	// # BLOCK ---------------------------------------------------------------------------------------------------------

	/**
	 * Enqueue assets needed for block.
	 *
	 * @since  1.0-dev-1
	 * @access public
	 *
	 * @uses   GFAddOn::get_base_path()
	 * @uses   GFAddOn::get_base_url()
	 * @uses   GF_Gutenberg::get_forms()
	 */
	public function enqueue_block_assets() {

		// Enqueue style.
		wp_enqueue_style(
			'gform_editor_block',
			$this->get_base_url() . '/css/block.css',
			array( 'wp-edit-blocks' ),
			filemtime( $this->get_base_path() . '/css/block.css' )
		);

		// Enqueue script.
		wp_enqueue_script(
			'gform_editor_block',
			$this->get_base_url() . '/js/block.min.js',
			array( 'wp-blocks', 'wp-element' ),
			filemtime( $this->get_base_path() . '/js/block.min.js' )
		);

		// Prepare JS variables.
		wp_localize_script(
			'gform_editor_block',
			'gform',
			array(
				'forms'              => $this->get_forms(),
				'conditionalOptions' => $this->get_conditional_options(),
				'icon'               => $this->get_base_url() . '/images/icon.svg',
			)
		);

	}

	/**
	 * Display block contents on frontend.
	 *
	 * @since  1.0-dev-1
	 * @access public
	 *
	 * @param array $attributes Block attributes.
	 *
	 * @return string
	 */
	public function render_block( $attributes = array() ) {

		// Prepare variables.
		$form_id     = rgar( $attributes, 'formId' ) ? $attributes['formId'] : false;
		$title       = isset( $attributes['title'] ) ? $attributes['title'] : true;
		$description = isset( $attributes['description'] ) ? $attributes['description'] : true;
		$ajax        = isset( $attributes['ajax'] ) ? $attributes['ajax'] : false;
		$tabindex    = isset( $attributes['tabindex'] ) ? $attributes['tabindex'] : 0;
		$logic       = isset( $attributes['conditionalLogic'] ) ? $attributes['conditionalLogic'] : array();

		// If form ID was not provided or form does not exist, return.
		if ( ! $form_id || ( $form_id && ! GFAPI::get_form( $form_id ) ) || ! $this->can_view_block( $logic ) ) {
			return '';
		}

		return gravity_form( $form_id, $title, $description, false, null, $ajax, $tabindex, false );

	}

	/**
	 * Determine if user can view block.
	 *
	 * @since  1.0-dev-3
	 * @access public
	 *
	 * @param array $logic Conditional logic.
	 *
	 * @uses   GFCommon::get_local_timestamp()
	 * @uses   GFFormsModel::matches_operation()
	 *
	 * @return bool
	 */
	public function can_view_block( $logic ) {

		if ( ! rgar( $logic, 'enabled' ) || ( isset( $logic['rules'] ) && empty( $logic['rules'] ) ) ) {
			return true;
		}

		// Get current user.
		$user = wp_get_current_user();

		// Initialize rule match count.
		$match_count = 0;

		// Loop through rules.
		foreach ( $logic['rules'] as $rule ) {

			switch ( $rule['key'] ) {

				case 'date':

					if ( ! rgblank( $rule['value'] ) && GFFormsModel::matches_operation( strtotime( $rule['value'] ), GFCommon::get_local_timestamp(), $rule['operator'] ) ) {
						$match_count++;
					}

					break;

				case 'user':

					// Handle logged in.
					if ( 'logged-in' === $rule['value'] ) {

						if ( ( is_user_logged_in() && $rule['operator'] === 'is' ) || ( ! is_user_logged_in() && $rule['operator'] === 'isnot' ) ) {
							$match_count++;
						}

					} else if ( 'logged-out' === $rule['value'] ) {

						if ( ( ! is_user_logged_in() && $rule['operator'] === 'is' ) || ( is_user_logged_in() && $rule['operator'] === 'isnot' ) ) {
							$match_count++;
						}

					} else {

						if ( ( in_array( $rule['value'], $user->roles ) && $rule['operator'] === 'is' ) || ( ! in_array( $rule['value'], $user->roles ) && $rule['operator'] === 'isnot' ) ) {
							$match_count++;
						}

					}

					break;

			}

		}

		$result = ( 'all' === $logic['logicType'] && $match_count === count( $logic['rules'] ) ) || ( 'any' === $logic['logicType'] && $match_count > 0 );

		return 'hide' === $logic['actionType'] ? ! $result : $result;

	}




	// # BLOCK PREVIEW -------------------------------------------------------------------------------------------------

	/**
	 * Register REST API route to preview block.
	 *
	 * @since  1.0-dev-2
	 * @access public
	 *
	 * @uses   GF_Gutenberg::preview_block()
	 */
	public function register_preview_route() {

		register_rest_route( 'gf/v2', '/block/preview', array(
			array(
				'methods'  => WP_REST_Server::READABLE,
				'callback' => array( $this, 'preview_block' ),
				'args'     => array(
					'formId'      => array(
						'description' => __( 'The ID of the form displayed in the block.' ),
						'type'        => 'integer',
						'required'    => true,
					),
					'title'       => array(
						'description' => __( 'Whether to display the form title.' ),
						'type'        => 'boolean',
						'default'     => true,
					),
					'description' => array(
						'description' => __( 'Whether to display the form description.' ),
						'type'        => 'boolean',
						'default'     => true,
					),
					'ajax'        => array(
						'description' => __( 'Whether to embed the form using AJAX.' ),
						'type'        => 'boolean',
						'default'     => true,
					),
				),
			),
		) );

	}

	/**
	 * Prepare form HTML for block preview.
	 *
	 * @since  1.0-dev-2
	 * @access public
	 *
	 * @param WP_REST_Request $request Full data about the request.
	 *
	 * @uses   GFAPI::get_form()
	 * @uses   WP_REST_Request::get_params()
	 */
	public function preview_block( $request ) {

		// Get request arguments.
		$attributes = $request->get_params();

		// Get form ID.
		$form_id = rgar( $attributes, 'formId' ) ? $attributes['formId'] : false;

		// If form ID was not provided or form does not exist, return.
		if ( ! $form_id || ( $form_id && ! GFAPI::get_form( $form_id ) ) ) {
			wp_send_json_error();
		}

		ob_start();
		include_once 'includes/preview.php';
		$html = ob_get_contents();
		ob_end_clean();

		if ( $html ) {
			wp_send_json_success( array( 'html' => trim( $html ) ) );
		} else {
			wp_send_json_error();
		}


	}





	// # HELPER METHODS ------------------------------------------------------------------------------------------------

	/**
	 * Get forms for block control.
	 *
	 * @since  1.0-dev-1
	 * @access public
	 *
	 * @uses   GFAPI::get_forms()
	 *
	 * @return array
	 */
	private function get_forms() {

		// Initialize options array.
		$options = array(
			array(
				'label' => esc_html__( 'Select a Form', 'gravityforms' ),
				'value' => '',
			),
		);

		// Get forms.
		$forms = GFAPI::get_forms();

		// Loop through forms.
		foreach ( $forms as $form ) {

			// Add form as option.
			$options[] = array(
				'label' => $form['title'],
				'value' => $form['id'],
			);

		}

		return $options;

	}

	/**
	 * Get options for the conditional logic drop downs.
	 *
	 * @since  1.0-dev-3
	 * @access public
	 *
	 * @uses   GF_Gutenberg::get_roles()
	 *
	 * @return array
	 */
	private function get_conditional_options() {

		return array(
			array(
				'key'       => array(
					'label' => esc_html__( 'User', 'gravityforms' ),
					'value' => 'user',
				),
				'operators' => array(
					array(
						'label' => 'is',
						'value' => 'is',
					),
					array(
						'label' => 'is not',
						'value' => 'isnot',
					),
				),
				'value'     => array(
					'type'    => 'select',
					'choices' => array(
						array(
							'label' => esc_html__( 'Logged In', 'gravityforms' ),
							'value' => 'logged-in',
						),
						array(
							'label' => esc_html__( 'Logged Out', 'gravityforms' ),
							'value' => 'logged-out',
						),
						array(
							'label'   => esc_html__( 'Roles', 'gravityforms' ),
							'choices' => $this->get_roles(),
						),
					),
				),
			),
			array(
				'key'       => array(
					'label' => esc_html__( 'Date', 'gravityforms' ),
					'value' => 'date',
				),
				'operators' => array(
					array(
						'label' => 'is before',
						'value' => 'greater_than',
					),
					array(
						'label' => 'is after',
						'value' => 'less_than',
					),
				),
				'value'     => array(
					'type' => 'date',
				),
			),
		);

	}

	/**
	 * Get available roles for block control.
	 *
	 * @since  1.0-dev-3
	 * @access public
	 *
	 * @return array
	 */
	private function get_roles() {

		// Load needed function file.
		if ( ! function_exists( 'get_editable_roles' ) ) {
			require_once( ABSPATH . '/wp-admin/includes/user.php' );
		}

		// Initialize roles array.
		$roles = array();

		// Loop through roles.
		foreach ( get_editable_roles() as $role_name => $role ) {

			// Add role as option.
			$roles[] = array(
				'label' => $role['name'],
				'value' => $role_name,
			);

		}

		return $roles;

	}

}