class-crowdsignal-forms-block.php

<?php
/**
 * Contains Crowdsignal_Forms\Frontend\Crowdsignal_Forms_Block
 *
 * @package Crowdsignal_Forms\Frontend\Blocks
 * @since   0.9.0
 */

namespace Crowdsignal_Forms\Frontend;

use Crowdsignal_Forms\Crowdsignal_Forms;

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Describes Crowdsignal Forms' Gutenberg blocks.
 *
 * @package Crowdsignal_Forms\Frontend
 * @since   0.9.0
 */
abstract class Crowdsignal_Forms_Block {
	const STATUS_TYPE_OPEN      = 'open';
	const STATUS_TYPE_CLOSED    = 'closed';
	const STATUS_TYPE_SCHEDULED = 'closed-after';

	/**
	 * Lazy-loaded state to determine if the api connection is set up.
	 *
	 * @var bool|null
	 */
	private static $is_cs_connected = null;

	/**
	 * Cached poll data. Array is indexed by poll_id (guid).
	 *
	 * @var array
	 */
	private $poll_data = [];

	/**
	 * Registers the Gutenberg block.
	 */
	abstract public function register();

	/**
	 * Returns a unique name for the block's registered assets.
	 *
	 * @return string The name for the registered assets.
	 */
	abstract public function asset_identifier();

	/**
	 * Configuration array for the assets of the block.
	 * Must conform to the following format:
	 * array(
	 *      'config' => '/build/poll.asset.php',
	 *      'script' => '/build/poll.js',
	 *      'style'  => '/build/poll.css',
	 * )
	 *
	 * @return array The config array.
	 */
	abstract public function assets();

	/**
	 * Determines if branding should be shown in the poll.
	 * Result is cached in a short-lived transient for performance.
	 *
	 * @return bool
	 */
	protected function should_hide_branding() {
		$enable_branding = defined( 'IS_ATOMIC' ) && IS_ATOMIC;
		$enable_branding = apply_filters( 'crowdsignal_forms_branding_enabled', $enable_branding );
		if ( ! $enable_branding ) {
			return true;
		}

		try {
			$capabilities  = Crowdsignal_Forms::instance()->get_api_gateway()->get_capabilities();
			$hide_branding = in_array( 'hide-branding', $capabilities, true );
		} catch ( \Exception $ex ) {
			// ignore error, we'll get the updated value next time.
			$hide_branding = true;
		}

		return $hide_branding;
	}

	/**
	 * Determines if the plugin is connected to Crowdsignal.
	 *
	 * @return bool
	 */
	protected function is_cs_connected() {
		if ( null !== self::$is_cs_connected ) {
			return self::$is_cs_connected;
		}

		$api_auth_provider     = Crowdsignal_Forms::instance()->get_api_authenticator();
		self::$is_cs_connected = ! empty( $api_auth_provider->get_user_code() );

		// purposely not doing the account is_verified check to avoid making a slow query on every page load.

		return self::$is_cs_connected;
	}

	/**
	 * Retrieves the saved crowdsignal poll data.
	 *
	 * @param string $poll_id The client id of the poll.
	 * @returns array|null
	 */
	protected function get_platform_poll_data( $poll_id ) {
		if ( ! isset( $poll_id ) ) {
			return null;
		}

		if ( ! empty( $this->poll_data[ $poll_id ] ) ) {
			return $this->poll_data[ $poll_id ];
		}

		$post = get_post();

		if ( null === $post ) {
			return null;
		}

		$data = Crowdsignal_Forms::instance()
			->get_post_poll_meta_gateway()
			->get_poll_data_for_poll_client_id( $post->ID, $poll_id );

		if ( empty( $data ) ) {
			return null;
		}

		$this->poll_data[ $poll_id ] = $data;
		return $data;
	}
}