Test Failed
Push — issue/3627 ( 9db3c8...fa91e5 )
by Ravinder
1036:35 queued 1027:44
created

Give_DB_Comments::create_table()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 20

Duplication

Lines 20
Ratio 100 %

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 0
dl 20
loc 20
rs 9.6
c 0
b 0
f 0
1
<?php
2
/**
3
 * Custom Comments & Notes
4
 *
5
 * @package     Give
6
 * @subpackage  Classes/Give_DB_Comments
7
 * @copyright   Copyright (c) 2018, WordImpress
8
 * @license     https://opensource.org/licenses/gpl-license GNU Public License
9
 * @since       2.3.0
10
 */
11
12
// Exit if accessed directly.
13
if ( ! defined( 'ABSPATH' ) ) {
14
	exit;
15
}
16
17
/**
18
 * Give_DB_Comments Class
19
 *
20
 * This class is for interacting with the comment database table.
21
 *
22
 * @since 2.3.0
23
 */
24
class Give_DB_Comments extends Give_DB {
25
26
	/**
27
	 * Give_DB_Comments constructor.
28
	 *
29
	 * Set up the Give DB Donor class.
30
	 *
31
	 * @since  2.3.0
32
	 * @access public
33
	 */
34
	public function __construct() {
35
		/* @var WPDB $wpdb */
36
		global $wpdb;
37
38
		$this->table_name  = $wpdb->prefix . 'give_comments';
39
		$this->primary_key = 'ID';
40
		$this->version     = '1.0';
41
42
		// Install table.
43
		$this->register_table();
44
45
		parent::__construct();
46
	}
47
48
	/**
49
	 * Get columns and formats
50
	 *
51
	 * @since  2.3.0
52
	 * @access public
53
	 *
54
	 * @return array  Columns and formats.
55
	 */
56
	public function get_columns() {
57
		return array(
58
			'ID'               => '%d',
59
			'comment_content'  => '%s',
60
			'comment_parent'   => '%s',
61
			'comment_type'     => '%s',
62
			'comment_date'     => '%s',
63
			'comment_date_gmt' => '%s',
64
		);
65
	}
66
67
	/**
68
	 * Get default column values
69
	 *
70
	 * @since  2.3.0
71
	 * @access public
72
	 *
73
	 * @return array  Default column values.
74
	 */
75
	public function get_column_defaults() {
76
		$comment_create_date     = current_time( 'mysql', 0 );
77
		$comment_create_date_gmt = get_gmt_from_date( $comment_create_date );
78
79
		return array(
80
			'ID'               => 0,
81
			'comment_content'  => '',
82
			'comment_parent'   => 0,
83
			'comment_type'     => '',
84
			'comment_date'     => $comment_create_date,
85
			'comment_date_gmt' => $comment_create_date_gmt,
86
		);
87
	}
88
89
	/**
90
	 * Add a comment
91
	 *
92
	 * @since  2.3.0
93
	 * @access public
94
	 *
95
	 * @param  array $data
96
	 *
97
	 * @return bool|int
98
	 */
99
	public function add( $data = array() ) {
100
		// Valid table columns.
101
		$table_columns = array_keys( $this->get_columns() );
102
103
		// Filter data.
104
		foreach ( $data as $table_column => $column_data ) {
105
			if ( ! in_array( $table_column, $table_columns ) ) {
106
				unset( $data[ $table_column ] );
107
			}
108
		}
109
110
		// Set default values.
111
		$current_comment_data = wp_parse_args( $data, $this->get_column_defaults() );
112
113
		// Comment parent should be an int.
114
		$current_comment_data['comment_parent'] = is_numeric( $current_comment_data['comment_parent'] )
115
			? absint( $current_comment_data['comment_parent'] )
116
			: $current_comment_data['comment_parent'];
117
118
		// Get comment.
119
		$existing_comment = $this->get_comment_by( $current_comment_data['ID'] );
120
121
		// Update an existing comment.
122
		if ( $existing_comment ) {
123
124
			// Create new comment data from existing and new comment data.
125
			$current_comment_data = array_merge( $current_comment_data, $existing_comment );
126
127
			// Update comment data.
128
			$this->update( $current_comment_data['ID'], $current_comment_data );
129
130
			$comment_id = $current_comment_data['ID'];
131
132
		} else {
133
			$comment_id = $this->insert( $current_comment_data, 'comment' );
134
		}
135
136
		return $comment_id;
137
	}
138
139
140
	/**
141
	 * Retrieves a single comment from the database
142
	 *
143
	 * @since  2.3.0
144
	 * @access public
145
	 *
146
	 * @param int    $comment_id
147
	 * @param string $by
148
	 *
149
	 * @return bool|null|array
150
	 */
151 View Code Duplication
	public function get_comment_by( $comment_id = 0, $by = 'id' ) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
152
		/* @var WPDB $wpdb */
153
		global $wpdb;
154
		$comment = null;
155
156
		// Make sure $comment_id is int.
157
		$comment_id = absint( $comment_id );
158
159
		// Bailout.
160
		if ( empty( $comment_id ) ) {
161
			return null;
162
		}
163
164
		switch ( $by ) {
165
			case 'id':
166
				$comment = $wpdb->get_row(
0 ignored issues
show
introduced by
Usage of a direct database call is discouraged.
Loading history...
introduced by
Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set.
Loading history...
167
					$wpdb->prepare(
168
						"SELECT * FROM $this->table_name WHERE ID = %s LIMIT 1",
169
						$comment_id
170
					),
171
					ARRAY_A
172
				);
173
				break;
174
175
			default:
176
				$comment = apply_filters( "give_get_comment_by_{$by}", $comment, $comment_id );
177
		}
178
179
		return $comment;
180
	}
