<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Emails\Templates;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Emails\Helpers;

[4] Fix | Delete

use WPForms\Emails\Styler;

[5] Fix | Delete

use WPForms\Helpers\Templates;

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* Base email template class.

[9] Fix | Delete

*

[10] Fix | Delete

* @since 1.5.4

[11] Fix | Delete

*/

[12] Fix | Delete

class General {

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Template slug.

[16] Fix | Delete

*

[17] Fix | Delete

* @since 1.5.4

[18] Fix | Delete

*

[19] Fix | Delete

* @var string

[20] Fix | Delete

*/

[21] Fix | Delete

const TEMPLATE_SLUG = 'general';

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Email message.

[25] Fix | Delete

*

[26] Fix | Delete

* @since 1.5.4

[27] Fix | Delete

*

[28] Fix | Delete

* @var string

[29] Fix | Delete

*/

[30] Fix | Delete

protected $message;

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Content is plain text type.

[34] Fix | Delete

*

[35] Fix | Delete

* @since 1.5.4

[36] Fix | Delete

*

[37] Fix | Delete

* @var bool

[38] Fix | Delete

*/

[39] Fix | Delete

protected $plain_text;

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* Dynamic {{tags}}.

[43] Fix | Delete

*

[44] Fix | Delete

* @since 1.5.4

[45] Fix | Delete

*

[46] Fix | Delete

* @var array

[47] Fix | Delete

*/

[48] Fix | Delete

protected $tags;

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* Header/footer/body arguments.

[52] Fix | Delete

*

[53] Fix | Delete

* @since 1.5.4

[54] Fix | Delete

*

[55] Fix | Delete

* @var array

[56] Fix | Delete

*/

[57] Fix | Delete

protected $args;

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* Final email content.

[61] Fix | Delete

*

[62] Fix | Delete

* @since 1.5.4

[63] Fix | Delete

*

[64] Fix | Delete

* @var string

[65] Fix | Delete

*/

[66] Fix | Delete

protected $content;

[67] Fix | Delete

[68] Fix | Delete

/**

[69] Fix | Delete

* Constructor.

[70] Fix | Delete

*

[71] Fix | Delete

* @since 1.5.4

[72] Fix | Delete

*

[73] Fix | Delete

* @param string $message Email message.

[74] Fix | Delete

*/

[75] Fix | Delete

public function __construct( $message = '' ) {

[76] Fix | Delete

[77] Fix | Delete

$this->set_message( $message );

[78] Fix | Delete

[79] Fix | Delete

$this->plain_text = Helpers::is_plain_text_template();

[80] Fix | Delete

[81] Fix | Delete

$this->set_initial_args();

[82] Fix | Delete

}

[83] Fix | Delete

[84] Fix | Delete

/**

[85] Fix | Delete

* Set initial arguments to use in a template.

[86] Fix | Delete

*

[87] Fix | Delete

* @since 1.5.4

[88] Fix | Delete

*/

[89] Fix | Delete

public function set_initial_args() {

[90] Fix | Delete

[91] Fix | Delete

$header_args = [

[92] Fix | Delete

'title' => \esc_html__( 'WPForms', 'wpforms-lite' ),

[93] Fix | Delete

];

[94] Fix | Delete

[95] Fix | Delete

if ( ! $this->plain_text ) {

[96] Fix | Delete

$header_args['header_image'] = $this->get_header_image();

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

$args = [

[100] Fix | Delete

'header' => $header_args,

[101] Fix | Delete

'body' => [ 'message' => $this->get_message() ],

[102] Fix | Delete

'footer' => [],

[103] Fix | Delete

'style' => [],

[104] Fix | Delete

];

[105] Fix | Delete

[106] Fix | Delete

$args = \apply_filters( 'wpforms_emails_templates_general_set_initial_args', $args, $this );

[107] Fix | Delete

[108] Fix | Delete

$this->set_args( $args );

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

/**

[112] Fix | Delete

* Get the template slug.

[113] Fix | Delete

*

[114] Fix | Delete

* @since 1.5.4

[115] Fix | Delete

*

[116] Fix | Delete

* @return string

[117] Fix | Delete

*/

[118] Fix | Delete

public function get_slug() {

[119] Fix | Delete

[120] Fix | Delete

return static::TEMPLATE_SLUG;

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

/**

[124] Fix | Delete

* Get the template parent slug.

[125] Fix | Delete

*

[126] Fix | Delete

* @since 1.5.4

[127] Fix | Delete

*

[128] Fix | Delete

* @return string

[129] Fix | Delete

*/

[130] Fix | Delete

public function get_parent_slug() {

[131] Fix | Delete

[132] Fix | Delete

return self::TEMPLATE_SLUG;

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

/**

[136] Fix | Delete

* Get the message.

[137] Fix | Delete

*

[138] Fix | Delete

* @since 1.5.4

[139] Fix | Delete

*

[140] Fix | Delete

* @return string

[141] Fix | Delete

*/

[142] Fix | Delete

public function get_message() {

[143] Fix | Delete

[144] Fix | Delete

return \apply_filters( 'wpforms_emails_templates_general_get_message', $this->message, $this );

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

/**

[148] Fix | Delete

* Get the dynamic tags.

[149] Fix | Delete

*

[150] Fix | Delete

* @since 1.5.4

[151] Fix | Delete

*

[152] Fix | Delete

* @return array

[153] Fix | Delete

*/

[154] Fix | Delete

public function get_tags() {

[155] Fix | Delete

[156] Fix | Delete

return \apply_filters( 'wpforms_emails_templates_general_get_tags', $this->tags, $this );

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

/**

[160] Fix | Delete

* Get header/footer/body arguments

[161] Fix | Delete

*

[162] Fix | Delete

* @since 1.5.4

[163] Fix | Delete

*

[164] Fix | Delete

* @param string $type Header/footer/body.

[165] Fix | Delete

*

[166] Fix | Delete

* @return array

[167] Fix | Delete

*/

[168] Fix | Delete

public function get_args( $type ) {

[169] Fix | Delete

[170] Fix | Delete

if ( ! empty( $type ) ) {

[171] Fix | Delete

return isset( $this->args[ $type ] ) ? apply_filters( 'wpforms_emails_templates_general_get_args_' . $type, $this->args[ $type ], $this ) : [];

[172] Fix | Delete

}

[173] Fix | Delete

[174] Fix | Delete

return apply_filters( 'wpforms_emails_templates_general_get_args', $this->args, $this );

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

/**

[178] Fix | Delete

* Set email message.

[179] Fix | Delete

*

[180] Fix | Delete

* @since 1.5.4

[181] Fix | Delete

*

[182] Fix | Delete

* @param string $message Email message.

[183] Fix | Delete

*

[184] Fix | Delete

* @return General

[185] Fix | Delete

*/

[186] Fix | Delete

public function set_message( $message ) {

[187] Fix | Delete

[188] Fix | Delete

$message = \apply_filters( 'wpforms_emails_templates_general_set_message', $message, $this );

[189] Fix | Delete

[190] Fix | Delete

if ( ! \is_string( $message ) ) {

[191] Fix | Delete

return $this;

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete

$this->message = $message;

[195] Fix | Delete

[196] Fix | Delete

return $this;

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

/**

[200] Fix | Delete

* Set the dynamic tags.

[201] Fix | Delete

*

[202] Fix | Delete

* @since 1.5.4

[203] Fix | Delete

*

[204] Fix | Delete

* @param array $tags Tags to set.

[205] Fix | Delete

*

[206] Fix | Delete

* @return General

[207] Fix | Delete

*/

[208] Fix | Delete

public function set_tags( $tags ) {

[209] Fix | Delete

[210] Fix | Delete

$tags = \apply_filters( 'wpforms_emails_templates_general_set_tags', $tags, $this );

[211] Fix | Delete

[212] Fix | Delete

if ( ! \is_array( $tags ) ) {

[213] Fix | Delete

return $this;

[214] Fix | Delete

}

[215] Fix | Delete

[216] Fix | Delete

$this->tags = $tags;

[217] Fix | Delete

[218] Fix | Delete

return $this;

[219] Fix | Delete

}

[220] Fix | Delete

[221] Fix | Delete

/**

[222] Fix | Delete

* Set header/footer/body/style arguments to use in a template.

[223] Fix | Delete

*

[224] Fix | Delete

* @since 1.5.4

[225] Fix | Delete

*

[226] Fix | Delete

* @param array $args Arguments to set.

[227] Fix | Delete

* @param bool $merge Merge the arguments with existing once or replace.

[228] Fix | Delete

*

[229] Fix | Delete

* @return General

[230] Fix | Delete

*/

[231] Fix | Delete

public function set_args( $args, $merge = true ) {

[232] Fix | Delete

[233] Fix | Delete

$args = \apply_filters( 'wpforms_emails_templates_general_set_args', $args, $this );

[234] Fix | Delete

[235] Fix | Delete

if ( empty( $args ) || ! \is_array( $args ) ) {

[236] Fix | Delete

return $this;

[237] Fix | Delete

}

[238] Fix | Delete

[239] Fix | Delete

foreach ( $args as $type => $value ) {

[240] Fix | Delete

[241] Fix | Delete

if ( ! \is_array( $value ) ) {

[242] Fix | Delete

continue;

[243] Fix | Delete

}

[244] Fix | Delete

[245] Fix | Delete

if ( ! isset( $this->args[ $type ] ) || ! \is_array( $this->args[ $type ] ) ) {

[246] Fix | Delete

$this->args[ $type ] = [];

[247] Fix | Delete

}

[248] Fix | Delete

[249] Fix | Delete

$this->args[ $type ] = $merge ? \array_merge( $this->args[ $type ], $value ) : $value;

[250] Fix | Delete

}

[251] Fix | Delete

[252] Fix | Delete

return $this;

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

/**

[256] Fix | Delete

* Process and replace any dynamic tags.

[257] Fix | Delete

*

[258] Fix | Delete

* @since 1.5.4

[259] Fix | Delete

*

[260] Fix | Delete

* @param string $content Content to make replacements in.

[261] Fix | Delete

*

[262] Fix | Delete

* @return string

[263] Fix | Delete

*/

[264] Fix | Delete

public function process_tags( $content ) {

[265] Fix | Delete

[266] Fix | Delete

$tags = $this->get_tags();

[267] Fix | Delete

[268] Fix | Delete

if ( empty( $tags ) ) {

[269] Fix | Delete

return $content;

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

foreach ( $tags as $tag => $value ) {

[273] Fix | Delete

$content = \str_replace( $tag, $value, $content );

[274] Fix | Delete

}

[275] Fix | Delete

[276] Fix | Delete

return $content;

[277] Fix | Delete

}

[278] Fix | Delete

[279] Fix | Delete

/**

[280] Fix | Delete

* Conditionally modify email template name.

[281] Fix | Delete

*

[282] Fix | Delete

* @since 1.5.4

[283] Fix | Delete

*

[284] Fix | Delete

* @param string $name Base template name.

[285] Fix | Delete

*

[286] Fix | Delete

* @return string

[287] Fix | Delete

*/

[288] Fix | Delete

protected function get_full_template_name( $name ) {

[289] Fix | Delete

[290] Fix | Delete

$name = \sanitize_file_name( $name );

[291] Fix | Delete

[292] Fix | Delete

if ( $this->plain_text ) {

[293] Fix | Delete

$name .= '-plain';

[294] Fix | Delete

}

[295] Fix | Delete

[296] Fix | Delete

$template = 'emails/' . $this->get_slug() . '-' . $name;

[297] Fix | Delete

[298] Fix | Delete

if ( ! Templates::locate( $template . '.php' ) ) {

[299] Fix | Delete

$template = 'emails/' . $this->get_parent_slug() . '-' . $name;

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

return \apply_filters( 'wpforms_emails_templates_general_get_full_template_name', $template, $this );

[303] Fix | Delete

}

[304] Fix | Delete

[305] Fix | Delete

/**

[306] Fix | Delete

* Get header image URL from settings.

[307] Fix | Delete

*

[308] Fix | Delete

* @since 1.5.4

[309] Fix | Delete

*

[310] Fix | Delete

* @return array

[311] Fix | Delete

*/

[312] Fix | Delete

protected function get_header_image() {

[313] Fix | Delete

[314] Fix | Delete

/**

[315] Fix | Delete

* Additional 'width' key with an integer value can be added to $img array to control image's width in pixels.

[316] Fix | Delete

* This setting helps to scale an image in some versions of MS Outlook and old email clients.

[317] Fix | Delete

* Percentage 'width' values have no effect in MS Outlook and will be sanitized as integer by an email template..

[318] Fix | Delete

*

[319] Fix | Delete

* Example:

[320] Fix | Delete

*

[321] Fix | Delete

* $img = [

[322] Fix | Delete

* 'url' => \wpforms_setting( 'email-header-image' ),

[323] Fix | Delete

* 'width' => 150,

[324] Fix | Delete

* ];

[325] Fix | Delete

*

[326] Fix | Delete

*

[327] Fix | Delete

* To set percentage values for the modern email clients, use $this->set_args() method:

[328] Fix | Delete

*

[329] Fix | Delete

* $this->set_args(

[330] Fix | Delete

* [

[331] Fix | Delete

* 'style' => [

[332] Fix | Delete

* 'header_image_max_width' => '45%',

[333] Fix | Delete

* ],

[334] Fix | Delete

* ]

[335] Fix | Delete

*);

[336] Fix | Delete

*

[337] Fix | Delete

* Both pixel and percentage approaches work well with 'wpforms_emails_templates_general_get_header_image' filter or this class extension.

[338] Fix | Delete

*/

[339] Fix | Delete

$img = [

[340] Fix | Delete

'url' => wpforms_setting( 'email-header-image' ),

[341] Fix | Delete

'size' => wpforms_setting( 'email-header-image-size', 'medium' ),

[342] Fix | Delete

];

[343] Fix | Delete

[344] Fix | Delete

return \apply_filters( 'wpforms_emails_templates_general_get_header_image', $img, $this );

[345] Fix | Delete

}

[346] Fix | Delete

[347] Fix | Delete

/**

[348] Fix | Delete

* Get content part HTML.

[349] Fix | Delete

*

[350] Fix | Delete

* @since 1.5.4

[351] Fix | Delete

*

[352] Fix | Delete

* @param string $name Name of the content part.

[353] Fix | Delete

*

[354] Fix | Delete

* @return string

[355] Fix | Delete

*/

[356] Fix | Delete

protected function get_content_part( $name ) {

[357] Fix | Delete

[358] Fix | Delete

if ( ! \is_string( $name ) ) {

[359] Fix | Delete

return '';

[360] Fix | Delete

}

[361] Fix | Delete

[362] Fix | Delete

$html = Templates::get_html(

[363] Fix | Delete

$this->get_full_template_name( $name ),

[364] Fix | Delete

$this->get_args( $name ),

[365] Fix | Delete

true

[366] Fix | Delete

);

[367] Fix | Delete

[368] Fix | Delete

return \apply_filters( 'wpforms_emails_templates_general_get_content_part', $html, $name, $this );

[369] Fix | Delete

}

[370] Fix | Delete

[371] Fix | Delete

/**

[372] Fix | Delete

* Assemble all content parts in an array.

[373] Fix | Delete

*

[374] Fix | Delete

* @since 1.5.4

[375] Fix | Delete

*

[376] Fix | Delete

* @return array

[377] Fix | Delete

*/

[378] Fix | Delete

protected function get_content_parts() {

[379] Fix | Delete

[380] Fix | Delete

$parts = [

[381] Fix | Delete

'header' => $this->get_content_part( 'header' ),

[382] Fix | Delete

'body' => $this->get_content_part( 'body' ),

[383] Fix | Delete

'footer' => $this->get_content_part( 'footer' ),

[384] Fix | Delete

];

[385] Fix | Delete

[386] Fix | Delete

return \apply_filters( 'wpforms_emails_templates_general_get_content_parts', $parts, $this );

[387] Fix | Delete

}

[388] Fix | Delete

[389] Fix | Delete

/**

[390] Fix | Delete

* Apply inline styling and save email content.

[391] Fix | Delete

*

[392] Fix | Delete

* @since 1.5.4

[393] Fix | Delete

*

[394] Fix | Delete

* @param string $content Content with no styling applied.

[395] Fix | Delete

*/

[396] Fix | Delete

protected function save_styled( $content ) {

[397] Fix | Delete

[398] Fix | Delete

if ( empty( $content ) ) {

[399] Fix | Delete

$this->content = '';

[400] Fix | Delete

return;

[401] Fix | Delete

}

[402] Fix | Delete

[403] Fix | Delete

if ( $this->plain_text ) {

[404] Fix | Delete

$this->content = \wp_strip_all_tags( $content );

[405] Fix | Delete

return;

[406] Fix | Delete

}

[407] Fix | Delete

[408] Fix | Delete

$style_templates = [

[409] Fix | Delete

'style' => $this->get_full_template_name( 'style' ),

[410] Fix | Delete

'queries' => $this->get_full_template_name( 'queries' ),

[411] Fix | Delete

];

[412] Fix | Delete

[413] Fix | Delete

$styler = new Styler( $content, $style_templates, $this->get_args( 'style' ) );

[414] Fix | Delete

[415] Fix | Delete

$this->content = \apply_filters( 'wpforms_emails_templates_general_save_styled_content', $styler->get(), $this );

[416] Fix | Delete

}

[417] Fix | Delete

[418] Fix | Delete

/**

[419] Fix | Delete

* Build an email including styling.

[420] Fix | Delete

*

[421] Fix | Delete

* @since 1.5.4

[422] Fix | Delete

*

[423] Fix | Delete

* @param bool $force Rebuild the content if it was already built and saved.

[424] Fix | Delete

*/

[425] Fix | Delete

protected function build( $force = false ) {

[426] Fix | Delete

[427] Fix | Delete

if ( $this->content && ! $force ) {

[428] Fix | Delete

return;

[429] Fix | Delete

}

[430] Fix | Delete

[431] Fix | Delete

$content = \implode( $this->get_content_parts() );

[432] Fix | Delete

[433] Fix | Delete

if ( empty( $content ) ) {

[434] Fix | Delete

return;

[435] Fix | Delete

}

[436] Fix | Delete

[437] Fix | Delete

$content = $this->process_tags( $content );

[438] Fix | Delete

[439] Fix | Delete

if ( ! $this->plain_text ) {

[440] Fix | Delete

$content = \make_clickable( $content );

[441] Fix | Delete

}

[442] Fix | Delete

[443] Fix | Delete

$content = \apply_filters( 'wpforms_emails_templates_general_build_content', $content, $this );

[444] Fix | Delete

[445] Fix | Delete

$this->save_styled( $content );

[446] Fix | Delete

}

[447] Fix | Delete

[448] Fix | Delete

/**

[449] Fix | Delete

* Return final email.

[450] Fix | Delete

*

[451] Fix | Delete

* @since 1.5.4

[452] Fix | Delete

*

[453] Fix | Delete

* @param bool $force Rebuild the content if it was already built and saved.

[454] Fix | Delete

*

[455] Fix | Delete

* @return string

[456] Fix | Delete

*/

[457] Fix | Delete

public function get( $force = false ) {

[458] Fix | Delete

[459] Fix | Delete

$this->build( $force );

[460] Fix | Delete

[461] Fix | Delete

return $this->content;

[462] Fix | Delete

}

[463] Fix | Delete

}

[464] Fix | Delete

[465] Fix | Delete