DB.php
145 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Give\Framework\Database; |
| 4 | |
| 5 | use Give\Framework\Database\Exceptions\DatabaseQueryException; |
| 6 | use WP_Error; |
| 7 | |
| 8 | /** |
| 9 | * Class DB |
| 10 | * |
| 11 | * A static decorator for the $wpdb class and decorator function which does SQL error checking when performing queries. |
| 12 | * If a SQL error occurs a DatabaseQueryException is thrown. |
| 13 | * |
| 14 | * @method static int|bool query( string $query ) |
| 15 | * @method static int|false insert( string $table, array $data, array|string $format ) |
| 16 | * @method static int|false delete( string $table, array $where, array|string $where_format ) |
| 17 | * @method static int|false update( string $table, array $where, array|string $where_format ) |
| 18 | * @method static int|false replace( string $table, array $data, array|string $format ) |
| 19 | * @method static null|string get_var( string $query = null, int $x = 0, int $y = 0 ) |
| 20 | * @method static array|object|null|void get_row( string $query = null, string $output = OBJECT, int $y = 0 ) |
| 21 | * @method static array get_col( string $query = null, int $x = 0 ) |
| 22 | * @method static array|object|null get_results( string $query = null, string $output = OBJECT ) |
| 23 | */ |
| 24 | class DB { |
| 25 | /** |
| 26 | * Runs the dbDelta function and returns a WP_Error with any errors that occurred during the process |
| 27 | * |
| 28 | * @see dbDelta() for parameter and return details |
| 29 | * |
| 30 | * @since 2.9.2 |
| 31 | * |
| 32 | * @param $delta |
| 33 | * |
| 34 | * @return array |
| 35 | * @throws DatabaseQueryException |
| 36 | */ |
| 37 | public static function delta( $delta ) { |
| 38 | return self::runQueryWithErrorChecking( |
| 39 | function () use ( $delta ) { |
| 40 | return dbDelta( $delta ); |
| 41 | } |
| 42 | ); |
| 43 | } |
| 44 | |
| 45 | /** |
| 46 | * A convenience method for the $wpdb->prepare method |
| 47 | * |
| 48 | * @see WPDB::prepare() for usage details |
| 49 | * |
| 50 | * @since 2.9.6 |
| 51 | * |
| 52 | * @param string $query |
| 53 | * @param mixed ...$args |
| 54 | * |
| 55 | * @return false|mixed |
| 56 | */ |
| 57 | public static function prepare( $query, ...$args ) { |
| 58 | global $wpdb; |
| 59 | |
| 60 | return $wpdb->prepare( $query, ...$args ); |
| 61 | } |
| 62 | |
| 63 | /** |
| 64 | * Magic method which calls the static method on the $wpdb while performing error checking |
| 65 | * |
| 66 | * @since 2.9.6 |
| 67 | * |
| 68 | * @param $name |
| 69 | * @param $arguments |
| 70 | * |
| 71 | * @return mixed |
| 72 | * @throws DatabaseQueryException |
| 73 | */ |
| 74 | public static function __callStatic( $name, $arguments ) { |
| 75 | return self::runQueryWithErrorChecking( |
| 76 | function () use ( $name, $arguments ) { |
| 77 | global $wpdb; |
| 78 | |
| 79 | return call_user_func_array( [ $wpdb, $name ], $arguments ); |
| 80 | } |
| 81 | ); |
| 82 | } |
| 83 | |
| 84 | /** |
| 85 | * Runs a query callable and checks to see if any unique SQL errors occurred when it was run |
| 86 | * |
| 87 | * @since 2.9.2 |
| 88 | * |
| 89 | * @param Callable $queryCaller |
| 90 | * |
| 91 | * @return mixed |
| 92 | * @throws DatabaseQueryException |
| 93 | */ |
| 94 | private static function runQueryWithErrorChecking( $queryCaller ) { |
| 95 | global $wpdb, $EZSQL_ERROR; |
| 96 | require_once ABSPATH . 'wp-admin/includes/upgrade.php'; |
| 97 | |
| 98 | $errorCount = is_array( $EZSQL_ERROR ) ? count( $EZSQL_ERROR ) : 0; |
| 99 | $hasShowErrors = $wpdb->hide_errors(); |
| 100 | |
| 101 | $output = $queryCaller(); |
| 102 | |
| 103 | if ( $hasShowErrors ) { |
| 104 | $wpdb->show_errors(); |
| 105 | } |
| 106 | |
| 107 | $wpError = self::getQueryErrors( $errorCount ); |
| 108 | |
| 109 | if ( ! empty( $wpError->errors ) ) { |
| 110 | throw DatabaseQueryException::create( $wpError->get_error_messages() ); |
| 111 | } |
| 112 | |
| 113 | return $output; |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * Retrieves the SQL errors stored by WordPress |
| 118 | * |
| 119 | * @since 2.9.2 |
| 120 | * |
| 121 | * @param int $initialCount |
| 122 | * |
| 123 | * @return WP_Error |
| 124 | */ |
| 125 | private static function getQueryErrors( $initialCount = 0 ) { |
| 126 | global $EZSQL_ERROR; |
| 127 | |
| 128 | $wpError = new WP_Error(); |
| 129 | |
| 130 | if ( is_array( $EZSQL_ERROR ) ) { |
| 131 | for ( $index = $initialCount, $indexMax = count( $EZSQL_ERROR ); $index < $indexMax; $index ++ ) { |
| 132 | $error = $EZSQL_ERROR[ $index ]; |
| 133 | |
| 134 | if ( empty( $error['error_str'] ) || empty( $error['query'] ) || 0 === strpos( $error['query'], 'DESCRIBE ' ) ) { |
| 135 | continue; |
| 136 | } |
| 137 | |
| 138 | $wpError->add( 'db_delta_error', $error['error_str'] ); |
| 139 | } |
| 140 | } |
| 141 | |
| 142 | return $wpError; |
| 143 | } |
| 144 | } |
| 145 |