181
182
	/**
183
	 * Retrieve comments from the database.
184
	 *
185
	 * @since  2.3.0
186
	 * @access public
187
	 *
188
	 * @param  array $args
189
	 *
190
	 * @return mixed
191
	 */
192 View Code Duplication
	public function get_comments( $args = array() ) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
193
		global $wpdb;
194
		$sql_query = $this->get_sql( $args );
195
196
		// Get comment.
197
		if ( ! ( $comments = Give_Cache::get( 'give_comments', true, $sql_query ) ) ) {
198
			$comments = $wpdb->get_results( $sql_query );
0 ignored issues
show
introduced by
Usage of a direct database call is discouraged.
Loading history...
introduced by
Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set.
Loading history...
199
			Give_Cache::set( 'give_comments', $comments, 3600, true, $sql_query );
200
		}
201
202
		return $comments;
203
	}
204
205
206
	/**
207
	 * Count the total number of comments in the database
208
	 *
209
	 * @since  2.3.0
210
	 * @access public
211
	 *
212
	 * @param  array $args
213
	 *
214
	 * @return int
215
	 */
216 View Code Duplication
	public function count( $args = array() ) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
217
		/* @var WPDB $wpdb */
218
		global $wpdb;
219
		$args['number'] = - 1;
220
		$args['fields'] = 'ID';
221
		$args['count']  = true;
222
223
		$sql_query = $this->get_sql( $args );
224
225
		if ( ! ( $count = Give_Cache::get( 'give_comments_count', true, $sql_query ) ) ) {
226
			$count = $wpdb->get_var( $sql_query );
0 ignored issues
show
introduced by
Usage of a direct database call is discouraged.
Loading history...
introduced by
Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set.
Loading history...
227
			Give_Cache::set( 'give_comments_count', $count, 3600, true, $args );
228
		}
229
230
		return absint( $count );
231
	}
232
233
	/**
234
	 * Create the table
235
	 *
236
	 * @since  2.3.0
237
	 * @access public
238
	 *
239
	 * @return void
240
	 */
241 View Code Duplication
	public function create_table() {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
242
		global $wpdb;
243
		$charset_collate = $wpdb->get_charset_collate();
244
245
		$sql = "CREATE TABLE {$this->table_name} (
246
        ID bigint(20) NOT NULL AUTO_INCREMENT,
247
        comment_title longtext NOT NULL,
248
        comment_content longtext NOT NULL,
249
      	comment_parent mediumtext NOT NULL,
250
        comment_type mediumtext NOT NULL,
251
        comment_date datetime NOT NULL,
252
        comment_date_gmt datetime NOT NULL,
253
        PRIMARY KEY  (ID)
254
        ) {$charset_collate};";
255
256
		require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
257
		dbDelta( $sql );
258
259
		update_option( $this->table_name . '_db_version', $this->version, false );
260
	}
261
262
263
	/**
264
	 * Get sql query from quaried array.
265
	 *
266
	 * @since  2.3.0
267
	 * @access public
268
	 *
269
	 * @param array $args
270
	 *
271
	 * @return string
272
	 */
273 View Code Duplication
	public function get_sql( $args = array() ) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
274
		/* @var WPDB $wpdb */
275
		global $wpdb;
276
277
		$defaults = array(
278
			'number'  => 20,
279
			'offset'  => 0,
280
			'paged'   => 0,
281
			'orderby' => 'date',
282
			'order'   => 'DESC',
283
			'fields'  => 'all',
284
			'count'   => false,
285
		);
