Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Abstract class for Provider

[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

* Class PUM_Abstract_Provider

[13] Fix | Delete

[14] Fix | Delete

abstract class PUM_Abstract_Provider implements PUM_Interface_Provider {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Option name prefix.

[18] Fix | Delete

[19] Fix | Delete

* @var string

[20] Fix | Delete

[21] Fix | Delete

public $opt_prefix = '';

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Email provider name such as 'mailchimp'

[25] Fix | Delete

[26] Fix | Delete

* @var string

[27] Fix | Delete

[28] Fix | Delete

public $id = '';

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Email provider name for labeling such as 'MailChimp's

[32] Fix | Delete

[33] Fix | Delete

* @var string

[34] Fix | Delete

[35] Fix | Delete

public $name = '';

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* Version of the email provider implementation. Used for compatibility.

[39] Fix | Delete

[40] Fix | Delete

* @var int

[41] Fix | Delete

[42] Fix | Delete

public $version = 1;

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Latest current version.

[46] Fix | Delete

[47] Fix | Delete

* @var int

[48] Fix | Delete

[49] Fix | Delete

public $current_version = 2;

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* The constructor method which sets up all filters and actions to prepare fields and messages

[53] Fix | Delete

[54] Fix | Delete

public function __construct() {

[55] Fix | Delete

/** Register Provider Globally */

[56] Fix | Delete

PUM_Newsletter_Providers::instance()->add_provider( $this );

[57] Fix | Delete

[58] Fix | Delete

/** Settings */

[59] Fix | Delete

add_filter( 'pum_settings_fields', [ $this, 'register_settings' ] );

[60] Fix | Delete

add_filter( 'pum_settings_tab_sections', [ $this, 'register_settings_tab_section' ] );

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Don't add the shortcodes or default options or process anything if the provider is disabled.

[64] Fix | Delete

[65] Fix | Delete

if ( ! $this->enabled() ) {

[66] Fix | Delete

return;

[67] Fix | Delete

}

[68] Fix | Delete

[69] Fix | Delete

/** Shortcodes Fields */

[70] Fix | Delete

add_filter( 'pum_sub_form_shortcode_tabs', [ $this, 'shortcode_tabs' ] );

[71] Fix | Delete

add_filter( 'pum_sub_form_shortcode_subtabs', [ $this, 'shortcode_subtabs' ] );

[72] Fix | Delete

add_filter( 'pum_sub_form_shortcode_fields', [ $this, 'shortcode_fields' ] );

[73] Fix | Delete

add_filter( 'pum_sub_form_shortcode_defaults', [ $this, 'shortcode_defaults' ] );

[74] Fix | Delete

[75] Fix | Delete

/** Forms Processing & AJAX */

[76] Fix | Delete

add_filter( 'pum_sub_form_sanitization', [ $this, 'process_form_sanitization' ], 10 );

[77] Fix | Delete

add_filter( 'pum_sub_form_validation', [ $this, 'process_form_validation' ], 10, 2 );

[78] Fix | Delete

add_action( 'pum_sub_form_submission', [ $this, 'process_form_submission' ], 10, 3 );

[79] Fix | Delete

[80] Fix | Delete

/** Form Rendering */

[81] Fix | Delete

add_action( 'pum_sub_form_fields', [ $this, 'render_fields' ] );

[82] Fix | Delete

}

[83] Fix | Delete

[84] Fix | Delete

/**

[85] Fix | Delete

* Determines whether to load this providers fields in the shortcode editor among other things.

[86] Fix | Delete

[87] Fix | Delete

* @return bool

[88] Fix | Delete

[89] Fix | Delete

abstract public function enabled();

[90] Fix | Delete

[91] Fix | Delete

/**

[92] Fix | Delete

* Contains each providers unique fields.

[93] Fix | Delete

[94] Fix | Delete

* @deprecated 1.7.0 Use instead: $this->shortcode_tabs, $this->shortcode_subtabs & $this->shortcode_fields instead.

[95] Fix | Delete

* @uses self::instance()->shortcode_tabs()

[96] Fix | Delete

[97] Fix | Delete

* @return array

[98] Fix | Delete

[99] Fix | Delete

public function fields() {

[100] Fix | Delete

return PUM_Admin_Helpers::flatten_fields_array( $this->shortcode_fields() );

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

/**

[104] Fix | Delete

* Contains each providers unique global settings.

[105] Fix | Delete

[106] Fix | Delete

* @return array

[107] Fix | Delete

[108] Fix | Delete

abstract public function register_settings();

[109] Fix | Delete

[110] Fix | Delete

/**

[111] Fix | Delete

* Contains each providers unique global settings tab sections..

[112] Fix | Delete

[113] Fix | Delete

* @param array $sections Array of settings page tab sections.

[114] Fix | Delete

[115] Fix | Delete

* @return array

[116] Fix | Delete

[117] Fix | Delete

public function register_settings_tab_section( $sections = [] ) {

[118] Fix | Delete

$sections['subscriptions'][ $this->id ] = $this->name;

[119] Fix | Delete

[120] Fix | Delete

return $sections;

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* Creates the inputs for each of the needed fields for the email provider

[125] Fix | Delete

[126] Fix | Delete

* TODO Determine how this should really work for visible custom fields.

[127] Fix | Delete

[128] Fix | Delete

* @param array $shortcode_atts Array of shortcodee attrs.

[129] Fix | Delete

[130] Fix | Delete

public function render_fields( $shortcode_atts ) {

[131] Fix | Delete

$fields = PUM_Admin_Helpers::flatten_fields_array( $this->shortcode_fields() );

[132] Fix | Delete

[133] Fix | Delete

foreach ( $fields as $key => $field ) {

[134] Fix | Delete

if ( ! $field['private'] && isset( $shortcode_atts[ $key ] ) ) {

[135] Fix | Delete

echo esc_html( '<input type="hidden" name="' . $key . '" value="' . $shortcode_atts[ $key ] . '" />' );

[136] Fix | Delete

}

[137] Fix | Delete

}

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

/**

[141] Fix | Delete

* Process form value sanitization.

[142] Fix | Delete

[143] Fix | Delete

* @param array $values Values.

[144] Fix | Delete

[145] Fix | Delete

* @return array $values

[146] Fix | Delete

[147] Fix | Delete

public function form_sanitization( $values = [] ) {

[148] Fix | Delete

return $values;

[149] Fix | Delete

}

[150] Fix | Delete

[151] Fix | Delete

/**

[152] Fix | Delete

* Process form values for errors.

[153] Fix | Delete

[154] Fix | Delete

* @param WP_Error $errors Errors object.

[155] Fix | Delete

* @param array $values Values.

[156] Fix | Delete

[157] Fix | Delete

* @return WP_Error

[158] Fix | Delete

[159] Fix | Delete

public function form_validation( WP_Error $errors, $values = [] ) {

[160] Fix | Delete

return $errors;

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete

/**

[164] Fix | Delete

* Subscribes the user to the list

[165] Fix | Delete

[166] Fix | Delete

* @param array $values Values.

[167] Fix | Delete

* @param array $json_response JSON Response.

[168] Fix | Delete

* @param WP_Error $errors Errors object.

[169] Fix | Delete

[170] Fix | Delete

public function form_submission( $values, &$json_response, WP_Error &$errors ) {

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* Internally processes sanitization only for the current provider.

[175] Fix | Delete

[176] Fix | Delete

* @param array $values Values.

[177] Fix | Delete

[178] Fix | Delete

* @return array $values

[179] Fix | Delete

[180] Fix | Delete

public function process_form_sanitization( $values = [] ) {

[181] Fix | Delete

if ( $this->id !== $values['provider'] && ( 'none' === $values['provider'] && PUM_Utils_Options::get( 'newsletter_default_provider' ) !== $this->id ) ) {

[182] Fix | Delete

return $values;

[183] Fix | Delete

}

[184] Fix | Delete

[185] Fix | Delete

return $this->form_sanitization( $values );

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

/**

[189] Fix | Delete

* Internally processes validation only for the current provider.

[190] Fix | Delete

[191] Fix | Delete

* @param WP_Error $errors Errors object.

[192] Fix | Delete

* @param array $values Values.

[193] Fix | Delete

[194] Fix | Delete

* @return WP_Error

[195] Fix | Delete

[196] Fix | Delete

public function process_form_validation( WP_Error $errors, $values = [] ) {

[197] Fix | Delete

if ( $this->id !== $values['provider'] && ( 'none' === $values['provider'] && PUM_Utils_Options::get( 'newsletter_default_provider' ) !== $this->id ) ) {

[198] Fix | Delete

return $errors;

[199] Fix | Delete

}

[200] Fix | Delete

[201] Fix | Delete

return $this->form_validation( $errors, $values );

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

/**

[205] Fix | Delete

* Internally processes submission only for the current provider.

[206] Fix | Delete

[207] Fix | Delete

* @param array $values Values.

[208] Fix | Delete

* @param array $json_response AJAX JSON Response array.

[209] Fix | Delete

* @param WP_Error $errors Errors object.

[210] Fix | Delete

[211] Fix | Delete

public function process_form_submission( $values, &$json_response, WP_Error &$errors ) {

[212] Fix | Delete

if ( $this->id !== $values['provider'] && ( 'none' === $values['provider'] && PUM_Utils_Options::get( 'newsletter_default_provider' ) !== $this->id ) ) {

[213] Fix | Delete

return;

[214] Fix | Delete

}

[215] Fix | Delete

[216] Fix | Delete

$this->form_submission( $values, $json_response, $errors );

[217] Fix | Delete

}

[218] Fix | Delete

[219] Fix | Delete

/**

[220] Fix | Delete

[221] Fix | Delete

[222] Fix | Delete

* @return string $tab_id;

[223] Fix | Delete

[224] Fix | Delete

public function shortcode_tab_id() {

[225] Fix | Delete

return 'provider_' . $this->id;

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

/**

[229] Fix | Delete

* Adds a tab for each provider. These will be hidden except for the chosen provider.

[230] Fix | Delete

[231] Fix | Delete

* @param array $tabs Array of tab.

[232] Fix | Delete

[233] Fix | Delete

* @return array

[234] Fix | Delete

[235] Fix | Delete

public function shortcode_tabs( $tabs = [] ) {

[236] Fix | Delete

$resorted_tabs = [];

[237] Fix | Delete

[238] Fix | Delete

foreach ( $tabs as $tab_id => $label ) {

[239] Fix | Delete

$resorted_tabs[ $tab_id ] = $label;

[240] Fix | Delete

[241] Fix | Delete

if ( 'general' === $tab_id ) {

[242] Fix | Delete

$resorted_tabs[ $this->shortcode_tab_id() ] = $this->name;

[243] Fix | Delete

}

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

return $resorted_tabs;

[247] Fix | Delete

}

[248] Fix | Delete

[249] Fix | Delete

/**

[250] Fix | Delete

* Adds a subtabs for each provider. These will be hidden except for the chosen provider.

[251] Fix | Delete

[252] Fix | Delete

* @param array $subtabs Array of tab=>subtabs.

[253] Fix | Delete

[254] Fix | Delete

* @return array

[255] Fix | Delete

[256] Fix | Delete

public function shortcode_subtabs( $subtabs = [] ) {

[257] Fix | Delete

return array_merge(

[258] Fix | Delete

$subtabs,

[259] Fix | Delete

[

[260] Fix | Delete

$this->shortcode_tab_id() => [

[261] Fix | Delete

'main' => $this->name,

[262] Fix | Delete

[263] Fix | Delete

]

[264] Fix | Delete

);

[265] Fix | Delete

}

[266] Fix | Delete

[267] Fix | Delete

/**

[268] Fix | Delete

* Registers the fields for this providers shortcode tab.

[269] Fix | Delete

[270] Fix | Delete

* @param array $fields Array of fields.

[271] Fix | Delete

[272] Fix | Delete

* @return array

[273] Fix | Delete

[274] Fix | Delete

public function shortcode_fields( $fields = [] ) {

[275] Fix | Delete

[276] Fix | Delete

$new_fields = $this->version < 2 ? PUM_Admin_Helpers::flatten_fields_array( $this->fields() ) : [];

[277] Fix | Delete

[278] Fix | Delete

foreach ( $new_fields as $field_id => $field ) {

[279] Fix | Delete

if ( isset( $field['options'] ) ) {

[280] Fix | Delete

$new_fields[ $field_id ]['options'] = array_flip( $field['options'] );

[281] Fix | Delete

}

[282] Fix | Delete

}

[283] Fix | Delete

[284] Fix | Delete

return array_merge(

[285] Fix | Delete

$fields,

[286] Fix | Delete

[

[287] Fix | Delete

$this->shortcode_tab_id() => [

[288] Fix | Delete

'main' => $new_fields,

[289] Fix | Delete

[290] Fix | Delete

]

[291] Fix | Delete

);

[292] Fix | Delete

}

[293] Fix | Delete

[294] Fix | Delete

/**

[295] Fix | Delete

* Registers the defaults for this provider.

[296] Fix | Delete

[297] Fix | Delete

* @param array $defaults Array of default values.

[298] Fix | Delete

[299] Fix | Delete

* @return array

[300] Fix | Delete

[301] Fix | Delete

public function shortcode_defaults( $defaults ) {

[302] Fix | Delete

// Flatten fields array.

[303] Fix | Delete

$fields = PUM_Admin_Helpers::flatten_fields_array( $this->shortcode_fields() );

[304] Fix | Delete

[305] Fix | Delete

return array_merge( $defaults, PUM_Admin_Helpers::get_field_defaults( $fields ) );

[306] Fix | Delete

}

[307] Fix | Delete

[308] Fix | Delete

/**

[309] Fix | Delete

* Gets default messages.

[310] Fix | Delete

[311] Fix | Delete

* @param string|null $context Context of the message to be returned.

[312] Fix | Delete

[313] Fix | Delete

* @return array|mixed|string

[314] Fix | Delete

[315] Fix | Delete

public function default_messages( $context = null ) {

[316] Fix | Delete

return pum_get_newsletter_default_messages( $context );

[317] Fix | Delete

}

[318] Fix | Delete

[319] Fix | Delete

/**

[320] Fix | Delete

* Get default or customized messages.

[321] Fix | Delete

[322] Fix | Delete

* @param string $context Context.

[323] Fix | Delete

* @param array $values Array of values.

[324] Fix | Delete

[325] Fix | Delete

* @return string

[326] Fix | Delete

[327] Fix | Delete

public function get_message( $context, $values = [] ) {

[328] Fix | Delete

$message = PUM_Utils_Options::get( "{$this->opt_prefix}{$context}_message", '' );

[329] Fix | Delete

[330] Fix | Delete

if ( empty( $message ) ) {

[331] Fix | Delete

$message = $this->default_messages( $context );

[332] Fix | Delete

}

[333] Fix | Delete

[334] Fix | Delete

if ( strpos( $message, '{' ) ) {

[335] Fix | Delete

$message = $this->dynamic_message( $message, $values );

[336] Fix | Delete

}

[337] Fix | Delete

[338] Fix | Delete

return apply_filters( "pum_newsletter_{$context}_message", $message, $this );

[339] Fix | Delete

}

[340] Fix | Delete

[341] Fix | Delete

[342] Fix | Delete

/**

[343] Fix | Delete

* Process a message with dynamic values.

[344] Fix | Delete

[345] Fix | Delete

* @param string $message Message.

[346] Fix | Delete

* @param array $values Array of values.

[347] Fix | Delete

[348] Fix | Delete

* @return mixed|string

[349] Fix | Delete

[350] Fix | Delete

protected function dynamic_message( $message = '', $values = [] ) {

[351] Fix | Delete

[352] Fix | Delete

preg_match_all( '/{(.*?)}/', $message, $found );

[353] Fix | Delete

[354] Fix | Delete

if ( count( $found[1] ) ) {

[355] Fix | Delete

[356] Fix | Delete

foreach ( $found[1] as $key => $match ) {

[357] Fix | Delete

[358] Fix | Delete

$message = $this->message_text_replace( $message, $match, $values );

[359] Fix | Delete

[360] Fix | Delete

}

[361] Fix | Delete

}

[362] Fix | Delete

[363] Fix | Delete

return $message;

[364] Fix | Delete

[365] Fix | Delete

}

[366] Fix | Delete

[367] Fix | Delete

/**

[368] Fix | Delete

* Replaces a single matched message.

[369] Fix | Delete

[370] Fix | Delete

* @param string $message Message.

[371] Fix | Delete

* @param string $match Matched phrase.

[372] Fix | Delete

* @param array $values Values for replacement.

[373] Fix | Delete

[374] Fix | Delete

* @return mixed|string

[375] Fix | Delete

[376] Fix | Delete

protected function message_text_replace( $message = '', $match = '', $values = [] ) {

[377] Fix | Delete

[378] Fix | Delete

if ( empty( $match ) ) {

[379] Fix | Delete

return $message;

[380] Fix | Delete

}

[381] Fix | Delete

[382] Fix | Delete

if ( strpos( $match, '||' ) !== false ) {

[383] Fix | Delete

$matches = explode( '||', $match );

[384] Fix | Delete

} else {

[385] Fix | Delete

$matches = [ $match ];

[386] Fix | Delete

}

[387] Fix | Delete

[388] Fix | Delete

$replace = '';

[389] Fix | Delete

[390] Fix | Delete

foreach ( $matches as $string ) {

[391] Fix | Delete

[392] Fix | Delete

if ( ! array_key_exists( $string, $values ) ) {

[393] Fix | Delete

[394] Fix | Delete

// If its not a valid code it is likely a fallback.

[395] Fix | Delete

$replace = $string;

[396] Fix | Delete

[397] Fix | Delete

} else {

[398] Fix | Delete

[399] Fix | Delete

// This is a form field value, replace accordingly.

[400] Fix | Delete

switch ( $string ) {

[401] Fix | Delete

[402] Fix | Delete

default:

[403] Fix | Delete

$replace = $values[ $string ];

[404] Fix | Delete

break;

[405] Fix | Delete

[406] Fix | Delete

}

[407] Fix | Delete

}

[408] Fix | Delete

[409] Fix | Delete

// If we found a replacement stop the loop.

[410] Fix | Delete

if ( ! empty( $replace ) ) {

[411] Fix | Delete

break;

[412] Fix | Delete

}

[413] Fix | Delete

}

[414] Fix | Delete

[415] Fix | Delete

return str_replace( '{' . $match . '}', $replace, $message );

[416] Fix | Delete

}

[417] Fix | Delete

[418] Fix | Delete

/**

[419] Fix | Delete

* Magic method replacement.

[420] Fix | Delete

[421] Fix | Delete

* @param string $name Function or field name.

[422] Fix | Delete

[423] Fix | Delete

* @return mixed

[424] Fix | Delete

[425] Fix | Delete

public function __get( $name ) {

[426] Fix | Delete

if ( method_exists( $this, 'get_' . $name ) ) {

[427] Fix | Delete

$method = 'get_' . $name;

[428] Fix | Delete

[429] Fix | Delete

return $this->$method();

[430] Fix | Delete

}

[431] Fix | Delete

[432] Fix | Delete

if ( property_exists( $this, $name ) ) {

[433] Fix | Delete

return $this->$name;

[434] Fix | Delete

}

[435] Fix | Delete

[436] Fix | Delete

return false;

[437] Fix | Delete

}

[438] Fix | Delete

}

[439] Fix | Delete

[440] Fix | Delete