OwlCyberSecurity - MANAGER

Edit File: class-addon-poll-hooks-abstract.php

<?php
/**
 * The Forminator_Addon_Poll_Hooks_Abstract class.
 *
 * @package Forminator
 */

/**
 * Class Forminator_Addon_Poll_Hooks_Abstract
 * Any change(s) to this file is subject to:
 * - Properly Written DocBlock! (what is this, why is that, how to be like those, etc, as long as you want!)
 * - Properly Written Changelog!
 *
 * If you override any of these method, please add necessary hooks in it,
 * Which you can see below, as a reference and keep the arguments signature.
 * If needed you can call these method, as parent::method_name(),
 * and add your specific hooks.
 *
 * @since 1.6.1
 */
abstract class Forminator_Addon_Poll_Hooks_Abstract extends Forminator_Addon_Hooks_Abstract {

/**
	 * Addon Instance
	 *
	 * @since 1.6.1
	 * @var Forminator_Addon_Abstract
	 */
	protected $addon;

/**
	 * Current Poll ID
	 *
	 * @since 1.6.1
	 * @var int
	 */
	protected $poll_id;

/**
	 * Customizable submit poll error message
	 *
	 * @since 1.6.1
	 * @var string
	 */
	protected $_submit_poll_error_message = '';

/**
	 * Poll settings instance
	 *
	 * @since 1.6.1
	 * @var Forminator_Addon_Poll_Settings_Abstract|null
	 */
	protected $poll_settings_instance;

/**
	 * Poll Model
	 *
	 * @since 1.6.1
	 * @var Forminator_Poll_Model
	 */
	protected $poll;

/**
	 * Forminator_Addon_Poll_Hooks_Abstract constructor.
	 *
	 * @param Forminator_Addon_Abstract $addon Class Forminator_Addon_Abstract.
	 * @param int                       $poll_id Poll Id.
	 *
	 * @since 1.6.1
	 * @throws Forminator_Addon_Exception When there is an addon error.
	 */
	public function __construct( Forminator_Addon_Abstract $addon, $poll_id ) {
		$this->addon   = $addon;
		$this->poll_id = $poll_id;
		$this->poll    = Forminator_Base_Form_Model::get_model( $this->poll_id );
		if ( ! $this->poll ) {
			/* translators: Poll ID */
			throw new Forminator_Addon_Exception( sprintf( esc_html__( 'Poll with id %d could not be found', 'forminator' ), esc_html( $this->poll_id ) ) );
		}

$this->_submit_poll_error_message = esc_html__( 'Failed to submit poll because of an addon, please check your poll and try again', 'forminator' );

// get poll settings instance to be available throughout cycle.
		$this->poll_settings_instance = $this->addon->get_addon_settings( $this->poll_id, 'poll' );
	}

/**
	 * Override this function to execute action before fields rendered
	 *
	 * If function generate output, it will output-ed,
	 * race condition between addon probably happen.
	 * Its void function, so return value will be ignored, and forminator process will always continue,
	 * unless it generates unrecoverable error, so please be careful on extending this function.
	 * If you want to `wp_enqueue_script` this might be the best place.
	 *
	 * @since 1.6.1
	 */
	public function on_before_render_poll_fields() {
		$addon_slug             = $this->addon->get_slug();
		$poll_id                = $this->poll_id;
		$poll_settings_instance = $this->poll_settings_instance;

/**
		 * Fires before poll fields rendered by forminator
		 *
		 * Although it can be used for all addon.
		 * Please keep in mind that if the addon override this method,
		 * then this action won't be triggered.
		 * To be sure please check individual addon documentations.
		 *
		 * @since 1.6.1
		 *
		 * @param int                                          $poll_id                current Poll ID.
		 * @param Forminator_Addon_Poll_Settings_Abstract|null $poll_settings_instance of Addon Poll Settings.
		 */
		do_action(
			'forminator_addon_' . $addon_slug . '_on_before_render_poll_fields',
			$poll_id,
			$poll_settings_instance
		);
	}

/**
	 * Override this function to execute action after all poll fields rendered
	 *
	 * If function generate output, it will output-ed
	 * race condition between addon probably happen
	 * its void function, so return value will be ignored, and forminator process will always continue
	 * unless it generates unrecoverable error, so please be careful on extending this function
	 *
	 * @since 1.6.1
	 */
	public function on_after_render_poll_fields() {
		$addon_slug             = $this->addon->get_slug();
		$poll_id                = $this->poll_id;
		$poll_settings_instance = $this->poll_settings_instance;

/**
		 * Fires when addon rendering extra output after connected poll fields rendered
		 *
		 * Although it can be used for all addon.
		 * Please keep in mind that if the addon override this method,
		 * then this action won't be triggered.
		 * To be sure please check individual addon documentations.
		 *
		 * @since 1.6.1
		 *
		 * @param int                                          $poll_id                current Form ID.
		 * @param Forminator_Addon_Form_Settings_Abstract|null $poll_settings_instance of Addon Poll Settings.
		 */
		do_action(
			'forminator_addon_' . $addon_slug . '_on_after_render_poll_fields',
			$poll_id,
			$poll_settings_instance
		);
	}

/**
	 * Override this function to execute action after html markup poll rendered completely
	 *
	 * If function generate output, it will output-ed
	 * race condition between addon probably happen
	 * its void function, so return value will be ignored, and forminator process will always continue
	 * unless it generates unrecoverable error, so please be careful on extending this function
	 *
	 * @since 1.6.1
	 */
	public function on_after_render_poll() {
		$addon_slug             = $this->addon->get_slug();
		$poll_id                = $this->poll_id;
		$poll_settings_instance = $this->poll_settings_instance;

/**
		 * Fires when connected poll completely rendered
		 *
		 * Although it can be used for all addon.
		 * Please keep in mind that if the addon override this method,
		 * then this action won't be triggered.
		 * To be sure please check individual addon documentations.
		 *
		 * @since 1.6.1
		 *
		 * @param int                                          $poll_id                current Poll ID.
		 * @param Forminator_Addon_Poll_Settings_Abstract|null $poll_settings_instance of Addon Poll Settings.
		 */
		do_action(
			'forminator_addon_' . $addon_slug . '_on_after_render_poll',
			$poll_id,
			$poll_settings_instance
		);
	}

/**
	 * Override this function to execute action on submit poll
	 *
	 * Return true will continue forminator process,
	 * return false will stop forminator process,
	 * and display error message to user @see Forminator_Addon_Poll_Hooks_Abstract::get_submit_poll_error_message()
	 *
	 * @since 1.6.1
	 *
	 * @param array $submitted_data Submitted data.
	 *
	 * @return bool
	 */
	public function on_poll_submit( $submitted_data ) {
		$addon_slug             = $this->addon->get_slug();
		$poll_id                = $this->poll_id;
		$poll_settings_instance = $this->poll_settings_instance;

/**
		 * Filter submitted poll data to be processed by addon
		 *
		 * Although it can be used for all addon.
		 * Please keep in mind that if the addon override this method,
		 * then this filter won't be applied.
		 * To be sure please check individual addon documentations.
		 *
		 * @since 1.6.1
		 *
		 * @param array                                        $submitted_data
		 * @param int                                          $poll_id                current Poll ID.
		 * @param Forminator_Addon_Poll_Settings_Abstract|null $poll_settings_instance Addon Poll Settings instance.
		 */
		$submitted_data = apply_filters(
			'forminator_addon_' . $addon_slug . '_poll_submitted_data',
			$submitted_data,
			$poll_id,
			$poll_settings_instance
		);

$is_success = true;
		/**
		 * Filter result of poll submit
		 *
		 * Return `true` if success, or **(string) error message** on fail
		 * Although it can be used for all addon.
		 * Please keep in mind that if the addon override this method,
		 * then this filter won't be applied.
		 * To be sure please check individual addon documentations.
		 *
		 * @since 1.6.1
		 *
		 * @param bool                                         $is_success
		 * @param int                                          $poll_id                current Poll ID.
		 * @param array                                        $submitted_data
		 * @param Forminator_Addon_Poll_Settings_Abstract|null $poll_settings_instance Addon Poll Settings instance.
		 */
		$is_success = apply_filters(
			'forminator_addon_' . $addon_slug . '_on_poll_submit_result',
			$is_success,
			$poll_id,
			$submitted_data,
			$poll_settings_instance
		);

// process filter.
		if ( true !== $is_success ) {
			// only update `_submit_poll_error_message` when not empty.
			if ( ! empty( $is_success ) ) {
				$this->_submit_poll_error_message = (string) $is_success;
			}

return $is_success;
		}

return $is_success;
	}

/**
	 * Override this function to add another entry field to storage
	 *
	 * Return an multi array with format (at least, or it will be skipped)
	 * [
	 *  'name' => NAME,
	 *  'value' => VALUE', => can be array/object/scalar, it will serialized on storage
	 * ],
	 * [
	 *  'name' => NAME,
	 *  'value' => VALUE'
	 * ]
	 *
	 * @since          1.6.1
	 *
	 * @param array $submitted_data Submitted data.
	 * @param array $current_entry_fields Current entry fields.
	 *
	 * @return array
	 */
	public function add_entry_fields( $submitted_data, $current_entry_fields = array() ) {
		$addon_slug             = $this->addon->get_slug();
		$poll_id                = $this->poll_id;
		$poll_settings_instance = $this->poll_settings_instance;

$poll_entry_fields = $current_entry_fields;

/**
		 * Filter current entry fields of poll to be processed by addon
		 *
		 * Although it can be used for all addon.
		 * Please keep in mind that if the addon override this method,
		 * then this filter won't be applied.
		 * To be sure please check individual addon documentations.
		 *
		 * @since 1.6.1
		 *
		 * @param array                                        $poll_entry_fields
		 * @param array                                        $submitted_data
		 * @param int                                          $poll_id                current Poll ID.
		 * @param Forminator_Addon_Poll_Settings_Abstract|null $poll_settings_instance Addon Form Settings instance.
		 */
		$poll_entry_fields = apply_filters(
			'forminator_addon_' . $addon_slug . '_poll_entry_fields',
			$poll_entry_fields,
			$submitted_data,
			$poll_id,
			$poll_settings_instance
		);

$entry_fields = array();
		/**
		 * Filter addon entry fields to be saved to entry model
		 *
		 * @since 1.6.1
		 *
		 * @param array                                        $entry_fields
		 * @param int                                          $poll_id                current Poll ID.
		 * @param array                                        $submitted_data
		 * @param Forminator_Addon_Poll_Settings_Abstract|null $poll_settings_instance Addon Poll Settings instance.
		 * @param array                                        $poll_entry_fields      Current entry fields of the poll.
		 */
		$entry_fields = apply_filters(
			'forminator_addon_poll_' . $addon_slug . '_entry_fields',
			$entry_fields,
			$poll_id,
			$submitted_data,
			$poll_settings_instance,
			$poll_entry_fields
		);

return $entry_fields;
	}

/**
	 * Override this function to execute action after entry saved
	 *
	 * Its void function, so return value will be ignored, and forminator process will always continue
	 * unless it generates unrecoverable error, so please be careful on extending this function
	 *
	 * @since 1.6.1
	 *
	 * @param Forminator_Form_Entry_Model $entry_model Form entry model.
	 */
	public function after_entry_saved( Forminator_Form_Entry_Model $entry_model ) {
		$addon_slug             = $this->addon->get_slug();
		$poll_id                = $this->poll_id;
		$poll_settings_instance = $this->poll_settings_instance;

/**
		 * Fires when entry already saved on db
		 *
		 * Although it can be used for all addon.
		 * Please keep in mind that if the addon override this method,
		 * then this filter probably won't be applied.
		 * To be sure please check individual addon documentations.
		 *
		 * @since 1.6.1
		 *
		 * @param int                                          $poll_id                current Poll ID.
		 * @param Forminator_Form_Entry_Model                  $entry_model            Forminator Entry Model.
		 * @param Forminator_Addon_Poll_Settings_Abstract|null $poll_settings_instance of Addon Poll Settings.
		 */
		do_action(
			'forminator_addon_poll_' . $addon_slug . '_after_entry_saved',
			$poll_id,
			$entry_model,
			$poll_settings_instance
		);
	}

// **.
	// * Override this function to display another sub-row on entry detail.
	// *
	// * Return a multi array with this format (at least, or it will skipped).
	// * [.
	// *  'label' => LABEL,.
	// *  'value' => VALUE (string) => its output is on html mode, so you can do styling, but please don't forgot to escape its html when needed.
	// * ],.
	// * [.
	// *  'label' => LABEL,.
	// *  'value' => VALUE.
	// * ].
	// *
	// * @since 1.1.
	// *
	// * @param Forminator_Form_Entry_Model $entry_model.
	// * @param     array                   $addon_meta_data specific meta_data that added by current addon from @see: add_entry_fields().
	// *
	// * @return array.
	// */.
	// public function on_render_entry( Forminator_Form_Entry_Model $entry_model, $addon_meta_data ) {.
	// $addon_slug             = $this->addon->get_slug();.
	// $form_id                = $this->poll_id;.
	// $form_settings_instance = $this->poll_settings_instance;.
	//
	// **.
	// *
	// * Filter addon metadata that previously saved on db to be processed.
	// *
	// * Although it can be used for all addon.
	// * Please keep in mind that if the addon override this method,.
	// * then this filter probably won't be applied.
	// * To be sure please check individual addon documentations.
	// *
	// * @since 1.1.
	// *
	// * @param array                                        $addon_meta_data.
	// * @param int                                          $form_id                current Form ID.
	// * @param Forminator_Form_Entry_Model                  $entry_model            Forminator Entry Model.
	// * @param Forminator_Addon_Form_Settings_Abstract|null $form_settings_instance of Addon Form Settings.
	// */.
	// $addon_meta_data = apply_filters(.
	// 'forminator_addon_' . $addon_slug . '_metadata',.
	// $addon_meta_data,.
	// $form_id,.
	// $entry_model,.
	// $form_settings_instance.
	// );.
	//
	//
	// $entry_items = array();.
	// **.
	// * Filter mailchimp row(s) to be displayed on entries page.
	// *
	// * Although it can be used for all addon.
	// * Please keep in mind that if the addon override this method,.
	// * then this filter probably won't be applied.
	// * To be sure please check individual addon documentations.
	// *
	// * @since 1.1.
	// *
	// * @param array                                        $entry_items            row(s) to be displayed on entries page.
	// * @param int                                          $form_id                current Form ID.
	// * @param Forminator_Form_Entry_Model                  $entry_model            Form Entry Model.
	// * @param array                                        $addon_meta_data        meta data saved by addon on entry fields.
	// * @param Forminator_Addon_Form_Settings_Abstract|null $form_settings_instance of Addon Form Settings.
	// */.
	// $entry_items = apply_filters(.
	// 'forminator_addon_' . $addon_slug . '_entry_items',.
	// $entry_items,.
	// $form_id,.
	// $entry_model,.
	// $addon_meta_data,.
	// $form_settings_instance.
	// );.
	//
	//
	// return $entry_items;.
	// }

/**
	 * Override this function to Add another Column on title Row
	 *
	 * This TITLE_ID will be referenced on @see Forminator_Addon_Poll_Hooks_Abstract::on_export_render_entry_row()
	 *
	 * @example
	 * {
	 *         TITLE_ID_1 => 'TITLE 1',
	 *         TITLE_ID_2 => 'TITLE 2',
	 *         TITLE_ID_3 => 'TITLE 3',
	 * }
	 *
	 * @since 1.6.1
	 * @return array
	 */
	public function on_export_render_title_row() {
		$addon_slug             = $this->addon->get_slug();
		$poll_id                = $this->poll_id;
		$poll_settings_instance = $this->poll_settings_instance;

$export_headers = array();
		/**
		 * Filter addon headers on export file
		 *
		 * Although it can be used for all addon.
		 * Please keep in mind that if the addon override this method,
		 * then this filter probably won't be applied.
		 * To be sure please check individual addon documentations.
		 *
		 * @since 1.6.1
		 *
		 * @param array                                        $export_headers         headers to be displayed on export file.
		 * @param int                                          $poll_id                current poll ID.
		 * @param Forminator_Addon_Poll_Settings_Abstract|null $poll_settings_instance of Addon Poll Settings.
		 */
		$export_headers = apply_filters(
			'forminator_addon_poll_' . $addon_slug . '_export_headers',
			$export_headers,
			$poll_id,
			$poll_settings_instance
		);

return $export_headers;
	}

/**
	 * Add Additional Column on entry row,
	 *
	 * Use TITLE_ID from @see Forminator_Addon_Poll_Hooks_Abstract::on_export_render_title_row()
	 *
	 * @example
	 * {
	 *   'TITLE_ID_1' => 'VALUE OF TITLE_1',
	 *   'TITLE_ID_2' => 'VALUE OF TITLE_2',
	 *   'TITLE_ID_3' => 'VALUE OF TITLE_3',
	 * }
	 *
	 * @since 1.6.1
	 *
	 * @param Forminator_Form_Entry_Model $entry_model Form entry model.
	 * @param array                       $addon_meta_data Addon meta.
	 *
	 * @return array
	 */
	public function on_export_render_entry( Forminator_Form_Entry_Model $entry_model, $addon_meta_data ) {
		$addon_slug             = $this->addon->get_slug();
		$poll_id                = $this->poll_id;
		$poll_settings_instance = $this->poll_settings_instance;

/**
		 *
		 * Filter addon metadata that previously saved on db to be processed
		 *
		 * Although it can be used for all addon.
		 * Please keep in mind that if the addon override this method,
		 * then this filter probably won't be applied.
		 * To be sure please check individual addon documentations.
		 *
		 * @since 1.6.1
		 *
		 * @param array                                        $addon_meta_data
		 * @param int                                          $poll_id                current poll ID.
		 * @param Forminator_Form_Entry_Model                  $entry_model            Forminator Entry Model.
		 * @param Forminator_Addon_Poll_Settings_Abstract|null $poll_settings_instance of Addon Poll Settings.
		 */
		$addon_meta_data = apply_filters(
			'forminator_addon_poll_' . $addon_slug . '_metadata',
			$addon_meta_data,
			$poll_id,
			$entry_model,
			$poll_settings_instance
		);

$export_columns = array();

/**
		 * Filter addon columns to be displayed on export submissions
		 *
		 * Although it can be used for all addon.
		 * Please keep in mind that if the addon override this method,
		 * then this filter probably won't be applied.
		 * To be sure please check individual addon documentations.
		 *
		 * @since 1.6.1
		 *
		 * @param array                                        $export_columns         column to be exported.
		 * @param int                                          $poll_id                current Poll ID.
		 * @param Forminator_Form_Entry_Model                  $entry_model            Form Entry Model.
		 * @param array                                        $addon_meta_data        meta data saved by addon on entry fields.
		 * @param Forminator_Addon_Poll_Settings_Abstract|null $poll_settings_instance of Addon Poll Settings.
		 */
		$export_columns = apply_filters(
			'forminator_addon_poll_' . $addon_slug . '_export_columns',
			$export_columns,
			$poll_id,
			$entry_model,
			$addon_meta_data,
			$poll_settings_instance
		);

return $export_columns;
	}

/**
	 * Get Submit poll error message
	 *
	 * @since 1.6.1
	 * @return string
	 */
	public function get_submit_poll_error_message() {
		$addon_slug             = $this->addon->get_slug();
		$poll_id                = $this->poll_id;
		$poll_settings_instance = $this->poll_settings_instance;

$error_message = $this->_submit_poll_error_message;
		/**
		 * Filter addon columns to be displayed on export submissions
		 *
		 * Although it can be used for all addon.
		 * Please keep in mind that if the addon override this method,
		 * then this filter probably won't be applied.
		 * To be sure please check individual addon documentations.
		 *
		 * @since 1.6.1
		 *
		 * @param array                                        $export_columns         column to be exported.
		 * @param int                                          $poll_id                current poll ID.
		 * @param Forminator_Addon_Poll_Settings_Abstract|null $poll_settings_instance of Addon Poll Settings.
		 */
		$error_message = apply_filters(
			'forminator_addon_' . $addon_slug . '_submit_poll_error_message',
			$error_message,
			$poll_id,
			$poll_settings_instance
		);

return $error_message;
	}

/**
	 * Override this function to execute action before submission deleted
	 *
	 * If function generate output, it will output-ed
	 * race condition between addon probably happen
	 * its void function, so return value will be ignored, and forminator process will always continue
	 * unless it generates unrecoverable error, so please be careful on extending this function
	 *
	 * @since 1.6.1
	 *
	 * @param Forminator_Form_Entry_Model $entry_model Form entry model.
	 * @param array                       $addon_meta_data Addon meta data.
	 */
	public function on_before_delete_entry( Forminator_Form_Entry_Model $entry_model, $addon_meta_data ) {
		$addon_slug             = $this->addon->get_slug();
		$poll_id                = $this->poll_id;
		$poll_settings_instance = $this->poll_settings_instance;

/**
		 *
		 * Filter addon metadata that previously saved on db to be processed
		 *
		 * Although it can be used for all addon.
		 * Please keep in mind that if the addon override this method,
		 * then this filter probably won't be applied.
		 * To be sure please check individual addon documentations.
		 *
		 * @since 1.6.1
		 *
		 * @param array                                        $addon_meta_data
		 * @param int                                          $poll_id                current Poll ID.
		 * @param Forminator_Form_Entry_Model                  $entry_model            Forminator Entry Model.
		 * @param Forminator_Addon_Poll_Settings_Abstract|null $poll_settings_instance of Addon Poll Settings.
		 */
		$addon_meta_data = apply_filters(
			'forminator_addon_poll_' . $addon_slug . '_metadata',
			$addon_meta_data,
			$poll_id,
			$entry_model,
			$poll_settings_instance
		);

/**
		 * Fires when connected poll delete a submission
		 *
		 * Although it can be used for all addon.
		 * Please keep in mind that if the addon override this method,
		 * then this action won't be triggered.
		 * To be sure please check individual addon documentations.
		 *
		 * @since 1.6.1
		 *
		 * @param int                                          $poll_id                current Poll ID.
		 * @param Forminator_Form_Entry_Model                  $entry_model            Forminator Entry Model.
		 * @param array                                        $addon_meta_data        addon meta data.
		 * @param Forminator_Addon_Poll_Settings_Abstract|null $poll_settings_instance of Addon Poll Settings.
		 */
		do_action(
			'forminator_addon_poll_' . $addon_slug . '_on_before_delete_submission',
			$poll_id,
			$entry_model,
			$addon_meta_data,
			$poll_settings_instance
		);
	}

/**
	 * Get Addon meta data, will be recursive if meta data is multiple because of multiple connection added
	 *
	 * @since 1.6.1
	 *
	 * @param array  $addon_meta_data Addon meta data.
	 * @param string $key Key.
	 * @param string $default_value Default value.
	 *
	 * @return string
	 */
	protected function get_from_addon_meta_data( $addon_meta_data, $key, $default_value = '' ) {
		$addon_meta_datas = $addon_meta_data;
		if ( ! isset( $addon_meta_data[0] ) || ! is_array( $addon_meta_data[0] ) ) {
			return $default_value;
		}

$addon_meta_data = $addon_meta_data[0];

// make sure its `status`, because we only add this.
		if ( 'status' !== $addon_meta_data['name'] ) {
			if ( stripos( $addon_meta_data['name'], 'status-' ) === 0 ) {
				$meta_data = array();
				foreach ( $addon_meta_datas as $addon_meta_data ) {
					// make it like single value so it will be processed like single meta data.
					$addon_meta_data['name'] = 'status';

// add it on an array for next recursive process.
					$meta_data[] = $this->get_from_addon_meta_data( array( $addon_meta_data ), $key, $default_value );
				}

return implode( ', ', $meta_data );
			}

return $default_value;

}

if ( ! isset( $addon_meta_data['value'] ) || ! is_array( $addon_meta_data['value'] ) ) {
			return $default_value;
		}
		$status = $addon_meta_data['value'];
		if ( isset( $status[ $key ] ) ) {
			$connection_name = '';
			if ( 'connection_name' !== $key ) {
				if ( isset( $status['connection_name'] ) ) {
					$connection_name = '[' . $status['connection_name'] . '] ';
				}
			}

return $connection_name . $status[ $key ];
		}

return $default_value;
	}
}