Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Admin\Forms\Table\Facades;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Admin\Base\Tables\Facades\ColumnsBase;

[4] Fix | Delete

use WPForms\Admin\Forms\Table\DataObjects\Column;

[5] Fix | Delete

use WPForms\Integrations\LiteConnect\LiteConnect;

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* Column facade class.

[9] Fix | Delete

[10] Fix | Delete

* Hides the complexity of columns' collection behind a simple interface.

[11] Fix | Delete

[12] Fix | Delete

* @since 1.8.6

[13] Fix | Delete

[14] Fix | Delete

class Columns extends ColumnsBase {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Saved columns order user meta name.

[18] Fix | Delete

[19] Fix | Delete

* @since 1.8.6

[20] Fix | Delete

[21] Fix | Delete

const COLUMNS_USER_META_NAME = 'wpforms_overview_table_columns';

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Legacy saved columns order user meta name.

[25] Fix | Delete

[26] Fix | Delete

* @since 1.8.6

[27] Fix | Delete

[28] Fix | Delete

const LEGACY_COLUMNS_USER_META_NAME = 'managetoplevel_page_wpforms-overviewcolumnshidden';

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Get columns.

[32] Fix | Delete

[33] Fix | Delete

* Returns all possible columns for the Forms table.

[34] Fix | Delete

[35] Fix | Delete

* @since 1.8.6

[36] Fix | Delete

[37] Fix | Delete

* @return Column[] Array of columns as objects.

[38] Fix | Delete

[39] Fix | Delete

protected static function get_all(): array {

[40] Fix | Delete

[41] Fix | Delete

static $columns = null;

[42] Fix | Delete

[43] Fix | Delete

if ( ! $columns ) {

[44] Fix | Delete

$columns = self::get_columns();

[45] Fix | Delete

}

[46] Fix | Delete

[47] Fix | Delete

return $columns;

[48] Fix | Delete

}

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* Get forms' list table columns.

[52] Fix | Delete

[53] Fix | Delete

* @since 1.8.6

[54] Fix | Delete

[55] Fix | Delete

* @return Column[] Array of columns as objects.

[56] Fix | Delete

[57] Fix | Delete

public static function get_columns(): array {

[58] Fix | Delete

[59] Fix | Delete

$columns_data = [

[60] Fix | Delete

'id' => [

[61] Fix | Delete

'label' => esc_html__( 'ID', 'wpforms-lite' ),

[62] Fix | Delete

[63] Fix | Delete

'name' => [

[64] Fix | Delete

'label' => esc_html__( 'Name', 'wpforms-lite' ),

[65] Fix | Delete

'readonly' => true,

[66] Fix | Delete

[67] Fix | Delete

'tags' => [

[68] Fix | Delete

'label' => esc_html__( 'Tags', 'wpforms-lite' ),

[69] Fix | Delete

[70] Fix | Delete

'author' => [

[71] Fix | Delete

'label' => esc_html__( 'Author', 'wpforms-lite' ),

[72] Fix | Delete

[73] Fix | Delete

'shortcode' => [

[74] Fix | Delete

'label' => esc_html__( 'Shortcode', 'wpforms-lite' ),

[75] Fix | Delete

[76] Fix | Delete

'created' => [

[77] Fix | Delete

'label' => esc_html__( 'Date', 'wpforms-lite' ),

[78] Fix | Delete

[79] Fix | Delete

'entries' => [

[80] Fix | Delete

'label' => esc_html__( 'Entries', 'wpforms-lite' ),

[81] Fix | Delete

[82] Fix | Delete

];

[83] Fix | Delete

[84] Fix | Delete

// In Lite, we should not show Entries column if Lite Connect is not enabled.

[85] Fix | Delete

if ( ! wpforms()->is_pro() && ! ( LiteConnect::is_allowed() && LiteConnect::is_enabled() ) ) {

[86] Fix | Delete

unset( $columns_data['entries'] );

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

/**

[90] Fix | Delete

* Filters the forms overview table columns data.

[91] Fix | Delete

[92] Fix | Delete

* @since 1.8.6

[93] Fix | Delete

[94] Fix | Delete

* @param array[] $columns Columns data.

[95] Fix | Delete

[96] Fix | Delete

$columns_data = apply_filters( 'wpforms_admin_forms_table_facades_columns_data', $columns_data );

[97] Fix | Delete

[98] Fix | Delete

$columns_data = self::set_columns_data_defaults( $columns_data );

[99] Fix | Delete

[100] Fix | Delete

$columns = [];

[101] Fix | Delete

[102] Fix | Delete

foreach ( $columns_data as $id => $column ) {

[103] Fix | Delete

$columns[ $id ] = new Column( $id, $column );

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

return $columns;

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

/**

[110] Fix | Delete

* Get columns' keys for the columns which user selected to be displayed.

[111] Fix | Delete

[112] Fix | Delete

* It returns an array of keys in the order they should be displayed.

[113] Fix | Delete

* It returns draggable and non-draggable columns.

[114] Fix | Delete

[115] Fix | Delete

* @since 1.8.6

[116] Fix | Delete

[117] Fix | Delete

* @return array

[118] Fix | Delete

[119] Fix | Delete

public static function get_selected_columns_keys(): array {

[120] Fix | Delete

[121] Fix | Delete

$user_id = get_current_user_id();

[122] Fix | Delete

[123] Fix | Delete

$user_meta_columns = get_user_meta( $user_id, self::COLUMNS_USER_META_NAME, true );

[124] Fix | Delete

$user_meta_legacy_columns_hidden = get_user_meta( $user_id, self::LEGACY_COLUMNS_USER_META_NAME, true );

[125] Fix | Delete

[126] Fix | Delete

$user_meta_columns = $user_meta_columns ? $user_meta_columns : [];

[127] Fix | Delete

$user_meta_legacy_columns_hidden = $user_meta_legacy_columns_hidden ? $user_meta_legacy_columns_hidden : [];

[128] Fix | Delete

[129] Fix | Delete

// Make form id column hidden by default.

[130] Fix | Delete

if ( empty( $user_meta_columns ) ) {

[131] Fix | Delete

$user_meta_legacy_columns_hidden[] = 'id';

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete

// Always include readonly columns.

[135] Fix | Delete

$user_meta_columns = array_unique( array_merge( $user_meta_columns, self::get_readonly_columns_keys() ) );

[136] Fix | Delete

[137] Fix | Delete

if ( ! empty( $user_meta_columns ) && empty( $user_meta_legacy_columns_hidden ) ) {

[138] Fix | Delete

return $user_meta_columns;

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

// If custom order is not saved, let's check if there is a legacy user meta-option.

[142] Fix | Delete

// It is a kind of migration from legacy user meta-option to the new one.

[143] Fix | Delete

$user_meta_columns = array_diff( array_keys( self::get_all() ), $user_meta_legacy_columns_hidden );

[144] Fix | Delete

[145] Fix | Delete

// Update user meta option.

[146] Fix | Delete

if ( update_user_meta( $user_id, self::COLUMNS_USER_META_NAME, $user_meta_columns ) ) {

[147] Fix | Delete

// Remove legacy user meta-option.

[148] Fix | Delete

delete_user_meta( $user_id, self::LEGACY_COLUMNS_USER_META_NAME );

[149] Fix | Delete

}

[150] Fix | Delete

[151] Fix | Delete

return $user_meta_columns;

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

/**

[155] Fix | Delete

* Get draggable columns ordered keys.

[156] Fix | Delete

[157] Fix | Delete

* It will return custom order if user has already saved it, otherwise it will return default order.

[158] Fix | Delete

[159] Fix | Delete

* @since 1.8.6

[160] Fix | Delete

[161] Fix | Delete

* @return array

[162] Fix | Delete

[163] Fix | Delete

private static function get_draggable_ordered_keys(): array {

[164] Fix | Delete

[165] Fix | Delete

// First, let's check if user has already saved custom order.

[166] Fix | Delete

$custom_order = self::get_selected_columns_keys();

[167] Fix | Delete

$all_columns = self::get_all();

[168] Fix | Delete

[169] Fix | Delete

if ( $custom_order ) {

[170] Fix | Delete

// If a user has saved custom order, let's filter out columns which are not draggable.

[171] Fix | Delete

return array_filter(

[172] Fix | Delete

$custom_order,

[173] Fix | Delete

static function ( $column ) use ( $all_columns ) {

[174] Fix | Delete

[175] Fix | Delete

return isset( $all_columns[ $column ] ) && $all_columns[ $column ]->is_draggable();

[176] Fix | Delete

}

[177] Fix | Delete

);

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

// If a user has not saved custom order, let's use the default order.

[181] Fix | Delete

$draggable = array_filter(

[182] Fix | Delete

$all_columns,

[183] Fix | Delete

static function ( $column ) {

[184] Fix | Delete

[185] Fix | Delete

return $column->is_draggable();

[186] Fix | Delete

}

[187] Fix | Delete

);

[188] Fix | Delete

[189] Fix | Delete

return array_keys( $draggable );

[190] Fix | Delete

}

[191] Fix | Delete

[192] Fix | Delete

/**

[193] Fix | Delete

* Save columns keys array into user meta.

[194] Fix | Delete

[195] Fix | Delete

* @since 1.8.6

[196] Fix | Delete

[197] Fix | Delete

* @param array $columns_keys Array of columns keys in desired display order.

[198] Fix | Delete

[199] Fix | Delete

* @return bool

[200] Fix | Delete

[201] Fix | Delete

public static function sanitize_and_save_columns( array $columns_keys ): bool {

[202] Fix | Delete

[203] Fix | Delete

$columns_keys = array_map( [ __CLASS__, 'sanitize_column_key' ], $columns_keys );

[204] Fix | Delete

$columns_keys = array_filter( $columns_keys, [ __CLASS__, 'validate_column_key' ] );

[205] Fix | Delete

[206] Fix | Delete

// Add readonly columns.

[207] Fix | Delete

$columns_keys = array_unique( array_merge( $columns_keys, self::get_readonly_columns_keys() ) );

[208] Fix | Delete

[209] Fix | Delete

$user_id = get_current_user_id();

[210] Fix | Delete

$user_meta_columns = get_user_meta( $user_id, self::COLUMNS_USER_META_NAME, true );

[211] Fix | Delete

[212] Fix | Delete

// If user has already saved custom order, let's check if it has been changed.

[213] Fix | Delete

if ( $user_meta_columns === $columns_keys ) {

[214] Fix | Delete

return true;

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

// Update user meta option.

[218] Fix | Delete

return update_user_meta( $user_id, self::COLUMNS_USER_META_NAME, $columns_keys );

[219] Fix | Delete

}

[220] Fix | Delete

[221] Fix | Delete

/**

[222] Fix | Delete

* Sanitize column key.

[223] Fix | Delete

[224] Fix | Delete

* @since 1.8.6

[225] Fix | Delete

[226] Fix | Delete

* @param string $key Column key.

[227] Fix | Delete

[228] Fix | Delete

* @return string

[229] Fix | Delete

[230] Fix | Delete

public static function sanitize_column_key( string $key ): string {

[231] Fix | Delete

[232] Fix | Delete

return sanitize_key( $key );

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

/**

[236] Fix | Delete

* Get columns' data ready to use in the list table object.

[237] Fix | Delete

[238] Fix | Delete

* @since 1.8.6

[239] Fix | Delete

[240] Fix | Delete

* @return array

[241] Fix | Delete

[242] Fix | Delete

public static function get_list_table_columns(): array {

[243] Fix | Delete

[244] Fix | Delete

$columns = [

[245] Fix | Delete

'cb' => '<input type="checkbox" />',

[246] Fix | Delete

];

[247] Fix | Delete

[248] Fix | Delete

$order = self::get_draggable_ordered_keys();

[249] Fix | Delete

$all_columns = self::get_all();

[250] Fix | Delete

[251] Fix | Delete

foreach ( $order as $column_id ) {

[252] Fix | Delete

$columns[ $column_id ] = $all_columns[ $column_id ]->get_label_html();

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

/**

[256] Fix | Delete

* Filters the forms overview table columns.

[257] Fix | Delete

[258] Fix | Delete

* @since 1.0.0

[259] Fix | Delete

[260] Fix | Delete

* @param array $columns Columns data.

[261] Fix | Delete

[262] Fix | Delete

$columns = apply_filters( 'wpforms_overview_table_columns', $columns ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[263] Fix | Delete

[264] Fix | Delete

// Add empty column for the cog icon.

[265] Fix | Delete

$columns['cog'] = '';

[266] Fix | Delete

[267] Fix | Delete

return $columns;

[268] Fix | Delete

}

[269] Fix | Delete

[270] Fix | Delete

/**

[271] Fix | Delete

* Get readonly columns keys.

[272] Fix | Delete

[273] Fix | Delete

* @since 1.8.6

[274] Fix | Delete

[275] Fix | Delete

* @return array

[276] Fix | Delete

[277] Fix | Delete

private static function get_readonly_columns_keys(): array {

[278] Fix | Delete

[279] Fix | Delete

$readonly = array_filter(

[280] Fix | Delete

self::get_all(),

[281] Fix | Delete

static function ( $column ) {

[282] Fix | Delete

[283] Fix | Delete

return $column->is_readonly();

[284] Fix | Delete

}

[285] Fix | Delete

);

[286] Fix | Delete

[287] Fix | Delete

return array_keys( $readonly );

[288] Fix | Delete

}

[289] Fix | Delete

[290] Fix | Delete

/**

[291] Fix | Delete

* Set columns data defaults.

[292] Fix | Delete

[293] Fix | Delete

* @since 1.8.6

[294] Fix | Delete

[295] Fix | Delete

* @param array $columns_data Columns data.

[296] Fix | Delete

[297] Fix | Delete

* @return array

[298] Fix | Delete

[299] Fix | Delete

private static function set_columns_data_defaults( array $columns_data ): array {

[300] Fix | Delete

[301] Fix | Delete

return array_map(

[302] Fix | Delete

static function ( $column ) {

[303] Fix | Delete

$column['type'] = $column['type'] ?? '';

[304] Fix | Delete

$column['draggable'] = $column['draggable'] ?? true;

[305] Fix | Delete

$column['label_html'] = $column['label_html'] ?? '';

[306] Fix | Delete

$column['readonly'] = $column['readonly'] ?? false;

[307] Fix | Delete

[308] Fix | Delete

return $column;

[309] Fix | Delete

[310] Fix | Delete

$columns_data

[311] Fix | Delete

);

[312] Fix | Delete

}

[313] Fix | Delete

}

[314] Fix | Delete

[315] Fix | Delete