238 lines
		
	
	
		
			5.0 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
			
		
		
	
	
			238 lines
		
	
	
		
			5.0 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
| <?php
 | |
| 
 | |
| // Exit if accessed directly
 | |
| defined( 'ABSPATH' ) || exit;
 | |
| 
 | |
| /**
 | |
|  * EDD DB base class
 | |
|  *
 | |
|  * @package     EDD
 | |
|  * @subpackage  Classes/EDD DB
 | |
|  * @copyright   Copyright (c) 2018, Easy Digital Downloads, LLC
 | |
|  * @license     http://opensource.org/licenses/gpl-2.0.php GNU Public License
 | |
|  * @since       2.1
 | |
| */
 | |
| abstract class EDD_DB {
 | |
| 
 | |
| 	/**
 | |
| 	 * The name of our database table
 | |
| 	 *
 | |
| 	 * @since   2.1
 | |
| 	 */
 | |
| 	public $table_name;
 | |
| 
 | |
| 	/**
 | |
| 	 * The version of our database table
 | |
| 	 *
 | |
| 	 * @since   2.1
 | |
| 	 */
 | |
| 	public $version;
 | |
| 
 | |
| 	/**
 | |
| 	 * The name of the primary column
 | |
| 	 *
 | |
| 	 * @since   2.1
 | |
| 	 */
 | |
| 	public $primary_key;
 | |
| 
 | |
| 	/**
 | |
| 	 * Get things started
 | |
| 	 *
 | |
| 	 * @since   2.1
 | |
| 	 */
 | |
| 	public function __construct() {}
 | |
| 
 | |
| 	/**
 | |
| 	 * Whitelist of columns
 | |
| 	 *
 | |
| 	 * @since   2.1
 | |
| 	 * @return  array
 | |
| 	 */
 | |
| 	public function get_columns() {
 | |
| 		return array();
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * Default column values
 | |
| 	 *
 | |
| 	 * @since   2.1
 | |
| 	 * @return  array
 | |
| 	 */
 | |
| 	public function get_column_defaults() {
 | |
| 		return array();
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * Retrieve a row by the primary key
 | |
| 	 *
 | |
| 	 * @since   2.1
 | |
| 	 * @return  object
 | |
| 	 */
 | |
| 	public function get( $row_id ) {
 | |
| 		global $wpdb;
 | |
| 		return $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $this->table_name WHERE $this->primary_key = %s LIMIT 1;", $row_id ) );
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * Retrieve a row by a specific column / value
 | |
| 	 *
 | |
| 	 * @since   2.1
 | |
| 	 * @return  object
 | |
| 	 */
 | |
| 	public function get_by( $column, $row_id ) {
 | |
| 		global $wpdb;
 | |
| 		$column = esc_sql( $column );
 | |
| 		return $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $this->table_name WHERE $column = %s LIMIT 1;", $row_id ) );
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * Retrieve a specific column's value by the primary key
 | |
| 	 *
 | |
| 	 * @since   2.1
 | |
| 	 * @return  string
 | |
| 	 */
 | |
| 	public function get_column( $column, $row_id ) {
 | |
| 		global $wpdb;
 | |
| 		$column = esc_sql( $column );
 | |
| 		return $wpdb->get_var( $wpdb->prepare( "SELECT $column FROM $this->table_name WHERE $this->primary_key = %s LIMIT 1;", $row_id ) );
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * Retrieve a specific column's value by the the specified column / value
 | |
| 	 *
 | |
| 	 * @since   2.1
 | |
| 	 * @return  string
 | |
| 	 */
 | |
| 	public function get_column_by( $column, $column_where, $column_value ) {
 | |
| 		global $wpdb;
 | |
| 		$column_where = esc_sql( $column_where );
 | |
| 		$column       = esc_sql( $column );
 | |
| 		return $wpdb->get_var( $wpdb->prepare( "SELECT $column FROM $this->table_name WHERE $column_where = %s LIMIT 1;", $column_value ) );
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * Insert a new row
 | |
| 	 *
 | |
| 	 * @since   2.1
 | |
| 	 * @return  int
 | |
| 	 */
 | |
| 	public function insert( $data, $type = '' ) {
 | |
| 		global $wpdb;
 | |
| 
 | |
| 		// Set default values
 | |
| 		$data = wp_parse_args( $data, $this->get_column_defaults() );
 | |
| 
 | |
| 		do_action( 'edd_pre_insert_' . $type, $data );
 | |
| 
 | |
| 		// Initialise column format array
 | |
| 		$column_formats = $this->get_columns();
 | |
| 
 | |
| 		// Force fields to lower case
 | |
| 		$data = array_change_key_case( $data );
 | |
| 
 | |
| 		// White list columns
 | |
| 		$data = array_intersect_key( $data, $column_formats );
 | |
| 
 | |
| 		// Reorder $column_formats to match the order of columns given in $data
 | |
| 		$data_keys = array_keys( $data );
 | |
| 		$column_formats = array_merge( array_flip( $data_keys ), $column_formats );
 | |
| 
 | |
| 		$wpdb->insert( $this->table_name, $data, $column_formats );
 | |
| 		$wpdb_insert_id = $wpdb->insert_id;
 | |
| 
 | |
| 		do_action( 'edd_post_insert_' . $type, $wpdb_insert_id, $data );
 | |
| 
 | |
| 		return $wpdb_insert_id;
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * Update a row
 | |
| 	 *
 | |
| 	 * @since   2.1
 | |
| 	 * @return  bool
 | |
| 	 */
 | |
| 	public function update( $row_id, $data = array(), $where = '' ) {
 | |
| 
 | |
| 		global $wpdb;
 | |
| 
 | |
| 		// Row ID must be positive integer
 | |
| 		$row_id = absint( $row_id );
 | |
| 
 | |
| 		if( empty( $row_id ) ) {
 | |
| 			return false;
 | |
| 		}
 | |
| 
 | |
| 		if( empty( $where ) ) {
 | |
| 			$where = $this->primary_key;
 | |
| 		}
 | |
| 
 | |
| 		// Initialise column format array
 | |
| 		$column_formats = $this->get_columns();
 | |
| 
 | |
| 		// Force fields to lower case
 | |
| 		$data = array_change_key_case( $data );
 | |
| 
 | |
| 		// White list columns
 | |
| 		$data = array_intersect_key( $data, $column_formats );
 | |
| 
 | |
| 		// Reorder $column_formats to match the order of columns given in $data
 | |
| 		$data_keys = array_keys( $data );
 | |
| 		$column_formats = array_merge( array_flip( $data_keys ), $column_formats );
 | |
| 
 | |
| 		if ( false === $wpdb->update( $this->table_name, $data, array( $where => $row_id ), $column_formats ) ) {
 | |
| 			return false;
 | |
| 		}
 | |
| 
 | |
| 		return true;
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * Delete a row identified by the primary key
 | |
| 	 *
 | |
| 	 * @since   2.1
 | |
| 	 * @return  bool
 | |
| 	 */
 | |
| 	public function delete( $row_id = 0 ) {
 | |
| 
 | |
| 		global $wpdb;
 | |
| 
 | |
| 		// Row ID must be positive integer
 | |
| 		$row_id = absint( $row_id );
 | |
| 
 | |
| 		if( empty( $row_id ) ) {
 | |
| 			return false;
 | |
| 		}
 | |
| 
 | |
| 		if ( false === $wpdb->query( $wpdb->prepare( "DELETE FROM $this->table_name WHERE $this->primary_key = %d", $row_id ) ) ) {
 | |
| 			return false;
 | |
| 		}
 | |
| 
 | |
| 		return true;
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * Check if the given table exists
 | |
| 	 *
 | |
| 	 * @since  2.4
 | |
| 	 * @param  string $table The table name
 | |
| 	 * @return bool          If the table name exists
 | |
| 	 */
 | |
| 	public function table_exists( $table ) {
 | |
| 		global $wpdb;
 | |
| 		$table = sanitize_text_field( $table );
 | |
| 
 | |
| 		return $wpdb->get_var( $wpdb->prepare( "SHOW TABLES LIKE '%s'", $table ) ) === $table;
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * Check if the table was ever installed
 | |
| 	 *
 | |
| 	 * @since  2.4
 | |
| 	 * @return bool Returns if the customers table was installed and upgrade routine run
 | |
| 	 */
 | |
| 	public function installed() {
 | |
| 		return $this->table_exists( $this->table_name );
 | |
| 	}
 | |
| 
 | |
| }
 |