add-post-activity-stream-to-group.php
10 months ago
add-post-sitewide-activity-stream.php
10 months ago
add-post-user-activity-stream.php
10 months ago
add-user-to-group.php
10 months ago
change-user-member-type.php
3 years ago
create-group.php
10 months ago
end-friendship-with-user.php
10 months ago
remove-user-from-group.php
10 months ago
send-all-members-group-notification.php
10 months ago
send-friendship-request-user.php
10 months ago
send-private-message-user.php
10 months ago
send-user-notification.php
10 months ago
set-user-xprofile-data.php
10 months ago
send-user-notification.php
226 lines
| 1 | <?php |
| 2 | /** |
| 3 | * SendUserNotification. |
| 4 | * php version 5.6 |
| 5 | * |
| 6 | * @category SendUserNotification |
| 7 | * @package SureTriggers |
| 8 | * @author BSF <username@example.com> |
| 9 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPLv3 |
| 10 | * @link https://www.brainstormforce.com/ |
| 11 | * @since 1.0.0 |
| 12 | */ |
| 13 | |
| 14 | namespace SureTriggers\Integrations\BuddyPress\Actions; |
| 15 | |
| 16 | use Exception; |
| 17 | use SureTriggers\Integrations\AutomateAction; |
| 18 | use SureTriggers\Integrations\WordPress\WordPress; |
| 19 | use SureTriggers\Traits\SingletonLoader; |
| 20 | |
| 21 | /** |
| 22 | * SendUserNotification |
| 23 | * |
| 24 | * @category SendUserNotification |
| 25 | * @package SureTriggers |
| 26 | * @author BSF <username@example.com> |
| 27 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPLv3 |
| 28 | * @link https://www.brainstormforce.com/ |
| 29 | * @since 1.0.0 |
| 30 | */ |
| 31 | class SendUserNotification extends AutomateAction { |
| 32 | |
| 33 | /** |
| 34 | * Integration type. |
| 35 | * |
| 36 | * @var string |
| 37 | */ |
| 38 | public $integration = 'BuddyPress'; |
| 39 | |
| 40 | /** |
| 41 | * Action name. |
| 42 | * |
| 43 | * @var string |
| 44 | */ |
| 45 | public $action = 'send_user_notification'; |
| 46 | |
| 47 | use SingletonLoader; |
| 48 | |
| 49 | /** |
| 50 | * Register a action. |
| 51 | * |
| 52 | * @param array $actions actions. |
| 53 | * @return array |
| 54 | */ |
| 55 | public function register( $actions ) { |
| 56 | add_filter( |
| 57 | 'bp_notifications_get_registered_components', |
| 58 | [ |
| 59 | $this, |
| 60 | 'st_bp_component', |
| 61 | ], |
| 62 | 10, |
| 63 | 2 |
| 64 | ); |
| 65 | |
| 66 | // BP notification content. |
| 67 | add_filter( |
| 68 | 'bp_notifications_get_notifications_for_user', |
| 69 | [ |
| 70 | $this, |
| 71 | 'st_bp_notification_content', |
| 72 | ], |
| 73 | 10, |
| 74 | 8 |
| 75 | ); |
| 76 | $actions[ $this->integration ][ $this->action ] = [ |
| 77 | 'label' => __( 'Send the user a notification', 'suretriggers' ), |
| 78 | 'action' => $this->action, |
| 79 | 'function' => [ $this, 'action_listener' ], |
| 80 | ]; |
| 81 | |
| 82 | return $actions; |
| 83 | } |
| 84 | |
| 85 | /** |
| 86 | * SureTrigger BuddyPress component. |
| 87 | * |
| 88 | * @param array $component_names components name. |
| 89 | * @param array $active_components active_components. |
| 90 | * |
| 91 | * @return array |
| 92 | */ |
| 93 | public function st_bp_component( $component_names, $active_components ) { |
| 94 | |
| 95 | $component_names = ! is_array( $component_names ) ? [] : $component_names; |
| 96 | array_push( $component_names, 'suretriggers' ); |
| 97 | |
| 98 | return $component_names; |
| 99 | } |
| 100 | |
| 101 | /** |
| 102 | * SureTrigger BuddyPress Notification content. |
| 103 | * |
| 104 | * @param string $content Component action. Deprecated. Do not do checks |
| 105 | * against this! Use the 6th parameter instead - |
| 106 | * $component_action_name. |
| 107 | * @param int $item_id Notification item ID. |
| 108 | * @param int $secondary_item_id Notification secondary item ID. |
| 109 | * @param int $action_item_count Number of notifications with the same |
| 110 | * action. |
| 111 | * @param string $format Format of return. Either 'string' or 'object'. |
| 112 | * @param string $component_action_name Canonical notification action. |
| 113 | * @param string $component_name Notification component ID. |
| 114 | * @param int $id Notification ID. |
| 115 | * |
| 116 | * @return string|array |
| 117 | */ |
| 118 | public function st_bp_notification_content( $content, $item_id, $secondary_item_id, $action_item_count, $format, $component_action_name, $component_name, $id ) { |
| 119 | |
| 120 | if ( 'suretriggers_bp_notification' === $component_action_name ) { |
| 121 | |
| 122 | if ( function_exists( 'bp_notifications_get_meta' ) ) { |
| 123 | $notification_content = bp_notifications_get_meta( $id, 'st_notification_content' ); |
| 124 | $notification_link = bp_notifications_get_meta( $id, 'st_notification_link' ); |
| 125 | if ( 'string' == $format ) { |
| 126 | return $notification_content; |
| 127 | } elseif ( 'object' == $format ) { |
| 128 | return [ |
| 129 | 'text' => $notification_content, |
| 130 | 'link' => $notification_link, |
| 131 | ]; |
| 132 | } |
| 133 | } |
| 134 | } |
| 135 | |
| 136 | return $content; |
| 137 | } |
| 138 | |
| 139 | /** |
| 140 | * Action listener. |
| 141 | * |
| 142 | * @param int $user_id user_id. |
| 143 | * @param int $automation_id automation_id. |
| 144 | * @param array $fields fields. |
| 145 | * @param array $selected_options selectedOptions. |
| 146 | * @throws Exception Exception. |
| 147 | * |
| 148 | * @return bool|array|void |
| 149 | */ |
| 150 | public function _action_listener( $user_id, $automation_id, $fields, $selected_options ) { |
| 151 | |
| 152 | $sender = $selected_options['wp_user_email']; |
| 153 | $receiver = $selected_options['to_user_email']; |
| 154 | $notification_content = $selected_options['notification_content']; |
| 155 | $notification_link = $selected_options['notification_link']; |
| 156 | |
| 157 | if ( empty( $sender ) || ! is_email( $sender ) ) { |
| 158 | return [ |
| 159 | 'status' => 'error', |
| 160 | 'message' => 'Invalid sender email.', |
| 161 | ]; |
| 162 | } |
| 163 | |
| 164 | if ( empty( $receiver ) || ! is_email( $receiver ) ) { |
| 165 | return [ |
| 166 | 'status' => 'error', |
| 167 | 'message' => 'Invalid receiver email.', |
| 168 | ]; |
| 169 | } |
| 170 | |
| 171 | $sender_user = get_user_by( 'email', $sender ); |
| 172 | $receiver_user = get_user_by( 'email', $receiver ); |
| 173 | |
| 174 | // Attempt to send notification. |
| 175 | if ( function_exists( 'bp_notifications_add_notification' ) ) { |
| 176 | if ( function_exists( 'bp_core_current_time' ) ) { |
| 177 | if ( $sender_user && $receiver_user ) { |
| 178 | $sender_id = $sender_user->ID; |
| 179 | $receiver_id = $receiver_user->ID; |
| 180 | $notification_id = bp_notifications_add_notification( |
| 181 | [ |
| 182 | 'user_id' => $receiver_id, |
| 183 | 'secondary_item_id' => $sender_id, |
| 184 | 'component_name' => 'suretriggers', |
| 185 | 'component_action' => 'suretriggers_bp_notification', |
| 186 | 'date_notified' => bp_core_current_time(), |
| 187 | 'is_new' => 1, |
| 188 | 'allow_duplicate' => true, |
| 189 | ] |
| 190 | ); |
| 191 | |
| 192 | if ( is_wp_error( $notification_id ) ) { |
| 193 | throw new Exception( $notification_id->get_error_message() ); |
| 194 | } else { |
| 195 | |
| 196 | // Add the link. |
| 197 | if ( ! empty( $notification_link ) ) { |
| 198 | $notification_content = '<a href="' . esc_url( $notification_link ) . '" title="' . esc_attr( wp_strip_all_tags( $notification_content ) ) . '">' . ( $notification_content ) . '</a>'; |
| 199 | } |
| 200 | |
| 201 | // Adding meta for notification display on front-end. |
| 202 | if ( function_exists( 'bp_notifications_update_meta' ) ) { |
| 203 | bp_notifications_update_meta( $notification_id, 'st_notification_content', $notification_content ); |
| 204 | bp_notifications_update_meta( $notification_id, 'st_notification_link', $notification_link ); |
| 205 | } |
| 206 | $context['sender'] = WordPress::get_user_context( $user_id ); |
| 207 | if ( function_exists( 'bp_notifications_get_notification' ) && function_exists( 'bp_notifications_get_meta' ) ) { |
| 208 | $notification = bp_notifications_get_notification( $notification_id ); |
| 209 | $notification_meta = bp_notifications_get_meta( $notification_id ); |
| 210 | $context['notification'] = array_merge( get_object_vars( $notification ), $notification_meta ); |
| 211 | } |
| 212 | return $context; |
| 213 | } |
| 214 | } |
| 215 | } |
| 216 | } else { |
| 217 | return [ |
| 218 | 'status' => 'error', |
| 219 | 'message' => 'BuddyPress notification module is not active.', |
| 220 | ]; |
| 221 | } |
| 222 | } |
| 223 | } |
| 224 | |
| 225 | SendUserNotification::get_instance(); |
| 226 |