id = 'wc_square_sync_completed';
$this->customer_email = false;
$this->title = __( 'Square sync completed', 'woocommerce-square' );
$this->description = __( 'This email is sent once a manual sync has been completed between WooCommerce and Square', 'woocommerce-square' );
$this->subject = _x( '[WooCommerce] Square sync completed', 'Email subject', 'woocommerce-square' );
$this->heading = _x( 'Square sync completed for {product_count}', 'Email heading with merge tag placeholder', 'woocommerce-square' );
$this->body = _x( 'Square sync completed for {site_title} at {sync_completed_date} {sync_completed_time}.', 'Email body with merge tag placeholders', 'woocommerce-square' );
$this->enabled_default = 'no';
// call parent constructor
parent::__construct();
// set default recipient
$this->recipient = $this->get_option( 'recipient', get_option( 'admin_email' ) );
}
/**
* Gets the email heading, adjusted by sync job result status.
*
* @since 2.0.0
*
* @param string $status sync job status
* @return string
*/
private function get_heading_by_job_status( $status ) {
if ( 'failed' === $status ) {
$email_heading = esc_html__( 'Square sync failed', 'woocommerce-square' );
} else {
$email_heading = parent::get_default_heading();
}
/**
* Filter hook to filter email heading.
*
* @see Sync_Completed::get_heading() for filter documentation
* @since 2.0.0
**/
return apply_filters( 'woocommerce_email_heading_' . $this->id, $this->format_string( $email_heading ), $this->object );
}
/**
* Gets the email body adjusted by sync job result status.
*
* @since 2.0.0
*
* @param string $status sync job status
* @param bool $html whether output should be HTML (true) or plain text (false)
* @return string may contain HTML
*/
private function get_body_by_job_status( $status, $html ) {
$email_body = $this->get_default_body();
if ( 'failed' === $status ) {
if ( true === $html ) {
$square = wc_square();
$settings_url = $square->get_settings_url();
$records_url = add_query_arg( array( 'section' => 'update' ), $settings_url );
if ( $square->get_settings_handler()->is_debug_enabled() ) {
$action = sprintf(
/* translators: Placeholders: %1$s - opening HTML link tag, %2$s - closing HTML link tag */
esc_html__( '%1$sInspect status logs%2$s', 'woocommerce-square' ),
'',
''
);
} else {
$action = sprintf(
/* translators: Placeholders: %1$s - opening HTML link tag, %2$s - closing HTML link tag */
esc_html__( '%1$sEnable logging%2$s', 'woocommerce-square' ),
'',
''
);
}
$email_body .= sprintf(
/* translators: Placeholders: %1$s - opening HTML link tag, %2$s - closing HTML link tag, %3$s - additional action */
'
' . esc_html__( 'The sync job has failed. %1$sClick for more details%2$s, or %3$s.', 'woocommerce-square' ),
'',
'',
strtolower( $action )
);
} else { // plain text
if ( wc_square()->get_settings_handler()->is_debug_enabled() ) {
$action = esc_html__( 'Inspect status logs', 'woocommerce-square' );
} else {
$action = esc_html__( 'Enable Logging', 'woocommerce-square' );
}
$email_body .= sprintf(
/* translators: Placeholders: %s - additional action */
esc_html__( 'The sync job has failed. Check sync records, or %s.', 'woocommerce-square' ),
strtolower( $action )
);
}
}
/**
* Filter hook to filter email body.
*
* @see Sync_Completed::get_body() for filter documentation
* @since 2.0.0
**/
return $this->format_string( (string) apply_filters( "{$this->id}_body", $email_body, $this ) );
}
/**
* Gets the email's related sync job, if set.
*
* @since 2.0.0
*
* @return \stdClass|null
*/
private function get_job() {
return $this->object && is_object( $this->object ) ? $this->object : null;
}
/**
* Triggers the email.
*
* @since 2.0.0
*
* @param string|object|\stdClass $job a sync job object or ID
*/
public function trigger( $job ) {
if ( $this->is_enabled() && $this->has_recipients() ) {
if ( is_string( $job ) || is_numeric( $job ) ) {
$job = wc_square()->get_background_job_handler()->get_job( $job );
}
if ( ! $job || ! is_object( $job ) || ! isset( $job->manual, $job->status ) ) {
return;
}
$should_send = false;
if ( $job->manual && ( 'completed' === $job->status || 'failed' === $job->status ) ) {
// for manual jobs, send an email if the job was either completed or failed
$should_send = true;
} elseif ( ! $job->manual && 'failed' === $job->status ) {
// for automated jobs, send an email only if the job failed and it's been a day since the last email
$already_sent = get_transient( 'wc_square_failed_sync_email_sent' );
if ( false === $already_sent ) {
$should_send = true;
set_transient( 'wc_square_failed_sync_email_sent', true, DAY_IN_SECONDS );
}
}
if ( $should_send ) {
$this->object = $job;
$this->parse_merge_tags();
$this->send( $this->get_recipient(), $this->get_subject(), $this->get_content(), $this->get_headers(), $this->get_attachments() );
}
}
}
/**
* Parses the email's body merge tags.
*
* @since 2.0.0
*/
protected function parse_merge_tags() {
$job = $this->get_job();
if ( ! $job ) {
return;
}
$product_count = is_array( $job->processed_product_ids ) ? count( $job->processed_product_ids ) : absint( $job->processed_product_ids );
/* translators: Placeholder: %d products count */
$product_count = sprintf( _n( '%d product', '%d products', $product_count, 'woocommerce-square' ), $product_count );
$sync_completed_date = '';
$sync_completed_time = '';
if ( isset( $job->completed_at ) ) {
$sync_completed_date = gmdate( wc_date_format(), strtotime( $job->completed_at ) );
$sync_completed_time = gmdate( wc_time_format(), strtotime( $job->completed_at ) );
} elseif ( isset( $job->failed_at ) ) {
$sync_completed_date = gmdate( wc_date_format(), strtotime( $job->failed_at ) );
$sync_completed_time = gmdate( wc_time_format(), strtotime( $job->failed_at ) );
}
// placeholders
$email_merge_tags = array(
'product_count' => $product_count,
'sync_started_date' => isset( $job->started_at ) ? gmdate( wc_date_format(), strtotime( $job->started_at ) ) : '',
'sync_started_time' => isset( $job->started_at ) ? gmdate( wc_time_format(), strtotime( $job->started_at ) ) : '',
'sync_completed_date' => $sync_completed_date,
'sync_completed_time' => $sync_completed_time,
);
foreach ( $email_merge_tags as $find => $replace ) {
$this->placeholders[ '{' . $find . '}' ] = $replace;
}
}
/**
* Gets the arguments that should be passed to an email template.
*
* @since 2.0.0
*
* @param array $args optional associative array with additional arguments
* @return array
*/
protected function get_template_args( $args = array() ) {
$sync_job = $this->get_job();
$html = empty( $args['plain_text'] );
if ( $sync_job && isset( $sync_job->status ) && 'failed' === $sync_job->status ) {
$email_heading = $this->get_heading_by_job_status( 'failed' );
$email_body = $this->get_body_by_job_status( 'failed', $html );
} else {
$email_heading = $this->get_heading_by_job_status( 'completed' );
$email_body = $this->get_body_by_job_status( 'completed', $html );
}
return array_merge(
$args,
array(
'email' => $this,
'email_heading' => $email_heading,
'email_body' => $email_body,
'additional_content' => $this->get_additional_content(),
)
);
}
}