286
287
		$args = wp_parse_args( $args, $defaults );
288
289
		// validate params.
290
		$this->validate_params( $args );
291
292
		if ( $args['number'] < 1 ) {
293
			$args['number'] = 99999999999;
294
		}
295
296
		// Where clause for primary table.
297
		$where = '';
298
299
		// Get sql query for meta.
300
		if ( ! empty( $args['meta_query'] ) ) {
301
			$meta_query_object = new WP_Meta_Query( $args['meta_query'] );
302
			$meta_query        = $meta_query_object->get_sql( 'comment', $this->table_name, 'id' );
303
			$where             = implode( '', $meta_query );
304
		}
305
306
		$where .= ' WHERE 1=1 ';
307
308
		// Set offset.
309
		if ( empty( $args['offset'] ) && ( 0 < $args['paged'] ) ) {
310
			$args['offset'] = $args['number'] * ( $args['paged'] - 1 );
311
		}
312
313
		// Set fields.
314
		$fields = "{$this->table_name}.*";
315
		if ( is_string( $args['fields'] ) && ( 'all' !== $args['fields'] ) ) {
316
			$fields = "{$this->table_name}.{$args['fields']}";
317
		}
318
319
		// Set count.
320
		if ( $args['count'] ) {
321
			$fields = "COUNT({$fields})";
322
		}
323
324
		// Specific comments.
325
		if ( ! empty( $args['ID'] ) ) {
326
327
			if ( ! is_array( $args['ID'] ) ) {
328
				$args['ID'] = explode( ',', $args['ID'] );
329
			}
330
			$comment_ids = implode( ',', array_map( 'intval', $args['ID'] ) );
331
332
			$where .= " AND {$this->table_name}.ID IN( {$comment_ids} ) ";
333
		}
334
335
		// Comments created for a specific date or in a date range
336
		if ( ! empty( $args['date_query'] ) ) {
337
			$date_query_object = new WP_Date_Query( $args['date_query'], "{$this->table_name}.comment_date" );
338
			$where             .= $date_query_object->get_sql();
339
		}
340
341
		// Comments create for specific parent.
342
		if ( ! empty( $args['comment_parent'] ) ) {
343
			if ( ! is_array( $args['comment_parent'] ) ) {
344
				$args['comment_parent'] = explode( ',', $args['comment_parent'] );
345
			}
346
			$parent_ids = implode( ',', array_map( 'intval', $args['comment_parent'] ) );
347
348
			$where .= " AND {$this->table_name}.comment_parent IN( {$parent_ids} ) ";
349
		}
350
351
		// Comments create for specific type.
352
		// is_array check is for backward compatibility.
353
		if ( ! empty( $args['comment_type'] ) && ! is_array( $args['comment_type'] ) ) {
354
			if ( ! is_array( $args['comment_type'] ) ) {
355
				$args['comment_type'] = explode( ',', $args['comment_type'] );
356
			}
357
358
			$comment_types = implode( '\',\'', array_map( 'trim', $args['comment_type'] ) );
359
360
			$where .= " AND {$this->table_name}.comment_type IN( '{$comment_types}' ) ";
361
		}
362
363
		$args['orderby'] = ! array_key_exists( $args['orderby'], $this->get_columns() ) ? 'comment_date' : $args['orderby'];
364
365
		$args['orderby'] = esc_sql( $args['orderby'] );
366
		$args['order']   = esc_sql( $args['order'] );
367
368
		return $wpdb->prepare(
369
			"SELECT {$fields} FROM {$this->table_name} {$where} ORDER BY {$this->table_name}.{$args['orderby']} {$args['order']} LIMIT %d,%d;",
370
			absint( $args['offset'] ),
371
			absint( $args['number'] )
372
		);
373
	}
374
375
376
	/**
377
	 * Validate query params.
378
	 *
379
	 * @since  2.3.0
380
	 * @access private
381
	 *
382
	 * @param $args
383
	 *
384
	 * @return mixed
385
	 */
386 View Code Duplication
	private function validate_params( &$args ) {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
387
		// fields params
388
		$args['fields'] = 'ids' === $args['fields']
389
			? 'ID'
390
			: $args['fields'];
391
		$args['fields'] = array_key_exists( $args['fields'], $this->get_columns() )
392
			? $args['fields']
393
			: 'all';
394
	}
395
}
396
397
// @todo: update cache logic.
398
// @todo: create issue for log cache logic.
399