Database::searchPosts() - Code Metrics - Inspection of "add button settings to glsr-divi/reviews" - pryley/site-reviews - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( d01060...4713f8 )

by Paul

created 2025-11-12 14:54 UTC

Database::searchPosts() A

↳ Parent: Database

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php

namespace GeminiLabs\SiteReviews;

use GeminiLabs\SiteReviews\Database\Query;
use GeminiLabs\SiteReviews\Database\Search\SearchAssignedPosts;
use GeminiLabs\SiteReviews\Database\Search\SearchAssignedUsers;
use GeminiLabs\SiteReviews\Database\Search\SearchPosts;
use GeminiLabs\SiteReviews\Database\Search\SearchUsers;
use GeminiLabs\SiteReviews\Database\Tables;
use GeminiLabs\SiteReviews\Helpers\Arr;
use GeminiLabs\SiteReviews\Helpers\Cast;
use GeminiLabs\SiteReviews\Helpers\Str;
use GeminiLabs\SiteReviews\Modules\Sanitizer;

class Database
{
    use Deprecated;

    protected \wpdb $db;

    public function __construct()
    {
        global $wpdb;
        $this->db = $wpdb;
    }

    /**
     * Use this before bulk insert (see: $this->finishTransaction()).
     */
    public function beginTransaction(string $table): void
    {
        if (glsr(Tables::class)->isSqlite()) {
            $this->dbQuery("BEGIN TRANSACTION;");
        } elseif (glsr(Tables::class)->isInnodb($table)) {
            $this->dbQuery("START TRANSACTION;");
        } elseif (glsr(Tables::class)->isMyisam($table)) {
            $this->dbQuery("SET autocommit = 0;");
        }
    }

    public function dbGetCol(string $sql): array
    {
        return $this->logErrors($this->db->get_col($sql));
    }

    /**
     * Query result in format specified by $output or null on failure.
     *
     * @return array|object|null
     */
    public function dbGetResults(string $sql, string $output = 'OBJECT')
    {
        $output = Str::restrictTo(['ARRAY_A', 'ARRAY_N', 'OBJECT', 'OBJECT_K'], $output, OBJECT);
        return $this->logErrors($this->db->get_results($sql, $output));
    }

    /**
     * Query result in format specified by $output or null on failure.
     *
     * @return array|object|void|null
     */
    public function dbGetRow(string $sql, string $output)
    {
        $output = Str::restrictTo(['ARRAY_A', 'ARRAY_N', 'OBJECT'], $output, OBJECT);
        return $this->logErrors($this->db->get_row($sql, $output));
    }

    /**
     * Query result as string, or null on failure.
     */
    public function dbGetVar(string $sql): ?string
    {
        return $this->logErrors($this->db->get_var($sql));
    }

    /**
     * True for CREATE, ALTER, TRUNCATE and DROP queries.
     * Number of rows affected/selected for all other queries.
     * False on error.
     *
     * @return int|bool
     */
    public function dbQuery(string $sql)
    {
        return $this->logErrors($this->db->query($sql));
    }

    /**
     * True for CREATE, ALTER, TRUNCATE and DROP queries.
     * Number of rows affected/selected for all other queries.
     * False on error.
     *
     * @return int|bool
     */
    public function dbSafeQuery(string $sql)
    {
        if (glsr(Tables::class)->isSqlite()) {
            return $this->dbQuery($sql);
        }
        $this->db->query('SET foreign_key_checks = 0');
        $result = $this->logErrors($this->db->query($sql));
        $this->db->query('SET foreign_key_checks = 1');
        return $result;
    }

    /**
     * Number of rows deleted. False on error.
     *
     * @return int|false
     */
    public function delete(string $table, array $where)
    {
        $result = $this->db->delete(glsr(Tables::class)->table($table), $where);
        glsr(Query::class)->sql($this->db->last_query); // for logging use only
        return $this->logErrors($result);
    }

