YIKES\EasyForms\Shortcode\EasyFormsShortcode

Complexity

Total Complexity

18

Size/Duplication

Total Lines	228
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	6	1
A	get_default_atts()	0	19	1
A	get_context()	0	17	1
A	process_shortcode()	0	12	2
A	get_view_uri()	0	7	3
A	set_view_uri()	0	3	1
A	is_submitting_form()	0	3	1
A	render()	0	9	2
A	get_optin_form()	0	7	2
A	handle_submission()	0	10	3
A	exception_to_string()	0	7	1

<?php
/**
 * YIKES Inc. Easy Forms.
 *
 * @package   YIKES\EasyForms
 * @author    Freddie Mixell
 * @license   GPL2
 */

namespace YIKES\EasyForms\Shortcode;

use YIKES\EasyForms\Asset;
use YIKES\EasyForms\AssetAware;
use YIKES\EasyForms\ScriptAsset;
use YIKES\EasyForms\StyleAsset;
use YIKES\EasyForms\Exception;
use YIKES\EasyForms\View\FormEscapedView;
use YIKES\EasyForms\View\NoOverrideLocationView;
use YIKES\EasyForms\Form\OptinForm as EasyForm;
use YIKES\EasyForms\Model\Subscriber;
use YIKES\EasyForms\Model\SubscriberRepository;
use YIKES\EasyForms\Model\OptinForm as EasyFormsModel;
use YIkes\EasyForms\Model\OptinFormRepository;

/**
 * Class EasyFormsShortcode
 *
 * @since %VERSION%
 * @package YIKES\EasyForms
 */

final class EasyFormsShortcode extends BaseShortcode {

    const TAG           = 'yikes-mailchimp';
	const VIEW_URI      = 'views/easy-forms-shortcode';
	const SUBMITTED_URI = 'views/easy-forms-shortcode-completed';

	/**
	 * Whether a form has been submitted.
	 *
	 * @since %VERSION%
	 * @var bool
	 */
	private $is_submitted = false;

	/**
	 * The view URI to use.
	 *
	 * This property is used so that the view can be switched dynamically
	 * as needed.
	 *
	 * @since %VERSION%
	 * @var string
	 */
    private $view_uri = self::VIEW_URI;
    
    /**
	 * Register the Shortcode.
	 *
	 * @since %VERSION%
	 */
	public function register() {
		parent::register();
		add_action( 'easy_forms_do_shortcode', function( $atts ) {
			echo $this->process_shortcode( $atts ); // phpcs:ignore WordPress.Security.EscapeOutput
		} );
    }
    
    /**
	 * Get the default array of attributes for the shortcode.
	 *
	 * @since %VERSION%
	 * @return array
	 */
	public function get_default_atts() {
		return [
			'form'                       => '',
			'submit'                     => '',
			'title'                      => '0',
			'custom_title'               => '',
			'description'                => '0',
			'custom_description'         => '',
			'ajax'                       => '',
			'recaptcha'                  => '', // manually set googles recptcha state
			'recaptcha_lang'             => '', // manually set the recaptcha language in the shortcode - also available is the yikes-mailchimp-recaptcha-language filter
			'recaptcha_type'             => '', // manually set the recaptcha type - audio/image - default image
			'recaptcha_theme'            => '', // manually set the recaptcha theme - light/dark - default light
			'recaptcha_size'             => '', // set the recaptcha size - normal/compact - default normal
			'recaptcha_data_callback'    => '', // set a custom js callback function to run after a successful recaptcha response - default none
			'recaptcha_expired_callback' => '', // set a custom js callback function to run after the recaptcha has expired - default none
			'inline'                     => '0',
		];
	}

	/**
	 * Get the context to pass onto the view.
	 *
	 * Override to provide data to the view that is not part of the shortcode
	 * attributes.
	 *
	 * @since %VERSION%
	 *
	 * @param array $atts Array of shortcode attributes.
	 *
	 * @return array Context to pass onto view.
	 * @throws InvalidPostID When the post ID is not valid.
	 */
	protected function get_context( array $atts ) {
		$optin_form = ( new OptinFormRepository() )->find( $atts['form'] );
		/** @todo Recaptcha Settings. */
		$this->is_submitted = $this->is_submitting_form();
		// Set up the classes we'll use for the form and the individual fields.
		$form_classes = $optin_form['form_settings']['yikes-easy-mc-form-class-names'];

		// Set up the form object.
		$form = $this->get_optin_form( $optin_form->get_id(), $optin_form, $field_classes );

The variable $field_classes does not exist. Did you forget to declare it?

$form is not used, you could remove the assignment.

		return [
			'form_settings' => $optin_form['form_settings'],
			'optin_form'    => $optin_form,
			'form_id'       => $optin_form->get_id(),
			'form_classes'  => $form_classes,
			'submitted'     => $this->is_submitted,
		];
	}

