Your IP : 216.73.216.5
<?php
namespace WPForms\Pro\Reports;
/**
* Generate form submissions reports.
*
* @since 1.5.4
*/
class EntriesCount {
/**
* Get entries count grouped by $param.
* Main point of entry to fetch form entry count data from DB.
*
* @since 1.5.4
*
* @param string $param Could be 'date' or 'form'.
* @param int $form_id Form ID to fetch the data for.
* @param int $days Timespan (in days) to fetch the data for.
* @param string $date_end_str End date of the timespan (PHP DateTime supported string, see http://php.net/manual/en/datetime.formats.php).
*
* @return array
*/
public function get_by( $param, $form_id = 0, $days = 0, $date_end_str = 'yesterday' ) {
if ( ! in_array( $param, [ 'date', 'form' ], true ) ) {
return [];
}
try {
$date_end = new \DateTime( $date_end_str );
$date_start = new \DateTime( $date_end_str );
} catch ( \Exception $e ) {
return [];
}
$date_end = $date_end
->setTime( 23, 59, 59 );
$date_start = $date_start
->modify( '-' . ( absint( $days ) - 1 ) . 'days' )
->setTime( 0, 0 );
if ( $param === 'date' ) {
return $this->get_by_date_sql( $form_id, $date_start, $date_end );
}
if ( $param === 'form' ) {
return $this->get_by_form_sql( $form_id, $date_start, $date_end );
}
return [];
}
/**
* Get entries count grouped by date.
* In most cases it's better to use `get_by( 'date' )` instead.
*
* Warning! Avoid GTM offsets: we are searching with offset by default.
*
* @since 1.5.4
* @since 1.6.5 Fixed GTM offset.
*
* @param int $form_id Form ID to fetch the data for.
* @param \DateTime|null $date_start Start date for the search. Leave it empty to restrict the starting day.
* @param \DateTime|null $date_end End date for the search. Leave it empty to restrict the ending day.
*
* @return array
*/
public function get_by_date_sql( $form_id = 0, $date_start = null, $date_end = null ) {
global $wpdb;
$table_name = wpforms()->entry->table_name;
$sql = $wpdb->prepare(
"SELECT CAST(DATE_ADD(date, INTERVAL %d MINUTE) AS DATE) as day, COUNT(entry_id) as count FROM {$table_name}", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
(int) ( get_option( 'gmt_offset' ) * 60 )
);
$sql .= $this->prepare_where_conditions( $form_id, $date_start, $date_end );
$sql .= ' GROUP BY day;';
return (array) $wpdb->get_results( $sql, OBJECT_K ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.NoCaching, WordPress.DB.PreparedSQL.NotPrepared
}
/**
* Get entries count grouped by form.
* In most cases it's better to use `get_by( 'form' )` instead.
*
* Warning! Avoid GTM offsets! We are searching with offset by default.
*
* @since 1.5.4
* @since 1.6.5 Fixed GTM offset.
*
* @param int $form_id Form ID to fetch the data for.
* @param \DateTime|null $date_start Start date for the search. Leave it empty to restrict the starting day.
* @param \DateTime|null $date_end End date for the search. Leave it empty to restrict the ending day.
*
* @return array
*/
public function get_by_form_sql( $form_id = 0, $date_start = null, $date_end = null ) {
global $wpdb;
$table_name = wpforms()->entry->table_name;
$sql = "SELECT form_id, COUNT(entry_id) as count FROM {$table_name}";
$sql .= $this->prepare_where_conditions( $form_id, $date_start, $date_end );
$sql .= 'GROUP BY form_id ORDER BY count DESC;';
$results = (array) $wpdb->get_results( $sql, OBJECT_K ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.NoCaching, WordPress.DB.PreparedSQL.NotPrepared
return $this->fill_forms_list_form_data( $results );
}
/**
* Fill a forms list with the data needed for a frontend display.
*
* @since 1.5.4
*
* @param array $results DB results from `$wpdb->prepare()`.
*
* @return array
*/
public function fill_forms_list_form_data( $results ) {
if ( ! is_array( $results ) ) {
return [];
}
$processed = [];
foreach ( $results as $form_id => $result ) {
$form = wpforms()->form->get( $form_id );
if ( empty( $form ) ) {
continue;
}
$edit_url = add_query_arg(
[
'page' => 'wpforms-entries',
'view' => 'list',
'form_id' => absint( $form->ID ),
],
admin_url( 'admin.php' )
);
$processed[ $form->ID ] = [
'form_id' => $form->ID,
'count' => isset( $results[ $form->ID ]->count ) ? absint( $results[ $form->ID ]->count ) : 0,
'title' => $form->post_title,
'edit_url' => $edit_url,
];
}
return $processed;
}
/**
* Prepare where conditions.
*
* @since 1.6.5
*
* @param int $form_id Form ID to fetch the data for.
* @param \DateTime|null $date_start Start date for the search. Leave it empty to restrict the starting day.
* @param \DateTime|null $date_end End date for the search. Leave it empty to restrict the ending day.
*
* @return string
*/
private function prepare_where_conditions( $form_id = 0, $date_start = null, $date_end = null ) {
global $wpdb;
$format = 'Y-m-d H:i:s';
$placeholders = [];
$sql = ' WHERE 1=1';
$modify_offset = (int) ( 60 * get_option( 'gmt_offset' ) ) . ' minutes';
if ( ! empty( $form_id ) ) {
$sql .= ' AND form_id = %d';
$placeholders[] = absint( $form_id );
}
if ( ! empty( $date_start ) ) {
$sql .= ' AND date >= %s';
$date_start->modify( $modify_offset );
$placeholders[] = $date_start->format( $format );
}
if ( ! empty( $date_end ) ) {
$sql .= ' AND date <= %s';
$date_end->modify( $modify_offset );
$placeholders[] = $date_end->format( $format );
}
return $wpdb->prepare( $sql, $placeholders ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
}
}