GravityView  1.22.6
The best, easiest way to display Gravity Forms entries on your website.
class-admin.php
Go to the documentation of this file.
1 <?php
2 
4 
5  function __construct() {
6 
7  if( ! is_admin() ) { return; }
8 
9  // If Gravity Forms isn't active or compatibile, stop loading
10  if( false === GravityView_Compatibility::is_valid() ) {
11  return;
12  }
13 
14  $this->include_required_files();
15  $this->add_hooks();
16  }
17 
18  /**
19  * @since 1.15
20  * @return void
21  */
22  private function include_required_files() {
23 
24  // Migrate Class
25  require_once( GRAVITYVIEW_DIR . 'includes/class-gravityview-migrate.php' );
26 
27  require_once( GRAVITYVIEW_DIR . 'includes/admin/metaboxes/class-gravityview-admin-metaboxes.php' );
28  require_once( GRAVITYVIEW_DIR . 'includes/admin/entry-list.php' );
29  require_once( GRAVITYVIEW_DIR . 'includes/class-gravityview-change-entry-creator.php' );
30 
31  /** @since 1.15 **/
32  require_once( GRAVITYVIEW_DIR . 'includes/admin/class-gravityview-support-port.php' );
33 
34  /** @since 1.6 */
35  require_once( GRAVITYVIEW_DIR . 'includes/class-gravityview-admin-duplicate-view.php' );
36 
37  /** @since 1.17 */
38  require_once( GRAVITYVIEW_DIR . 'includes/admin/class-gravityview-admin-no-conflict.php' );
39  }
40 
41  /**
42  * @since 1.7.5
43  * @return void
44  */
45  private function add_hooks() {
46 
47  // Filter Admin messages
48  add_filter( 'post_updated_messages', array( $this, 'post_updated_messages' ) );
49  add_filter( 'bulk_post_updated_messages', array( $this, 'post_updated_messages' ) );
50 
51  add_filter( 'plugin_action_links_'. plugin_basename( GRAVITYVIEW_FILE ) , array( $this, 'plugin_action_links' ) );
52 
53  add_action( 'plugins_loaded', array( $this, 'backend_actions' ), 100 );
54 
55  add_action( 'gravityview/metaboxes/data-source/before', array( 'GravityView_Admin', 'connected_form_warning' ) );
56  }
57 
58  /**
59  * Get text for no views found.
60  *
61  * @since 1.18 Moved to GravityView_Admin
62  *
63  * @return string HTML message with no container tags.
64  */
65  public static function no_views_text() {
66 
67  if ( isset( $_REQUEST['post_status'] ) && 'trash' === $_REQUEST['post_status'] ) {
68  return __( 'No Views found in Trash', 'gravityview' );
69  } elseif( ! empty( $_GET['s'] ) ) {
70  return __( 'No Views found.', 'gravityview' );
71  }
72 
73  // Floaty the Astronaut says "oi"
74  $image = self::get_floaty();
75 
76  if ( GVCommon::has_cap( 'edit_gravityviews' ) ) {
77  $output = sprintf( esc_attr__( "%sYou don't have any active views. Let&rsquo;s go %screate one%s!%s\n\nIf you feel like you're lost in space and need help getting started, check out the %sGetting Started%s page.", 'gravityview' ), '<h3>', '<a href="' . admin_url( 'post-new.php?post_type=gravityview' ) . '">', '</a>', '</h3>', '<a href="' . admin_url( 'edit.php?post_type=gravityview&page=gv-getting-started' ) . '">', '</a>' );
78  } else {
79  $output = esc_attr__( 'There are no active Views', 'gravityview' );
80  }
81 
82  return $image . wpautop( $output );
83  }
84 
85  /**
86  * Display error HTML in Edit View when the form is in the trash or no longer exists in Gravity Forms
87  *
88  * @since 1.19
89  *
90  * @param int $form_id Gravity Forms
91  *
92  * @return void
93  */
94  public static function connected_form_warning( $form_id = 0 ) {
95  global $pagenow;
96 
97  if ( ! is_int( $form_id ) || $pagenow === 'post-new.php' ) {
98  return;
99  }
100 
101  $form_info = GFFormsModel::get_form( $form_id, true );
102 
103  $error = '';
104  if ( empty( $form_info ) ) {
105  $error = esc_html__( 'The form connected to this View no longer exists.', 'gravityview' );
106  $error .= ' ' . esc_html__( 'Select another form as the data source for this View.', 'gravityview' );
107  } elseif ( $form_info->is_trash ) {
108  $error = esc_html__( 'The connected form is in the trash.', 'gravityview' );
109  $error .= ' ' . gravityview_get_link( admin_url( 'admin.php?page=gf_edit_forms&filter=trash' ), esc_html__( 'Restore the form from the trash', 'gravityview' ) );
110  $error .= ' ' . esc_html__( 'or select another form.', 'gravityview' );
111  }
112 
113  if( $error ) {
114  ?>
115  <div class="wp-dialog notice-warning inline error wp-clearfix">
116  <?php echo gravityview_get_floaty(); ?>
117  <h3><?php echo $error; ?></h3>
118  </div>
119  <?php
120  }
121  }
122 
123  /**
124  * Function to launch admin objects
125  *
126  * @access public
127  * @return void
128  */
129  public function backend_actions() {
130 
131  /** @define "GRAVITYVIEW_DIR" "../" */
132  include_once( GRAVITYVIEW_DIR .'includes/admin/class.field.type.php' );
133  include_once( GRAVITYVIEW_DIR .'includes/admin/class.render.settings.php' );
134  include_once( GRAVITYVIEW_DIR .'includes/admin/class-gravityview-admin-view-item.php' );
135  include_once( GRAVITYVIEW_DIR .'includes/admin/class-gravityview-admin-view-field.php' );
136  include_once( GRAVITYVIEW_DIR .'includes/admin/class-gravityview-admin-view-widget.php' );
137  include_once( GRAVITYVIEW_DIR .'includes/class-admin-views.php' );
138  include_once( GRAVITYVIEW_DIR .'includes/class-admin-welcome.php' );
139  include_once( GRAVITYVIEW_DIR .'includes/class-admin-add-shortcode.php' );
140  include_once( GRAVITYVIEW_DIR .'includes/class-admin-approve-entries.php' );
141 
142  /**
143  * @action `gravityview_include_backend_actions` Triggered after all GravityView admin files are loaded
144  *
145  * Nice place to insert extensions' backend stuff
146  */
147  do_action('gravityview_include_backend_actions');
148  }
149 
150  /**
151  * Modify plugin action links at plugins screen
152  *
153  * @since 1.15 Added check for `gravityview_view_settings` and `gravityview_support_port` capabilities
154  * @access public
155  * @static
156  * @param array $links Array of action links under GravityView on the plugin page
157  * @return array Action links with Settings and Support included, if the user has the appropriate caps
158  */
159  public static function plugin_action_links( $links ) {
160 
161  $actions = array();
162 
163  if( GVCommon::has_cap( 'gravityview_view_settings' ) ) {
164  $actions[] = sprintf( '<a href="%s">%s</a>', admin_url( 'edit.php?post_type=gravityview&page=gravityview_settings' ), esc_html__( 'Settings', 'gravityview' ) );
165  }
166 
167  if( GVCommon::has_cap( 'gravityview_support_port' ) ) {
168  $actions[] = '<a href="http://docs.gravityview.co">' . esc_html__( 'Support', 'gravityview' ) . '</a>';
169  }
170 
171  return array_merge( $actions, $links );
172  }
173 
174  /**
175  * Get an image of our intrepid explorer friend
176  * @return string HTML image tag with floaty's cute mug on it
177  */
178  public static function get_floaty() {
179  return gravityview_get_floaty();
180  }
181 
182  /**
183  * Filter Admin messages
184  *
185  * @param array $messages Existing messages
186  * @return array Messages with GravityView views!
187  */
188  function post_updated_messages( $messages, $bulk_counts = NULL ) {
189  global $post;
190 
191  $post_id = get_the_ID();
192 
193  // By default, there will only be one item being modified.
194  // When in the `bulk_post_updated_messages` filter, there will be passed a number
195  // of modified items that will override this array.
196  $bulk_counts = is_null( $bulk_counts ) ? array( 'updated' => 1 , 'locked' => 1 , 'deleted' => 1 , 'trashed' => 1, 'untrashed' => 1 ) : $bulk_counts;
197 
198  // If we're starting fresh, a new form was created.
199  // We should let the user know this is the case.
200  $start_fresh = get_post_meta( $post_id, '_gravityview_start_fresh', true );
201 
202  $new_form_text = '';
203 
204  if( !empty( $start_fresh ) ) {
205 
206  // Get the form that was created
207  $connected_form = gravityview_get_form_id( $post_id );
208 
209  if( !empty( $connected_form ) ) {
210  $form = gravityview_get_form( $connected_form );
211  $form_name = esc_attr( $form['title'] );
212  $image = self::get_floaty();
213  $new_form_text .= '<h3>'.$image.sprintf( __( 'A new form was created for this View: "%s"', 'gravityview' ), $form_name ).'</h3>';
214  $new_form_text .= sprintf( __( '%sThere are no entries for the new form, so the View will also be empty.%s To start collecting entries, you can add submissions through %sthe preview form%s and also embed the form on a post or page using this code: %s
215 
216  You can %sedit the form%s in Gravity Forms and the updated fields will be available here. Don&rsquo;t forget to %scustomize the form settings%s.
217  ', 'gravityview' ), '<strong>', '</strong>', '<a href="'.site_url( '?gf_page=preview&amp;id='.$connected_form ).'">', '</a>', '<code>[gravityform id="'.$connected_form.'" name="'.$form_name.'"]</code>', '<a href="'.admin_url( 'admin.php?page=gf_edit_forms&amp;id='.$connected_form ).'">', '</a>', '<a href="'.admin_url( 'admin.php?page=gf_edit_forms&amp;view=settings&amp;id='.$connected_form ).'">', '</a>');
218  $new_form_text = wpautop( $new_form_text );
219 
220  delete_post_meta( $post_id, '_gravityview_start_fresh' );
221  }
222  }
223 
224  $messages['gravityview'] = array(
225  0 => '', // Unused. Messages start at index 1.
226  /* translators: %s and %s are HTML tags linking to the View on the website */
227  1 => sprintf(__( 'View updated. %sView on website.%s', 'gravityview' ), '<a href="'.get_permalink( $post_id ).'">', '</a>'),
228  /* translators: %s and %s are HTML tags linking to the View on the website */
229  2 => sprintf(__( 'View updated. %sView on website.%s', 'gravityview' ), '<a href="'.get_permalink( $post_id ).'">', '</a>'),
230  3 => __( 'View deleted.', 'gravityview' ),
231  /* translators: %s and %s are HTML tags linking to the View on the website */
232  4 => sprintf(__( 'View updated. %sView on website.%s', 'gravityview' ), '<a href="'.get_permalink( $post_id ).'">', '</a>'),
233  /* translators: %s: date and time of the revision */
234  5 => isset( $_GET['revision'] ) ? sprintf( __( 'View restored to revision from %s', 'gravityview' ), wp_post_revision_title( (int) $_GET['revision'], false ) ) : false,
235  /* translators: %s and %s are HTML tags linking to the View on the website */
236  6 => sprintf(__( 'View published. %sView on website.%s', 'gravityview' ), '<a href="'.get_permalink( $post_id ).'">', '</a>') . $new_form_text,
237  /* translators: %s and %s are HTML tags linking to the View on the website */
238  7 => sprintf(__( 'View saved. %sView on website.%s', 'gravityview' ), '<a href="'.get_permalink( $post_id ).'">', '</a>') . $new_form_text,
239  8 => __( 'View submitted.', 'gravityview' ),
240  9 => sprintf(
241  /* translators: Date and time the View is scheduled to be published */
242  __( 'View scheduled for: %1$s.', 'gravityview' ),
243  // translators: Publish box date format, see http://php.net/date
244  date_i18n( __( 'M j, Y @ G:i', 'gravityview' ), strtotime( ( isset( $post->post_date ) ? $post->post_date : NULL ) ) )
245  ) . $new_form_text,
246  /* translators: %s and %s are HTML tags linking to the View on the website */
247  10 => sprintf(__( 'View draft updated. %sView on website.%s', 'gravityview' ), '<a href="'.get_permalink( $post_id ).'">', '</a>') . $new_form_text,
248 
249  /**
250  * These apply to `bulk_post_updated_messages`
251  * @file wp-admin/edit.php
252  */
253  'updated' => _n( '%s View updated.', '%s Views updated.', $bulk_counts['updated'], 'gravityview' ),
254  'locked' => _n( '%s View not updated, somebody is editing it.', '%s Views not updated, somebody is editing them.', $bulk_counts['locked'], 'gravityview' ),
255  'deleted' => _n( '%s View permanently deleted.', '%s Views permanently deleted.', $bulk_counts['deleted'], 'gravityview' ),
256  'trashed' => _n( '%s View moved to the Trash.', '%s Views moved to the Trash.', $bulk_counts['trashed'], 'gravityview' ),
257  'untrashed' => _n( '%s View restored from the Trash.', '%s Views restored from the Trash.', $bulk_counts['untrashed'], 'gravityview' ),
258  );
259 
260  return $messages;
261  }
262 
263 
264  /**
265  * Get admin notices
266  * @deprecated since 1.12
267  * @return array
268  */
269  public static function get_notices() {
271  }
272 
273  /**
274  * Add a notice to be displayed in the admin.
275  * @deprecated since 1.12
276  * @param array $notice Array with `class` and `message` keys. The message is not escaped.
277  */
278  public static function add_notice( $notice = array() ) {
280  }
281 
282  /**
283  * Check if Gravity Forms plugin is active and show notice if not.
284  *
285  * @deprecated since 1.12
286  * @see GravityView_Compatibility::get_plugin_status()
287  * @return boolean True: checks have been passed; GV is fine to run; False: checks have failed, don't continue loading
288  */
289  public static function check_gravityforms() {
291  }
292 
293  /**
294  * Check if specified plugin is active, inactive or not installed
295  *
296  * @deprecated since 1.12
297  * @see GravityView_Compatibility::get_plugin_status()
298 
299  * @return boolean|string True: plugin is active; False: plugin file doesn't exist at path; 'inactive' it's inactive
300  */
301  static function get_plugin_status( $location = '' ) {
303  }
304 
305  /**
306  * Is the current admin page a GravityView-related page?
307  *
308  * @todo Convert to use WP_Screen
309  * @param string $hook
310  * @param null|string $page Optional. String return value of page to compare against.
311  *
312  * @return bool|string If `false`, not a GravityView page. `true` if $page is passed and is the same as current page. Otherwise, the name of the page (`single`, `settings`, or `views`)
313  */
314  static function is_admin_page( $hook = '', $page = NULL ) {
315  global $current_screen, $plugin_page, $pagenow, $post;
316 
317  if( ! is_admin() ) { return false; }
318 
319  $is_page = false;
320 
321  $is_gv_screen = (!empty($current_screen) && isset($current_screen->post_type) && $current_screen->post_type === 'gravityview');
322 
323  $is_gv_post_type_get = (isset($_GET['post_type']) && $_GET['post_type'] === 'gravityview');
324 
325  $is_gv_settings_get = isset( $_GET['page'] ) && $_GET['page'] === 'gravityview_settings';
326 
327  if( empty( $post ) && $pagenow === 'post.php' && !empty( $_GET['post'] ) ) {
328  $gv_post = get_post( intval( $_GET['post'] ) );
329  $is_gv_post_type = (!empty($gv_post) && !empty($gv_post->post_type) && $gv_post->post_type === 'gravityview');
330  } else {
331  $is_gv_post_type = (!empty($post) && !empty($post->post_type) && $post->post_type === 'gravityview');
332  }
333 
334  if( $is_gv_screen || $is_gv_post_type || $is_gv_post_type || $is_gv_post_type_get || $is_gv_settings_get ) {
335 
336  // $_GET `post_type` variable
337  if(in_array($pagenow, array( 'post.php' , 'post-new.php' )) ) {
338  $is_page = 'single';
339  } else if ( in_array( $plugin_page, array( 'gravityview_settings', 'gravityview_page_gravityview_settings' ) ) || ( !empty( $_GET['page'] ) && $_GET['page'] === 'gravityview_settings' ) ) {
340  $is_page = 'settings';
341  } else {
342  $is_page = 'views';
343  }
344  }
345 
346  /**
347  * @filter `gravityview_is_admin_page` Is the current admin page a GravityView-related page?
348  * @param[in,out] string|bool $is_page If false, no. If string, the name of the page (`single`, `settings`, or `views`)
349  * @param[in] string $hook The name of the page to check against. Is passed to the method.
350  */
351  $is_page = apply_filters( 'gravityview_is_admin_page', $is_page, $hook );
352 
353  // If the current page is the same as the compared page
354  if( !empty( $page ) ) {
355  return $is_page === $page;
356  }
357 
358  return $is_page;
359  }
360 
361 }
362 
364 
365 /**
366  * Alias for GravityView_Admin::is_admin_page()
367  *
368  * @see GravityView_Admin::is_admin_page
369  *
370  * @param string $hook
371  * @param null|string $page Optional. String return value of page to compare against.
372  *
373  * @return bool|string If `false`, not a GravityView page. `true` if $page is passed and is the same as current page. Otherwise, the name of the page (`single`, `settings`, or `views`)
374  */
375 function gravityview_is_admin_page($hook = '', $page = NULL) {
376  return GravityView_Admin::is_admin_page( $hook, $page );
377 }
const GRAVITYVIEW_DIR
"GRAVITYVIEW_DIR" "./" The absolute path to the plugin directory, with trailing slash ...
Definition: gravityview.php:35
$image
Definition: post_image.php:98
static plugin_action_links( $links)
Modify plugin action links at plugins screen.
static get_notices()
Get admin notices.
gravityview_get_form( $form_id)
Returns the form object for a given Form ID.
gravityview_get_link( $href='', $anchor_text='', $atts=array())
Generate an HTML anchor tag with a list of supported attributes.
new GravityView_Admin
static check_gravityforms()
Check if Gravity Forms plugin is active and show notice if not.
static is_valid()
Is everything compatible with this version of GravityView?
backend_actions()
Function to launch admin objects.
static get_plugin_status( $location='')
Check if specified plugin is active, inactive or not installed.
static no_views_text()
Get text for no views found.
Definition: class-admin.php:65
static is_admin_page( $hook='', $page=NULL)
Is the current admin page a GravityView-related page?
gravityview_get_form_id( $view_id)
Get the connected form ID from a View ID.
gravityview_get_floaty( $height=87)
Get an image of our intrepid explorer friend.
static get_plugin_status( $location='')
Check if specified plugin is active, inactive or not installed.
static check_gravityforms()
Check if Gravity Forms plugin is active and show notice if not.
static connected_form_warning( $form_id=0)
Display error HTML in Edit View when the form is in the trash or no longer exists in Gravity Forms...
Definition: class-admin.php:94
static add_notice( $notice=array())
Add a notice to be displayed in the admin.
if(empty( $created_by)) $form_id
static add_notice( $notice=array())
Add a notice to be displayed in the admin.
static get_floaty()
Get an image of our intrepid explorer friend.
global $post
gravityview_is_admin_page($hook='', $page=NULL)
Alias for GravityView_Admin::is_admin_page()
static has_cap( $caps='', $object_id=null, $user_id=null)
Alias of GravityView_Roles_Capabilities::has_cap()
const GRAVITYVIEW_FILE(! defined( 'ABSPATH'))
Plugin Name: GravityView Plugin URI: https://gravityview.co Description: The best, easiest way to display Gravity Forms entries on your website.
Definition: gravityview.php:26
static get_notices()
Get admin notices.