wpdb = $wpdb; } /** * Prepares a query. Queries without placeholders are returned as they are, because `wpdb::prepare()` rejects them. * * @param string $sql SQL with placeholders. Table names are interpolated by the caller from the Tables whitelist. * @param array $params Values for the placeholders. * @return string */ protected function prepare( string $sql, array $params = array() ): string { if ( array() === $params ) { return $sql; } return $this->wpdb->prepare( $sql, $params ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared,WordPress.DB.PreparedSQLPlaceholders.UnfinishedPrepare -- Placeholders are built by the calling repository. } /** * Runs a SELECT that returns rows as objects. * * @param string $sql SQL with placeholders. * @param array $params Values. * @return object[] */ protected function rows( string $sql, array $params = array() ): array { $rows = $this->wpdb->get_results( $this->prepare( $sql, $params ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching,WordPress.DB.PreparedSQL.NotPrepared,PluginCheck.Security.DirectDB.UnescapedDBParameter -- Prepared by prepare(). return is_array( $rows ) ? $rows : array(); } /** * Runs a SELECT that returns one row. * * @param string $sql SQL with placeholders. * @param array $params Values. * @return object|null */ protected function row( string $sql, array $params = array() ): ?object { $row = $this->wpdb->get_row( $this->prepare( $sql, $params ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching,WordPress.DB.PreparedSQL.NotPrepared,PluginCheck.Security.DirectDB.UnescapedDBParameter -- Prepared by prepare(). return is_object( $row ) ? $row : null; } /** * Runs a SELECT that returns one value. * * @param string $sql SQL with placeholders. * @param array $params Values. * @return string|null */ protected function value( string $sql, array $params = array() ): ?string { return $this->wpdb->get_var( $this->prepare( $sql, $params ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching,WordPress.DB.PreparedSQL.NotPrepared,PluginCheck.Security.DirectDB.UnescapedDBParameter -- Prepared by prepare(). } /** * Runs a SELECT that returns one column as a list of strings. * * @param string $sql SQL with placeholders. * @param array $params Values. * @return string[] */ protected function column( string $sql, array $params = array() ): array { $values = $this->wpdb->get_col( $this->prepare( $sql, $params ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching,WordPress.DB.PreparedSQL.NotPrepared,PluginCheck.Security.DirectDB.UnescapedDBParameter -- Prepared by prepare(). return is_array( $values ) ? $values : array(); } /** * Runs an UPDATE/DELETE statement. * * @param string $sql SQL with placeholders. * @param array $params Values. * @return int|false Rows affected, or false on error. */ protected function execute( string $sql, array $params = array() ) { return $this->wpdb->query( $this->prepare( $sql, $params ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching,WordPress.DB.PreparedSQL.NotPrepared,PluginCheck.Security.DirectDB.UnescapedDBParameter -- Prepared by prepare(). } /** * Inserts a row and returns its id, or 0 on failure. * * @param string $table Full table name. * @param array $data Column values. * @return int */ protected function insert_row( string $table, array $data ): int { $ok = $this->wpdb->insert( $table, $data ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching return false === $ok ? 0 : (int) $this->wpdb->insert_id; } /** * Updates a row by id. * * @param string $table Full table name. * @param int $id Row id. * @param array $data Column values. * @return bool False on a database error (updating nothing is not an error). */ protected function update_row( string $table, int $id, array $data ): bool { return false !== $this->wpdb->update( $table, $data, array( 'id' => $id ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching } /** * Deletes rows matching all given columns. * * @param string $table Full table name. * @param array $where Column values. * @return bool False on a database error. */ protected function delete_where( string $table, array $where ): bool { return false !== $this->wpdb->delete( $table, $where ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery,WordPress.DB.DirectDatabaseQuery.NoCaching } /** * Clamps paging input. * * @param array $args Arguments with `page` and `per_page`. * @return int[] Page, per page, offset. */ protected function paging( array $args ): array { $page = max( 1, (int) ( $args['page'] ?? 1 ) ); $per_page = max( 1, min( 100, (int) ( $args['per_page'] ?? 20 ) ) ); return array( $page, $per_page, ( $page - 1 ) * $per_page ); } }