%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
/**
* Query helper class contains static helper methods to perform basic
* operations
*
* @package Tutor\Helper
* @since v2.0.7
*/
namespace Tutor\Helpers;
/**
* Do the common db operations through helper
* methods
*/
class QueryHelper {
/**
* Insert data in the table
*
* @param string $table table name.
* @param array $data | data to insert in the table.
*
* @return int, inserted id.
*
* @since v2.0.7
*
* @since 3.0.0
*
* @throws \Exception Database error if occur.
*/
public static function insert( string $table, array $data ): int {
global $wpdb;
// Sanitize text field.
$data = array_map(
function ( $value ) {
return sanitize_text_field( $value );
},
$data
);
$insert = $wpdb->insert(
$table,
$data
);
if ( $wpdb->last_error ) {
throw new \Exception( $wpdb->last_error );
}
return $insert ? $wpdb->insert_id : 0;
}
/**
* Update data
*
* @param string $table table name.
* @param array $data | data to update in the table.
* @param array $where | condition array.
*
* @return bool, true on success false on failure
*
* @since v2.0.7
*/
public static function update( string $table, array $data, array $where ): bool {
global $wpdb;
// Sanitize text field.
$data = array_map(
function ( $value ) {
return sanitize_text_field( $value );
},
$data
);
$where = array_map(
function ( $value ) {
return sanitize_text_field( $value );
},
$where
);
$wpdb->update(
$table,
$data,
$where
);
if ( $wpdb->last_error ) {
error_log( $wpdb->last_error );
return false;
}
return true;
}
/**
* Delete rows from table
*
* @param string $table table name.
* @param array $where key value pairs.Where key is the name of
* column & value is the value to match.
* For ex: [ 'id' => 1 ].
*
* @since v2.0.7
*/
public static function delete( string $table, array $where ): bool {
global $wpdb;
$delete = $wpdb->delete(
$table,
$where
);
return $delete ? true : false;
}
/**
* Delete rows from table
*
* @since 3.0.0
*
* @param string $table table name.
* @param array $ids array of ids.
*
* @see prepare_in_clause
*
* @throws \Exception Throw database error if occurred.
*
* @return true on success
*/
public static function bulk_delete_by_ids( string $table, array $ids ): bool {
global $wpdb;
$ids = self::prepare_in_clause( $ids );
//phpcs:ignore --ids already sanitized.
$wpdb->query( "DELETE FROM {$table} WHERE id IN ( $ids )");
if ( $wpdb->last_error ) {
throw new \Exception( $wpdb->last_error );
}
return true;
}
/**
* Clean everything from table
*
* @since v2.0.7
*
* @param string $table table name.
*
* @return bool
*/
public static function table_clean( string $table ): bool {
global $wpdb;
$delete = $wpdb->query(
//phpcs:ignore
$wpdb->prepare( "DELETE FROM {$table} WHERE 1 = %d", 1 )
);
return $delete ? true : false;
}
/**
* Insert multiple rows without knowing key value
*
* @since v2.0.7
*
* @param string $table table name.
* @param array $request two dimensional array
* for ex: [ [id => 1], [id => 2] ].
*
* @return mixed wpdb response true or int on success, false on failure.
* @throws \Exception If error occur.
*/
public static function insert_multiple_rows( $table, $request ) {
global $wpdb;
$column_keys = '';
$column_values = '';
$sql = '';
$last_key = array_key_last( $request );
$first_key = array_key_first( $request );
foreach ( $request as $k => $value ) {
$keys = array_keys( $value );
// Prepare column keys & values.
foreach ( $keys as $v ) {
$column_keys .= sanitize_key( $v ) . ',';
$sanitize_value = is_null( $value[ $v ] ) ? $value[ $v ] : sanitize_text_field( $value[ $v ] );
$column_values .= is_numeric( $sanitize_value ) ? $sanitize_value . ',' : "'$sanitize_value'" . ',';
}
// Trim trailing comma.
$column_keys = rtrim( $column_keys, ',' );
$column_values = rtrim( $column_values, ',' );
if ( $first_key === $k ) {
$sql .= "INSERT INTO {$table} ($column_keys) VALUES ($column_values)";
if ( count( $request ) > 1 ) {
$sql .= ',';
}
} elseif ( $last_key == $k ) {
$sql .= "($column_values)";
} else {
$sql .= "($column_values),";
}
// Reset keys & values to avoid duplication.
$column_keys = '';
$column_values = '';
}
$wpdb->query( $sql );//phpcs:ignore
// If error occurred then throw new exception.
if ( $wpdb->last_error ) {
throw new \Exception( $wpdb->last_error );
}
return true;
}
/**
* Make tge where clause base on its column operator and values.
*
* If the operator is IN then make the clause like `WHERE column_name IN (value1, value2, ...)`
* Otherwise the clause would be `WHERE column_name = 'value'`
*
* @since 3.0.0
*
* @param array $where The where clause array. e.g. array( 'id', 'IN', array(1, 2, 3) ) or array( 'id', '=', 1 ).
*
* @return string
*/
public static function make_clause( array $where ) {
list ( $field, $operator, $value ) = $where;
if ( 'IN' === strtoupper( $operator ) ) {
$value = '(' . self::prepare_in_clause( $value ) . ')';
}
return "{$field} {$operator} {$value}";
}
/**
* Build where clause string
*
* @param array $where assoc array with field and value.
* @return string
*
* @since 2.0.9
*
* @since 3.0.0
* Null value support added, if need to check with
* null: [name => 'null'] we can pass
*/
public static function build_where_clause( array $where ) {
$arr = array();
foreach ( $where as $field => $value ) {
if ( is_array( $value ) ) {
$value = array( $field, 'IN', $value );
} else {
if ( 'null' == $value ) {
$value = array( $field, 'IS', 'NULL' );
} else {
$value = is_numeric( $value ) ? $value : "'" . $value . "'";
$value = array( $field, '=', $value );
}
}
$arr[] = self::make_clause( $value );
}
return implode( ' AND ', $arr );
}
/**
* Build like clause string with or
*
* @since 1.0.0
*
* @param array $where assoc array with field and value.
* @param string $relation default is OR.
*
* @return string
*/
public static function build_like_clause( array $where, $relation = 'OR' ) {
global $wpdb;
$like_conditions = array();
foreach ( $where as $column_name => $term ) {
//phpcs:ignore
$like_conditions[] = $wpdb->prepare( "$column_name LIKE %s", '%' . $wpdb->esc_like( $term ) . '%' );
}
$where_clause = implode( ' OR ', $like_conditions );
return $where_clause;
}
/**
* Sanitize assoc array
*
* @param array $array an assoc array.
* @return array
*
* @since 2.0.9
*/
private static function sanitize_assoc_array( array $array ) {
return array_map(
function ( $value ) {
return sanitize_text_field( $value );
},
$array
);
}
/**
* Delete comment with associate meta data
*
* @param array $where associative array with field and value.
* Example: array( 'comment_type' => 'comment', 'comment_id' => 1 ).
* @return bool
*
* @since 2.0.9
*/
public static function delete_comment_with_meta( array $where ) {
if ( count( $where ) === 0 || ! tutor_utils()->is_assoc( $where ) ) {
return false;
}
$where = self::build_where_clause( self::sanitize_assoc_array( $where ) );
global $wpdb;
$ids = $wpdb->get_col( "SELECT comment_id FROM {$wpdb->comments} WHERE {$where}" );//phpcs:ignore
if ( is_array( $ids ) && count( $ids ) ) {
$ids_str = "'" . implode( "','", $ids ) . "'";
// delete comment metas.
$wpdb->query( "DELETE FROM {$wpdb->commentmeta} WHERE comment_id IN({$ids_str}) " );//phpcs:ignore
// delete comment.
$wpdb->query( "DELETE FROM {$wpdb->comments} WHERE {$where}" );//phpcs:ignore
return true;
}
return false;
}
/**
* Delete post with associate meta data
*
* @param array $where associative array with field and value.
* Example: array( 'post_type' => 'post', 'id' => 1 ).
* @return bool
*
* @since 2.0.9
*/
public static function delete_post_with_meta( array $where ) {
if ( count( $where ) === 0 || ! tutor_utils()->is_assoc( $where ) ) {
return false;
}
$where = self::build_where_clause( self::sanitize_assoc_array( $where ) );
global $wpdb;
$ids = $wpdb->get_col( "SELECT id FROM {$wpdb->posts} WHERE {$where}" );//phpcs:ignore
if ( is_array( $ids ) && count( $ids ) ) {
$ids_str = "'" . implode( "','", $ids ) . "'";
// delete post metas.
$wpdb->query( "DELETE FROM {$wpdb->postmeta} WHERE post_id IN({$ids_str}) " );//phpcs:ignore
// delete post.
$wpdb->query( "DELETE FROM {$wpdb->posts} WHERE {$where}" );//phpcs:ignore
return true;
}
return false;
}
/**
* Get a single row from any table with where clause
*
* @param string $table table name with prefix.
*
* @param array $where assoc_array. For ex: [col_name => value ].
* @param string $order_by order by column name.
* @param string $order DESC or ASC, default is DESC.
* @param string $output expected output type, default is object.
*
* @return mixed based on output param, default object
*/
public static function get_row( string $table, array $where, string $order_by, string $order = 'DESC', string $output = 'OBJECT' ) {
global $wpdb;
$where_clause = self::build_where_clause( $where );
//phpcs:disable
$query = $wpdb->prepare(
"SELECT *
FROM {$table}
WHERE {$where_clause}
ORDER BY {$order_by} {$order}
LIMIT %d
",
1
);
return $wpdb->get_row(
$query,
$output
);
//phpcs:enable
}
/**
* Get all row from any table with where clause
*
* @since 2.2.1
* @since 3.0.0 added support for -1 value in the limit parameter.
*
* @param string $table table name with prefix.
*
* @param array $where assoc_array. For ex: [col_name => value ].
* @param string $order_by order by column name.
* @param int $limit default is 1000, -1 for no limit.
* @param string $order DESC or ASC, default is DESC.
* @param string $output expected output type, default is object.
*
* @return mixed based on output param, default object
*/
public static function get_all( string $table, array $where, string $order_by, $limit = 1000, string $order = 'DESC', string $output = 'OBJECT' ) {
global $wpdb;
$where_clause = self::build_where_clause( $where );
$limit = (int) sanitize_text_field( $limit );
$limit_clause = ( -1 === $limit ) ? '' : 'LIMIT ' . $limit;
//phpcs:disable
$query = "SELECT *
FROM {$table}
WHERE {$where_clause}
ORDER BY {$order_by} {$order}
{$limit_clause}";
return $wpdb->get_results(
$query,
$output
);
//phpcs:enable
}
/**
* Update multiple rows by using where in
* clause
*
* @since v2.1.0
*
* @param string $table table name.
* @param array $data assoc_array data to update
* ex: [id => 2, name => 'john' ].
* @param string $where_in comma separated values, ex: 1,2,3.
* @param string $where_col default is ID but could be other.
*
* @return bool true on success, false on failure
*/
public static function update_where_in( string $table, array $data, string $where_in, string $where_col = 'ID' ) {
global $wpdb;
if ( empty( $where_in ) || empty( $where_col ) ) {
return false;
}
$set_clause = self::prepare_set_clause( $data );
if ( '' === $set_clause ) {
return false;
}
// @codingStandardsIgnoreStart
$query = $wpdb->prepare(
"UPDATE {$table}
{$set_clause}
WHERE $where_col IN ( $where_in )
AND 1 = %d
",
1
);
return $wpdb->query( $query ) ? true : false;
}
/**
* Prepare MySQL SET clause for update query
*
* @since v2.1.0
*
* @param array $data single dimension assoc_array.
*
* @return string
*/
public static function prepare_set_clause( array $data ) {
$set = '';
foreach ( $data as $key => $value ) {
if ( $key === array_key_first ( $data ) ) {
$set .= "SET ";
}
// Multi dimension not allowed.
if ( is_array( $value ) ) {
continue;
}
if ( is_null( $value ) ) {
$set .= "$key = null";
} else {
$value = esc_sql( sanitize_text_field( $value ) );
$set .= is_numeric( $value ) ? "$key = $value" : "$key = '" . $value ."'";
}
$set .= ",";
}
return rtrim( $set, ',' );
}
/**
* Make sanitized SQL IN clause value from an array
*
* @param array $arr a sequentital array.
* @return string
* @since 2.1.1
*/
public static function prepare_in_clause( array $arr ) {
$escaped = array_map(
function( $value ) {
global $wpdb;
$escaped_value = null;
if ( is_int( $value ) ) {
$escaped_value = $wpdb->prepare( '%d', $value );
} else if( is_float( $value ) ) {
list( $whole, $decimal ) = explode( '.', $value );
$expression = '%.'. strlen( $decimal ) . 'f';
$escaped_value = $wpdb->prepare( $expression, $value );
} else {
$escaped_value = $wpdb->prepare( '%s', $value );
}
return $escaped_value;
},
$arr
);
return implode( ',', $escaped );
}
/**
* Check table exist in database.
*
* @since 2.5.0
*
* @param string $table table name.
*
* @return bool
*/
public static function table_exists( $table ) {
global $wpdb;
$sql = "SHOW TABLES LIKE '{$table}'";
return $wpdb->get_var( $sql ) === $table;
}
/**
* Check column exist in a table
*
* @since 3.0.0
*
* @param string $table table name.
* @param string $column column name.
*
* @return bool
*/
public static function column_exist( $table, $column ) {
global $wpdb;
$sql = "SHOW COLUMNS FROM {$table} LIKE '{$column}'";
return $wpdb->get_var( $sql ) === $column;
}
/**
* Get data by joining multiple tables with specified join relations.
*
* Argument should be SQL escaped.
*
* @since 3.0.0
*
* @param string $primary_table The primary table name with prefix.
* @param array $joining_tables An array of join relations. Each relation should be an array with keys 'type', 'table', 'on'.
* @param array $select_columns An array of columns to select.
* @param array $where An associative array for the WHERE clause. For example: [col_name => value]. Without sql esc.
* @param array $search An associative array for the search clause. For example: [col_name => value]. Without sql esc.
* @param string $order_by Order by column name.
* @param int $limit Maximum number of rows to return.
* @param int $offset Offset for pagination.
* @param string $order DESC or ASC, default is DESC.
* @param string $output Expected output type, default is OBJECT.
*
* @throws \Exception If an error occurred during the query execution.
*
* @return mixed Based on output param, default OBJECT.
*/
public static function get_joined_data(
string $primary_table,
array $joining_tables,
array $select_columns,
array $where = [],
array $search = [],
string $order_by = '',
$limit = 10,
$offset = 0,
string $order = 'DESC',
string $output = 'OBJECT'
) {
global $wpdb;
$select_clause = implode(', ', $select_columns);
$from_clause = $primary_table;
$join_clauses = '';
foreach ($joining_tables as $relation) {
$join_clauses .= " {$relation['type']} JOIN {$relation['table']} ON {$relation['on']}";
}
$where_clause = !empty($where) ? 'WHERE ' . self::build_where_clause($where) : '';
if (!empty($search)) {
$search_clause = self::build_like_clause( $search );
// foreach ($search as $column => $value) {
// $search_clauses[] = $wpdb->prepare("{$column} LIKE %s", '%' . $wpdb->esc_like($value) . '%');
// }
$where_clause .= !empty($where_clause) ? ' AND (' . $search_clause . ')' : 'WHERE ' . $search_clause;
}
$order_by_clause = !empty($order_by) ? "ORDER BY {$order_by} {$order}" : '';
// Query to get total count.
$count_query = "
SELECT COUNT(*) as total_count
FROM {$from_clause}
{$join_clauses}
{$where_clause}
";
$total_count = $wpdb->get_var($count_query);
if (empty($limit) && empty($offset)) {
$query = "SELECT
{$select_clause}
FROM {$from_clause}
{$join_clauses}
{$where_clause}
{$order_by_clause}";
} else {
$query = $wpdb->prepare(
"SELECT {$select_clause}
FROM {$from_clause}
{$join_clauses}
{$where_clause}
{$order_by_clause}
LIMIT %d OFFSET %d",
$limit,
$offset
);
}
$results = $wpdb->get_results($query, $output);
// Throw exception if error occurred.
if ($wpdb->last_error) {
throw new \Exception($wpdb->last_error);
}
// Prepare response array.
$response = array(
'total_count' => (int) $total_count,
'results' => $results,
);
return $response;
}
/**
* Get count var
*
* Argument should be SQL escaped.
*
* @since 1.0.0
*
* @param string $table table name with prefix.
* @param array $where array of where condition.
* @param array $search array of search conditions for LIKE operator.
* @param string $count_column column name to count, default id.
*
* @return int
*/
public static function get_count( $table, $where = [], $search = [], $count_column = 'id' ): int {
global $wpdb;
$where_clause = !empty( $where ) ? 'WHERE ' . self::build_where_clause( $where ) : '';
$search_clause = !empty( $search ) ? self::build_like_clause( $search, 'AND' ) : '';
if ( !empty( $search_clause ) ) {
if ( !empty( $where_clause ) ) {
$where_clause .= ' AND (' . $search_clause . ')';
} else {
$where_clause = 'WHERE ' . $search_clause;
}
}
$count = $wpdb->get_var(
"SELECT COUNT($count_column)
FROM $table
{$where_clause}"
);
// If error occurred then throw new exception.
if ( $wpdb->last_error ) {
throw new \Exception( $wpdb->last_error );
}
return (int) $count;
}
/**
* Get count by joining multiple tables with specified join relations.
*
* Argument should be SQL escaped.
*
* @since 3.0.0
*
* @param string $primary_table The primary table name with prefix.
* @param array $joining_tables An array of join relations. Each relation should be an array with keys 'type', 'table', 'on'.
* @param array $where array of where conditions.
* @param array $search array of search conditions for LIKE operator.
* @param string $count_column column name to count, default id.
*
* @return int
*/
public static function get_joined_count(string $primary_table, array $joining_tables, array $where = [], array $search = [], string $count_column = '*'): int {
global $wpdb;
$from_clause = $primary_table;
$join_clauses = '';
foreach ($joining_tables as $relation) {
$join_clauses .= " {$relation['type']} JOIN {$relation['table']} ON {$relation['on']}";
}
$where_clause = !empty($where) ? 'WHERE ' . self::build_where_clause($where) : '';
$search_clause = !empty($search) ? self::build_like_clause($search, 'AND') : '';
if (!empty($search_clause)) {
if (!empty($where_clause)) {
$where_clause .= ' AND (' . $search_clause . ')';
} else {
$where_clause = 'WHERE ' . $search_clause;
}
}
$count_query = "
SELECT COUNT($count_column) as total_count
FROM {$from_clause}
{$join_clauses}
{$where_clause}
";
$total_count = $wpdb->get_var($count_query);
// If error occurred then throw new exception.
if ($wpdb->last_error) {
throw new \Exception($wpdb->last_error);
}
return (int) $total_count;
}
/**
* Get all rows from any table with where and search clauses.
*
* @since 3.0.0
*
* @param string $table Table name with prefix.
* @param array $where Assoc array for exact match. For example: [col_name => value]. Without sql esc.
* @param array $search Assoc array for LIKE match. For example: [col_name => search_term]. Without sql esc.
* @param string $order_by Order by column name.
* @param int $limit Maximum number of rows to return, default is 10.
* @param int $offset Offset for pagination, default is 0.
* @param string $order DESC or ASC, default is DESC.
* @param string $output Expected output type, default is OBJECT.
*
* @throws \Exception Throw exception if error occurred during query execution.
*
* @return mixed Based on output param, default OBJECT.
*/
public static function get_all_with_search(string $table, array $where, array $search, string $order_by, $limit = 10, $offset = 0, string $order = 'DESC', string $output = 'OBJECT'): array {
global $wpdb;
$where_clause = !empty($where) ? 'WHERE ' . self::build_where_clause($where) : '';
$search_clause = !empty($search) ? self::build_like_clause($search, 'AND') : '';
if (!empty($search_clause)) {
if (!empty($where_clause)) {
$where_clause .= ' AND (' . $search_clause . ')';
} else {
$where_clause = 'WHERE ' . $search_clause;
}
}
// Query to get total count
$count_query = "
SELECT COUNT(*)
FROM {$table}
{$where_clause}
";
$total_count = $wpdb->get_var($count_query);
// If error occurred then throw new exception.
if ($wpdb->last_error) {
throw new \Exception($wpdb->last_error);
}
$query = $wpdb->prepare(
"SELECT *
FROM {$table}
{$where_clause}
ORDER BY {$order_by} {$order}
LIMIT %d OFFSET %d",
$limit,
$offset
);
$results = $wpdb->get_results($query, $output);
// If error occurred then throw new exception.
if ($wpdb->last_error) {
throw new \Exception($wpdb->last_error);
}
// Prepare response array.
$response = array(
'results' => $results,
'total_count' => (int) $total_count,
);
return $response;
}
/**
* Get period clause based on the provided period.
*
* @since 3.0.0
*
* @param string $column Table.column name, ex: table.created_at.
* @param string $period Period for filter refund data.
*
* @return string
*/
public static function get_period_clause( string $column, string $period = '' ) {
$period_clause = '';
switch ( $period ) {
case 'today':
$period_clause = "AND DATE($column) = CURDATE()";
break;
case 'monthly':
$period_clause = "AND MONTH($column) = MONTH(CURDATE())";
break;
case 'yearly':
$period_clause = "AND YEAR($column) = YEAR(CURDATE())";
break;
case 'last30days':
$period_clause = "AND DATE($column) BETWEEN DATE_SUB(CURDATE(), INTERVAL 30 DAY) AND CURDATE()";
break;
case 'last90days':
$period_clause = "AND DATE($column) BETWEEN DATE_SUB(CURDATE(), INTERVAL 90 DAY) AND CURDATE()";
break;
case 'last365days':
$period_clause = "AND DATE($column) BETWEEN DATE_SUB(CURDATE(), INTERVAL 365 DAY) AND CURDATE()";
break;
default:
break;
}
return $period_clause;
}
}
Zerion Mini Shell 1.0