class-field-updated-trigger.php

<?php

use FluentCrm\App\Services\Funnel\BaseTrigger;
use FluentCrm\App\Services\Funnel\FunnelHelper;
use FluentCrm\App\Services\Funnel\FunnelProcessor;
use FluentCrm\Framework\Support\Arr;

class Field_Updated_Trigger extends BaseTrigger {

	/**
	 * Get things started.
	 *
	 * @since 1.0.0
	 */
	public function __construct() {

		$this->{'triggerName'}  = 'fluentcrm_contact_custom_data_updated';
		$this->{'priority'}     = 15;
		$this->{'actionArgNum'} = 3;
		parent::__construct();
	}

	/**
	 * Defines the trigger.
	 *
	 * @since 1.0.0
	 */
	public function getTrigger() {
		return array(
			'category'    => __( 'CRM', 'fluentcampaign-pro' ),
			'label'       => __( 'A field is updated', 'fluentcampaign-pro' ),
			'description' => __( 'This funnel will start when a custom field is updated on a contact.', 'fluentcampaign-pro' ),
		);
	}

	/**
	 * Get the funnel setting defaults.
	 *
	 * @since 1.0.0
	 */
	public function getFunnelSettingsDefaults() {
		return array(
			'field_name'  => '',
			'update_type' => 'any',
			'field_value' => '',
			'run_muliple' => 'no',
		);
	}

	/**
	 * Adds the settings fields.
	 *
	 * @since 1.0.0
	 *
	 * @param FluentCrm\App\Models\Funnel $funnel The funnel.
	 */
	public function getSettingsFields( $funnel ) {

		$options = array();

		foreach ( fluentcrm_get_custom_contact_fields() as $field ) {

			$options[] = array(
				'id'    => $field['slug'],
				'title' => $field['label'],
			);

		}

		return array(
			'title'     => __( 'Field Updated', 'fluentcampaign-pro' ),
			'sub_title' => __( 'This Funnel will start when the selected custom field is updated for a contact.', 'fluentcampaign-pro' ),
			'fields'    => array(
				'field_name' => array(
					'type'        => 'select',
					'options'     => $options,
					'label'       => __( 'Field', 'fluentcampaign-pro' ),
					'placeholder' => __( 'Select a field', 'fluentcampaign-pro' ),
				),
			),
		);
	}

	/**
	 * Get the defaults for the funnel.
	 *
	 * @since 1.0.0
	 *
	 * @param FluentCrm\App\Models\Funnel $funnel The funnel.
	 */
	public function getFunnelConditionDefaults( $funnel ) {
		return array(
			'update_type'  => 'any',
			'run_multiple' => 'no',
		);
	}

	/**
	 * Get the conditional fields for the funnel.
	 *
	 * @since 1.0.0
	 *
	 * @param FluentCrm\App\Models\Funnel $funnel The funnel.
	 */
	public function getConditionFields( $funnel ) {

		return array(
			'update_type'  => array(
				'type'    => 'radio',
				'label'   => __( 'If the field changes to?', 'fluentcampaign-pro' ),
				'options' => array(
					array(
						'id'    => 'any',
						'title' => __( 'Any Value', 'fluentcampaign-pro' ),
					),
					array(
						'id'    => 'specific',
						'title' => __( 'A Specific Value', 'fluentcampaign-pro' ),
					),
				),
			),
			'field_value'  => array(
				'type'       => 'input-text',
				'label'      => __( 'Field Value', 'fluentcampaign-pro' ),
				'help'       => __( 'Enter the field value that must match to trigger the automation.', 'fluentcampaign-pro' ),
				'dependency' => array(
					'depends_on' => 'update_type',
					'operator'   => '=',
					'value'      => 'specific',
				),
			),
			'run_multiple' => array(
				'type'        => 'yes_no_check',
				'label'       => '',
				'check_label' => __( 'Restart the Automation Multiple times for a contact for this event. (Only enable if you want to restart automation for the same contact)', 'fluentcampaign-pro' ),
				'inline_help' => __( 'If you enable, then it will restart the automation for a contact even if the contact is already in the automation. Otherwise, It will just skip if already exist.', 'fluentcampaign-pro' ),
			),
		);
	}

	/**
	 * Handle the action.
	 *
	 * @since 1.0.0
	 *
	 * @param FluentCrm\App\Models\Funnel $funnel        The funnel.
	 * @param array                       $original_args The original arguments.
	 */
	public function handle( $funnel, $original_args ) {

		$subscriber   = $original_args[1];
		$updated_data = $original_args[2];

		$will_process = $this->isProcessable( $funnel, $subscriber, $updated_data );

		$will_process = apply_filters( 'fluentcrm_funnel_will_process_' . $this->{'triggerName'}, $will_process, $funnel, $subscriber, $original_args );

		if ( ! $will_process ) {
			return;
		}

		( new FunnelProcessor() )->startFunnelSequence(
			$funnel,
			array(),
			array(
				'source_trigger_name' => $this->{'triggerName'},
			),
			$subscriber
		);
	}

	/**
	 * Is the action processable?
	 *
	 * @since 1.0.0
	 *
	 * @param FluentCrm\App\Models\Funnel     $funnel       The funnel.
	 * @param FluentCrm\App\Models\Subscriber $subscriber   The subscriber.
	 * @param array                           $updated_data The updated custom fields.
	 * @return bool Whether or not the action is processable.
	 */
	private function isProcessable( $funnel, $subscriber, $updated_data ) {

		$field = Arr::get( $funnel->settings, 'field_name' );

		// Check if the correct field was updated.
		if ( ! array_key_exists( $field, $updated_data ) ) {
			return false;
		}

		$update_type = Arr::get( $funnel->conditions, 'update_type' );

		// Check if we're looking for a specific value match.
		if ( 'specific' === $update_type && Arr::get( $funnel->conditions, 'field_value' ) !== $updated_data[ $field ] ) {
			return false;
		}

		// check run_only_once.
		if ( $subscriber && FunnelHelper::ifAlreadyInFunnel( $funnel->id, $subscriber->id ) ) {

			if ( 'yes' === Arr::get( $funnel->conditions, 'run_multiple' ) ) {
				FunnelHelper::removeSubscribersFromFunnel( $funnel->id, array( $subscriber->id ) );
			} else {
				return false;
			}
		}

		return true;
	}
}