Payments
extends Task
in package
Payments Task
Table of Contents
- ACTIONED_OPTION = 'woocommerce_task_list_tracked_completed_actions'
- Name of the actioned option.
- ACTIVE_TASK_TRANSIENT = 'wc_onboarding_active_task'
- Name of the active task transient.
- COMPLETED_OPTION = 'woocommerce_task_list_tracked_completed_tasks'
- Option name of completed tasks.
- DISMISSED_OPTION = 'woocommerce_task_list_dismissed_tasks'
- Name of the dismiss option.
- SNOOZED_OPTION = 'woocommerce_task_list_remind_me_later_tasks'
- Name of the snooze option.
- $duration_to_ms : string
- Duration to millisecond mapping.
- $task_list : TaskList
- Parent task list.
- $is_complete_result : null
- Used to cache is_complete() method result.
- __construct() : mixed
- Constructor
- can_view() : bool
- Task visibility.
- convert_object_to_camelcase() : object
- Convert object keys to camelcase.
- dismiss() : bool
- Dismiss the task.
- get_action_label() : string
- Action label.
- get_action_url() : string
- The task action URL.
- get_additional_data() : array<string|int, mixed>
- Additional data to be passed to the front-end JS logic.
- get_additional_info() : string
- Additional info.
- get_badge() : string
- Badge.
- get_content() : string
- Content.
- get_id() : string
- ID.
- get_json() : array<string|int, mixed>
- Get the task as JSON.
- get_level() : string
- Level.
- get_list_id() : string
- Get the task list ID.
- get_parent_id() : string
- Parent ID.
- get_parent_option() : mixed|null
- Get custom option.
- get_parent_options() : array<string|int, mixed>
- Get task list options.
- get_record_view_event() : bool
- Check if should record event when task is viewed
- get_snoozed_until() : string
- Get the snoozed until datetime.
- get_time() : string
- Time.
- get_title() : string
- Title.
- has_gateways() : bool
- Check if the store has any enabled gateways.
- has_previously_completed() : bool
- Check if a task list has previously been marked as complete.
- has_providers_enabled_other_than_woopayments() : bool
- Check if the store has any enabled providers other than WooPayments.
- is_actioned() : bool
- Check if a task has been actioned.
- is_active() : mixed
- Check if this is the active task.
- is_always_accessible() : bool
- If a task is always accessible, relevant for when a task list is hidden but a task can still be viewed.
- is_complete() : bool
- Task completion.
- is_disabled() : bool
- Check if task is disabled.
- is_dismissable() : bool
- Check if a task is dismissable.
- is_dismissed() : bool
- Bool for task dismissal.
- is_snoozeable() : bool
- Check if a task is snoozeable.
- is_snoozed() : bool
- Bool for task snoozed.
- is_task_actioned() : bool
- Check if a provided task ID has been actioned.
- is_visited() : bool
- Check if the task has been visited.
- mark_actioned() : bool
- Mark a task as actioned. Used to verify an action has taken place in some tasks.
- possibly_track_completion() : void
- Track task completion if task is viewable and is complete.
- prefix_event() : string
- Prefix event for track event naming.
- record_tracks_event() : string
- Record a tracks event with the prefixed event name.
- set_active() : mixed
- Set this as the active task across page loads.
- snooze() : bool
- Snooze the task.
- sort() : int
- Sorting function for tasks.
- undo_dismiss() : bool
- Undo task dismissal.
- undo_snooze() : bool
- Undo task snooze.
- get_payments_extension_suggestions() : array<string|int, mixed>
- Get the list of payments extension suggestions as it is used on the Payments Settings page.
- get_payments_providers() : array<string|int, mixed>
- Get the list of payments providers as it is used on the Payments Settings page.
- get_payments_settings_country() : string
- Get the store's business registration country/location as it is used on the Payments Settings page.
- get_woopayments_provider() : array<string|int, mixed>|null
- Get the WooPayments provider details from the list used on the Payments Settings page.
- get_woopayments_suggestion() : array<string|int, mixed>|null
- Get the WooPayments payments extension suggestion details from the lists used on the Payments Settings page.
- has_online_gateways() : bool
- Check if the store has any enabled online gateways.
- has_providers_needing_setup_other_than_woopayments() : bool
- Check if any non-WooPayments providers need setup.
- has_woopayments_test_account() : bool
- Check if WooPayments is onboarded and has a test [drive] account.
- is_woopayments_active() : bool
- Check if the WooPayments plugin is active.
- is_woopayments_installed() : bool
- Check if the WooPayments plugin is installed.
- is_woopayments_onboarded() : bool
- Check if WooPayments is completely onboarded.
- is_woopayments_supported_country() : bool
- Check if the store is in a WooPayments-supported geography.
Constants
ACTIONED_OPTION
Name of the actioned option.
public
string
ACTIONED_OPTION
= 'woocommerce_task_list_tracked_completed_actions'
ACTIVE_TASK_TRANSIENT
Name of the active task transient.
public
string
ACTIVE_TASK_TRANSIENT
= 'wc_onboarding_active_task'
COMPLETED_OPTION
Option name of completed tasks.
public
string
COMPLETED_OPTION
= 'woocommerce_task_list_tracked_completed_tasks'
DISMISSED_OPTION
Name of the dismiss option.
public
string
DISMISSED_OPTION
= 'woocommerce_task_list_dismissed_tasks'
SNOOZED_OPTION
Name of the snooze option.
public
string
SNOOZED_OPTION
= 'woocommerce_task_list_remind_me_later_tasks'
Tags
Properties
$duration_to_ms
Duration to millisecond mapping.
protected
string
$duration_to_ms
= array('day' => DAY_IN_SECONDS * 1000, 'hour' => HOUR_IN_SECONDS * 1000, 'week' => WEEK_IN_SECONDS * 1000)
$task_list
Parent task list.
protected
TaskList
$task_list
$is_complete_result
Used to cache is_complete() method result.
private
null
$is_complete_result
= null
Methods
__construct()
Constructor
public
__construct([TaskList|null $task_list = null ]) : mixed
Parameters
- $task_list : TaskList|null = null
-
Parent task list.
Return values
mixed —can_view()
Task visibility.
public
can_view() : bool
Return values
bool —convert_object_to_camelcase()
Convert object keys to camelcase.
public
static convert_object_to_camelcase(array<string|int, mixed> $data) : object
Parameters
- $data : array<string|int, mixed>
-
Data to convert.
Return values
object —dismiss()
Dismiss the task.
public
dismiss() : bool
Return values
bool —get_action_label()
Action label.
public
get_action_label() : string
Return values
string —get_action_url()
The task action URL.
public
get_action_url() : string
Empty string means the JS logic will handle the task linking.
Return values
string —get_additional_data()
Additional data to be passed to the front-end JS logic.
public
get_additional_data() : array<string|int, mixed>
Primarily used to inform the behavior of the Payments task in the LYS context.
Return values
array<string|int, mixed> —get_additional_info()
Additional info.
public
get_additional_info() : string
Return values
string —get_badge()
Badge.
public
get_badge() : string
Return values
string —get_content()
Content.
public
get_content() : string
Return values
string —get_id()
ID.
public
get_id() : string
Return values
string —get_json()
Get the task as JSON.
public
get_json() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_level()
Level.
public
get_level() : string
Tags
Return values
string —get_list_id()
Get the task list ID.
public
get_list_id() : string
Return values
string —get_parent_id()
Parent ID.
public
get_parent_id() : string
Return values
string —get_parent_option()
Get custom option.
public
get_parent_option(string $option_name) : mixed|null
Parameters
- $option_name : string
-
name of custom option.
Return values
mixed|null —get_parent_options()
Get task list options.
public
get_parent_options() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_record_view_event()
Check if should record event when task is viewed
public
get_record_view_event() : bool
Return values
bool —get_snoozed_until()
Get the snoozed until datetime.
public
get_snoozed_until() : string
Tags
Return values
string —get_time()
Time.
public
get_time() : string
Return values
string —get_title()
Title.
public
get_title() : string
Return values
string —has_gateways()
Check if the store has any enabled gateways.
public
static has_gateways() : bool
Return values
bool —has_previously_completed()
Check if a task list has previously been marked as complete.
public
has_previously_completed() : bool
Return values
bool —has_providers_enabled_other_than_woopayments()
Check if the store has any enabled providers other than WooPayments.
public
has_providers_enabled_other_than_woopayments() : bool
Return values
bool —is_actioned()
Check if a task has been actioned.
public
is_actioned() : bool
Return values
bool —is_active()
Check if this is the active task.
public
is_active() : mixed
Return values
mixed —is_always_accessible()
If a task is always accessible, relevant for when a task list is hidden but a task can still be viewed.
public
is_always_accessible() : bool
Return values
bool —is_complete()
Task completion.
public
is_complete() : bool
Return values
bool —is_disabled()
Check if task is disabled.
public
is_disabled() : bool
Tags
Return values
bool —is_dismissable()
Check if a task is dismissable.
public
is_dismissable() : bool
Return values
bool —is_dismissed()
Bool for task dismissal.
public
is_dismissed() : bool
Return values
bool —is_snoozeable()
Check if a task is snoozeable.
public
is_snoozeable() : bool
Tags
Return values
bool —is_snoozed()
Bool for task snoozed.
public
is_snoozed() : bool
Tags
Return values
bool —is_task_actioned()
Check if a provided task ID has been actioned.
public
static is_task_actioned(string $id) : bool
Parameters
- $id : string
-
Task ID.
Return values
bool —is_visited()
Check if the task has been visited.
public
is_visited() : bool
Return values
bool —mark_actioned()
Mark a task as actioned. Used to verify an action has taken place in some tasks.
public
mark_actioned() : bool
Return values
bool —possibly_track_completion()
Track task completion if task is viewable and is complete.
public
possibly_track_completion() : void
Return values
void —prefix_event()
Prefix event for track event naming.
public
prefix_event(string $event_name) : string
Parameters
- $event_name : string
-
Event name.
Return values
string —record_tracks_event()
Record a tracks event with the prefixed event name.
public
record_tracks_event(string $event_name[, array<string|int, mixed> $args = array() ]) : string
Parameters
- $event_name : string
-
Event name.
- $args : array<string|int, mixed> = array()
-
Array of tracks arguments.
Return values
string — Prefixed event name.set_active()
Set this as the active task across page loads.
public
set_active() : mixed
Return values
mixed —snooze()
Snooze the task.
public
snooze([string $duration = 'day' ]) : bool
Parameters
- $duration : string = 'day'
-
Duration to snooze. day|hour|week.
Tags
Return values
bool —sort()
Sorting function for tasks.
public
static sort(Task $a, Task $b[, array<string|int, mixed> $sort_by = array() ]) : int
Parameters
- $a : Task
-
Task a.
- $b : Task
-
Task b.
- $sort_by : array<string|int, mixed> = array()
-
list of columns with sort order.
Return values
int —undo_dismiss()
Undo task dismissal.
public
undo_dismiss() : bool
Return values
bool —undo_snooze()
Undo task snooze.
public
undo_snooze() : bool
Tags
Return values
bool —get_payments_extension_suggestions()
Get the list of payments extension suggestions as it is used on the Payments Settings page.
private
get_payments_extension_suggestions() : array<string|int, mixed>
Return values
array<string|int, mixed> — The list of payments extension suggestions.get_payments_providers()
Get the list of payments providers as it is used on the Payments Settings page.
private
get_payments_providers() : array<string|int, mixed>
The list can include payments extension suggestions, the same as on the Payments Settings page.
Return values
array<string|int, mixed> — The list of payments providers.get_payments_settings_country()
Get the store's business registration country/location as it is used on the Payments Settings page.
private
get_payments_settings_country() : string
Return values
string — The business registration country/location code.get_woopayments_provider()
Get the WooPayments provider details from the list used on the Payments Settings page.
private
get_woopayments_provider() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null — The WooPayments provider details or null if not found.get_woopayments_suggestion()
Get the WooPayments payments extension suggestion details from the lists used on the Payments Settings page.
private
get_woopayments_suggestion() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null — The WooPayments suggestion details or null if not found.has_online_gateways()
Check if the store has any enabled online gateways.
private
has_online_gateways() : bool
Return values
bool —has_providers_needing_setup_other_than_woopayments()
Check if any non-WooPayments providers need setup.
private
has_providers_needing_setup_other_than_woopayments() : bool
Return values
bool —has_woopayments_test_account()
Check if WooPayments is onboarded and has a test [drive] account.
private
has_woopayments_test_account() : bool
Return values
bool —is_woopayments_active()
Check if the WooPayments plugin is active.
private
is_woopayments_active() : bool
Return values
bool —is_woopayments_installed()
Check if the WooPayments plugin is installed.
private
is_woopayments_installed() : bool
Return values
bool —is_woopayments_onboarded()
Check if WooPayments is completely onboarded.
private
is_woopayments_onboarded() : bool
Return values
bool —is_woopayments_supported_country()
Check if the store is in a WooPayments-supported geography.
private
is_woopayments_supported_country(string $country_code) : bool
Parameters
- $country_code : string
-
Country code to check. If not provided, uses store base country.