GravityView  1.19.4
The best, easiest way to display Gravity Forms entries on your website.
class-gravityview-change-entry-creator.php
Go to the documentation of this file.
1 <?php
2 
3 /**
4  * @since 1.2
5  */
7 
8  function __construct() {
9 
10  /**
11  * @since 1.5.1
12  */
13  add_action('gform_user_registered', array( $this, 'assign_new_user_to_lead'), 10, 4 );
14 
15  // ONLY ADMIN FROM HERE ON.
16  if( !is_admin() ) { return; }
17 
18  /**
19  * @filter `gravityview_disable_change_entry_creator` Disable the Change Entry Creator functionality
20  * @since 1.7.4
21  * @param boolean $disable Disable the Change Entry Creator functionality. Default: false.
22  */
23  if( apply_filters('gravityview_disable_change_entry_creator', false ) ) {
24  return;
25  }
26 
27  /**
28  * Use `init` to fix bbPress warning
29  * @see https://bbpress.trac.wordpress.org/ticket/2309
30  */
31  add_action('init', array( $this, 'load'), 100 );
32 
33  add_action('plugins_loaded', array( $this, 'prevent_conflicts') );
34 
35  }
36 
37  /**
38  * When an user is created using the User Registration add-on, assign the entry to them
39  *
40  * @since 1.5.1
41  * @uses RGFormsModel::update_lead_property() Modify the entry `created_by` field
42  * @param int $user_id WordPress User ID
43  * @param array $config User registration feed configuration
44  * @param array $entry GF Entry array
45  * @param string $password User password
46  * @return void
47  */
48  function assign_new_user_to_lead( $user_id, $config, $entry = array(), $password = '' ) {
49 
50  /**
51  * Disable assigning the new user to the entry by returning false.
52  * @param int $user_id WordPress User ID
53  * @param array $config User registration feed configuration
54  * @param array $entry GF Entry array
55  */
56  $assign_to_lead = apply_filters( 'gravityview_assign_new_user_to_entry', true, $user_id, $config, $entry );
57 
58  // If filter returns false, do not process
59  if( empty( $assign_to_lead ) ) {
60  return;
61  }
62 
63  // Update the entry. The `false` prevents checking Akismet; `true` disables the user updated hook from firing
64  $result = RGFormsModel::update_lead_property( $entry['id'], 'created_by', $user_id, false, true );
65 
66  if( empty( $result ) ) {
67  $status = __('Error', 'gravityview');
68  } else {
69  $status = __('Success', 'gravityview');
70  }
71 
72  $note = sprintf( _x('%s: Assigned User ID #%d as the entry creator.', 'First parameter: Success or error of the action. Second: User ID number', 'gravityview'), $status, $user_id );
73 
74  do_action( 'gravityview_log_debug', 'GravityView_Change_Entry_Creator[assign_new_user_to_lead] - '.$note );
75 
76  GravityView_Entry_Notes::add_note( $entry['id'], -1, 'GravityView', $note, 'gravityview' );
77 
78  }
79 
80  /**
81  * Disable previous functionality; use this one as the canonical.
82  * @return void
83  */
84  function prevent_conflicts() {
85 
86  // Plugin that was provided here:
87  // @link https://gravityview.co/support/documentation/201991205/
88  remove_action("gform_entry_info", 'gravityview_change_entry_creator_form', 10 );
89  remove_action("gform_after_update_entry", 'gravityview_update_entry_creator', 10 );
90 
91  // Disable for Gravity Forms Add-ons 3.6.2 and lower
92  if( class_exists( 'KWS_GF_Change_Lead_Creator' ) ) {
93 
94  $Old_Lead_Creator = new KWS_GF_Change_Lead_Creator;
95 
96  // Now, no validation is required in the methods; let's hook in.
97  remove_action('admin_init', array( $Old_Lead_Creator, 'set_screen_mode' ) );
98 
99  remove_action("gform_entry_info", array( $Old_Lead_Creator, 'add_select' ), 10 );
100 
101  remove_action("gform_after_update_entry", array( $Old_Lead_Creator, 'update_entry_creator' ), 10 );
102  }
103 
104  }
105 
106  /**
107  * @since 3.6.3
108  * @return void
109  */
110  function load() {
111 
112  // Does GF exist?
113  if( !class_exists('GFCommon') ) {
114  return;
115  }
116 
117  // Can the user edit entries?
118  if( ! GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_entries' ) ) ) {
119  return;
120  }
121 
122  // If screen mode isn't set, then we're in the wrong place.
123  if( empty( $_REQUEST['screen_mode'] ) ) {
124  return;
125  }
126 
127  // Now, no validation is required in the methods; let's hook in.
128  add_action('admin_init', array( &$this, 'set_screen_mode' ) );
129 
130  add_action("gform_entry_info", array( &$this, 'add_select' ), 10, 2);
131 
132  add_action("gform_after_update_entry", array( &$this, 'update_entry_creator' ), 10, 2);
133 
134  }
135 
136  /**
137  * Allows for edit links to work with a link instead of a form (GET instead of POST)
138  * @return void
139  */
140  function set_screen_mode() {
141 
142  // If $_GET['screen_mode'] is set to edit, set $_POST value
143  if( rgget('screen_mode') === 'edit' ) {
144  $_POST["screen_mode"] = 'edit';
145  }
146 
147  }
148 
149  /**
150  * When the entry creator is changed, add a note to the entry
151  * @param array $form GF entry array
152  * @param int $entry_id Entry ID
153  * @return void
154  */
155  function update_entry_creator($form, $entry_id) {
156  global $current_user;
157 
158  // Update the entry
159  $created_by = absint( rgpost('created_by') );
160 
161  RGFormsModel::update_lead_property( $entry_id, 'created_by', $created_by );
162 
163  // If the creator has changed, let's add a note about who it used to be.
164  $originally_created_by = rgpost('originally_created_by');
165 
166  // If there's no owner and there didn't used to be, keep going
167  if( empty( $originally_created_by ) && empty( $created_by ) ) {
168  return;
169  }
170 
171  // If the values have changed
172  if( absint( $originally_created_by ) !== absint( $created_by ) ) {
173 
174  $user_data = get_userdata($current_user->ID);
175 
176  $user_format = _x('%s (ID #%d)', 'The name and the ID of users who initiated changes to entry ownership', 'gravityview');
177 
178  $original_name = $created_by_name = esc_attr_x( 'No User', 'To show that the entry was unassigned from an actual user to no user.', 'gravityview');
179 
180  if( !empty( $originally_created_by ) ) {
181  $originally_created_by_user_data = get_userdata($originally_created_by);
182  $original_name = sprintf( $user_format, $originally_created_by_user_data->display_name, $originally_created_by_user_data->ID );
183  }
184 
185  if( !empty( $created_by ) ) {
186  $created_by_user_data = get_userdata($created_by);
187  $created_by_name = sprintf( $user_format, $created_by_user_data->display_name, $created_by_user_data->ID );
188  }
189 
190  GravityView_Entry_Notes::add_note( $entry_id, $current_user->ID, $user_data->display_name, sprintf( __('Changed entry creator from %s to %s', 'gravityview'), $original_name, $created_by_name ), 'note' );
191  }
192 
193  }
194 
195  /**
196  * Output the select to change the entry creator
197  * @param int $form_id GF Form ID
198  * @param array $entry GF entry array
199  * @return void
200  */
201  function add_select($form_id, $entry ) {
202 
203  if( rgpost('screen_mode') !== 'edit' ) {
204  return;
205  }
206 
207  $users = GVCommon::get_users( 'change_entry_creator' );
208 
209  $output = '<label for="change_created_by">';
210  $output .= esc_html__('Change Entry Creator:', 'gravityview');
211  $output .= '</label>
212  <select name="created_by" id="change_created_by" class="widefat">';
213  $output .= '<option value=""> &mdash; '.esc_attr_x( 'No User', 'No user assigned to the entry', 'gravityview').' &mdash; </option>';
214  foreach($users as $user) {
215  $output .= '<option value="'. $user->ID .'"'. selected( $entry['created_by'], $user->ID, false ).'>'.esc_attr( $user->display_name.' ('.$user->user_nicename.')' ).'</option>';
216  }
217  $output .= '</select>';
218  $output .= '<input name="originally_created_by" value="'.esc_attr( $entry['created_by'] ).'" type="hidden" />';
219  echo $output;
220 
221  }
222 
223 }
224 
__construct()
static has_cap($caps= '', $object_id=null, $user_id=null)
Alias of GravityView_Roles_Capabilities::has_cap()
static get_users($context= 'change_entry_creator', $args=array())
Get WordPress users with reasonable limits set.
assign_new_user_to_lead($user_id, $config, $entry=array(), $password= '')
When an user is created using the User Registration add-on, assign the entry to them.
set_screen_mode()
Allows for edit links to work with a link instead of a form (GET instead of POST) ...
update_entry_creator($form, $entry_id)
When the entry creator is changed, add a note to the entry.
$created_by
load()
if(empty($created_by)) $form_id
add_select($form_id, $entry)
Output the select to change the entry creator.
new GravityView_Change_Entry_Creator
static add_note($lead_id, $user_id, $user_name, $note= '', $note_type= 'gravityview')
Alias for GFFormsModel::add_note() with default note_type of &#39;gravityview&#39;.
$entry
Definition: notes.php:27
prevent_conflicts()
Disable previous functionality; use this one as the canonical.