	/**
	 * Process the shortcode attributes and prepare rendering.
	 *
	 * @since %VERSION%
	 *
	 * @param array|string $atts Attributes as passed to the shortcode.
	 *
	 * @return string Rendered HTML of the shortcode.
	 */
	public function process_shortcode( $atts ) {
		try {
			// Determine if the form has been submitted.
			$this->is_submitted = $this->is_submitting_form();
			// Process the shortcode attributes.
			$atts    = $this->process_attributes( $atts );
			$context = $this->get_context( $atts );
			return $this->render( $context );
		} catch ( Exception $e ) {

The class YIKES\EasyForms\Exception does not exist. Did you forget a USE statement, or did you not list all dependencies?

			return $this->exception_to_string( $e );
		}
	}
    
   /**
	 * Get the View URI to use for rendering the shortcode.
	 *
	 * @since %VERSION%
	 *
	 * @return string View URI.
	 */
	protected function get_view_uri() {
		if ( self::VIEW_URI !== $uri && self::SUBMITTED_URI !== $uri ) {

The variable $uri does not exist. Did you forget to declare it?

			throw InvalidURI::from_list( $uri, [ self::VIEW_URI, self::SUBMITTED_URI ] );
		}

		return $this->view_uri;
    }
    
    /**
	 * Set the view URI.
	 *
	 * @since %VERSION%
	 *
	 * @param string $uri The URI to use.
	 */
	private function set_view_uri( $uri ) {
		$this->view_uri = $uri;
	}
	
	/**
	 * Determine whether a form is currently being submitted.
	 *
	 * @since %VERSION%
	 * @return bool
	 */
	private function is_submitting_form() {
		return ! empty( $_POST );
	}
    
    /**
	 * Render the current Renderable.
	 *
	 * @since %VERSION%
	 *
	 * @param array $context Context in which to render.
	 *
	 * @return string Rendered HTML.
	 */
	public function render( array $context = [] ) {
		try {
			$this->enqueue_assets();
			$view = new FormEscapedView( new NoOverrideLocationView( $this->get_view_uri() ) );
			return $view->render( $context );
		} catch ( \Exception $e ) {
			return $this->exception_to_string( $e );
		}
	}
	
	/**
	 * Get the form object.
	 *
	 * @since %VERSION%
	 *
	 * @param int              $form_id       The ID for the form.
	 * @param EasyFormsModel   $form   The form Object.
	 * @param array            $field_classes The classes for fields in the form.
	 *
	 * @return EasyForm
	 */
	private function get_optin_form( $form_id, $form, $field_classes ) {
		$form = new EasyForm( $form_id, $form, $field_classes );
		if ( $this->is_submitted ) {
			$this->handle_submission( $form );
		}
		return $form;
	}

	/**
	 * Handle the form submission.
	 *
	 * @since %VERSION%
	 *
	 * @param EasyForm $form The form object.
	 *
	 * @return Subscriber|null Returns a new Subscriber object, or null if one was not created.
	 * @throws InvalidURI When an invalid URI is set for the view.
	 */
	private function handle_submission( EasyForm $form ) {
		$form->set_submission( $_POST );
		$form->validate_submission();
		// Maybe update the view URI.
		if ( ! $form->has_errors() ) {
			$this->set_view_uri( self::SUBMITTED_URI );
			$subscriber = ( new SubscriberRepository() )->create_from_form( $form );
		}
		return isset( $subscriber ) ? $subscriber : null;
	}
    
    /**
	 * Convert an exception to a string.
	 *
	 * @since %VERSION%
	 *
	 * @param \Exception $e The exception object.
	 *
	 * @return string
	 */
	private function exception_to_string( \Exception $e ) {
		return sprintf(
			/* translators: %s refers to the error message */
			esc_html__( 'There was an error displaying the form: %s', 'easy-forms-text-domain' ),
			$e->getMessage()
		);
	}
}