    /**
     * Number of rows deleted. False on error.
     *
     * @param string|string[] $keys
     *
     * @return int|false
     */
    public function deleteMeta($keys, string $table = 'postmeta')
    {
        $table = glsr(Tables::class)->table($table);
        $metaKeys = glsr(Query::class)->escValuesForInsert(Arr::convertFromString($keys));
        $sql = glsr(Query::class)->sql("
            DELETE FROM {$table} WHERE meta_key IN {$metaKeys}
        ");
        return $this->dbQuery($sql);
    }

    /**
     * Use this after bulk insert (see: $this->beginTransaction()).
     */
    public function finishTransaction(string $table): void
    {
        if (glsr(Tables::class)->isSqlite()) {
            $this->dbQuery("COMMIT;");
        } elseif (glsr(Tables::class)->isInnodb($table)) {
            $this->dbQuery("COMMIT;");
        } elseif (glsr(Tables::class)->isMyisam($table)) {
            $this->dbQuery("SET autocommit = 1;");
        }
    }

    /**
     * Number of rows inserted. False on error.
     *
     * @return int|false
     */
    public function insert(string $table, array $data)
    {
        $this->db->insert_id = 0;
        $table = glsr(Tables::class)->table($table);
        $fields = glsr(Query::class)->escFieldsForInsert(array_keys($data));
        $values = glsr(Query::class)->escValuesForInsert($data);
        if (glsr(Tables::class)->isSqlite()) {
            $sql = glsr(Query::class)->sql("INSERT OR IGNORE INTO {$table} {$fields} VALUES {$values}");
        } else {
            $sql = glsr(Query::class)->sql("INSERT IGNORE INTO {$table} {$fields} VALUES {$values}");
        }
        $result = $this->dbQuery($sql);
        return $result;
    }

    /**
     * Number of rows inserted. False on error.
     *
     * @return int|false
     */
    public function insertBulk(string $table, array $values, array $fields)
    {
        $this->db->insert_id = 0;
        $data = [];
        foreach ($values as $value) {
            $value = array_intersect_key($value, array_flip($fields)); // only keep field values
            if (count($value) === count($fields)) {
                $value = array_merge(array_flip($fields), $value); // make sure the order is correct
                $data[] = glsr(Query::class)->escValuesForInsert($value);
            }
        }
        $table = glsr(Tables::class)->table($table);
        $fields = glsr(Query::class)->escFieldsForInsert($fields);
        $values = implode(',', $data);
        if (glsr(Tables::class)->isSqlite()) {
            $sql = glsr(Query::class)->sql("INSERT OR IGNORE INTO {$table} {$fields} VALUES {$values}");
        } else {
            $sql = glsr(Query::class)->sql("INSERT IGNORE INTO {$table} {$fields} VALUES {$values}");
        }
        return $this->dbQuery($sql);
    }

    public function isMigrationNeeded(): bool
    {
        $postTypes = wp_count_posts(glsr()->post_type);
        $postCount = Arr::get($postTypes, 'publish');
        if (empty($postCount)) {
            return false;
        }
        $sql = glsr(Query::class)->sql("SELECT COUNT(*) FROM table|ratings WHERE is_approved = 1");
        return empty($this->dbGetVar($sql));
    }

    /**
     * @param mixed $result
     *
     * @return mixed
     */
    public function logErrors($result = null)
    {
        if ($this->db->last_error) {
            glsr_log()->error($this->db->last_error);
            glsr_trace();
        }
        return $result;
    }

    public function posts(array $args = []): array
    {
        $args = wp_parse_args($args, [
            'order' => 'ASC',
            'orderby' => 'title',
            'post_type' => glsr()->prefix.'assigned_posts',
            'posts_per_page' => 50,
            'search_columns' => [
                'post_title',
            ],
            'suppress_filters' => true,
        ]);
        $posts = get_posts($args);
        $results = [];
        foreach ($posts as $post) {
            $results[$post->ID] = sanitize_text_field($post->post_title) ?: _x('(no title)', 'admin-text', 'site-reviews');
        }
        natcasesort($results);
        return $results;
    }

    public function searchAssignedPosts(string $searchTerm): SearchAssignedPosts
    {
        return glsr(SearchAssignedPosts::class)->search($searchTerm);
    }

    public function searchAssignedUsers(string $searchTerm): SearchAssignedUsers
    {
        return glsr(SearchAssignedUsers::class)->search($searchTerm);
    }

    public function searchPosts(string $searchTerm): SearchPosts
    {
        return glsr(SearchPosts::class)->search($searchTerm);
    }

    public function searchUsers(string $searchTerm): SearchUsers
    {
        return glsr(SearchUsers::class)->search($searchTerm);
    }

    public function terms(array $args = []): array
    {
        $args = wp_parse_args($args, [
            'count' => false,
            'fields' => 'id=>name',
            'hide_empty' => false,
            'taxonomy' => glsr()->taxonomy,
        ]);
        $terms = get_terms($args);
        if (is_wp_error($terms)) {
            glsr_log()->error($terms->get_error_message());
            glsr_trace();
            return [];
        }
        return $terms;
    }

    /**
     * Number of rows updated. False on error.
     *
     * @return int|false
     */
    public function update(string $table, array $data, array $where)
    {
        $result = $this->db->update(glsr(Tables::class)->table($table), $data, $where);
        glsr(Query::class)->sql($this->db->last_query); // for logging use only
        return $this->logErrors($result);
    }

    public function users(array $args = []): array
    {
        $args = wp_parse_args($args, [
            'fields' => ['ID', 'display_name', 'user_nicename'],
            'number' => 50, // only get the first 50 users!
            'orderby' => 'display_name',
            'search' => '',
            'search_columns' => ['display_name', 'user_nicename'],
            'search_wild' => '',
        ]);
        if (!empty($args['search_wild'])) {
            $args['search'] = "*{$args['search_wild']}*";
        }
        $results = [];
        $users = get_users($args);
        foreach ($users as $user) {
            $name = glsr(Sanitizer::class)->sanitizeUserName($user);
            $results[$user->ID] = $name;
        }
        return $results;
    }

    public function version(): string
    {
        $dbVersion = Cast::toString(get_option(glsr()->prefix.'db_version'));
        if (version_compare($dbVersion, Application::DB_VERSION, '>')) { // version should never be higher than plugin database version
            update_option(glsr()->prefix.'db_version', '1.0'); // setting it to a low version will trigger the plugin migration
            $dbVersion = '1.0';
        }
        return $dbVersion;
    }
}


1		<?php
2
3		namespace GeminiLabs\SiteReviews;
4
5		use GeminiLabs\SiteReviews\Database\Query;
6		use GeminiLabs\SiteReviews\Database\Search\SearchAssignedPosts;
7		use GeminiLabs\SiteReviews\Database\Search\SearchAssignedUsers;
8		use GeminiLabs\SiteReviews\Database\Search\SearchPosts;
9		use GeminiLabs\SiteReviews\Database\Search\SearchUsers;
10		use GeminiLabs\SiteReviews\Database\Tables;
11		use GeminiLabs\SiteReviews\Helpers\Arr;
12		use GeminiLabs\SiteReviews\Helpers\Cast;
13		use GeminiLabs\SiteReviews\Helpers\Str;
14		use GeminiLabs\SiteReviews\Modules\Sanitizer;
15
16		class Database
17		{
18		use Deprecated;
19
20		protected \wpdb $db;
21
22	45	public function __construct()
23		{
24		global $wpdb;
25	45	$this->db = $wpdb;
26		}
27
28		/**
29		* Use this before bulk insert (see: $this->finishTransaction()).
30		*/
31	37	public function beginTransaction(string $table): void
32		{
33	37	if (glsr(Tables::class)->isSqlite()) {
34		$this->dbQuery("BEGIN TRANSACTION;");
35	37	} elseif (glsr(Tables::class)->isInnodb($table)) {
36		$this->dbQuery("START TRANSACTION;");
37	37	} elseif (glsr(Tables::class)->isMyisam($table)) {
38		$this->dbQuery("SET autocommit = 0;");
39		}
40		}
41
42	37	public function dbGetCol(string $sql): array
43		{
44	37	return $this->logErrors($this->db->get_col($sql));
45		}
46
47		/**
48		* Query result in format specified by $output or null on failure.
49		*
50		* @return array\|object\|null
51		*/
52	37	public function dbGetResults(string $sql, string $output = 'OBJECT')
53		{
54	37	$output = Str::restrictTo(['ARRAY_A', 'ARRAY_N', 'OBJECT', 'OBJECT_K'], $output, OBJECT);
55	37	return $this->logErrors($this->db->get_results($sql, $output));
56		}
57
58		/**
59		* Query result in format specified by $output or null on failure.
60		*
61		* @return array\|object\|void\|null
62		*/
63	18	public function dbGetRow(string $sql, string $output)
64		{
65	18	$output = Str::restrictTo(['ARRAY_A', 'ARRAY_N', 'OBJECT'], $output, OBJECT);
66	18	return $this->logErrors($this->db->get_row($sql, $output));
67		}
68
69		/**
70		* Query result as string, or null on failure.
71		*/
72	21	public function dbGetVar(string $sql): ?string
73		{
74	21	return $this->logErrors($this->db->get_var($sql));
75		}
76
77		/**
78		* True for CREATE, ALTER, TRUNCATE and DROP queries.
79		* Number of rows affected/selected for all other queries.
80		* False on error.
81		*
82		* @return int\|bool
83		*/
84	37	public function dbQuery(string $sql)
85		{
86	37	return $this->logErrors($this->db->query($sql));
87		}
88
89		/**
90		* True for CREATE, ALTER, TRUNCATE and DROP queries.
91		* Number of rows affected/selected for all other queries.
92		* False on error.
93		*
94		* @return int\|bool
95		*/
96	37	public function dbSafeQuery(string $sql)
97		{
98	37	if (glsr(Tables::class)->isSqlite()) {
99		return $this->dbQuery($sql);
100		}
101	37	$this->db->query('SET foreign_key_checks = 0');
102	37	$result = $this->logErrors($this->db->query($sql));
103	37	$this->db->query('SET foreign_key_checks = 1');
104	37	return $result;
105		}
106
107		/**
108		* Number of rows deleted. False on error.
109		*
110		* @return int\|false
111		*/
112	3	public function delete(string $table, array $where)
113		{
114	3	$result = $this->db->delete(glsr(Tables::class)->table($table), $where);
115	3	glsr(Query::class)->sql($this->db->last_query); // for logging use only
116	3	return $this->logErrors($result);
117		}
118
119		/**
120		* Number of rows deleted. False on error.
121		*
122		* @param string\|string[] $keys
123		*
124		* @return int\|false
125		*/
126	37	public function deleteMeta($keys, string $table = 'postmeta')
127		{
128	37	$table = glsr(Tables::class)->table($table);
129	37	$metaKeys = glsr(Query::class)->escValuesForInsert(Arr::convertFromString($keys));
130	37	$sql = glsr(Query::class)->sql("
131	37	DELETE FROM {$table} WHERE meta_key IN {$metaKeys}
132	37	");
133	37	return $this->dbQuery($sql);
134		}
135
136		/**
137		* Use this after bulk insert (see: $this->beginTransaction()).
138		*/
139	37	public function finishTransaction(string $table): void
140		{
141	37	if (glsr(Tables::class)->isSqlite()) {
142		$this->dbQuery("COMMIT;");
143	37	} elseif (glsr(Tables::class)->isInnodb($table)) {
144		$this->dbQuery("COMMIT;");
145	37	} elseif (glsr(Tables::class)->isMyisam($table)) {
146		$this->dbQuery("SET autocommit = 1;");
147		}
148		}
149
150		/**
151		* Number of rows inserted. False on error.
152		*
153		* @return int\|false
154		*/
155	18	public function insert(string $table, array $data)
156		{
157	18	$this->db->insert_id = 0;
158	18	$table = glsr(Tables::class)->table($table);
159	18	$fields = glsr(Query::class)->escFieldsForInsert(array_keys($data));
160	18	$values = glsr(Query::class)->escValuesForInsert($data);
161	18	if (glsr(Tables::class)->isSqlite()) {
162		$sql = glsr(Query::class)->sql("INSERT OR IGNORE INTO {$table} {$fields} VALUES {$values}");
163		} else {
164	18	$sql = glsr(Query::class)->sql("INSERT IGNORE INTO {$table} {$fields} VALUES {$values}");
165		}
166	18	$result = $this->dbQuery($sql);
167	18	return $result;
168		}
169
170		/**
171		* Number of rows inserted. False on error.
172		*
173		* @return int\|false
174		*/
175		public function insertBulk(string $table, array $values, array $fields)
176		{
177		$this->db->insert_id = 0;
178		$data = [];
179		foreach ($values as $value) {
180		$value = array_intersect_key($value, array_flip($fields)); // only keep field values
181		if (count($value) === count($fields)) {
182		$value = array_merge(array_flip($fields), $value); // make sure the order is correct
183		$data[] = glsr(Query::class)->escValuesForInsert($value);
184		}
185		}
186		$table = glsr(Tables::class)->table($table);
187		$fields = glsr(Query::class)->escFieldsForInsert($fields);
188		$values = implode(',', $data);
189		if (glsr(Tables::class)->isSqlite()) {
190		$sql = glsr(Query::class)->sql("INSERT OR IGNORE INTO {$table} {$fields} VALUES {$values}");
191		} else {
192		$sql = glsr(Query::class)->sql("INSERT IGNORE INTO {$table} {$fields} VALUES {$values}");
193		}
194		return $this->dbQuery($sql);
195		}
196
197		public function isMigrationNeeded(): bool
198		{
199		$postTypes = wp_count_posts(glsr()->post_type);
200		$postCount = Arr::get($postTypes, 'publish');
201		if (empty($postCount)) {
202		return false;
203		}
204		$sql = glsr(Query::class)->sql("SELECT COUNT(*) FROM table\|ratings WHERE is_approved = 1");
205		return empty($this->dbGetVar($sql));
206		}
207
208		/**
209		* @param mixed $result
210		*
211		* @return mixed
212		*/
213	40	public function logErrors($result = null)
214		{
215	40	if ($this->db->last_error) {
216		glsr_log()->error($this->db->last_error);
217		glsr_trace();
218		}
219	40	return $result;
220		}
221
222		public function posts(array $args = []): array
223		{
224		$args = wp_parse_args($args, [
225		'order' => 'ASC',
226		'orderby' => 'title',
227		'post_type' => glsr()->prefix.'assigned_posts',
228		'posts_per_page' => 50,
229		'search_columns' => [
230		'post_title',
231		],
232		'suppress_filters' => true,
233		]);
234		$posts = get_posts($args);
235		$results = [];
236		foreach ($posts as $post) {
237		$results[$post->ID] = sanitize_text_field($post->post_title) ?: _x('(no title)', 'admin-text', 'site-reviews');
238		}
239		natcasesort($results);
240		return $results;
241		}
242
243		public function searchAssignedPosts(string $searchTerm): SearchAssignedPosts
244		{
245		return glsr(SearchAssignedPosts::class)->search($searchTerm);
246		}
247
248		public function searchAssignedUsers(string $searchTerm): SearchAssignedUsers
249		{
250		return glsr(SearchAssignedUsers::class)->search($searchTerm);
251		}
252
253		public function searchPosts(string $searchTerm): SearchPosts
254		{
255		return glsr(SearchPosts::class)->search($searchTerm);
256		}
257
258		public function searchUsers(string $searchTerm): SearchUsers
259		{
260		return glsr(SearchUsers::class)->search($searchTerm);
261		}
262
263		public function terms(array $args = []): array
264		{
265		$args = wp_parse_args($args, [
266		'count' => false,
267		'fields' => 'id=>name',
268		'hide_empty' => false,
269		'taxonomy' => glsr()->taxonomy,
270		]);
271		$terms = get_terms($args);
272		if (is_wp_error($terms)) {
273		glsr_log()->error($terms->get_error_message());
274		glsr_trace();
275		return [];
276		}
277		return $terms;
278		}
279
280		/**
281		* Number of rows updated. False on error.
282		*
283		* @return int\|false
284		*/
285		public function update(string $table, array $data, array $where)
286		{
287		$result = $this->db->update(glsr(Tables::class)->table($table), $data, $where);
288		glsr(Query::class)->sql($this->db->last_query); // for logging use only
289		return $this->logErrors($result);
290		}
291
292		public function users(array $args = []): array
293		{
294		$args = wp_parse_args($args, [
295		'fields' => ['ID', 'display_name', 'user_nicename'],
296		'number' => 50, // only get the first 50 users!
297		'orderby' => 'display_name',
298		'search' => '',
299		'search_columns' => ['display_name', 'user_nicename'],
300		'search_wild' => '',
301		]);
302		if (!empty($args['search_wild'])) {
303		$args['search'] = "{$args['search_wild']}";
304		}
305		$results = [];
306		$users = get_users($args);
307		foreach ($users as $user) {
308		$name = glsr(Sanitizer::class)->sanitizeUserName($user);
309		$results[$user->ID] = $name;
310		}
311		return $results;
312		}
313
314	43	public function version(): string
315		{
316	43	$dbVersion = Cast::toString(get_option(glsr()->prefix.'db_version'));
317	43	if (version_compare($dbVersion, Application::DB_VERSION, '>')) { // version should never be higher than plugin database version
318		update_option(glsr()->prefix.'db_version', '1.0'); // setting it to a low version will trigger the plugin migration
319		$dbVersion = '1.0';
320		}
321	43	return $dbVersion;
322		}
323		}
324

pryley / site-reviews

Push — develop ( d01060...4713f8 )

Database::searchPosts() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like