/home/techb158/on-time-movers.com/wp-content/plugins/wpforms/src/Pro/Admin
Edit: /home/techb158/on-time-movers.com/wp-content/plugins/wpforms/src/Pro/Admin/DashboardWidget.php (30121B)
entries_count = new EntriesCount();
add_action( 'admin_init', [ $this, 'init' ] );
}
/**
* Init class.
*
* @since 1.5.5
*/
public function init() {
// This widget should be displayed for certain high-level users only.
if ( ! wpforms_current_user_can( 'view_forms' ) ) {
return;
}
global $pagenow;
// phpcs:disable WordPress.Security.NonceVerification.Recommended
$is_admin_page = $pagenow === 'index.php' && empty( $_GET['page'] );
$is_ajax_request = wp_doing_ajax() && isset( $_REQUEST['action'] ) && strpos( sanitize_key( $_REQUEST['action'] ), 'wpforms_dash_widget' ) !== false;
// phpcs:enable WordPress.Security.NonceVerification.Recommended
if ( ! $is_admin_page && ! $is_ajax_request ) {
return;
}
if ( ! apply_filters( 'wpforms_admin_dashboardwidget', '__return_true' ) ) {
return;
}
$this->settings();
$this->hooks();
}
/**
* Filterable widget settings.
*
* @since 1.5.0
*/
public function settings() {
$widget_slug = static::SLUG;
// phpcs:disable WPForms.Comments.PHPDocHooks.RequiredHookDocumentation, WPForms.PHP.ValidateHooks.InvalidHookName
$this->settings = [
// Number of forms to display in the forms list before "Show More" button appears.
'forms_list_number_to_display' => apply_filters( "wpforms_{$widget_slug}_forms_list_number_to_display", 5 ),
// Allow results caching to reduce DB load.
'allow_data_caching' => apply_filters( "wpforms_{$widget_slug}_allow_data_caching", true ),
// PHP DateTime supported string (http://php.net/manual/en/datetime.formats.php).
'date_end_str' => apply_filters( "wpforms_{$widget_slug}_date_end_str", 'yesterday' ),
// Transient lifetime in seconds. Defaults to the end of a current day.
'transient_lifetime' => apply_filters( "wpforms_{$widget_slug}_transient_lifetime", strtotime( 'tomorrow' ) - time() ),
// Determine if the days with no entries should appear on a chart. Once switched, the effect applies after cache expiration.
'display_chart_empty_entries' => apply_filters( "wpforms_{$widget_slug}_display_chart_empty_entries", true ),
// Determine if the forms with no entries should appear in a forms list. Once switched, the effect applies after cache expiration.
'display_forms_list_empty_entries' => apply_filters( "wpforms_{$widget_slug}_display_forms_list_empty_entries", true ),
];
// phpcs:enable WPForms.Comments.PHPDocHooks.RequiredHookDocumentation, WPForms.PHP.ValidateHooks.InvalidHookName
}
/**
* Widget hooks.
*
* @since 1.5.0
*/
public function hooks() {
$widget_slug = static::SLUG;
add_action( 'admin_enqueue_scripts', [ $this, 'widget_scripts' ] );
if ( $widget_slug === 'dash_widget' ) {
add_action( 'wp_dashboard_setup', [ $this, 'widget_register' ] );
}
add_action( "wp_ajax_wpforms_{$widget_slug}_get_chart_data", [ $this, 'get_chart_data_ajax' ] );
add_action( "wp_ajax_wpforms_{$widget_slug}_get_forms_list", [ $this, 'get_forms_list_ajax' ] );
add_action( "wp_ajax_wpforms_{$widget_slug}_save_widget_meta", [ $this, 'save_widget_meta_ajax' ] );
add_action( 'wpforms_create_form', [ static::class, 'clear_widget_cache' ] );
add_action( 'wpforms_save_form', [ static::class, 'clear_widget_cache' ] );
add_action( 'wpforms_delete_form', [ static::class, 'clear_widget_cache' ] );
}
/**
* Load widget-specific scripts.
*
* @since 1.5.0
*
* @param string $hook_suffix The current admin page.
*/
public function widget_scripts( $hook_suffix ) {
if ( ! in_array( $hook_suffix, [ 'index.php', 'wpforms_page_wpforms-entries' ], true ) ) {
return;
}
$min = wpforms_get_min_suffix();
wp_enqueue_style(
'wpforms-dashboard-widget',
WPFORMS_PLUGIN_URL . "assets/css/dashboard-widget{$min}.css",
[],
WPFORMS_VERSION
);
wp_enqueue_script(
'wpforms-moment',
WPFORMS_PLUGIN_URL . 'assets/lib/moment/moment.min.js',
[],
'2.22.2',
true
);
wp_enqueue_script(
'wpforms-chart',
WPFORMS_PLUGIN_URL . 'assets/lib/chart.min.js',
[ 'wpforms-moment' ],
'2.7.2',
true
);
wp_enqueue_script(
'wpforms-dashboard-widget',
WPFORMS_PLUGIN_URL . "assets/pro/js/admin/dashboard-widget{$min}.js",
[ 'jquery', 'wpforms-chart' ],
WPFORMS_VERSION,
true
);
wp_localize_script(
'wpforms-dashboard-widget',
'wpforms_dashboard_widget',
[
'nonce' => wp_create_nonce( 'wpforms_' . static::SLUG . '_nonce' ),
'slug' => static::SLUG,
'empty_chart_html' => $this->get_empty_chart_html(),
'chart_data' => $this->get_entries_count_by(
'date',
$this->widget_meta( 'get', 'timespan' ),
$this->widget_meta( 'get', 'active_form_id' )
),
'chart_type' => (int) $this->widget_meta( 'get', 'graph_style' ) === 2 ? 'line' : 'bar',
'color_scheme' => (int) $this->widget_meta( 'get', 'color_scheme' ) === 2 ? 'wp' : 'wpforms',
'show_more_html' => esc_html__( 'Show More', 'wpforms' ) . '
',
'show_less_html' => esc_html__( 'Show Less', 'wpforms' ) . '
',
'i18n' => [
'total_entries' => esc_html__( 'Total Entries', 'wpforms' ),
'entries' => esc_html__( 'Entries', 'wpforms' ),
'form_entries' => esc_html__( 'Form Entries', 'wpforms' ),
],
]
);
}
/**
* Register the widget.
*
* @since 1.5.0
*/
public function widget_register() {
global $wp_meta_boxes;
$widget_key = 'wpforms_reports_widget_pro';
\wp_add_dashboard_widget(
$widget_key,
\esc_html__( 'WPForms', 'wpforms' ),
array( $this, 'widget_content' )
);
// Attempt to place the widget at the top.
$normal_dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
$widget_instance = array( $widget_key => $normal_dashboard[ $widget_key ] );
unset( $normal_dashboard[ $widget_key ] );
$sorted_dashboard = \array_merge( $widget_instance, $normal_dashboard );
$wp_meta_boxes['dashboard']['normal']['core'] = $sorted_dashboard;
}
/**
* Load widget content.
*
* @since 1.5.0
*/
public function widget_content() {
$forms = wpforms()->get( 'form' )->get( '', [ 'fields' => 'ids' ] );
echo '
';
if ( empty( $forms ) ) {
$this->widget_content_no_forms_html();
} else {
$this->widget_content_html();
}
$plugin = $this->get_recommended_plugin();
$hide_recommended = $this->widget_meta( 'get', 'hide_recommended_block' );
if (
! empty( $plugin ) &&
! empty( $forms ) &&
! $hide_recommended
) {
$this->recommended_plugin_block_html( $plugin );
}
echo '
';
}
/**
* Widget content HTML if a user has no forms.
*
* @since 1.5.0
*/
public function widget_content_no_forms_html() {
$create_form_url = \add_query_arg( 'page', 'wpforms-builder', \admin_url( 'admin.php' ) );
$learn_more_url = 'https://wpforms.com/docs/creating-first-form/?utm_source=WordPress&utm_medium=link&utm_campaign=plugin&utm_content=dashboardwidget';
?>
widget_meta( 'get', 'timespan' );
$active_form_id = $this->widget_meta( 'get', 'active_form_id' );
// phpcs:disable WPForms.Comments.PHPDocHooks.RequiredHookDocumentation, WPForms.PHP.ValidateHooks.InvalidHookName
$title = empty( $active_form_id ) ? apply_filters( "wpforms_{$widget_slug}_total_entries_title", esc_html__( 'Total Entries', 'wpforms' ) ) : get_the_title( $active_form_id );
$timespan_at_top = (bool) apply_filters( "wpforms_{$widget_slug}_timespan_at_top", false );
// phpcs:enable WPForms.Comments.PHPDocHooks.RequiredHookDocumentation, WPForms.PHP.ValidateHooks.InvalidHookName
// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
/**
* Filters the content before the Dashboard Widget Chart block container (for Pro).
*
* @since 1.7.4
*
* @param string $chart_block_before Chart block before markup.
*/
echo apply_filters( 'wpforms_pro_admin_dashboard_widget_content_html_chart_block_before', '' );
// phpcs:enable WordPress.Security.EscapeOutput.OutputNotEscaped
?>
forms_list_block( $timespan ); ?>
get_entries_count_by( 'form', $days );
if ( empty( $forms ) ) {
$this->forms_list_block_empty_html();
} else {
$this->forms_list_block_html( $forms );
}
}
/**
* Empty forms list block HTML.
*
* @since 1.5.0
*/
public function forms_list_block_empty_html() {
?>
settings['forms_list_number_to_display'];
$active_form_id = $this->widget_meta( 'get', 'active_form_id' );
$widget_slug = static::SLUG;
?>
$show_forms && $show_forms > 0 ) : ?>
get_timespan_options();
}
/**
* Get default timespan option for $element.
*
* @since 1.5.0
*
* @deprecated 1.5.2
*
* @param string $element Possible value: 'chart' or 'forms_list'.
*
* @return int|null
*/
public function get_timespan_default_for( $element ) {
_deprecated_function( __METHOD__, '1.5.2 of the WPForms plugin', 'DashboardWidget::get_timespan_default()' );
return $this->get_timespan_default();
}
/**
* Converts number of days to day start and day end values.
*
* @since 1.5.5
*
* @param integer $days Timespan days.
*
* @return mixed
*/
public function get_days_interval( $days = 0 ) {
if ( empty( $days ) ) {
$days = $this->runtime_data['days'];
} else {
$this->runtime_data['days'] = $days;
}
// PHP DateTime supported string (http://php.net/manual/en/datetime.formats.php).
$date_end_str = $this->settings['date_end_str'];
$modify_offset = (float) get_option( 'gmt_offset' ) * 60 . ' minutes';
try {
$now = new DateTime();
$interval['start'] = new DateTime( $date_end_str );
$interval['end'] = new DateTime( $date_end_str );
$interval['end']
->setTime( $now->format( 'H' ), $now->format( 'i' ), $now->format( 's' ) )
->modify( $modify_offset )
->setTime( 23, 59, 59 );
$interval['start']
->setTime( $now->format( 'H' ), $now->format( 'i' ), $now->format( 's' ) )
->modify( $modify_offset )
->modify( '-' . ( absint( $days ) - 1 ) . 'days' )
->setTime( 0, 0 );
} catch ( Exception $e ) {
return false;
}
return $interval;
}
/**
* Get entries count grouped by $param.
* Main point of entry to fetch form entry count data from DB.
* Caches the result.
*
* @since 1.5.0
*
* @param string $param Possible value: 'date' or 'form'.
* @param int $days Timespan (in days) to fetch the data for.
* @param int $form_id Form ID to fetch the data for.
*
* @return array
* @throws Exception When dates management fails.
*/
public function get_entries_count_by( $param, $days = 0, $form_id = 0 ) {
$widget_slug = static::SLUG;
$allowed_params = array( 'date', 'form' );
if ( ! \in_array( $param, $allowed_params, true ) ) {
return array();
}
$dates = $this->get_days_interval( $days );
$cache = false;
// Allow results caching to reduce DB load.
$allow_caching = $this->settings['allow_data_caching'];
if ( $allow_caching ) {
$transient_name = "wpforms_{$widget_slug}_pro_entries_by_{$param}_{$days}";
$transient_name .= ! empty( $form_id ) ? '_' . $form_id : '';
$cache = \get_transient( $transient_name );
// Filter the cache to clear or alter its data.
// phpcs:ignore WPForms.Comments.PHPDocHooks.RequiredHookDocumentation, WPForms.PHP.ValidateHooks.InvalidHookName
$cache = apply_filters( "wpforms_{$widget_slug}_cached_data", $cache, $param, $days, $form_id );
}
// is_array() detects cached empty searches.
if ( $allow_caching && \is_array( $cache ) ) {
return $cache;
}
switch ( $param ) {
case 'date':
$result = $this->get_entries_count_by_date_sql( $form_id, $dates['start'], $dates['end'] );
break;
case 'form':
$result = $this->get_entries_count_by_form_sql( $form_id, $dates['start'], $dates['end'] );
break;
default:
$result = array();
}
if ( $allow_caching ) {
// Transient lifetime in seconds. Defaults to the end of a current day.
$transient_lifetime = $this->settings['transient_lifetime'];
\set_transient( $transient_name, $result, $transient_lifetime );
}
return $result;
}
/**
* Get total number of form entries.
*
* @since 1.7.4
*
* @return int
* @throws Exception When dates management fails.
*/
private function get_total_entries() {
$total = 0;
$forms = $this->get_entries_count_by( 'form' );
if ( ! empty( $forms ) ) {
foreach ( $forms as $form ) {
$total += $form['count'];
}
}
return (int) $total;
}
/**
* Get entries count grouped by date.
* In most cases it's better to use `get_entries_count_by( 'date' )` instead.
* Doesn't cache the result.
*
* @since 1.5.0
* @since 1.7.5 Filter the forms where entries are fetched by allowed
* access of the current user.
*
* @param int $form_id Form ID to fetch the data for.
* @param DateTime $date_start Start date for the search.
* @param DateTime $date_end End date for the search.
*
* @return array
* @throws Exception When dates are failing.
*/
public function get_entries_count_by_date_sql( $form_id = 0, $date_start = null, $date_end = null ) {
if ( ! empty( $form_id ) && ! wpforms_current_user_can( 'view_entries_form_single', $form_id ) ) {
return [];
}
$results = $this->entries_count->get_by_date_sql( $form_id, $date_start, $date_end );
if ( ! $this->settings['display_chart_empty_entries'] ) {
return $results;
}
return $this->fill_chart_empty_entries( $results, $date_start, $date_end );
}
/**
* Get entries count grouped by form.
* In most cases it's better to use `get_entries_count_by( 'form' )` instead.
* Doesn't cache the result.
*
* @since 1.5.0
* @since 1.7.5 Filter the results by allowed access of the current user.
*
* @param int $form_id Form ID to fetch the data for.
* @param DateTime $date_start Start date for the search.
* @param DateTime $date_end End date for the search.
*
* @return array
*/
public function get_entries_count_by_form_sql( $form_id = 0, $date_start = null, $date_end = null ) {
if ( ! empty( $form_id ) && ! \wpforms_current_user_can( 'view_entries_form_single', $form_id ) ) {
return [];
}
$results = $this->entries_count->get_by_form_sql( $form_id, $date_start, $date_end );
// Keep backward compatibility converting an array to object.
foreach ( $results as $key => $form ) {
$results[ $key ] = (object) $form;
}
// Determine if the forms with no entries should appear in a forms list. Once switched, the effect applies after cache expiration.
if ( $this->settings['display_forms_list_empty_entries'] ) {
$forms = $this->fill_forms_list_empty_entries_form_data( $results );
} else {
$forms = (array) $this->fill_forms_list_form_data( $results );
}
return wpforms()->get( 'access' )->filter_forms_by_current_user_capability( $forms, 'view_entries_form_single' );
}
/**
* Fill DB results with empty entries where there's no data.
* Needed to correctly distribute labels and data on a chart.
*
* @since 1.5.0
*
* @param array $results DB results from `$wpdb->prepare()`.
* @param DateTime $date_start Start date for the search.
* @param DateTime $date_end End date for the search.
*
* @return array
* @throws Exception DatePeriod may throw an exception.
*/
public function fill_chart_empty_entries( $results, $date_start, $date_end ) {
if ( ! \is_array( $results ) ) {
return array();
}
$period = new \DatePeriod(
$date_start,
new \DateInterval( 'P1D' ),
$date_end
);
foreach ( $period as $key => $value ) {
/* @var \DateTime $value */
$date = $value->format( 'Y-m-d' );
if ( ! \array_key_exists( $date, $results ) ) {
$results[ $date ] = array(
'day' => $date,
'count' => 0,
);
continue;
}
// Mold an object to array to stay uniform.
$results[ $date ] = (array) $results[ $date ];
}
\ksort( $results );
return $results;
}
/**
* Fill a forms list with the data needed for a frontend display.
*
* @since 1.5.0
*
* @param array $results DB results from `$wpdb->prepare()`.
*
* @return array
*/
public function fill_forms_list_form_data( $results ) {
if ( ! \is_array( $results ) ) {
return array();
}
$processed = array();
foreach ( $results as $form_id => $result ) {
$form = \wpforms()->form->get( $form_id );
if ( empty( $form ) ) {
continue;
}
$data = $this->get_formatted_forms_list_form_data( $form, $results );
if ( $data ) {
$processed[ $form->ID ] = $data;
}
}
return $processed;
}
/**
* Fill a forms list with the data needed for a frontend display.
* Includes forms with zero entries.
*
* @since 1.5.0
*
* @param array $results DB results from `$wpdb->prepare()`.
*
* @return array
*/
public function fill_forms_list_empty_entries_form_data( $results ) {
if ( ! \is_array( $results ) ) {
return array();
}
$forms = \wpforms()->form->get();
if ( empty( $forms ) ) {
return array();
}
$processed = array();
foreach ( $forms as $form ) {
$data = $this->get_formatted_forms_list_form_data( $form, $results );
if ( $data ) {
$processed[ $form->ID ] = $data;
}
}
return \wp_list_sort( $processed, 'count', 'DESC' );
}
/**
* Get formatted form data for a forms list frontend display.
*
* @since 1.5.4
*
* @param \WP_Post $form Form object.
* @param array $results DB results from `$wpdb->prepare()`.
*
* @return array
*/
public function get_formatted_forms_list_form_data( $form, $results ) {
if ( ! ( $form instanceof \WP_Post ) ) {
return array();
}
$widget_slug = static::SLUG;
$edit_url = \add_query_arg(
array(
'page' => 'wpforms-entries',
'view' => 'list',
'form_id' => \absint( $form->ID ),
),
\admin_url( 'admin.php' )
);
$form_data = array(
'form_id' => $form->ID,
'count' => isset( $results[ $form->ID ]->count ) ? \absint( $results[ $form->ID ]->count ) : 0,
'title' => $form->post_title,
'edit_url' => $edit_url,
);
// phpcs:ignore WPForms.Comments.PHPDocHooks.RequiredHookDocumentation, WPForms.PHP.ValidateHooks.InvalidHookName
return (array) apply_filters( "wpforms_{$widget_slug}_form_item_fields", $form_data, $form );
}
/**
* Get the data for a chart using AJAX.
*
* @since 1.5.0
*/
public function get_chart_data_ajax() {
\check_admin_referer( 'wpforms_' . static::SLUG . '_nonce' );
$days = ! empty( $_POST['days'] ) ? \absint( $_POST['days'] ) : 0;
$form_id = ! empty( $_POST['form_id'] ) ? \absint( $_POST['form_id'] ) : 0;
$data = $this->get_entries_count_by( 'date', $days, $form_id );
\wp_send_json( $data );
}
/**
* Get the data for a forms list using AJAX.
*
* @since 1.5.0
*/
public function get_forms_list_ajax() {
\check_admin_referer( 'wpforms_' . static::SLUG . '_nonce' );
$days = ! empty( $_POST['days'] ) ? \absint( $_POST['days'] ) : 0;
\ob_start();
$this->forms_list_block( $days );
\wp_send_json( \ob_get_clean() );
}
/**
* Clear dashboard widget cached data.
*
* @since 1.5.2
*/
public static function clear_widget_cache() {
global $wpdb;
$wpdb->query("DELETE FROM {$wpdb->options} WHERE option_name LIKE '%wpforms_" . static::SLUG . "_pro_entries_by_%'" ); //phpcs:ignore
}
}
; ?>)