Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Abstract class for database

[2] Fix | Delete

[3] Fix | Delete

* @package PUM

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

[7] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[8] Fix | Delete

exit;

[9] Fix | Delete

}

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Abstract database class.

[13] Fix | Delete

[14] Fix | Delete

* @package PopupMaker

[15] Fix | Delete

[16] Fix | Delete

abstract class PUM_Abstract_Database {

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Instance of the class.

[20] Fix | Delete

[21] Fix | Delete

* @var static

[22] Fix | Delete

[23] Fix | Delete

public static $instance;

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* The name of our database table.

[27] Fix | Delete

[28] Fix | Delete

* @var string

[29] Fix | Delete

[30] Fix | Delete

public $table_name = '';

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* The version of our database table.

[34] Fix | Delete

[35] Fix | Delete

* @var integer

[36] Fix | Delete

[37] Fix | Delete

public $version = 1;

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* The name of the primary column.

[41] Fix | Delete

[42] Fix | Delete

* @var string

[43] Fix | Delete

[44] Fix | Delete

public $primary_key = 'ID';

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Get things started

[48] Fix | Delete

[49] Fix | Delete

public function __construct() {

[50] Fix | Delete

global $wpdb;

[51] Fix | Delete

[52] Fix | Delete

$current_db_version = $this->get_installed_version();

[53] Fix | Delete

[54] Fix | Delete

if ( ! $current_db_version || $current_db_version < $this->version ) {

[55] Fix | Delete

// Install the table.

[56] Fix | Delete

@$this->create_table();

[57] Fix | Delete

[58] Fix | Delete

if ( $wpdb->get_var( "SHOW TABLES LIKE '{$this->table_name()}'" ) === $this->table_name() ) {

[59] Fix | Delete

$this->update_db_version();

[60] Fix | Delete

}

[61] Fix | Delete

}

[62] Fix | Delete

[63] Fix | Delete

$wpdb->{$this->table_name} = $this->table_name();

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* Gets db version from new or old source.

[68] Fix | Delete

[69] Fix | Delete

* @return float

[70] Fix | Delete

[71] Fix | Delete

public function get_installed_version() {

[72] Fix | Delete

// Get list of all current db table versions.

[73] Fix | Delete

$db_versions = get_option( 'pum_db_versions', [] );

[74] Fix | Delete

[75] Fix | Delete

// #1 If it exists in new pum_db_vers[] option, move on.

[76] Fix | Delete

if ( isset( $db_versions[ $this->table_name ] ) ) {

[77] Fix | Delete

return (float) $db_versions[ $this->table_name ];

[78] Fix | Delete

}

[79] Fix | Delete

[80] Fix | Delete

// #2 Else look for old key, if exists, migrate and delete.

[81] Fix | Delete

$db_version_old_key = get_option( $this->table_name . '_db_version' );

[82] Fix | Delete

[83] Fix | Delete

if ( $db_version_old_key ) {

[84] Fix | Delete

if ( $db_version_old_key > 0 ) {

[85] Fix | Delete

$db_versions[ $this->table_name ] = (float) $db_version_old_key;

[86] Fix | Delete

update_option( 'pum_db_versions', $db_versions );

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

delete_option( $this->table_name . '_db_version' );

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

return (float) $db_version_old_key;

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

public function update_db_version() {

[96] Fix | Delete

// Get list of all current db table versions.

[97] Fix | Delete

$db_versions = get_option( 'pum_db_versions', [] );

[98] Fix | Delete

[99] Fix | Delete

$db_versions[ $this->table_name ] = (float) $this->version;

[100] Fix | Delete

update_option( 'pum_db_versions', $db_versions );

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

/**

[104] Fix | Delete

* Create the table

[105] Fix | Delete

[106] Fix | Delete

abstract public function create_table();

[107] Fix | Delete

[108] Fix | Delete

/**

[109] Fix | Delete

* @return static

[110] Fix | Delete

* @throws \Exception

[111] Fix | Delete

[112] Fix | Delete

public static function instance() {

[113] Fix | Delete

$class = get_called_class();

[114] Fix | Delete

[115] Fix | Delete

if ( ! isset( self::$instance[ $class ] ) ) {

[116] Fix | Delete

self::$instance[ $class ] = new $class();

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

return self::$instance[ $class ];

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

/**

[123] Fix | Delete

* Retrieve a row by the primary key

[124] Fix | Delete

[125] Fix | Delete

* @param $row_id

[126] Fix | Delete

[127] Fix | Delete

* @return object

[128] Fix | Delete

[129] Fix | Delete

public function get( $row_id ) {

[130] Fix | Delete

global $wpdb;

[131] Fix | Delete

[132] Fix | Delete

return $this->prepare_result( $wpdb->get_row( "SELECT * FROM {$this->table_name()} WHERE $this->primary_key = $row_id LIMIT 1;" ) );

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

/**

[136] Fix | Delete

* @param object|array $result

[137] Fix | Delete

[138] Fix | Delete

* @return object|array

[139] Fix | Delete

[140] Fix | Delete

public function prepare_result( $result ) {

[141] Fix | Delete

if ( ! $result || ( ! is_array( $result ) && ! is_object( $result ) ) ) {

[142] Fix | Delete

return $result;

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

if ( is_object( $result ) ) {

[146] Fix | Delete

$vars = get_object_vars( $result );

[147] Fix | Delete

foreach ( $vars as $key => $value ) {

[148] Fix | Delete

if ( is_string( $value ) ) {

[149] Fix | Delete

$result->$key = maybe_unserialize( $value );

[150] Fix | Delete

}

[151] Fix | Delete

}

[152] Fix | Delete

} elseif ( is_array( $result ) ) {

[153] Fix | Delete

foreach ( $result as $key => $value ) {

[154] Fix | Delete

if ( is_string( $value ) ) {

[155] Fix | Delete

$result[ $key ] = maybe_unserialize( $value );

[156] Fix | Delete

}

[157] Fix | Delete

}

[158] Fix | Delete

}

[159] Fix | Delete

[160] Fix | Delete

return $result;

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete

/**

[164] Fix | Delete

* @param array|object[] $results

[165] Fix | Delete

[166] Fix | Delete

* @return mixed

[167] Fix | Delete

[168] Fix | Delete

public function prepare_results( $results ) {

[169] Fix | Delete

[170] Fix | Delete

foreach ( $results as $key => $result ) {

[171] Fix | Delete

$results[ $key ] = $this->prepare_result( $result );

[172] Fix | Delete

}

[173] Fix | Delete

[174] Fix | Delete

return $results;

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

/**

[178] Fix | Delete

* @return string

[179] Fix | Delete

[180] Fix | Delete

public function table_name() {

[181] Fix | Delete

global $wpdb;

[182] Fix | Delete

[183] Fix | Delete

return $wpdb->prefix . $this->table_name;

[184] Fix | Delete

}

[185] Fix | Delete

[186] Fix | Delete

/**

[187] Fix | Delete

* Retrieve a row by a specific column / value

[188] Fix | Delete

[189] Fix | Delete

* @param $column

[190] Fix | Delete

* @param $row_id

[191] Fix | Delete

[192] Fix | Delete

* @return object

[193] Fix | Delete

[194] Fix | Delete

public function get_by( $column, $row_id ) {

[195] Fix | Delete

global $wpdb;

[196] Fix | Delete

[197] Fix | Delete

return $this->prepare_result( $wpdb->get_row( "SELECT * FROM {$this->table_name()} WHERE $column = '$row_id' LIMIT 1;" ) );

[198] Fix | Delete

}

[199] Fix | Delete

[200] Fix | Delete

/**

[201] Fix | Delete

* Retrieve a specific column's value by the primary key

[202] Fix | Delete

[203] Fix | Delete

* @param $column

[204] Fix | Delete

* @param $row_id

[205] Fix | Delete

[206] Fix | Delete

* @return string

[207] Fix | Delete

[208] Fix | Delete

public function get_column( $column, $row_id ) {

[209] Fix | Delete

global $wpdb;

[210] Fix | Delete

[211] Fix | Delete

return $wpdb->get_var( "SELECT $column FROM {$this->table_name()} WHERE $this->primary_key = $row_id LIMIT 1;" );

[212] Fix | Delete

}

[213] Fix | Delete

[214] Fix | Delete

/**

[215] Fix | Delete

* Retrieve a specific column's value by the the specified column / value

[216] Fix | Delete

[217] Fix | Delete

* @param $column

[218] Fix | Delete

* @param $column_where

[219] Fix | Delete

* @param $column_value

[220] Fix | Delete

[221] Fix | Delete

* @return string

[222] Fix | Delete

[223] Fix | Delete

public function get_column_by( $column, $column_where, $column_value ) {

[224] Fix | Delete

global $wpdb;

[225] Fix | Delete

[226] Fix | Delete

return $wpdb->get_var( "SELECT $column FROM {$this->table_name()} WHERE $column_where = '$column_value' LIMIT 1;" );

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

/**

[230] Fix | Delete

* Insert a new row

[231] Fix | Delete

[232] Fix | Delete

* @param $data

[233] Fix | Delete

* @param string $type

[234] Fix | Delete

[235] Fix | Delete

* @return int

[236] Fix | Delete

[237] Fix | Delete

public function insert( $data ) {

[238] Fix | Delete

global $wpdb;

[239] Fix | Delete

[240] Fix | Delete

// Set default values

[241] Fix | Delete

$data = wp_parse_args( $data, $this->get_column_defaults() );

[242] Fix | Delete

[243] Fix | Delete

do_action( 'pum_pre_insert_' . $this->table_name, $data );

[244] Fix | Delete

[245] Fix | Delete

// Initialise column format array

[246] Fix | Delete

$column_formats = $this->get_columns();

[247] Fix | Delete

[248] Fix | Delete

// Force fields to lower case

[249] Fix | Delete

$data = array_change_key_case( $data );

[250] Fix | Delete

[251] Fix | Delete

// White list columns

[252] Fix | Delete

$data = array_intersect_key( $data, $column_formats );

[253] Fix | Delete

[254] Fix | Delete

// Reorder $column_formats to match the order of columns given in $data

[255] Fix | Delete

$data_keys = array_keys( $data );

[256] Fix | Delete

$column_formats = array_merge( array_flip( $data_keys ), $column_formats );

[257] Fix | Delete

[258] Fix | Delete

foreach ( $data as $key => $value ) {

[259] Fix | Delete

if ( is_array( $value ) ) {

[260] Fix | Delete

$data[ $key ] = maybe_serialize( $value );

[261] Fix | Delete

}

[262] Fix | Delete

}

[263] Fix | Delete

[264] Fix | Delete

$wpdb->insert( $this->table_name(), $data, $column_formats );

[265] Fix | Delete

[266] Fix | Delete

do_action( 'pum_post_insert_' . $this->table_name, $wpdb->insert_id, $data );

[267] Fix | Delete

[268] Fix | Delete

return $wpdb->insert_id;

[269] Fix | Delete

}

[270] Fix | Delete

[271] Fix | Delete

/**

[272] Fix | Delete

* Default column values

[273] Fix | Delete

[274] Fix | Delete

* @return array

[275] Fix | Delete

[276] Fix | Delete

public function get_column_defaults() {

[277] Fix | Delete

return [];

[278] Fix | Delete

}

[279] Fix | Delete

[280] Fix | Delete

/**

[281] Fix | Delete

* Whitelist of columns

[282] Fix | Delete

[283] Fix | Delete

* @return array

[284] Fix | Delete

[285] Fix | Delete

public function get_columns() {

[286] Fix | Delete

return [];

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete

/**

[290] Fix | Delete

* Update a row

[291] Fix | Delete

[292] Fix | Delete

* @param $row_id

[293] Fix | Delete

* @param array $data

[294] Fix | Delete

* @param string $where

[295] Fix | Delete

[296] Fix | Delete

* @return bool

[297] Fix | Delete

[298] Fix | Delete

public function update( $row_id, $data = [], $where = '' ) {

[299] Fix | Delete

[300] Fix | Delete

global $wpdb;

[301] Fix | Delete

[302] Fix | Delete

// Row ID must be positive integer

[303] Fix | Delete

$row_id = absint( $row_id );

[304] Fix | Delete

[305] Fix | Delete

if ( empty( $row_id ) ) {

[306] Fix | Delete

return false;

[307] Fix | Delete

}

[308] Fix | Delete

[309] Fix | Delete

if ( empty( $where ) ) {

[310] Fix | Delete

$where = $this->primary_key;

[311] Fix | Delete

}

[312] Fix | Delete

[313] Fix | Delete

// Initialise column format array

[314] Fix | Delete

$column_formats = $this->get_columns();

[315] Fix | Delete

[316] Fix | Delete

// Force fields to lower case

[317] Fix | Delete

$data = array_change_key_case( $data );

[318] Fix | Delete

[319] Fix | Delete

// White list columns

[320] Fix | Delete

$data = array_intersect_key( $data, $column_formats );

[321] Fix | Delete

[322] Fix | Delete

foreach ( $data as $key => $value ) {

[323] Fix | Delete

if ( is_array( $value ) ) {

[324] Fix | Delete

$data[ $key ] = maybe_serialize( $value );

[325] Fix | Delete

}

[326] Fix | Delete

}

[327] Fix | Delete

[328] Fix | Delete

// Reorder $column_formats to match the order of columns given in $data

[329] Fix | Delete

$data_keys = array_keys( $data );

[330] Fix | Delete

$column_formats = array_merge( array_flip( $data_keys ), $column_formats );

[331] Fix | Delete

[332] Fix | Delete

if ( false === $wpdb->update( $this->table_name(), $data, [ $where => $row_id ], $column_formats ) ) {

[333] Fix | Delete

return false;

[334] Fix | Delete

}

[335] Fix | Delete

[336] Fix | Delete

return true;

[337] Fix | Delete

}

[338] Fix | Delete

[339] Fix | Delete

/**

[340] Fix | Delete

* Delete a row identified by the primary key

[341] Fix | Delete

[342] Fix | Delete

* @param int $row_id

[343] Fix | Delete

[344] Fix | Delete

* @return bool

[345] Fix | Delete

[346] Fix | Delete

public function delete( $row_id = 0 ) {

[347] Fix | Delete

[348] Fix | Delete

global $wpdb;

[349] Fix | Delete

[350] Fix | Delete

// Row ID must be positive integer

[351] Fix | Delete

$row_id = absint( $row_id );

[352] Fix | Delete

[353] Fix | Delete

if ( empty( $row_id ) ) {

[354] Fix | Delete

return false;

[355] Fix | Delete

}

[356] Fix | Delete

[357] Fix | Delete

if ( false === $wpdb->query( $wpdb->prepare( "DELETE FROM {$this->table_name()} WHERE $this->primary_key = %d", $row_id ) ) ) {

[358] Fix | Delete

return false;

[359] Fix | Delete

}

[360] Fix | Delete

[361] Fix | Delete

return true;

[362] Fix | Delete

}

[363] Fix | Delete

[364] Fix | Delete

/**

[365] Fix | Delete

* Delete a row identified by the primary key

[366] Fix | Delete

[367] Fix | Delete

* @param $column

[368] Fix | Delete

* @param $row_id

[369] Fix | Delete

[370] Fix | Delete

* @return bool

[371] Fix | Delete

[372] Fix | Delete

public function delete_by( $column, $row_id ) {

[373] Fix | Delete

global $wpdb;

[374] Fix | Delete

if ( empty( $row_id ) ) {

[375] Fix | Delete

return false;

[376] Fix | Delete

}

[377] Fix | Delete

if ( false === $wpdb->query( $wpdb->prepare( "DELETE FROM {$this->table_name()} WHERE $column = '%s'", $row_id ) ) ) {

[378] Fix | Delete

return false;

[379] Fix | Delete

}

[380] Fix | Delete

[381] Fix | Delete

return true;

[382] Fix | Delete

}

[383] Fix | Delete

[384] Fix | Delete

/**

[385] Fix | Delete

* Prepare query.

[386] Fix | Delete

[387] Fix | Delete

* @param $query

[388] Fix | Delete

* @param array $args

[389] Fix | Delete

[390] Fix | Delete

* @return string

[391] Fix | Delete

[392] Fix | Delete

public function prepare_query( $query, $args = [] ) {

[393] Fix | Delete

[394] Fix | Delete

if ( $args['orderby'] ) {

[395] Fix | Delete

$query .= " ORDER BY {$args['orderby']} {$args['order']}";

[396] Fix | Delete

}

[397] Fix | Delete

[398] Fix | Delete

$query .= " LIMIT {$args['limit']}";

[399] Fix | Delete

[400] Fix | Delete

if ( $args['offset'] ) {

[401] Fix | Delete

$query .= " OFFSET {$args['offset']}";

[402] Fix | Delete

}

[403] Fix | Delete

[404] Fix | Delete

$query .= ';';

[405] Fix | Delete

[406] Fix | Delete

return $query;

[407] Fix | Delete

[408] Fix | Delete

}

[409] Fix | Delete

[410] Fix | Delete

/**

[411] Fix | Delete

* @param array $args

[412] Fix | Delete

* @param string $return_type

[413] Fix | Delete

[414] Fix | Delete

* @return array|mixed|object[]

[415] Fix | Delete

[416] Fix | Delete

public function query( $args = [], $return_type = OBJECT ) {

[417] Fix | Delete

global $wpdb;

[418] Fix | Delete

[419] Fix | Delete

$args = wp_parse_args(

[420] Fix | Delete

$args,

[421] Fix | Delete

[

[422] Fix | Delete

'fields' => '*',

[423] Fix | Delete

'page' => null,

[424] Fix | Delete

'limit' => null,

[425] Fix | Delete

'offset' => null,

[426] Fix | Delete

's' => null,

[427] Fix | Delete

'orderby' => null,

[428] Fix | Delete

'order' => null,

[429] Fix | Delete

]

[430] Fix | Delete

);

[431] Fix | Delete

[432] Fix | Delete

$columns = $this->get_columns();

[433] Fix | Delete

[434] Fix | Delete

$fields = $args['fields'];

[435] Fix | Delete

[436] Fix | Delete

if ( '*' === $fields ) {

[437] Fix | Delete

$fields = array_keys( $columns );

[438] Fix | Delete

} else {

[439] Fix | Delete

$fields = explode( ',', $args['fields'] );

[440] Fix | Delete

$fields = array_map( 'trim', $fields );

[441] Fix | Delete

$fields = array_map( 'sanitize_text_field', $fields );

[442] Fix | Delete

}

[443] Fix | Delete

[444] Fix | Delete

$select_fields = implode( '`, `', $fields );

[445] Fix | Delete

[446] Fix | Delete

// Begin building query.

[447] Fix | Delete

$query = "SELECT `$select_fields` FROM {$this->table_name()}";

[448] Fix | Delete

[449] Fix | Delete

// Set up $values array for wpdb::prepare

[450] Fix | Delete

$values = [];

[451] Fix | Delete

[452] Fix | Delete

// Define an empty WHERE clause to start from.

[453] Fix | Delete

$where = 'WHERE 1=1';

[454] Fix | Delete

[455] Fix | Delete

// Build search query.

[456] Fix | Delete

if ( $args['s'] && ! empty( $args['s'] ) ) {

[457] Fix | Delete

[458] Fix | Delete

$search = wp_unslash( trim( $args['s'] ) );

[459] Fix | Delete

[460] Fix | Delete

$search_where = [];

[461] Fix | Delete

[462] Fix | Delete

foreach ( $columns as $key => $type ) {

[463] Fix | Delete

if ( in_array( $key, $fields ) ) {

[464] Fix | Delete

if ( '%s' === $type || ( '%d' === $type && is_numeric( $search ) ) ) {

[465] Fix | Delete

$values[] = '%' . $wpdb->esc_like( $search ) . '%';

[466] Fix | Delete

$search_where[] = "`$key` LIKE '%s'";

[467] Fix | Delete

}

[468] Fix | Delete

}

[469] Fix | Delete

}

[470] Fix | Delete

[471] Fix | Delete

if ( ! empty( $search_where ) ) {

[472] Fix | Delete

$where .= ' AND (' . join( ' OR ', $search_where ) . ')';

[473] Fix | Delete

}

[474] Fix | Delete

}

[475] Fix | Delete

[476] Fix | Delete

$query .= " $where";

[477] Fix | Delete

[478] Fix | Delete

if ( ! empty( $args['orderby'] ) ) {

[479] Fix | Delete

$query .= ' ORDER BY %s';

[480] Fix | Delete

$values[] = wp_unslash( trim( $args['orderby'] ) );

[481] Fix | Delete

[482] Fix | Delete

switch ( $args['order'] ) {

[483] Fix | Delete

case 'asc':

[484] Fix | Delete

case 'ASC':

[485] Fix | Delete

$query .= ' ASC';

[486] Fix | Delete

break;

[487] Fix | Delete

case 'desc':

[488] Fix | Delete

case 'DESC':

[489] Fix | Delete

default:

[490] Fix | Delete

$query .= ' DESC';

[491] Fix | Delete

break;

[492] Fix | Delete

}

[493] Fix | Delete

}

[494] Fix | Delete

[495] Fix | Delete

if ( ! empty( $args['limit'] ) ) {

[496] Fix | Delete

$query .= ' LIMIT %d';

[497] Fix | Delete

$values[] = absint( $args['limit'] );

[498] Fix | Delete

}

[499] Fix | Delete