@@ -11,7 +11,7 @@ discard block |
||
| 11 | 11 | */ |
| 12 | 12 | |
| 13 | 13 | if ( ! defined( 'WPINC' ) ) { |
| 14 | - die; |
|
| 14 | + die; |
|
| 15 | 15 | } |
| 16 | 16 | |
| 17 | 17 | /** |
@@ -22,109 +22,109 @@ discard block |
||
| 22 | 22 | /** |
| 23 | 23 | * @var GravityView_Edit_Entry $loader |
| 24 | 24 | */ |
| 25 | - protected $loader; |
|
| 25 | + protected $loader; |
|
| 26 | 26 | |
| 27 | - /** |
|
| 28 | - * @var WP_User|null Temporary storage used by restore_user_details() |
|
| 29 | - */ |
|
| 30 | - private $_user_before_update = null; |
|
| 27 | + /** |
|
| 28 | + * @var WP_User|null Temporary storage used by restore_user_details() |
|
| 29 | + */ |
|
| 30 | + private $_user_before_update = null; |
|
| 31 | 31 | |
| 32 | - function __construct( GravityView_Edit_Entry $loader ) { |
|
| 33 | - $this->loader = $loader; |
|
| 34 | - } |
|
| 32 | + function __construct( GravityView_Edit_Entry $loader ) { |
|
| 33 | + $this->loader = $loader; |
|
| 34 | + } |
|
| 35 | 35 | |
| 36 | 36 | /** |
| 37 | 37 | * @since 1.11 |
| 38 | 38 | */ |
| 39 | 39 | public function load() { |
| 40 | 40 | add_action( 'wp', array( $this, 'add_hooks' ), 10 ); |
| 41 | - } |
|
| 41 | + } |
|
| 42 | 42 | |
| 43 | 43 | /** |
| 44 | 44 | * Add hooks to trigger updating the user |
| 45 | 45 | * |
| 46 | 46 | * @since 1.18 |
| 47 | 47 | */ |
| 48 | - public function add_hooks() { |
|
| 49 | - |
|
| 50 | - /** |
|
| 51 | - * @filter `gravityview/edit_entry/user_registration/trigger_update` Choose whether to update user information via User Registration add-on when an entry is updated? |
|
| 52 | - * @since 1.11 |
|
| 53 | - * @param boolean $boolean Whether to trigger update on user registration (default: true) |
|
| 54 | - */ |
|
| 55 | - if( apply_filters( 'gravityview/edit_entry/user_registration/trigger_update', true ) ) { |
|
| 56 | - |
|
| 57 | - add_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10, 2 ); |
|
| 58 | - |
|
| 59 | - // last resort in case the current user display name don't match any of the defaults |
|
| 60 | - add_action( 'gform_user_updated', array( $this, 'restore_display_name' ), 10, 4 ); |
|
| 61 | - } |
|
| 62 | - } |
|
| 63 | - |
|
| 64 | - /** |
|
| 65 | - * Update the WordPress user profile based on the GF User Registration create feed |
|
| 66 | - * |
|
| 67 | - * @since 1.11 |
|
| 68 | - * |
|
| 69 | - * @param array $form Gravity Forms form array |
|
| 70 | - * @param string $entry_id Gravity Forms entry ID |
|
| 71 | - * @return void |
|
| 72 | - */ |
|
| 73 | - public function update_user( $form = array(), $entry_id = 0 ) { |
|
| 74 | - |
|
| 75 | - if( ! class_exists( 'GFAPI' ) || ! class_exists( 'GF_User_Registration' ) ) { |
|
| 76 | - gravityview()->log->error( 'GFAPI or User Registration class not found; not updating the user' ); |
|
| 77 | - return; |
|
| 78 | - } elseif( empty( $entry_id ) ) { |
|
| 79 | - gravityview()->log->error( 'Entry ID is empty [{entry_id}]; not updating the user', array( 'entry_id' => $entry_id ) ); |
|
| 80 | - return; |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - $gf_user_registration = GF_User_Registration::get_instance(); |
|
| 84 | - |
|
| 85 | - $entry = GFAPI::get_entry( $entry_id ); |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * @filter `gravityview/edit_entry/user_registration/entry` Modify entry details before updating the user via User Registration add-on |
|
| 89 | - * @since 1.11 |
|
| 90 | - * @param array $entry Gravity Forms entry |
|
| 91 | - * @param array $form Gravity Forms form |
|
| 92 | - */ |
|
| 93 | - $entry = apply_filters( 'gravityview/edit_entry/user_registration/entry', $entry, $form ); |
|
| 94 | - |
|
| 95 | - $config = $this->get_feed_configuration( $entry, $form ); |
|
| 96 | - |
|
| 97 | - // Make sure the feed is active |
|
| 98 | - if ( ! \GV\Utils::get( $config, 'is_active', false ) ) { |
|
| 48 | + public function add_hooks() { |
|
| 49 | + |
|
| 50 | + /** |
|
| 51 | + * @filter `gravityview/edit_entry/user_registration/trigger_update` Choose whether to update user information via User Registration add-on when an entry is updated? |
|
| 52 | + * @since 1.11 |
|
| 53 | + * @param boolean $boolean Whether to trigger update on user registration (default: true) |
|
| 54 | + */ |
|
| 55 | + if( apply_filters( 'gravityview/edit_entry/user_registration/trigger_update', true ) ) { |
|
| 56 | + |
|
| 57 | + add_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10, 2 ); |
|
| 58 | + |
|
| 59 | + // last resort in case the current user display name don't match any of the defaults |
|
| 60 | + add_action( 'gform_user_updated', array( $this, 'restore_display_name' ), 10, 4 ); |
|
| 61 | + } |
|
| 62 | + } |
|
| 63 | + |
|
| 64 | + /** |
|
| 65 | + * Update the WordPress user profile based on the GF User Registration create feed |
|
| 66 | + * |
|
| 67 | + * @since 1.11 |
|
| 68 | + * |
|
| 69 | + * @param array $form Gravity Forms form array |
|
| 70 | + * @param string $entry_id Gravity Forms entry ID |
|
| 71 | + * @return void |
|
| 72 | + */ |
|
| 73 | + public function update_user( $form = array(), $entry_id = 0 ) { |
|
| 74 | + |
|
| 75 | + if( ! class_exists( 'GFAPI' ) || ! class_exists( 'GF_User_Registration' ) ) { |
|
| 76 | + gravityview()->log->error( 'GFAPI or User Registration class not found; not updating the user' ); |
|
| 99 | 77 | return; |
| 100 | - } |
|
| 78 | + } elseif( empty( $entry_id ) ) { |
|
| 79 | + gravityview()->log->error( 'Entry ID is empty [{entry_id}]; not updating the user', array( 'entry_id' => $entry_id ) ); |
|
| 80 | + return; |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + $gf_user_registration = GF_User_Registration::get_instance(); |
|
| 84 | + |
|
| 85 | + $entry = GFAPI::get_entry( $entry_id ); |
|
| 101 | 86 | |
| 102 | - // If an Update feed, make sure the conditions are met. |
|
| 103 | - if ( \GV\Utils::get( $config, 'meta/feedType' ) === 'update' ) { |
|
| 104 | - if( ! $gf_user_registration->is_feed_condition_met( $config, $form, $entry ) ) { |
|
| 105 | - return; |
|
| 106 | - } |
|
| 107 | - } |
|
| 87 | + /** |
|
| 88 | + * @filter `gravityview/edit_entry/user_registration/entry` Modify entry details before updating the user via User Registration add-on |
|
| 89 | + * @since 1.11 |
|
| 90 | + * @param array $entry Gravity Forms entry |
|
| 91 | + * @param array $form Gravity Forms form |
|
| 92 | + */ |
|
| 93 | + $entry = apply_filters( 'gravityview/edit_entry/user_registration/entry', $entry, $form ); |
|
| 108 | 94 | |
| 109 | - // Do not update user if the user hasn't been registered (happens when manual activation is enabled in User Registration feed) |
|
| 110 | - $username = \GV\Utils::get( $config, 'meta/username', null ); |
|
| 111 | - if ( ! isset( $entry[ $username ] ) || ! get_user_by( 'login', $entry[ $username ] ) ) { |
|
| 112 | - return; |
|
| 113 | - } |
|
| 95 | + $config = $this->get_feed_configuration( $entry, $form ); |
|
| 96 | + |
|
| 97 | + // Make sure the feed is active |
|
| 98 | + if ( ! \GV\Utils::get( $config, 'is_active', false ) ) { |
|
| 99 | + return; |
|
| 100 | + } |
|
| 101 | + |
|
| 102 | + // If an Update feed, make sure the conditions are met. |
|
| 103 | + if ( \GV\Utils::get( $config, 'meta/feedType' ) === 'update' ) { |
|
| 104 | + if( ! $gf_user_registration->is_feed_condition_met( $config, $form, $entry ) ) { |
|
| 105 | + return; |
|
| 106 | + } |
|
| 107 | + } |
|
| 108 | + |
|
| 109 | + // Do not update user if the user hasn't been registered (happens when manual activation is enabled in User Registration feed) |
|
| 110 | + $username = \GV\Utils::get( $config, 'meta/username', null ); |
|
| 111 | + if ( ! isset( $entry[ $username ] ) || ! get_user_by( 'login', $entry[ $username ] ) ) { |
|
| 112 | + return; |
|
| 113 | + } |
|
| 114 | 114 | |
| 115 | - // The priority is set to 3 so that default priority (10) will still override it |
|
| 116 | - add_filter( 'send_password_change_email', '__return_false', 3 ); |
|
| 117 | - add_filter( 'send_email_change_email', '__return_false', 3 ); |
|
| 115 | + // The priority is set to 3 so that default priority (10) will still override it |
|
| 116 | + add_filter( 'send_password_change_email', '__return_false', 3 ); |
|
| 117 | + add_filter( 'send_email_change_email', '__return_false', 3 ); |
|
| 118 | 118 | |
| 119 | - // Trigger the User Registration update user method |
|
| 120 | - $gf_user_registration->update_user( $entry, $form, $config ); |
|
| 119 | + // Trigger the User Registration update user method |
|
| 120 | + $gf_user_registration->update_user( $entry, $form, $config ); |
|
| 121 | 121 | |
| 122 | - remove_filter( 'send_password_change_email', '__return_false', 3 ); |
|
| 123 | - remove_filter( 'send_email_change_email', '__return_false', 3 ); |
|
| 122 | + remove_filter( 'send_password_change_email', '__return_false', 3 ); |
|
| 123 | + remove_filter( 'send_email_change_email', '__return_false', 3 ); |
|
| 124 | 124 | |
| 125 | - // Prevent double-triggering by removing the hook |
|
| 126 | - remove_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10 ); |
|
| 127 | - } |
|
| 125 | + // Prevent double-triggering by removing the hook |
|
| 126 | + remove_action( 'gravityview/edit_entry/after_update' , array( $this, 'update_user' ), 10 ); |
|
| 127 | + } |
|
| 128 | 128 | |
| 129 | 129 | /** |
| 130 | 130 | * Get the User Registration feed configuration for the entry & form |
@@ -139,184 +139,184 @@ discard block |
||
| 139 | 139 | * |
| 140 | 140 | * @return array |
| 141 | 141 | */ |
| 142 | - public function get_feed_configuration( $entry, $form ) { |
|
| 143 | - |
|
| 144 | - $gf_user_registration = GF_User_Registration::get_instance(); |
|
| 145 | - |
|
| 146 | - $config = $gf_user_registration->get_single_submission_feed( $entry, $form ); |
|
| 147 | - |
|
| 148 | - /** |
|
| 149 | - * @filter `gravityview/edit_entry/user_registration/preserve_role` Keep the current user role or override with the role defined in the Create feed |
|
| 150 | - * @since 1.15 |
|
| 151 | - * @param[in,out] boolean $preserve_role Preserve current user role Default: true |
|
| 152 | - * @param[in] array $config Gravity Forms User Registration feed configuration for the form |
|
| 153 | - * @param[in] array $form Gravity Forms form array |
|
| 154 | - * @param[in] array $entry Gravity Forms entry being edited |
|
| 155 | - */ |
|
| 156 | - $preserve_role = apply_filters( 'gravityview/edit_entry/user_registration/preserve_role', true, $config, $form, $entry ); |
|
| 157 | - |
|
| 158 | - if( $preserve_role ) { |
|
| 159 | - $config['meta']['role'] = 'gfur_preserve_role'; |
|
| 160 | - } |
|
| 161 | - |
|
| 162 | - $displayname = $this->match_current_display_name( $entry['created_by'] ); |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * Make sure the current display name is not changed with the update user method. |
|
| 166 | - * @since 1.15 |
|
| 167 | - */ |
|
| 168 | - $config['meta']['displayname'] = $displayname ? $displayname : $config['meta']['displayname']; |
|
| 169 | - |
|
| 170 | - /** |
|
| 171 | - * @filter `gravityview/edit_entry/user_registration/config` Modify the User Registration Addon feed configuration |
|
| 172 | - * @since 1.14 |
|
| 173 | - * @param[in,out] array $config Gravity Forms User Registration feed configuration for the form |
|
| 174 | - * @param[in] array $form Gravity Forms form array |
|
| 175 | - * @param[in] array $entry Gravity Forms entry being edited |
|
| 176 | - */ |
|
| 177 | - $config = apply_filters( 'gravityview/edit_entry/user_registration/config', $config, $form, $entry ); |
|
| 178 | - |
|
| 179 | - return $config; |
|
| 180 | - } |
|
| 181 | - |
|
| 182 | - /** |
|
| 183 | - * Calculate the user display name format |
|
| 184 | - * |
|
| 185 | - * @since 1.15 |
|
| 186 | - * @since 1.20 Returns false if user not found at $user_id |
|
| 187 | - * |
|
| 188 | - * @param int $user_id WP User ID |
|
| 189 | - * @return false|string Display name format as used inside Gravity Forms User Registration. Returns false if user not found. |
|
| 190 | - */ |
|
| 191 | - public function match_current_display_name( $user_id ) { |
|
| 192 | - |
|
| 193 | - $user = get_userdata( $user_id ); |
|
| 194 | - |
|
| 195 | - if( ! $user ) { |
|
| 196 | - return false; |
|
| 197 | - } |
|
| 198 | - |
|
| 199 | - $names = $this->generate_display_names( $user ); |
|
| 200 | - |
|
| 201 | - $format = array_search( $user->display_name, $names, true ); |
|
| 202 | - |
|
| 203 | - /** |
|
| 204 | - * In case we can't find the current display name format, trigger last resort method at the 'gform_user_updated' hook |
|
| 205 | - * @see restore_display_name |
|
| 206 | - */ |
|
| 207 | - if( false === $format ) { |
|
| 208 | - $this->_user_before_update = $user; |
|
| 209 | - } |
|
| 210 | - |
|
| 211 | - return $format; |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - /** |
|
| 215 | - * Generate an array of all the user display names possibilities |
|
| 216 | - * |
|
| 217 | - * @since 1.15 |
|
| 218 | - * |
|
| 219 | - * @param object $profileuser WP_User object |
|
| 220 | - * @return array List all the possible display names for a certain User object |
|
| 221 | - */ |
|
| 222 | - public function generate_display_names( $profileuser ) { |
|
| 223 | - |
|
| 224 | - $public_display = array(); |
|
| 225 | - $public_display['nickname'] = $profileuser->nickname; |
|
| 226 | - $public_display['username'] = $profileuser->user_login; |
|
| 227 | - |
|
| 228 | - if ( !empty($profileuser->first_name) ) { |
|
| 229 | - $public_display['firstname'] = $profileuser->first_name; |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - if ( !empty($profileuser->last_name) ) { |
|
| 233 | - $public_display['lastname'] = $profileuser->last_name; |
|
| 234 | - } |
|
| 235 | - |
|
| 236 | - if ( !empty($profileuser->first_name) && !empty($profileuser->last_name) ) { |
|
| 237 | - $public_display['firstlast'] = $profileuser->first_name . ' ' . $profileuser->last_name; |
|
| 238 | - $public_display['lastfirst'] = $profileuser->last_name . ' ' . $profileuser->first_name; |
|
| 239 | - } |
|
| 240 | - |
|
| 241 | - $public_display = array_map( 'trim', $public_display ); |
|
| 242 | - $public_display = array_unique( $public_display ); |
|
| 243 | - |
|
| 244 | - return $public_display; |
|
| 245 | - } |
|
| 246 | - |
|
| 247 | - |
|
| 248 | - /** |
|
| 249 | - * Restore the Display Name and roles of a user after being updated by Gravity Forms User Registration Addon |
|
| 250 | - * |
|
| 251 | - * @see GFUser::update_user() |
|
| 252 | - * @param int $user_id WP User ID that was updated by Gravity Forms User Registration Addon |
|
| 253 | - * @param array $config Gravity Forms User Registration Addon form feed configuration |
|
| 254 | - * @param array $entry The Gravity Forms entry that was just updated |
|
| 255 | - * @param string $password User password |
|
| 256 | - * @return int|false|WP_Error|null True: User updated; False: $user_id not a valid User ID; WP_Error: User update error; Null: Method didn't process |
|
| 257 | - */ |
|
| 258 | - public function restore_display_name( $user_id = 0, $config = array(), $entry = array(), $password = '' ) { |
|
| 259 | - |
|
| 260 | - /** |
|
| 261 | - * @filter `gravityview/edit_entry/restore_display_name` Whether display names should be restored to before updating an entry. |
|
| 262 | - * Otherwise, display names will be reset to the format specified in Gravity Forms User Registration "Update" feed |
|
| 263 | - * @since 1.14.4 |
|
| 264 | - * @param boolean $restore_display_name Restore Display Name? Default: true |
|
| 265 | - */ |
|
| 266 | - $restore_display_name = apply_filters( 'gravityview/edit_entry/restore_display_name', true ); |
|
| 267 | - |
|
| 268 | - $is_update_feed = ( $config && \GV\Utils::get( $config, 'meta/feed_type' ) === 'update' ); |
|
| 269 | - |
|
| 270 | - /** |
|
| 271 | - * Don't restore display name: |
|
| 272 | - * - either disabled, |
|
| 273 | - * - or it is an Update feed (we only care about Create feed) |
|
| 274 | - * - or we don't need as we found the correct format before updating user. |
|
| 275 | - * @since 1.14.4 |
|
| 276 | - */ |
|
| 277 | - if( ! $restore_display_name || $is_update_feed || is_null( $this->_user_before_update ) ) { |
|
| 278 | - return null; |
|
| 279 | - } |
|
| 280 | - |
|
| 281 | - $user_after_update = get_userdata( $user_id ); |
|
| 282 | - |
|
| 283 | - // User not found |
|
| 284 | - if ( ! $user_after_update ) { |
|
| 285 | - gravityview()->log->error( 'User not found at $user_id #{user_id}', array( 'user_id' => $user_id ) ); |
|
| 286 | - return false; |
|
| 287 | - } |
|
| 288 | - |
|
| 289 | - $restored_user = $user_after_update; |
|
| 290 | - |
|
| 291 | - // Restore previous display_name |
|
| 292 | - $restored_user->display_name = $this->_user_before_update->display_name; |
|
| 293 | - |
|
| 294 | - // Don't have WP update the password. |
|
| 295 | - unset( $restored_user->data->user_pass, $restored_user->user_pass ); |
|
| 296 | - |
|
| 297 | - /** |
|
| 298 | - * Modify the user data after updated by Gravity Forms User Registration but before restored by GravityView |
|
| 299 | - * @since 1.14 |
|
| 300 | - * @param WP_User $restored_user The user with restored details about to be updated by wp_update_user() |
|
| 301 | - * @param WP_User $user_before_update The user before being updated by Gravity Forms User Registration |
|
| 302 | - * @param WP_User $user_after_update The user after being updated by Gravity Forms User Registration |
|
| 303 | - * @param array $entry The Gravity Forms entry that was just updated |
|
| 304 | - */ |
|
| 305 | - $restored_user = apply_filters( 'gravityview/edit_entry/user_registration/restored_user', $restored_user, $this->_user_before_update, $user_after_update, $entry ); |
|
| 306 | - |
|
| 307 | - $updated = wp_update_user( $restored_user ); |
|
| 308 | - |
|
| 309 | - if( is_wp_error( $updated ) ) { |
|
| 310 | - gravityview()->log->error( 'There was an error updating user #{user_id} details', array( 'user_id' => $user_id, 'data' => $updated ) ); |
|
| 311 | - } else { |
|
| 312 | - gravityview()->log->debug( 'User #{user_id} details restored', array( 'user_id' => $user_id ) ); |
|
| 313 | - } |
|
| 314 | - |
|
| 315 | - $this->_user_before_update = null; |
|
| 316 | - |
|
| 317 | - unset( $restored_user, $user_after_update ); |
|
| 318 | - |
|
| 319 | - return $updated; |
|
| 320 | - } |
|
| 142 | + public function get_feed_configuration( $entry, $form ) { |
|
| 143 | + |
|
| 144 | + $gf_user_registration = GF_User_Registration::get_instance(); |
|
| 145 | + |
|
| 146 | + $config = $gf_user_registration->get_single_submission_feed( $entry, $form ); |
|
| 147 | + |
|
| 148 | + /** |
|
| 149 | + * @filter `gravityview/edit_entry/user_registration/preserve_role` Keep the current user role or override with the role defined in the Create feed |
|
| 150 | + * @since 1.15 |
|
| 151 | + * @param[in,out] boolean $preserve_role Preserve current user role Default: true |
|
| 152 | + * @param[in] array $config Gravity Forms User Registration feed configuration for the form |
|
| 153 | + * @param[in] array $form Gravity Forms form array |
|
| 154 | + * @param[in] array $entry Gravity Forms entry being edited |
|
| 155 | + */ |
|
| 156 | + $preserve_role = apply_filters( 'gravityview/edit_entry/user_registration/preserve_role', true, $config, $form, $entry ); |
|
| 157 | + |
|
| 158 | + if( $preserve_role ) { |
|
| 159 | + $config['meta']['role'] = 'gfur_preserve_role'; |
|
| 160 | + } |
|
| 161 | + |
|
| 162 | + $displayname = $this->match_current_display_name( $entry['created_by'] ); |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * Make sure the current display name is not changed with the update user method. |
|
| 166 | + * @since 1.15 |
|
| 167 | + */ |
|
| 168 | + $config['meta']['displayname'] = $displayname ? $displayname : $config['meta']['displayname']; |
|
| 169 | + |
|
| 170 | + /** |
|
| 171 | + * @filter `gravityview/edit_entry/user_registration/config` Modify the User Registration Addon feed configuration |
|
| 172 | + * @since 1.14 |
|
| 173 | + * @param[in,out] array $config Gravity Forms User Registration feed configuration for the form |
|
| 174 | + * @param[in] array $form Gravity Forms form array |
|
| 175 | + * @param[in] array $entry Gravity Forms entry being edited |
|
| 176 | + */ |
|
| 177 | + $config = apply_filters( 'gravityview/edit_entry/user_registration/config', $config, $form, $entry ); |
|
| 178 | + |
|
| 179 | + return $config; |
|
| 180 | + } |
|
| 181 | + |
|
| 182 | + /** |
|
| 183 | + * Calculate the user display name format |
|
| 184 | + * |
|
| 185 | + * @since 1.15 |
|
| 186 | + * @since 1.20 Returns false if user not found at $user_id |
|
| 187 | + * |
|
| 188 | + * @param int $user_id WP User ID |
|
| 189 | + * @return false|string Display name format as used inside Gravity Forms User Registration. Returns false if user not found. |
|
| 190 | + */ |
|
| 191 | + public function match_current_display_name( $user_id ) { |
|
| 192 | + |
|
| 193 | + $user = get_userdata( $user_id ); |
|
| 194 | + |
|
| 195 | + if( ! $user ) { |
|
| 196 | + return false; |
|
| 197 | + } |
|
| 198 | + |
|
| 199 | + $names = $this->generate_display_names( $user ); |
|
| 200 | + |
|
| 201 | + $format = array_search( $user->display_name, $names, true ); |
|
| 202 | + |
|
| 203 | + /** |
|
| 204 | + * In case we can't find the current display name format, trigger last resort method at the 'gform_user_updated' hook |
|
| 205 | + * @see restore_display_name |
|
| 206 | + */ |
|
| 207 | + if( false === $format ) { |
|
| 208 | + $this->_user_before_update = $user; |
|
| 209 | + } |
|
| 210 | + |
|
| 211 | + return $format; |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + /** |
|
| 215 | + * Generate an array of all the user display names possibilities |
|
| 216 | + * |
|
| 217 | + * @since 1.15 |
|
| 218 | + * |
|
| 219 | + * @param object $profileuser WP_User object |
|
| 220 | + * @return array List all the possible display names for a certain User object |
|
| 221 | + */ |
|
| 222 | + public function generate_display_names( $profileuser ) { |
|
| 223 | + |
|
| 224 | + $public_display = array(); |
|
| 225 | + $public_display['nickname'] = $profileuser->nickname; |
|
| 226 | + $public_display['username'] = $profileuser->user_login; |
|
| 227 | + |
|
| 228 | + if ( !empty($profileuser->first_name) ) { |
|
| 229 | + $public_display['firstname'] = $profileuser->first_name; |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + if ( !empty($profileuser->last_name) ) { |
|
| 233 | + $public_display['lastname'] = $profileuser->last_name; |
|
| 234 | + } |
|
| 235 | + |
|
| 236 | + if ( !empty($profileuser->first_name) && !empty($profileuser->last_name) ) { |
|
| 237 | + $public_display['firstlast'] = $profileuser->first_name . ' ' . $profileuser->last_name; |
|
| 238 | + $public_display['lastfirst'] = $profileuser->last_name . ' ' . $profileuser->first_name; |
|
| 239 | + } |
|
| 240 | + |
|
| 241 | + $public_display = array_map( 'trim', $public_display ); |
|
| 242 | + $public_display = array_unique( $public_display ); |
|
| 243 | + |
|
| 244 | + return $public_display; |
|
| 245 | + } |
|
| 246 | + |
|
| 247 | + |
|
| 248 | + /** |
|
| 249 | + * Restore the Display Name and roles of a user after being updated by Gravity Forms User Registration Addon |
|
| 250 | + * |
|
| 251 | + * @see GFUser::update_user() |
|
| 252 | + * @param int $user_id WP User ID that was updated by Gravity Forms User Registration Addon |
|
| 253 | + * @param array $config Gravity Forms User Registration Addon form feed configuration |
|
| 254 | + * @param array $entry The Gravity Forms entry that was just updated |
|
| 255 | + * @param string $password User password |
|
| 256 | + * @return int|false|WP_Error|null True: User updated; False: $user_id not a valid User ID; WP_Error: User update error; Null: Method didn't process |
|
| 257 | + */ |
|
| 258 | + public function restore_display_name( $user_id = 0, $config = array(), $entry = array(), $password = '' ) { |
|
| 259 | + |
|
| 260 | + /** |
|
| 261 | + * @filter `gravityview/edit_entry/restore_display_name` Whether display names should be restored to before updating an entry. |
|
| 262 | + * Otherwise, display names will be reset to the format specified in Gravity Forms User Registration "Update" feed |
|
| 263 | + * @since 1.14.4 |
|
| 264 | + * @param boolean $restore_display_name Restore Display Name? Default: true |
|
| 265 | + */ |
|
| 266 | + $restore_display_name = apply_filters( 'gravityview/edit_entry/restore_display_name', true ); |
|
| 267 | + |
|
| 268 | + $is_update_feed = ( $config && \GV\Utils::get( $config, 'meta/feed_type' ) === 'update' ); |
|
| 269 | + |
|
| 270 | + /** |
|
| 271 | + * Don't restore display name: |
|
| 272 | + * - either disabled, |
|
| 273 | + * - or it is an Update feed (we only care about Create feed) |
|
| 274 | + * - or we don't need as we found the correct format before updating user. |
|
| 275 | + * @since 1.14.4 |
|
| 276 | + */ |
|
| 277 | + if( ! $restore_display_name || $is_update_feed || is_null( $this->_user_before_update ) ) { |
|
| 278 | + return null; |
|
| 279 | + } |
|
| 280 | + |
|
| 281 | + $user_after_update = get_userdata( $user_id ); |
|
| 282 | + |
|
| 283 | + // User not found |
|
| 284 | + if ( ! $user_after_update ) { |
|
| 285 | + gravityview()->log->error( 'User not found at $user_id #{user_id}', array( 'user_id' => $user_id ) ); |
|
| 286 | + return false; |
|
| 287 | + } |
|
| 288 | + |
|
| 289 | + $restored_user = $user_after_update; |
|
| 290 | + |
|
| 291 | + // Restore previous display_name |
|
| 292 | + $restored_user->display_name = $this->_user_before_update->display_name; |
|
| 293 | + |
|
| 294 | + // Don't have WP update the password. |
|
| 295 | + unset( $restored_user->data->user_pass, $restored_user->user_pass ); |
|
| 296 | + |
|
| 297 | + /** |
|
| 298 | + * Modify the user data after updated by Gravity Forms User Registration but before restored by GravityView |
|
| 299 | + * @since 1.14 |
|
| 300 | + * @param WP_User $restored_user The user with restored details about to be updated by wp_update_user() |
|
| 301 | + * @param WP_User $user_before_update The user before being updated by Gravity Forms User Registration |
|
| 302 | + * @param WP_User $user_after_update The user after being updated by Gravity Forms User Registration |
|
| 303 | + * @param array $entry The Gravity Forms entry that was just updated |
|
| 304 | + */ |
|
| 305 | + $restored_user = apply_filters( 'gravityview/edit_entry/user_registration/restored_user', $restored_user, $this->_user_before_update, $user_after_update, $entry ); |
|
| 306 | + |
|
| 307 | + $updated = wp_update_user( $restored_user ); |
|
| 308 | + |
|
| 309 | + if( is_wp_error( $updated ) ) { |
|
| 310 | + gravityview()->log->error( 'There was an error updating user #{user_id} details', array( 'user_id' => $user_id, 'data' => $updated ) ); |
|
| 311 | + } else { |
|
| 312 | + gravityview()->log->debug( 'User #{user_id} details restored', array( 'user_id' => $user_id ) ); |
|
| 313 | + } |
|
| 314 | + |
|
| 315 | + $this->_user_before_update = null; |
|
| 316 | + |
|
| 317 | + unset( $restored_user, $user_after_update ); |
|
| 318 | + |
|
| 319 | + return $updated; |
|
| 320 | + } |
|
| 321 | 321 | |
| 322 | 322 | } //end class |
@@ -284,7 +284,7 @@ |
||
| 284 | 284 | <div class="gv-field-detail gv-field-detail--field"> |
| 285 | 285 | <span class="gv-field-detail--label">' . esc_html__( 'Field ID', 'gravityview' ) .'</span><span class="gv-field-detail--value">#{{field_id}}</span> |
| 286 | 286 | </div>'; |
| 287 | - } |
|
| 287 | + } |
|
| 288 | 288 | |
| 289 | 289 | $item_details .= ' |
| 290 | 290 | <div class="gv-field-detail gv-field-detail--type"> |
@@ -45,13 +45,13 @@ |
||
| 45 | 45 | } |
| 46 | 46 | |
| 47 | 47 | $field_options['link_phone'] = array( |
| 48 | - 'type' => 'checkbox', |
|
| 49 | - 'label' => __( 'Make Phone Number Clickable', 'gravityview' ), |
|
| 50 | - 'desc' => __( 'Allow dialing a number by clicking it?', 'gravityview'), |
|
| 51 | - 'value' => true, |
|
| 52 | - 'group' => 'display', |
|
| 53 | - 'priority' => 100, |
|
| 54 | - ); |
|
| 48 | + 'type' => 'checkbox', |
|
| 49 | + 'label' => __( 'Make Phone Number Clickable', 'gravityview' ), |
|
| 50 | + 'desc' => __( 'Allow dialing a number by clicking it?', 'gravityview'), |
|
| 51 | + 'value' => true, |
|
| 52 | + 'group' => 'display', |
|
| 53 | + 'priority' => 100, |
|
| 54 | + ); |
|
| 55 | 55 | |
| 56 | 56 | return $field_options; |
| 57 | 57 | } |
@@ -66,9 +66,9 @@ discard block |
||
| 66 | 66 | */ |
| 67 | 67 | public function add_downloads_data_filters() { |
| 68 | 68 | |
| 69 | - $downloads_data = get_site_transient( self::DOWNLOADS_DATA_TRANSIENT ); |
|
| 69 | + $downloads_data = get_site_transient( self::DOWNLOADS_DATA_TRANSIENT ); |
|
| 70 | 70 | |
| 71 | - if ( ! $downloads_data && ! isset( $_GET['cache'] ) ) { |
|
| 71 | + if ( ! $downloads_data && ! isset( $_GET['cache'] ) ) { |
|
| 72 | 72 | return; |
| 73 | 73 | } |
| 74 | 74 | |
@@ -97,7 +97,7 @@ discard block |
||
| 97 | 97 | */ |
| 98 | 98 | public function add_admin_menu() { |
| 99 | 99 | |
| 100 | - $menu_text = _x( 'Manage Add-Ons', 'Extensions are WordPress plugins that add functionality to GravityView and Gravity Forms', 'gravityview' ); |
|
| 100 | + $menu_text = _x( 'Manage Add-Ons', 'Extensions are WordPress plugins that add functionality to GravityView and Gravity Forms', 'gravityview' ); |
|
| 101 | 101 | |
| 102 | 102 | $menu_text = sprintf( '<span title="%s" style="margin: 0">%s</span>', esc_attr__( 'Plugins that extend GravityView and Gravity Forms functionality.', 'gravityview' ), $menu_text ); |
| 103 | 103 | |
@@ -112,8 +112,8 @@ discard block |
||
| 112 | 112 | } |
| 113 | 113 | |
| 114 | 114 | /** |
| 115 | - * When on the Installer page, show a different notice than on the Settings page |
|
| 116 | - * |
|
| 115 | + * When on the Installer page, show a different notice than on the Settings page |
|
| 116 | + * |
|
| 117 | 117 | * @param array $notice |
| 118 | 118 | * |
| 119 | 119 | * @return string License notice |
@@ -121,10 +121,10 @@ discard block |
||
| 121 | 121 | public function maybe_modify_license_notice( $notice = '' ) { |
| 122 | 122 | |
| 123 | 123 | if ( ! gravityview()->request->is_admin( '', 'downloads' ) ) { |
| 124 | - return $notice; |
|
| 125 | - } |
|
| 124 | + return $notice; |
|
| 125 | + } |
|
| 126 | 126 | |
| 127 | - return esc_html__( 'Your license %s. Do you want access to these plugins? %sActivate your license%s or %sget a license here%s.', 'gravityview' ); |
|
| 127 | + return esc_html__( 'Your license %s. Do you want access to these plugins? %sActivate your license%s or %sget a license here%s.', 'gravityview' ); |
|
| 128 | 128 | } |
| 129 | 129 | |
| 130 | 130 | /** |
@@ -167,43 +167,43 @@ discard block |
||
| 167 | 167 | * Get downloads data from transient or from API; save transient after getting data from API |
| 168 | 168 | * |
| 169 | 169 | * @return WP_Error|array If error, returns WP_Error. If not valid JSON, empty array. Otherwise, this structure: { |
| 170 | - * @type array $info { |
|
| 171 | - * @type string $id int 17 |
|
| 172 | - * @type string $slug Extension slug |
|
| 173 | - * @type string $title Extension title |
|
| 174 | - * @type string $create_date in '2018-07-19 20:03:10' format |
|
| 175 | - * @type string $modified_date |
|
| 176 | - * @type string $status |
|
| 177 | - * @type string $link URL to public plugin page |
|
| 178 | - * @type string $content |
|
| 179 | - * @type string $excerpt |
|
| 180 | - * @type string $thumbnail URL to thumbnail |
|
| 181 | - * @type array $category Taxonomy details for the plugin's category { |
|
| 182 | - * @type int $term_id => int 30 |
|
| 183 | - * @type string $name => string 'Plugins' (length=7) |
|
| 184 | - * @type string $slug => string 'plugins' (length=7) |
|
| 185 | - * @type int $term_group => int 0 |
|
| 186 | - * @type int $term_taxonomy_id => int 30 |
|
| 187 | - * @type string $taxonomy => string 'download_category' (length=17) |
|
| 188 | - * @type string $description => string '' (length=0) |
|
| 189 | - * @type int $parent => int 0 |
|
| 190 | - * @type int $count => int 4 |
|
| 191 | - * @type string $filter => string 'raw' (length=3) |
|
| 192 | - * } |
|
| 193 | - * @type array $tags {see $category above} |
|
| 194 | - * @type string $textdomain string 'gravityview' (length=11) |
|
| 195 | - * } |
|
| 196 | - * @type array $pricing array of `price_name_slugs` => '00.00' values, if price options exist |
|
| 197 | - * @type array $licensing { |
|
| 198 | - * @type bool $enabled Is licensing enabled for the extension |
|
| 199 | - * @type string $version Version number |
|
| 200 | - * @type string $exp_unit Expiration unit ('years') |
|
| 201 | - * @type string $exp_length Expiration length ('1') |
|
| 202 | - * } |
|
| 203 | - * @type array $files Array of files. Empty if user has no access to the file. { |
|
| 204 | - * @type string $file string URL of the file download |
|
| 205 | - * } |
|
| 206 | - * } |
|
| 170 | + * @type array $info { |
|
| 171 | + * @type string $id int 17 |
|
| 172 | + * @type string $slug Extension slug |
|
| 173 | + * @type string $title Extension title |
|
| 174 | + * @type string $create_date in '2018-07-19 20:03:10' format |
|
| 175 | + * @type string $modified_date |
|
| 176 | + * @type string $status |
|
| 177 | + * @type string $link URL to public plugin page |
|
| 178 | + * @type string $content |
|
| 179 | + * @type string $excerpt |
|
| 180 | + * @type string $thumbnail URL to thumbnail |
|
| 181 | + * @type array $category Taxonomy details for the plugin's category { |
|
| 182 | + * @type int $term_id => int 30 |
|
| 183 | + * @type string $name => string 'Plugins' (length=7) |
|
| 184 | + * @type string $slug => string 'plugins' (length=7) |
|
| 185 | + * @type int $term_group => int 0 |
|
| 186 | + * @type int $term_taxonomy_id => int 30 |
|
| 187 | + * @type string $taxonomy => string 'download_category' (length=17) |
|
| 188 | + * @type string $description => string '' (length=0) |
|
| 189 | + * @type int $parent => int 0 |
|
| 190 | + * @type int $count => int 4 |
|
| 191 | + * @type string $filter => string 'raw' (length=3) |
|
| 192 | + * } |
|
| 193 | + * @type array $tags {see $category above} |
|
| 194 | + * @type string $textdomain string 'gravityview' (length=11) |
|
| 195 | + * } |
|
| 196 | + * @type array $pricing array of `price_name_slugs` => '00.00' values, if price options exist |
|
| 197 | + * @type array $licensing { |
|
| 198 | + * @type bool $enabled Is licensing enabled for the extension |
|
| 199 | + * @type string $version Version number |
|
| 200 | + * @type string $exp_unit Expiration unit ('years') |
|
| 201 | + * @type string $exp_length Expiration length ('1') |
|
| 202 | + * } |
|
| 203 | + * @type array $files Array of files. Empty if user has no access to the file. { |
|
| 204 | + * @type string $file string URL of the file download |
|
| 205 | + * } |
|
| 206 | + * } |
|
| 207 | 207 | */ |
| 208 | 208 | public function get_downloads_data() { |
| 209 | 209 | |
@@ -235,7 +235,7 @@ discard block |
||
| 235 | 235 | ) ); |
| 236 | 236 | |
| 237 | 237 | if ( is_wp_error( $response ) ) { |
| 238 | - gravityview()->log->error( "Extension data response is an error", array( 'data' => $response ) ); |
|
| 238 | + gravityview()->log->error( "Extension data response is an error", array( 'data' => $response ) ); |
|
| 239 | 239 | return $response; |
| 240 | 240 | } |
| 241 | 241 | |
@@ -288,10 +288,10 @@ discard block |
||
| 288 | 288 | <div class="gv-admin-installer-notice notice inline error"> |
| 289 | 289 | <h3><?php esc_html_e( 'Extensions and plugins data cannot be loaded at the moment. Please try again later.', 'gravityview' ); ?></h3> |
| 290 | 290 | <?php |
| 291 | - if ( is_wp_error( $downloads_data ) ) { |
|
| 292 | - echo wpautop( '<pre>' . esc_html( $downloads_data->get_error_message() ) . '</pre>' ); |
|
| 293 | - } |
|
| 294 | - ?> |
|
| 291 | + if ( is_wp_error( $downloads_data ) ) { |
|
| 292 | + echo wpautop( '<pre>' . esc_html( $downloads_data->get_error_message() ) . '</pre>' ); |
|
| 293 | + } |
|
| 294 | + ?> |
|
| 295 | 295 | </div> |
| 296 | 296 | </div> |
| 297 | 297 | <?php |
@@ -379,9 +379,9 @@ discard block |
||
| 379 | 379 | */ |
| 380 | 380 | protected function render_download( $download, $wp_plugins ) { |
| 381 | 381 | |
| 382 | - $details = $this->get_download_display_details( $download, $wp_plugins ); |
|
| 382 | + $details = $this->get_download_display_details( $download, $wp_plugins ); |
|
| 383 | 383 | |
| 384 | - $download_info = $details['download_info']; |
|
| 384 | + $download_info = $details['download_info']; |
|
| 385 | 385 | |
| 386 | 386 | ?> |
| 387 | 387 | <div class="item <?php echo esc_attr( $details['item_class'] ); ?>"> |
@@ -405,45 +405,45 @@ discard block |
||
| 405 | 405 | |
| 406 | 406 | <div class="addon-excerpt"><?php |
| 407 | 407 | |
| 408 | - $excerpt = \GV\Utils::get( $download_info, 'installer_excerpt', $download_info['excerpt'] ); |
|
| 408 | + $excerpt = \GV\Utils::get( $download_info, 'installer_excerpt', $download_info['excerpt'] ); |
|
| 409 | 409 | |
| 410 | - // Allow some pure HTML tags, but remove everything else from the excerpt. |
|
| 411 | - $tags = array( '<strong>', '</strong>', '<em>', '</em>', '<code>', '</code>' ); |
|
| 412 | - $replacements = array( '[b]', '[/b]', '[i]', '[/i]', '[code]', '[/code]' ); |
|
| 410 | + // Allow some pure HTML tags, but remove everything else from the excerpt. |
|
| 411 | + $tags = array( '<strong>', '</strong>', '<em>', '</em>', '<code>', '</code>' ); |
|
| 412 | + $replacements = array( '[b]', '[/b]', '[i]', '[/i]', '[code]', '[/code]' ); |
|
| 413 | 413 | |
| 414 | - $excerpt = str_replace( $tags, $replacements, $excerpt ); |
|
| 415 | - $excerpt = esc_html( strip_tags( $excerpt ) ); |
|
| 414 | + $excerpt = str_replace( $tags, $replacements, $excerpt ); |
|
| 415 | + $excerpt = esc_html( strip_tags( $excerpt ) ); |
|
| 416 | 416 | $excerpt = str_replace( $replacements, $tags, $excerpt ); |
| 417 | 417 | |
| 418 | 418 | echo wpautop( $excerpt ); |
| 419 | - ?></div> |
|
| 419 | + ?></div> |
|
| 420 | 420 | </div> |
| 421 | 421 | </div> |
| 422 | 422 | <?php |
| 423 | 423 | } |
| 424 | 424 | |
| 425 | 425 | /** |
| 426 | - * Generates details array for the download to keep the render_download() method a bit tidier |
|
| 427 | - * |
|
| 426 | + * Generates details array for the download to keep the render_download() method a bit tidier |
|
| 427 | + * |
|
| 428 | 428 | * @since 2.10 Allow managing installed add-ons whether or not the user's license shows they have access. |
| 429 | 429 | * |
| 430 | 430 | * @param array $download Single download, as returned by {@see get_downloads_data} |
| 431 | 431 | * @param array $wp_plugins All active plugins, as returned by {@see get_plugins()} |
| 432 | 432 | * |
| 433 | 433 | * @return array { |
| 434 | - * @type array $download_info |
|
| 435 | - * @type string $plugin_path |
|
| 436 | - * @type string $status License status returned by Easy Digital Downloads ("active", "inactive", "expired", "revoked", etc) |
|
| 437 | - * @type string $status_label |
|
| 438 | - * @type string $button_title Title attribute to show when hovering over the download's button |
|
| 439 | - * @type string $button_class CSS class to use for the button |
|
| 440 | - * @type string $button_label Text to use for the download's anchor link |
|
| 441 | - * @type string $href URL for the download's button |
|
| 442 | - * @type bool $spinner Whether to show the spinner icon |
|
| 443 | - * @type string $item_class CSS class for the download container |
|
| 444 | - * @type string $required_license The name of the required license for the download ("All Access" or "Core + Extensions") |
|
| 445 | - * @type bool $is_active Is the current GravityView license (as entered in Settings) active? |
|
| 446 | - * } |
|
| 434 | + * @type array $download_info |
|
| 435 | + * @type string $plugin_path |
|
| 436 | + * @type string $status License status returned by Easy Digital Downloads ("active", "inactive", "expired", "revoked", etc) |
|
| 437 | + * @type string $status_label |
|
| 438 | + * @type string $button_title Title attribute to show when hovering over the download's button |
|
| 439 | + * @type string $button_class CSS class to use for the button |
|
| 440 | + * @type string $button_label Text to use for the download's anchor link |
|
| 441 | + * @type string $href URL for the download's button |
|
| 442 | + * @type bool $spinner Whether to show the spinner icon |
|
| 443 | + * @type string $item_class CSS class for the download container |
|
| 444 | + * @type string $required_license The name of the required license for the download ("All Access" or "Core + Extensions") |
|
| 445 | + * @type bool $is_active Is the current GravityView license (as entered in Settings) active? |
|
| 446 | + * } |
|
| 447 | 447 | */ |
| 448 | 448 | private function get_download_display_details( $download, $wp_plugins ) { |
| 449 | 449 | |
@@ -454,7 +454,7 @@ discard block |
||
| 454 | 454 | 'slug' => '', |
| 455 | 455 | 'excerpt' => '', |
| 456 | 456 | 'link' => '', |
| 457 | - 'coming_soon' => false, |
|
| 457 | + 'coming_soon' => false, |
|
| 458 | 458 | 'installer_title' => null, // May not be defined |
| 459 | 459 | 'installer_excerpt' => null, // May not be defined |
| 460 | 460 | ) ); |
@@ -496,14 +496,14 @@ discard block |
||
| 496 | 496 | $href = 'https://gravityview.co/pricing/?utm_source=admin-installer&utm_medium=admin&utm_campaign=Admin%20Notice&utm_content=' . $required_license; |
| 497 | 497 | } |
| 498 | 498 | |
| 499 | - elseif ( ! empty( $download_info['coming_soon'] ) ) { |
|
| 500 | - $spinner = false; |
|
| 501 | - $status = 'notinstalled'; |
|
| 502 | - $status_label = __( 'Coming Soon', 'gravityview' ); |
|
| 503 | - $button_label = __( 'Learn More', 'gravityview' ); |
|
| 504 | - $button_class = 'button-primary button-large'; |
|
| 505 | - $href = \GV\Utils::get( $download_info, 'link', 'https://gravityview.co/extensions/' ); |
|
| 506 | - } |
|
| 499 | + elseif ( ! empty( $download_info['coming_soon'] ) ) { |
|
| 500 | + $spinner = false; |
|
| 501 | + $status = 'notinstalled'; |
|
| 502 | + $status_label = __( 'Coming Soon', 'gravityview' ); |
|
| 503 | + $button_label = __( 'Learn More', 'gravityview' ); |
|
| 504 | + $button_class = 'button-primary button-large'; |
|
| 505 | + $href = \GV\Utils::get( $download_info, 'link', 'https://gravityview.co/extensions/' ); |
|
| 506 | + } |
|
| 507 | 507 | |
| 508 | 508 | // Access but the plugin is not installed |
| 509 | 509 | elseif ( ! $wp_plugin ) { |
@@ -547,18 +547,18 @@ discard block |
||
| 547 | 547 | $download_info['link'] = add_query_arg( array( 'license_key' => $license_key ), $download_info['link'] ); |
| 548 | 548 | |
| 549 | 549 | return compact( 'download_info','plugin_path', 'status', 'status_label', 'button_title', 'button_class', 'button_label', 'href', 'spinner', 'item_class', 'required_license', 'is_active' ); |
| 550 | - } |
|
| 550 | + } |
|
| 551 | 551 | |
| 552 | 552 | /** |
| 553 | - * Returns the base price for an extension |
|
| 554 | - * |
|
| 553 | + * Returns the base price for an extension |
|
| 554 | + * |
|
| 555 | 555 | * @param array $download |
| 556 | 556 | * |
| 557 | 557 | * @return float Base price for an extension. If not for sale separately, returns 0 |
| 558 | 558 | */ |
| 559 | 559 | private function get_download_base_price( $download ) { |
| 560 | 560 | |
| 561 | - $base_price = \GV\Utils::get( $download, 'pricing/amount', 0 ); |
|
| 561 | + $base_price = \GV\Utils::get( $download, 'pricing/amount', 0 ); |
|
| 562 | 562 | $base_price = \GFCommon::to_number( $base_price ); |
| 563 | 563 | |
| 564 | 564 | unset( $download['pricing']['amount'] ); |
@@ -569,7 +569,7 @@ discard block |
||
| 569 | 569 | } |
| 570 | 570 | |
| 571 | 571 | return floatval( $base_price ); |
| 572 | - } |
|
| 572 | + } |
|
| 573 | 573 | |
| 574 | 574 | /** |
| 575 | 575 | * Handle AJAX request to activate extension |
@@ -587,8 +587,8 @@ discard block |
||
| 587 | 587 | |
| 588 | 588 | if ( is_wp_error( $result ) || ! is_plugin_active( $data['path'] ) ) { |
| 589 | 589 | wp_send_json_error( array( |
| 590 | - 'error' => sprintf( __( 'Plugin activation failed: %s', 'gravityview' ), $result->get_error_message() ) |
|
| 591 | - ) ); |
|
| 590 | + 'error' => sprintf( __( 'Plugin activation failed: %s', 'gravityview' ), $result->get_error_message() ) |
|
| 591 | + ) ); |
|
| 592 | 592 | } |
| 593 | 593 | |
| 594 | 594 | wp_send_json_success(); |
@@ -609,10 +609,10 @@ discard block |
||
| 609 | 609 | deactivate_plugins( $data['path'] ); |
| 610 | 610 | |
| 611 | 611 | if( is_plugin_active( $data['path'] ) ) { |
| 612 | - wp_send_json_error( array( |
|
| 613 | - 'error' => sprintf( __( 'Plugin deactivation failed.', 'gravityview' ) ) |
|
| 614 | - ) ); |
|
| 615 | - } |
|
| 612 | + wp_send_json_error( array( |
|
| 613 | + 'error' => sprintf( __( 'Plugin deactivation failed.', 'gravityview' ) ) |
|
| 614 | + ) ); |
|
| 615 | + } |
|
| 616 | 616 | |
| 617 | 617 | wp_send_json_success(); |
| 618 | 618 | } |
@@ -10,42 +10,42 @@ discard block |
||
| 10 | 10 | */ |
| 11 | 11 | |
| 12 | 12 | if ( ! defined( 'WPINC' ) ) { |
| 13 | - die; |
|
| 13 | + die; |
|
| 14 | 14 | } |
| 15 | 15 | |
| 16 | 16 | |
| 17 | 17 | class GravityView_Edit_Entry_Admin { |
| 18 | 18 | |
| 19 | - protected $loader; |
|
| 19 | + protected $loader; |
|
| 20 | 20 | |
| 21 | - function __construct( GravityView_Edit_Entry $loader ) { |
|
| 22 | - $this->loader = $loader; |
|
| 23 | - } |
|
| 21 | + function __construct( GravityView_Edit_Entry $loader ) { |
|
| 22 | + $this->loader = $loader; |
|
| 23 | + } |
|
| 24 | 24 | |
| 25 | - function load() { |
|
| 25 | + function load() { |
|
| 26 | 26 | |
| 27 | - if( !is_admin() ) { |
|
| 28 | - return; |
|
| 29 | - } |
|
| 27 | + if( !is_admin() ) { |
|
| 28 | + return; |
|
| 29 | + } |
|
| 30 | 30 | |
| 31 | - // Add Edit Link as a default field, outside those set in the Gravity Form form |
|
| 32 | - add_filter( 'gravityview_entry_default_fields', array( $this, 'add_default_field' ), 10, 3 ); |
|
| 31 | + // Add Edit Link as a default field, outside those set in the Gravity Form form |
|
| 32 | + add_filter( 'gravityview_entry_default_fields', array( $this, 'add_default_field' ), 10, 3 ); |
|
| 33 | 33 | |
| 34 | - // For the Edit Entry Link, you don't want visible to all users. |
|
| 35 | - add_filter( 'gravityview_field_visibility_caps', array( $this, 'modify_visibility_caps' ), 10, 5 ); |
|
| 34 | + // For the Edit Entry Link, you don't want visible to all users. |
|
| 35 | + add_filter( 'gravityview_field_visibility_caps', array( $this, 'modify_visibility_caps' ), 10, 5 ); |
|
| 36 | 36 | |
| 37 | - // Modify the field options based on the name of the field type |
|
| 38 | - add_filter( 'gravityview_template_edit_link_options', array( $this, 'edit_link_field_options' ), 10, 5 ); |
|
| 37 | + // Modify the field options based on the name of the field type |
|
| 38 | + add_filter( 'gravityview_template_edit_link_options', array( $this, 'edit_link_field_options' ), 10, 5 ); |
|
| 39 | 39 | |
| 40 | - // add tooltips |
|
| 41 | - add_filter( 'gravityview/metaboxes/tooltips', array( $this, 'tooltips') ); |
|
| 40 | + // add tooltips |
|
| 41 | + add_filter( 'gravityview/metaboxes/tooltips', array( $this, 'tooltips') ); |
|
| 42 | 42 | |
| 43 | - // custom fields' options for zone EDIT |
|
| 44 | - add_filter( 'gravityview_template_field_options', array( $this, 'field_options' ), 10, 6 ); |
|
| 43 | + // custom fields' options for zone EDIT |
|
| 44 | + add_filter( 'gravityview_template_field_options', array( $this, 'field_options' ), 10, 6 ); |
|
| 45 | 45 | |
| 46 | - // Add Edit Entry settings to View Settings |
|
| 47 | - add_action( 'gravityview/metaboxes/edit_entry', array( $this, 'view_settings_metabox' ) ); |
|
| 48 | - } |
|
| 46 | + // Add Edit Entry settings to View Settings |
|
| 47 | + add_action( 'gravityview/metaboxes/edit_entry', array( $this, 'view_settings_metabox' ) ); |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | 50 | /** |
| 51 | 51 | * Render Edit Entry View metabox settings |
@@ -73,109 +73,109 @@ discard block |
||
| 73 | 73 | GravityView_Render_Settings::render_setting_row( 'action_label_cancel', $current_settings ); |
| 74 | 74 | } |
| 75 | 75 | |
| 76 | - /** |
|
| 77 | - * Add Edit Link as a default field, outside those set in the Gravity Form form |
|
| 78 | - * @param array $entry_default_fields Existing fields |
|
| 79 | - * @param string|array $form form_ID or form object |
|
| 80 | - * @param string $zone Either 'single', 'directory', 'header', 'footer' |
|
| 81 | - */ |
|
| 82 | - function add_default_field( $entry_default_fields, $form = array(), $zone = '' ) { |
|
| 83 | - |
|
| 84 | - if( $zone !== 'edit' ) { |
|
| 85 | - |
|
| 86 | - $entry_default_fields['edit_link'] = array( |
|
| 87 | - 'label' => __('Link to Edit Entry', 'gravityview'), |
|
| 88 | - 'type' => 'edit_link', |
|
| 89 | - 'desc' => __('A link to edit the entry. Visible based on View settings.', 'gravityview'), |
|
| 90 | - 'icon' => 'dashicons-welcome-write-blog', |
|
| 91 | - ); |
|
| 92 | - |
|
| 93 | - } |
|
| 94 | - |
|
| 95 | - return $entry_default_fields; |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * Change wording for the Edit context to read Entry Creator |
|
| 100 | - * |
|
| 101 | - * @param array $visibility_caps Array of capabilities to display in field dropdown. |
|
| 102 | - * @param string $field_type Type of field options to render (`field` or `widget`) |
|
| 103 | - * @param string $template_id Table slug |
|
| 104 | - * @param float $field_id GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by` |
|
| 105 | - * @param string $context What context are we in? Example: `single` or `directory` |
|
| 106 | - * @param string $input_type (textarea, list, select, etc.) |
|
| 107 | - * @return array Array of field options with `label`, `value`, `type`, `default` keys |
|
| 108 | - */ |
|
| 109 | - function modify_visibility_caps( $visibility_caps = array(), $template_id = '', $field_id = '', $context = '', $input_type = '' ) { |
|
| 110 | - |
|
| 111 | - $caps = $visibility_caps; |
|
| 112 | - |
|
| 113 | - // If we're configuring fields in the edit context, we want a limited selection |
|
| 114 | - if( $context === 'edit' ) { |
|
| 115 | - |
|
| 116 | - // Remove other built-in caps. |
|
| 117 | - unset( $caps['publish_posts'], $caps['gravityforms_view_entries'], $caps['delete_others_posts'] ); |
|
| 118 | - |
|
| 119 | - $caps['read'] = _x('Entry Creator','User capability', 'gravityview'); |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - return $caps; |
|
| 123 | - } |
|
| 124 | - |
|
| 125 | - /** |
|
| 126 | - * Add "Edit Link Text" setting to the edit_link field settings |
|
| 127 | - * |
|
| 128 | - * @param array $field_options |
|
| 129 | - * @param string $template_id |
|
| 130 | - * @param string $field_id |
|
| 131 | - * @param string $context |
|
| 132 | - * @param string $input_type |
|
| 133 | - * |
|
| 134 | - * @return array $field_options, with "Edit Link Text" field option |
|
| 135 | - */ |
|
| 136 | - function edit_link_field_options( $field_options, $template_id, $field_id, $context, $input_type ) { |
|
| 137 | - |
|
| 138 | - // Always a link, never a filter |
|
| 139 | - unset( $field_options['show_as_link'], $field_options['search_filter'] ); |
|
| 140 | - |
|
| 141 | - // Edit Entry link should only appear to visitors capable of editing entries |
|
| 142 | - unset( $field_options['only_loggedin'], $field_options['only_loggedin_cap'] ); |
|
| 143 | - |
|
| 144 | - $add_option['edit_link'] = array( |
|
| 145 | - 'type' => 'text', |
|
| 146 | - 'label' => __( 'Edit Link Text', 'gravityview' ), |
|
| 147 | - 'desc' => NULL, |
|
| 148 | - 'value' => __('Edit Entry', 'gravityview'), |
|
| 149 | - 'merge_tags' => true, |
|
| 150 | - ); |
|
| 151 | - |
|
| 152 | - $add_option['new_window'] = array( |
|
| 153 | - 'type' => 'checkbox', |
|
| 154 | - 'label' => __( 'Open link in a new tab or window?', 'gravityview' ), |
|
| 155 | - 'value' => false, |
|
| 156 | - 'group' => 'display', |
|
| 157 | - 'priority' => 1300, |
|
| 158 | - ); |
|
| 159 | - |
|
| 160 | - return array_merge( $add_option, $field_options ); |
|
| 161 | - } |
|
| 162 | - |
|
| 163 | - /** |
|
| 164 | - * Add tooltips |
|
| 165 | - * @param array $tooltips Existing tooltips |
|
| 166 | - * @return array Modified tooltips |
|
| 167 | - */ |
|
| 168 | - function tooltips( $tooltips ) { |
|
| 169 | - |
|
| 170 | - $return = $tooltips; |
|
| 171 | - |
|
| 172 | - $return['allow_edit_cap'] = array( |
|
| 173 | - 'title' => __('Limiting Edit Access', 'gravityview'), |
|
| 174 | - 'value' => __('Change this setting if you don\'t want the user who created the entry to be able to edit this field.', 'gravityview'), |
|
| 175 | - ); |
|
| 176 | - |
|
| 177 | - return $return; |
|
| 178 | - } |
|
| 76 | + /** |
|
| 77 | + * Add Edit Link as a default field, outside those set in the Gravity Form form |
|
| 78 | + * @param array $entry_default_fields Existing fields |
|
| 79 | + * @param string|array $form form_ID or form object |
|
| 80 | + * @param string $zone Either 'single', 'directory', 'header', 'footer' |
|
| 81 | + */ |
|
| 82 | + function add_default_field( $entry_default_fields, $form = array(), $zone = '' ) { |
|
| 83 | + |
|
| 84 | + if( $zone !== 'edit' ) { |
|
| 85 | + |
|
| 86 | + $entry_default_fields['edit_link'] = array( |
|
| 87 | + 'label' => __('Link to Edit Entry', 'gravityview'), |
|
| 88 | + 'type' => 'edit_link', |
|
| 89 | + 'desc' => __('A link to edit the entry. Visible based on View settings.', 'gravityview'), |
|
| 90 | + 'icon' => 'dashicons-welcome-write-blog', |
|
| 91 | + ); |
|
| 92 | + |
|
| 93 | + } |
|
| 94 | + |
|
| 95 | + return $entry_default_fields; |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * Change wording for the Edit context to read Entry Creator |
|
| 100 | + * |
|
| 101 | + * @param array $visibility_caps Array of capabilities to display in field dropdown. |
|
| 102 | + * @param string $field_type Type of field options to render (`field` or `widget`) |
|
| 103 | + * @param string $template_id Table slug |
|
| 104 | + * @param float $field_id GF Field ID - Example: `3`, `5.2`, `entry_link`, `created_by` |
|
| 105 | + * @param string $context What context are we in? Example: `single` or `directory` |
|
| 106 | + * @param string $input_type (textarea, list, select, etc.) |
|
| 107 | + * @return array Array of field options with `label`, `value`, `type`, `default` keys |
|
| 108 | + */ |
|
| 109 | + function modify_visibility_caps( $visibility_caps = array(), $template_id = '', $field_id = '', $context = '', $input_type = '' ) { |
|
| 110 | + |
|
| 111 | + $caps = $visibility_caps; |
|
| 112 | + |
|
| 113 | + // If we're configuring fields in the edit context, we want a limited selection |
|
| 114 | + if( $context === 'edit' ) { |
|
| 115 | + |
|
| 116 | + // Remove other built-in caps. |
|
| 117 | + unset( $caps['publish_posts'], $caps['gravityforms_view_entries'], $caps['delete_others_posts'] ); |
|
| 118 | + |
|
| 119 | + $caps['read'] = _x('Entry Creator','User capability', 'gravityview'); |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + return $caps; |
|
| 123 | + } |
|
| 124 | + |
|
| 125 | + /** |
|
| 126 | + * Add "Edit Link Text" setting to the edit_link field settings |
|
| 127 | + * |
|
| 128 | + * @param array $field_options |
|
| 129 | + * @param string $template_id |
|
| 130 | + * @param string $field_id |
|
| 131 | + * @param string $context |
|
| 132 | + * @param string $input_type |
|
| 133 | + * |
|
| 134 | + * @return array $field_options, with "Edit Link Text" field option |
|
| 135 | + */ |
|
| 136 | + function edit_link_field_options( $field_options, $template_id, $field_id, $context, $input_type ) { |
|
| 137 | + |
|
| 138 | + // Always a link, never a filter |
|
| 139 | + unset( $field_options['show_as_link'], $field_options['search_filter'] ); |
|
| 140 | + |
|
| 141 | + // Edit Entry link should only appear to visitors capable of editing entries |
|
| 142 | + unset( $field_options['only_loggedin'], $field_options['only_loggedin_cap'] ); |
|
| 143 | + |
|
| 144 | + $add_option['edit_link'] = array( |
|
| 145 | + 'type' => 'text', |
|
| 146 | + 'label' => __( 'Edit Link Text', 'gravityview' ), |
|
| 147 | + 'desc' => NULL, |
|
| 148 | + 'value' => __('Edit Entry', 'gravityview'), |
|
| 149 | + 'merge_tags' => true, |
|
| 150 | + ); |
|
| 151 | + |
|
| 152 | + $add_option['new_window'] = array( |
|
| 153 | + 'type' => 'checkbox', |
|
| 154 | + 'label' => __( 'Open link in a new tab or window?', 'gravityview' ), |
|
| 155 | + 'value' => false, |
|
| 156 | + 'group' => 'display', |
|
| 157 | + 'priority' => 1300, |
|
| 158 | + ); |
|
| 159 | + |
|
| 160 | + return array_merge( $add_option, $field_options ); |
|
| 161 | + } |
|
| 162 | + |
|
| 163 | + /** |
|
| 164 | + * Add tooltips |
|
| 165 | + * @param array $tooltips Existing tooltips |
|
| 166 | + * @return array Modified tooltips |
|
| 167 | + */ |
|
| 168 | + function tooltips( $tooltips ) { |
|
| 169 | + |
|
| 170 | + $return = $tooltips; |
|
| 171 | + |
|
| 172 | + $return['allow_edit_cap'] = array( |
|
| 173 | + 'title' => __('Limiting Edit Access', 'gravityview'), |
|
| 174 | + 'value' => __('Change this setting if you don\'t want the user who created the entry to be able to edit this field.', 'gravityview'), |
|
| 175 | + ); |
|
| 176 | + |
|
| 177 | + return $return; |
|
| 178 | + } |
|
| 179 | 179 | |
| 180 | 180 | /** |
| 181 | 181 | * Add "Edit Link Text" setting to the edit_link field settings |
@@ -191,28 +191,28 @@ discard block |
||
| 191 | 191 | */ |
| 192 | 192 | public function field_options( $field_options, $template_id, $field_id, $context, $input_type, $form_id ) { |
| 193 | 193 | |
| 194 | - // We only want to modify the settings for the edit context |
|
| 195 | - if( 'edit' !== $context ) { |
|
| 196 | - return $field_options; |
|
| 197 | - } |
|
| 198 | - |
|
| 199 | - // Entry field is only for logged in users |
|
| 200 | - unset( $field_options['only_loggedin'], $field_options['only_loggedin_cap'] ); |
|
| 201 | - |
|
| 202 | - $add_options = array( |
|
| 203 | - 'allow_edit_cap' => array( |
|
| 204 | - 'type' => 'select', |
|
| 205 | - 'label' => __( 'Make field editable to:', 'gravityview' ), |
|
| 206 | - 'choices' => GravityView_Render_Settings::get_cap_choices( $template_id, $field_id, $context, $input_type ), |
|
| 207 | - 'tooltip' => 'allow_edit_cap', |
|
| 208 | - 'class' => 'widefat', |
|
| 209 | - 'value' => 'read', // Default: entry creator |
|
| 210 | - 'group' => 'visibility', |
|
| 211 | - ), |
|
| 212 | - ); |
|
| 213 | - |
|
| 214 | - return array_merge( $field_options, $add_options ); |
|
| 215 | - } |
|
| 194 | + // We only want to modify the settings for the edit context |
|
| 195 | + if( 'edit' !== $context ) { |
|
| 196 | + return $field_options; |
|
| 197 | + } |
|
| 198 | + |
|
| 199 | + // Entry field is only for logged in users |
|
| 200 | + unset( $field_options['only_loggedin'], $field_options['only_loggedin_cap'] ); |
|
| 201 | + |
|
| 202 | + $add_options = array( |
|
| 203 | + 'allow_edit_cap' => array( |
|
| 204 | + 'type' => 'select', |
|
| 205 | + 'label' => __( 'Make field editable to:', 'gravityview' ), |
|
| 206 | + 'choices' => GravityView_Render_Settings::get_cap_choices( $template_id, $field_id, $context, $input_type ), |
|
| 207 | + 'tooltip' => 'allow_edit_cap', |
|
| 208 | + 'class' => 'widefat', |
|
| 209 | + 'value' => 'read', // Default: entry creator |
|
| 210 | + 'group' => 'visibility', |
|
| 211 | + ), |
|
| 212 | + ); |
|
| 213 | + |
|
| 214 | + return array_merge( $field_options, $add_options ); |
|
| 215 | + } |
|
| 216 | 216 | |
| 217 | 217 | |
| 218 | 218 | } // end class |
@@ -20,16 +20,16 @@ discard block |
||
| 20 | 20 | <div id="publishing-action"> |
| 21 | 21 | <?php |
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * @filter `gravityview/edit_entry/cancel_link` Modify the cancel button link URL |
|
| 25 | - * @since 1.11.1 |
|
| 26 | - * @since 2.11 The cancel link now uses history.back() so the $back_link URL matters less. |
|
| 27 | - * @param string $back_link Existing URL of the Cancel link |
|
| 28 | - * @param array $form The Gravity Forms form |
|
| 29 | - * @param array $entry The Gravity Forms entry |
|
| 30 | - * @param int $view_id The current View ID |
|
| 31 | - */ |
|
| 32 | - $back_link = apply_filters( 'gravityview/edit_entry/cancel_link', remove_query_arg( array( 'page', 'view', 'edit' ) ), $object->form, $object->entry, $object->view_id ); |
|
| 23 | + /** |
|
| 24 | + * @filter `gravityview/edit_entry/cancel_link` Modify the cancel button link URL |
|
| 25 | + * @since 1.11.1 |
|
| 26 | + * @since 2.11 The cancel link now uses history.back() so the $back_link URL matters less. |
|
| 27 | + * @param string $back_link Existing URL of the Cancel link |
|
| 28 | + * @param array $form The Gravity Forms form |
|
| 29 | + * @param array $entry The Gravity Forms entry |
|
| 30 | + * @param int $view_id The current View ID |
|
| 31 | + */ |
|
| 32 | + $back_link = apply_filters( 'gravityview/edit_entry/cancel_link', remove_query_arg( array( 'page', 'view', 'edit' ) ), $object->form, $object->entry, $object->view_id ); |
|
| 33 | 33 | |
| 34 | 34 | /** |
| 35 | 35 | * @action `gravityview/edit-entry/publishing-action/before` Triggered before the submit buttons in the Edit Entry screen, inside the `<div id="publishing-action">` container. |
@@ -84,11 +84,11 @@ discard block |
||
| 84 | 84 | * @used-by GravityView_Delete_Entry::add_delete_button() |
| 85 | 85 | * |
| 86 | 86 | * @since 1.5.1 |
| 87 | - * @since 2.0.13 Added $post_id |
|
| 87 | + * @since 2.0.13 Added $post_id |
|
| 88 | 88 | * @param array $form The Gravity Forms form |
| 89 | 89 | * @param array $entry The Gravity Forms entry |
| 90 | 90 | * @param int $view_id The current View ID |
| 91 | - * @param int $post_id The current Post ID |
|
| 91 | + * @param int $post_id The current Post ID |
|
| 92 | 92 | */ |
| 93 | 93 | do_action( 'gravityview/edit-entry/publishing-action/after', $object->form, $object->entry, $object->view_id, $object->post_id ); |
| 94 | 94 | ?> |
@@ -17,118 +17,118 @@ |
||
| 17 | 17 | */ |
| 18 | 18 | abstract class AbstractLogger implements LoggerInterface |
| 19 | 19 | { |
| 20 | - /** |
|
| 21 | - * System is unusable. |
|
| 22 | - * |
|
| 23 | - * @param string $message |
|
| 24 | - * @param mixed[] $context |
|
| 25 | - * |
|
| 26 | - * @return void |
|
| 27 | - */ |
|
| 28 | - public function emergency($message, array $context = array()) |
|
| 29 | - { |
|
| 30 | - $this->log(LogLevel::EMERGENCY, $message, $context); |
|
| 31 | - } |
|
| 20 | + /** |
|
| 21 | + * System is unusable. |
|
| 22 | + * |
|
| 23 | + * @param string $message |
|
| 24 | + * @param mixed[] $context |
|
| 25 | + * |
|
| 26 | + * @return void |
|
| 27 | + */ |
|
| 28 | + public function emergency($message, array $context = array()) |
|
| 29 | + { |
|
| 30 | + $this->log(LogLevel::EMERGENCY, $message, $context); |
|
| 31 | + } |
|
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * Action must be taken immediately. |
|
| 35 | - * |
|
| 36 | - * Example: Entire website down, database unavailable, etc. This should |
|
| 37 | - * trigger the SMS alerts and wake you up. |
|
| 38 | - * |
|
| 39 | - * @param string $message |
|
| 40 | - * @param mixed[] $context |
|
| 41 | - * |
|
| 42 | - * @return void |
|
| 43 | - */ |
|
| 44 | - public function alert($message, array $context = array()) |
|
| 45 | - { |
|
| 46 | - $this->log(LogLevel::ALERT, $message, $context); |
|
| 47 | - } |
|
| 33 | + /** |
|
| 34 | + * Action must be taken immediately. |
|
| 35 | + * |
|
| 36 | + * Example: Entire website down, database unavailable, etc. This should |
|
| 37 | + * trigger the SMS alerts and wake you up. |
|
| 38 | + * |
|
| 39 | + * @param string $message |
|
| 40 | + * @param mixed[] $context |
|
| 41 | + * |
|
| 42 | + * @return void |
|
| 43 | + */ |
|
| 44 | + public function alert($message, array $context = array()) |
|
| 45 | + { |
|
| 46 | + $this->log(LogLevel::ALERT, $message, $context); |
|
| 47 | + } |
|
| 48 | 48 | |
| 49 | - /** |
|
| 50 | - * Critical conditions. |
|
| 51 | - * |
|
| 52 | - * Example: Application component unavailable, unexpected exception. |
|
| 53 | - * |
|
| 54 | - * @param string $message |
|
| 55 | - * @param mixed[] $context |
|
| 56 | - * |
|
| 57 | - * @return void |
|
| 58 | - */ |
|
| 59 | - public function critical($message, array $context = array()) |
|
| 60 | - { |
|
| 61 | - $this->log(LogLevel::CRITICAL, $message, $context); |
|
| 62 | - } |
|
| 49 | + /** |
|
| 50 | + * Critical conditions. |
|
| 51 | + * |
|
| 52 | + * Example: Application component unavailable, unexpected exception. |
|
| 53 | + * |
|
| 54 | + * @param string $message |
|
| 55 | + * @param mixed[] $context |
|
| 56 | + * |
|
| 57 | + * @return void |
|
| 58 | + */ |
|
| 59 | + public function critical($message, array $context = array()) |
|
| 60 | + { |
|
| 61 | + $this->log(LogLevel::CRITICAL, $message, $context); |
|
| 62 | + } |
|
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * Runtime errors that do not require immediate action but should typically |
|
| 66 | - * be logged and monitored. |
|
| 67 | - * |
|
| 68 | - * @param string $message |
|
| 69 | - * @param mixed[] $context |
|
| 70 | - * |
|
| 71 | - * @return void |
|
| 72 | - */ |
|
| 73 | - public function error($message, array $context = array()) |
|
| 74 | - { |
|
| 75 | - $this->log(LogLevel::ERROR, $message, $context); |
|
| 76 | - } |
|
| 64 | + /** |
|
| 65 | + * Runtime errors that do not require immediate action but should typically |
|
| 66 | + * be logged and monitored. |
|
| 67 | + * |
|
| 68 | + * @param string $message |
|
| 69 | + * @param mixed[] $context |
|
| 70 | + * |
|
| 71 | + * @return void |
|
| 72 | + */ |
|
| 73 | + public function error($message, array $context = array()) |
|
| 74 | + { |
|
| 75 | + $this->log(LogLevel::ERROR, $message, $context); |
|
| 76 | + } |
|
| 77 | 77 | |
| 78 | - /** |
|
| 79 | - * Exceptional occurrences that are not errors. |
|
| 80 | - * |
|
| 81 | - * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
| 82 | - * that are not necessarily wrong. |
|
| 83 | - * |
|
| 84 | - * @param string $message |
|
| 85 | - * @param mixed[] $context |
|
| 86 | - * |
|
| 87 | - * @return void |
|
| 88 | - */ |
|
| 89 | - public function warning($message, array $context = array()) |
|
| 90 | - { |
|
| 91 | - $this->log(LogLevel::WARNING, $message, $context); |
|
| 92 | - } |
|
| 78 | + /** |
|
| 79 | + * Exceptional occurrences that are not errors. |
|
| 80 | + * |
|
| 81 | + * Example: Use of deprecated APIs, poor use of an API, undesirable things |
|
| 82 | + * that are not necessarily wrong. |
|
| 83 | + * |
|
| 84 | + * @param string $message |
|
| 85 | + * @param mixed[] $context |
|
| 86 | + * |
|
| 87 | + * @return void |
|
| 88 | + */ |
|
| 89 | + public function warning($message, array $context = array()) |
|
| 90 | + { |
|
| 91 | + $this->log(LogLevel::WARNING, $message, $context); |
|
| 92 | + } |
|
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * Normal but significant events. |
|
| 96 | - * |
|
| 97 | - * @param string $message |
|
| 98 | - * @param mixed[] $context |
|
| 99 | - * |
|
| 100 | - * @return void |
|
| 101 | - */ |
|
| 102 | - public function notice($message, array $context = array()) |
|
| 103 | - { |
|
| 104 | - $this->log(LogLevel::NOTICE, $message, $context); |
|
| 105 | - } |
|
| 94 | + /** |
|
| 95 | + * Normal but significant events. |
|
| 96 | + * |
|
| 97 | + * @param string $message |
|
| 98 | + * @param mixed[] $context |
|
| 99 | + * |
|
| 100 | + * @return void |
|
| 101 | + */ |
|
| 102 | + public function notice($message, array $context = array()) |
|
| 103 | + { |
|
| 104 | + $this->log(LogLevel::NOTICE, $message, $context); |
|
| 105 | + } |
|
| 106 | 106 | |
| 107 | - /** |
|
| 108 | - * Interesting events. |
|
| 109 | - * |
|
| 110 | - * Example: User logs in, SQL logs. |
|
| 111 | - * |
|
| 112 | - * @param string $message |
|
| 113 | - * @param mixed[] $context |
|
| 114 | - * |
|
| 115 | - * @return void |
|
| 116 | - */ |
|
| 117 | - public function info($message, array $context = array()) |
|
| 118 | - { |
|
| 119 | - $this->log(LogLevel::INFO, $message, $context); |
|
| 120 | - } |
|
| 107 | + /** |
|
| 108 | + * Interesting events. |
|
| 109 | + * |
|
| 110 | + * Example: User logs in, SQL logs. |
|
| 111 | + * |
|
| 112 | + * @param string $message |
|
| 113 | + * @param mixed[] $context |
|
| 114 | + * |
|
| 115 | + * @return void |
|
| 116 | + */ |
|
| 117 | + public function info($message, array $context = array()) |
|
| 118 | + { |
|
| 119 | + $this->log(LogLevel::INFO, $message, $context); |
|
| 120 | + } |
|
| 121 | 121 | |
| 122 | - /** |
|
| 123 | - * Detailed debug information. |
|
| 124 | - * |
|
| 125 | - * @param string $message |
|
| 126 | - * @param mixed[] $context |
|
| 127 | - * |
|
| 128 | - * @return void |
|
| 129 | - */ |
|
| 130 | - public function debug($message, array $context = array()) |
|
| 131 | - { |
|
| 132 | - $this->log(LogLevel::DEBUG, $message, $context); |
|
| 133 | - } |
|
| 122 | + /** |
|
| 123 | + * Detailed debug information. |
|
| 124 | + * |
|
| 125 | + * @param string $message |
|
| 126 | + * @param mixed[] $context |
|
| 127 | + * |
|
| 128 | + * @return void |
|
| 129 | + */ |
|
| 130 | + public function debug($message, array $context = array()) |
|
| 131 | + { |
|
| 132 | + $this->log(LogLevel::DEBUG, $message, $context); |
|
| 133 | + } |
|
| 134 | 134 | } |
@@ -13,20 +13,20 @@ |
||
| 13 | 13 | */ |
| 14 | 14 | trait LoggerAwareTrait |
| 15 | 15 | { |
| 16 | - /** |
|
| 17 | - * The logger instance. |
|
| 18 | - * |
|
| 19 | - * @var LoggerInterface|null |
|
| 20 | - */ |
|
| 21 | - protected $logger; |
|
| 16 | + /** |
|
| 17 | + * The logger instance. |
|
| 18 | + * |
|
| 19 | + * @var LoggerInterface|null |
|
| 20 | + */ |
|
| 21 | + protected $logger; |
|
| 22 | 22 | |
| 23 | - /** |
|
| 24 | - * Sets a logger. |
|
| 25 | - * |
|
| 26 | - * @param LoggerInterface $logger |
|
| 27 | - */ |
|
| 28 | - public function setLogger(LoggerInterface $logger) |
|
| 29 | - { |
|
| 30 | - $this->logger = $logger; |
|
| 31 | - } |
|
| 23 | + /** |
|
| 24 | + * Sets a logger. |
|
| 25 | + * |
|
| 26 | + * @param LoggerInterface $logger |
|
| 27 | + */ |
|
| 28 | + public function setLogger(LoggerInterface $logger) |
|
| 29 | + { |
|
| 30 | + $this->logger = $logger; |
|
| 31 | + } |
|
| 32 | 32 | } |
@@ -13,12 +13,12 @@ |
||
| 13 | 13 | */ |
| 14 | 14 | interface LoggerAwareInterface |
| 15 | 15 | { |
| 16 | - /** |
|
| 17 | - * Sets a logger instance on the object. |
|
| 18 | - * |
|
| 19 | - * @param LoggerInterface $logger |
|
| 20 | - * |
|
| 21 | - * @return void |
|
| 22 | - */ |
|
| 23 | - public function setLogger(LoggerInterface $logger); |
|
| 16 | + /** |
|
| 17 | + * Sets a logger instance on the object. |
|
| 18 | + * |
|
| 19 | + * @param LoggerInterface $logger |
|
| 20 | + * |
|
| 21 | + * @return void |
|
| 22 | + */ |
|
| 23 | + public function setLogger(LoggerInterface $logger); |
|
| 24 | 24 | } |