Class Gravity_Flow_Step_Feed_Add_On

Abstract class to be used for integration with Gravity Forms Feed Add-Ons. Extend this class to integrate any Gravity Forms Add-On that is built using the Feed-Add-On Framework.

Register your extending class using Gravity_Flow_Steps::register(). example: Gravity_Flow_Steps::register( new Gravity_Flow_Step_My_Feed_Add_On_Step() )

stdClass

Gravity_Flow_Step

Gravity_Flow_Step_Feed_Add_On

Abstract
Package: GravityFlow\Classes\Step\Feed\Add\On
Copyright: Copyright (c) 2015-2018, Steven Henty S.L.
License: GNU Public License
Since: 1.0
Located at

Methods summary
`public string`	# `get_feed_add_on_class_name( )` Returns the class name for the add-on. Returns the class name for the add-on. Returns string
`public boolean`	# `is_supported( )` Is this feed step supported on this server? Override to hide this step in the list of step types if the requirements are not met. Is this feed step supported on this server? Override to hide this step in the list of step types if the requirements are not met. Returns boolean Overrides `Gravity_Flow_Step::is_supported()`
`public array`	# `get_settings( )` Returns the settings for this step. Returns the settings for this step. Returns array Overrides `Gravity_Flow_Step::get_settings()`
`public boolean`	# `process( )` Processes this step. Processes this step. Returns boolean Is the step complete? Overrides `Gravity_Flow_Step::process()`
`public array\|mixed`	# `get_feeds( )` Returns the feeds for the add-on. Returns the feeds for the add-on. Returns array\|mixed
`public boolean`	# `process_feed( array $feed )` Processes the given feed for the add-on. Processes the given feed for the add-on. Parameters `$feed` The add-on feed properties. Returns boolean Is feed processing complete?
`public`	# `intercept_submission( )` Prevent the feeds assigned to the current step from being processed by the associated add-on. Prevent the feeds assigned to the current step from being processed by the associated add-on.
`public string`	# `get_feed_label( array $feed )` Returns the label of the given feed. Returns the label of the given feed. Parameters `$feed` The add-on feed properties. Returns string
`public boolean`	# `is_feed_condition_met( array $feed, array $form, array $entry )` Determines if the supplied feed should be processed. Determines if the supplied feed should be processed. Parameters `$feed` The current feed. `$form` The current form. `$entry` The current entry. Returns boolean
`public GFFeedAddOn`	# `get_add_on_instance( )` Retrieve an instance of the add-on associated with this step. Retrieve an instance of the add-on associated with this step. Returns GFFeedAddOn
`public array`	# `pre_process_feeds( array $feeds, array $entry )` Remove the feeds assigned to the current step from the array to be processed by the associated add-on. Remove the feeds assigned to the current step from the array to be processed by the associated add-on. Parameters `$feeds` An array of $feed objects for the add-on currently being processed. `$entry` The entry object currently being processed. Returns array
`public boolean`	# `is_active( )` Ensure active steps are not processed if the associated add-on is not available. Ensure active steps are not processed if the associated add-on is not available. Returns boolean Overrides `Gravity_Flow_Step::is_active()`
`public string`	# `get_slug( )` Get the slug for the add-on associated with this step. Get the slug for the add-on associated with this step. Returns string
`public array`	# `get_processed_feeds( boolean\|integer $entry_id = false )` Retrieve an array containing the IDs of all the feeds processed for the current entry. Retrieve an array containing the IDs of all the feeds processed for the current entry. Parameters `$entry_id` False or the ID of the entry the meta should be retrieved from. Returns array
`public array`	# `get_processed_add_on_feeds( boolean\|integer $entry_id = false )` Retrieve an array of this add-ons feed IDs which have been processed for the current entry. Retrieve an array of this add-ons feed IDs which have been processed for the current entry. Parameters `$entry_id` False or the ID of the entry the meta should be retrieved from. Returns array
`public array`	# `maybe_set_processed_feed( array $add_on_feeds, integer $feed_id )` Add the ID of the current feed to the processed feeds array for the current add-on. Add the ID of the current feed to the processed feeds array for the current add-on. Parameters `$add_on_feeds` The IDs of the processed feeds. `$feed_id` The ID of the processed feed. Returns array
`public array`	# `maybe_unset_processed_feed( array $add_on_feeds, integer $feed_id )` If necessary remove the current feed from the processed feeds array for the current add-on. If necessary remove the current feed from the processed feeds array for the current add-on. Parameters `$add_on_feeds` The IDs of the processed feeds. `$feed_id` The ID of the processed feed. Returns array
`public`	# `update_processed_feeds( array $add_on_feeds, boolean\|integer $entry_id = false )` Update the processed_feeds array for the current entry. Update the processed_feeds array for the current entry. Parameters `$add_on_feeds` The IDs of the processed feeds for the current add-on. `$entry_id` False or the ID of the entry the meta should be saved for.
`public string`	# `status_evaluation( )` Evaluates the status for the step. Evaluates the status for the step. The step is only complete when all the feeds for this step have been added to the entry meta processed_feeds array. Returns string 'pending' or 'complete' Overrides `Gravity_Flow_Step::status_evaluation()`

