Contracts
5 years ago
Enum
5 years ago
Events
5 years ago
Helpers
5 years ago
Repositories
5 years ago
TrackingData
4 years ago
AccessToken.php
5 years ago
AdminActionHandler.php
5 years ago
AdminSettings.php
5 years ago
TrackClient.php
5 years ago
TrackJob.php
5 years ago
TrackJobScheduler.php
5 years ago
TrackRegisterer.php
5 years ago
TrackingServiceProvider.php
5 years ago
UsageTrackingOnBoarding.php
4 years ago
UsageTrackingOnBoarding.php
134 lines
| 1 | <?php |
| 2 | namespace Give\Tracking; |
| 3 | |
| 4 | use Give\Onboarding\Setup\PageView; |
| 5 | use Give\Tracking\Repositories\Settings; |
| 6 | use Give_Admin_Settings; |
| 7 | |
| 8 | /** |
| 9 | * Class OnBoarding |
| 10 | * @package Give\Tracking |
| 11 | * |
| 12 | * This class uses to setup notice nag to website administrator if admin is not opt in for usage tracking and gives admin an option to directly opt-in. |
| 13 | * |
| 14 | * @since 2.10.0 |
| 15 | */ |
| 16 | class UsageTrackingOnBoarding { |
| 17 | /** |
| 18 | * @var Settings |
| 19 | */ |
| 20 | private $settings; |
| 21 | |
| 22 | /** |
| 23 | * UsageTrackingOnBoarding constructor. |
| 24 | * |
| 25 | * @param Settings $settings |
| 26 | */ |
| 27 | public function __construct( Settings $settings ) { |
| 28 | $this->settings = $settings; |
| 29 | } |
| 30 | |
| 31 | /** |
| 32 | * Register notice. |
| 33 | * |
| 34 | * @since 2.10.0 |
| 35 | */ |
| 36 | public function addNotice() { |
| 37 | if ( ! $this->canShowNotice() ) { |
| 38 | return; |
| 39 | } |
| 40 | |
| 41 | echo $this->getNotice( true ); |
| 42 | } |
| 43 | |
| 44 | /** |
| 45 | * Get option name of notice. |
| 46 | * |
| 47 | * We use this option key to disable notice nag for specific user for a interval. |
| 48 | * |
| 49 | * @since 2.10.0 |
| 50 | * @return string |
| 51 | */ |
| 52 | public function getNoticeOptionKey() { |
| 53 | return give()->notices->get_notice_key( 'usage-tracking-nag', 'permanent' ); |
| 54 | } |
| 55 | |
| 56 | /** |
| 57 | * Get notice. |
| 58 | * |
| 59 | * @param bool $wrapper |
| 60 | * |
| 61 | * @return string |
| 62 | * @since 2.10.0 |
| 63 | * |
| 64 | */ |
| 65 | public function getNotice( $wrapper = false ) { |
| 66 | /* @var PageView $pageView */ |
| 67 | $pageView = give()->make( PageView::class ); |
| 68 | |
| 69 | $notice = $pageView->render_template( |
| 70 | 'row-item', |
| 71 | [ |
| 72 | 'icon' => $pageView->image( 'hands-in.svg' ), |
| 73 | 'class' => ! $wrapper ? 'usage-tracking' : '', |
| 74 | 'icon_alt' => esc_html__( 'Anonymous usage tracking icon', 'give' ), |
| 75 | 'title' => esc_html__( 'Help GiveWP improve your fundraising experience', 'give' ), |
| 76 | 'description' => sprintf( |
| 77 | '%1$s<br><br><a href="https://go.givewp.com/plugin-optin" class="learn-more-link" target="_blank">%2$s</a>', |
| 78 | esc_html__( 'Can you help improve GiveWP? With your permission, the GiveWP team uses non-sensitive data from plugin users to optimize donation form conversion rates, increase average donation amounts, and streamline the fundraising experience. This data is never shared with any third party.', 'give' ), |
| 79 | esc_html__( 'Learn more about how GiveWP respects user and donor privacy while improving the plugin >', 'give' ) |
| 80 | ), |
| 81 | 'action' => sprintf( |
| 82 | '<a class="button" href="%1$s">%2$s</a><div class="sub-links"><a href="%3$s" title="%7$s">%4$s</a><a href="%5$s">%6$s</a></div>', |
| 83 | add_query_arg( [ 'give_action' => 'opt_in_into_tracking' ] ), |
| 84 | esc_html__( 'Glad to Help', 'give' ), |
| 85 | add_query_arg( [ 'give_action' => 'hide_opt_in_notice_shortly' ] ), |
| 86 | esc_html__( 'Not Right Now', 'give' ), |
| 87 | add_query_arg( [ 'give_action' => 'hide_opt_in_notice_permanently' ] ), |
| 88 | esc_html__( 'Dismiss Forever', 'give' ), |
| 89 | esc_html__( 'Disable notice for 48 hours', 'give' ) |
| 90 | ), |
| 91 | ] |
| 92 | ); |
| 93 | |
| 94 | return $wrapper ? sprintf( '<div class="usage-tracking notice"><section><main>%1$s</main></section></div>', $notice ) : $notice; |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Return whether or not user can see notice. |
| 99 | * |
| 100 | * @since 2.10.0 |
| 101 | */ |
| 102 | public function canShowNotice() { |
| 103 | if ( ! current_user_can( 'manage_give_settings' ) ) { |
| 104 | return false; |
| 105 | } |
| 106 | |
| 107 | $section = isset( $_GET['section'] ) ? 'advanced-options' : ''; |
| 108 | if ( Give_Admin_Settings::is_setting_page( 'advanced', $section ) ) { |
| 109 | return false; |
| 110 | } |
| 111 | |
| 112 | $optionValue = $this->settings->getUsageTrackingNoticeNagOptionValue(); |
| 113 | |
| 114 | if ( is_numeric( $optionValue ) && ( '0' === $optionValue || $optionValue > time() ) ) { |
| 115 | return false; |
| 116 | } |
| 117 | |
| 118 | return ! give_is_setting_enabled( $this->settings->getUsageTrackingOptionValue() ); |
| 119 | } |
| 120 | |
| 121 | /** |
| 122 | * Disable notice. |
| 123 | * |
| 124 | * @since 2.10.0 |
| 125 | * |
| 126 | * @param int $timestamp |
| 127 | * |
| 128 | * @return bool |
| 129 | */ |
| 130 | public function disableNotice( $timestamp ) { |
| 131 | return $this->settings->saveUsageTrackingNoticeNagOptionValue( $timestamp ); |
| 132 | } |
| 133 | } |
| 134 |