Methods inherited from Gravity_Flow_Step
__construct(), __get(), __isset(), __set(), __unset(), add_note(), assign(), can_set_workflow_status(), end(), end_if_complete(), entry_count(), entry_detail_status_box(), evaluate_routing_rule(), evaluate_status(), flush_assignees(), get_actions(), get_assignee(), get_assignee_args(), get_assignee_details(), get_assignee_keys(), get_assignees(), get_base_path(), get_base_url(), get_common_settings_api(), get_current_assignee_key(), get_current_assignee_status(), get_current_role_status(), get_editable_fields(), get_entry(), get_entry_id(), get_entry_meta(), get_entry_timestamp(), get_entry_url(), get_expiration_status_key(), get_expiration_timestamp(), get_feed_meta(), get_final_status_config(), get_form(), get_form_id(), get_icon_url(), get_id(), get_inbox_url(), get_label(), get_name(), get_next_step_id(), get_notification(), get_notification_assignees(), get_rest_base(), get_role_status(), get_schedule_timestamp(), get_setting(), get_status(), get_status_config(), get_status_key(), get_status_label(), get_status_timestamp_key(), get_step_timestamp(), get_timestamp_date(), get_timestamp_date_field(), get_timestamp_delay(), get_type(), get_user_status(), get_validation_result(), get_workflow_url_access_token(), gpdf_add_notification_attachment(), handle_rest_request(), is_assignee(), is_complete(), is_condition_met(), is_expired(), is_queued(), log_debug(), log_event(), maybe_add_assignee(), maybe_add_routing_assignees(), maybe_add_select_assignees(), maybe_add_user_note(), maybe_adjust_assignment(), maybe_filter_validation_result(), maybe_process_status_update(), maybe_process_token_action(), maybe_send_assignee_notification(), maybe_send_notification(), process_assignee_status(), purge_assignees(), refresh_entry(), remove_assignee(), replace_variables(), replace_workflow_cancel_variables(), replace_workflow_url_variables(), rest_callback(), rest_permission_callback(), restart_action(), send_assignee_notification(), send_notification(), send_notifications(), set_next_step_id(), start(), supports_expiration(), update_role_status(), update_step_status(), update_user_status(), validate_note(), validate_note_mode(), validate_schedule(), workflow_detail_box(), workflow_detail_status_box()

Properties summary
`protected string`	`$_class_name` The name of the class used by the add-on. Example: GFMailChimp. The name of the class used by the add-on. Example: GFMailChimp.	# `''`
`protected string`	`$_slug` The add-on slug. Example: gravityformsmailchimp. The add-on slug. Example: gravityformsmailchimp.	# `''`

Properties inherited from Gravity_Flow_Step
`$_assignees, $_next_step_id, $_rest_base, $_step_type`

Classes

Class Gravity_Flow_Step_Feed_Add_On

Returns

Returns

Overrides

Returns

Overrides

Returns

Overrides

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Overrides

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Overrides