Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

/**

[2] Fix | Delete

* Wrapper for Campaign Monitor's API.

[3] Fix | Delete

[4] Fix | Delete

* @since 1.1.0

[5] Fix | Delete

[6] Fix | Delete

* @package ET\Core\API\Email

[7] Fix | Delete

[8] Fix | Delete

class ET_Core_API_Email_CampaignMonitor extends ET_Core_API_Email_Provider {

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* @inheritDoc

[12] Fix | Delete

[13] Fix | Delete

public $BASE_URL = 'https://api.createsend.com/api/v3.1';

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* @inheritDoc

[17] Fix | Delete

[18] Fix | Delete

public $http_auth = array(

[19] Fix | Delete

'username' => 'api_key',

[20] Fix | Delete

'password' => '-',

[21] Fix | Delete

);

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* @inheritDoc

[25] Fix | Delete

[26] Fix | Delete

public $name = 'CampaignMonitor';

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* @inheritDoc

[30] Fix | Delete

[31] Fix | Delete

public $name_field_only = true;

[32] Fix | Delete

[33] Fix | Delete

/**

[34] Fix | Delete

* @inheritDoc

[35] Fix | Delete

[36] Fix | Delete

public $slug = 'campaign_monitor';

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* @inheritDoc

[40] Fix | Delete

* @internal If true, oauth endpoints properties must also be defined.

[41] Fix | Delete

[42] Fix | Delete

public $uses_oauth = false;

[43] Fix | Delete

[44] Fix | Delete

public function __construct( $owner, $account_name, $api_key = '' ) {

[45] Fix | Delete

parent::__construct( $owner, $account_name, $api_key );

[46] Fix | Delete

[47] Fix | Delete

$this->http_auth['password'] = $owner;

[48] Fix | Delete

}

[49] Fix | Delete

[50] Fix | Delete

protected function _fetch_custom_fields( $list_id = '', $list = array() ) {

[51] Fix | Delete

$this->prepare_request( "{$this->BASE_URL}/lists/{$list_id}/customfields.json" );

[52] Fix | Delete

$this->make_remote_request();

[53] Fix | Delete

[54] Fix | Delete

$result = array();

[55] Fix | Delete

[56] Fix | Delete

if ( $this->response->ERROR ) {

[57] Fix | Delete

et_debug( $this->get_error_message() );

[58] Fix | Delete

[59] Fix | Delete

return $result;

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

foreach ( $this->response->DATA as &$custom_field ) {

[63] Fix | Delete

$custom_field = $this->transform_data_to_our_format( $custom_field, 'custom_field' );

[64] Fix | Delete

$custom_field['field_id'] = ltrim( rtrim( $custom_field['field_id'], ']' ), '[' );

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

$fields = array();

[68] Fix | Delete

[69] Fix | Delete

foreach ( $this->response->DATA as $field ) {

[70] Fix | Delete

$field_id = $field['field_id'];

[71] Fix | Delete

$type = self::$_->array_get( $field, 'type', 'any' );

[72] Fix | Delete

[73] Fix | Delete

$field['type'] = self::$_->array_get( $this->data_keys, "custom_field_type.{$type}", 'any' );

[74] Fix | Delete

[75] Fix | Delete

$fields[ $field_id ] = $field;

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

return $fields;

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

protected function _get_clients() {

[82] Fix | Delete

$url = "{$this->BASE_URL}/clients.json";

[83] Fix | Delete

[84] Fix | Delete

$this->prepare_request( $url );

[85] Fix | Delete

$this->make_remote_request();

[86] Fix | Delete

[87] Fix | Delete

if ( $this->response->ERROR ) {

[88] Fix | Delete

return $this->get_error_message();

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

return (array) $this->response->DATA;

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

protected function _get_subscriber_counts() {

[95] Fix | Delete

$subscriber_lists = $this->_process_subscriber_lists( $this->response->DATA );

[96] Fix | Delete

$with_counts = array();

[97] Fix | Delete

[98] Fix | Delete

foreach ( $subscriber_lists as $subscriber_list ) {

[99] Fix | Delete

$list_id = $subscriber_list['list_id'];

[100] Fix | Delete

$with_counts[ $list_id ] = $subscriber_list;

[101] Fix | Delete

$url = "{$this->BASE_URL}/lists/{$list_id}/stats.json";

[102] Fix | Delete

[103] Fix | Delete

$this->prepare_request( $url );

[104] Fix | Delete

$this->make_remote_request();

[105] Fix | Delete

[106] Fix | Delete

if ( $this->response->ERROR ) {

[107] Fix | Delete

continue;

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

if ( isset( $this->response->DATA['TotalActiveSubscribers'] ) ) {

[111] Fix | Delete

$with_counts[ $list_id ]['subscribers_count'] = $this->response->DATA['TotalActiveSubscribers'];

[112] Fix | Delete

} else {

[113] Fix | Delete

$with_counts[ $list_id ]['subscribers_count'] = 0;

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

usleep( 500000 ); // 0.5 seconds

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

return $with_counts;

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

protected function _process_custom_fields( $args ) {

[123] Fix | Delete

if ( ! isset( $args['custom_fields'] ) ) {

[124] Fix | Delete

return $args;

[125] Fix | Delete

}

[126] Fix | Delete

[127] Fix | Delete

$fields_unprocessed = $args['custom_fields'];

[128] Fix | Delete

[129] Fix | Delete

unset( $args['custom_fields'] );

[130] Fix | Delete

[131] Fix | Delete

$fields = array();

[132] Fix | Delete

[133] Fix | Delete

foreach ( $fields_unprocessed as $field_id => $value ) {

[134] Fix | Delete

if ( is_array( $value ) && $value ) {

[135] Fix | Delete

// This is a multiple choice field (eg. checkbox)

[136] Fix | Delete

foreach ( $value as $selected_option ) {

[137] Fix | Delete

$fields[] = array(

[138] Fix | Delete

'Key' => $field_id,

[139] Fix | Delete

'Value' => $selected_option,

[140] Fix | Delete

);

[141] Fix | Delete

}

[142] Fix | Delete

} else {

[143] Fix | Delete

$fields[] = array(

[144] Fix | Delete

'Key' => $field_id,

[145] Fix | Delete

'Value' => $value,

[146] Fix | Delete

);

[147] Fix | Delete

}

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

$args['CustomFields'] = $fields;

[151] Fix | Delete

[152] Fix | Delete

return $args;

[153] Fix | Delete

}

[154] Fix | Delete

[155] Fix | Delete

/**

[156] Fix | Delete

* @inheritDoc

[157] Fix | Delete

[158] Fix | Delete

public function get_account_fields() {

[159] Fix | Delete

return array(

[160] Fix | Delete

'api_key' => array(

[161] Fix | Delete

'label' => esc_html__( 'API Key', 'et_core' ),

[162] Fix | Delete

[163] Fix | Delete

);

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

/**

[167] Fix | Delete

* @inheritDoc

[168] Fix | Delete

[169] Fix | Delete

public function get_data_keymap( $keymap = array() ) {

[170] Fix | Delete

$keymap = array(

[171] Fix | Delete

'list' => array(

[172] Fix | Delete

'list_id' => 'ListID',

[173] Fix | Delete

'name' => 'Name',

[174] Fix | Delete

'subscribers_count' => 'TotalActiveSubscribers',

[175] Fix | Delete

[176] Fix | Delete

'subscriber' => array(

[177] Fix | Delete

'name' => 'Name',

[178] Fix | Delete

'email' => 'EmailAddress',

[179] Fix | Delete

'custom_fields' => 'custom_fields',

[180] Fix | Delete

[181] Fix | Delete

'error' => array(

[182] Fix | Delete

'error_message' => 'Message',

[183] Fix | Delete

[184] Fix | Delete

'custom_field' => array(

[185] Fix | Delete

'field_id' => 'Key',

[186] Fix | Delete

'name' => 'FieldName',

[187] Fix | Delete

'type' => 'DataType',

[188] Fix | Delete

'options' => 'FieldOptions',

[189] Fix | Delete

[190] Fix | Delete

'custom_field_type' => array(

[191] Fix | Delete

// Us => Them

[192] Fix | Delete

'input' => 'Text',

[193] Fix | Delete

'select' => 'MultiSelectOne',

[194] Fix | Delete

'checkbox' => 'MultiSelectMany',

[195] Fix | Delete

// Them => Us

[196] Fix | Delete

'Text' => 'input',

[197] Fix | Delete

'Number' => 'input',

[198] Fix | Delete

'Date' => 'input',

[199] Fix | Delete

'MultiSelectOne' => 'select',

[200] Fix | Delete

'MultiSelectMany' => 'checkbox',

[201] Fix | Delete

[202] Fix | Delete

);

[203] Fix | Delete

[204] Fix | Delete

return parent::get_data_keymap( $keymap );

[205] Fix | Delete

}

[206] Fix | Delete

[207] Fix | Delete

/**

[208] Fix | Delete

* @inheritDoc

[209] Fix | Delete

[210] Fix | Delete

public function fetch_subscriber_lists() {

[211] Fix | Delete

if ( empty( $this->data['api_key'] ) ) {

[212] Fix | Delete

return $this->API_KEY_REQUIRED;

[213] Fix | Delete

}

[214] Fix | Delete

[215] Fix | Delete

$clients = $this->_get_clients();

[216] Fix | Delete

$lists = array();

[217] Fix | Delete

[218] Fix | Delete

if ( ! is_array( $clients ) ) {

[219] Fix | Delete

// Request failed with an error, return the error message.

[220] Fix | Delete

return $clients;

[221] Fix | Delete

}

[222] Fix | Delete

[223] Fix | Delete

foreach ( $clients as $client_info ) {

[224] Fix | Delete

if ( empty( $client_info['ClientID'] ) ) {

[225] Fix | Delete

continue;

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

$url = "{$this->BASE_URL}/clients/{$client_info['ClientID']}/lists.json";

[229] Fix | Delete

[230] Fix | Delete

$this->prepare_request( $url );

[231] Fix | Delete

[232] Fix | Delete

parent::fetch_subscriber_lists();

[233] Fix | Delete

[234] Fix | Delete

if ( $this->response->ERROR ) {

[235] Fix | Delete

return $this->get_error_message();

[236] Fix | Delete

}

[237] Fix | Delete

[238] Fix | Delete

if ( isset( $this->response->DATA ) ) {

[239] Fix | Delete

$with_counts = $this->_get_subscriber_counts();

[240] Fix | Delete

$lists = $lists + $with_counts;

[241] Fix | Delete

$this->data['is_authorized'] = true;

[242] Fix | Delete

[243] Fix | Delete

$this->save_data();

[244] Fix | Delete

}

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete

if ( empty( $this->data['lists'] ) || ! empty( $lists ) ) {

[248] Fix | Delete

$this->data['lists'] = $lists;

[249] Fix | Delete

$this->save_data();

[250] Fix | Delete

}

[251] Fix | Delete

[252] Fix | Delete

return $this->is_authenticated() ? 'success' : $this->FAILURE_MESSAGE;

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

/**

[256] Fix | Delete

* @inheritDoc

[257] Fix | Delete

[258] Fix | Delete

public function subscribe( $args, $url = '' ) {

[259] Fix | Delete

$url = "{$this->BASE_URL}/subscribers/{$args['list_id']}.json";

[260] Fix | Delete

$params = $this->transform_data_to_provider_format( $args, 'subscriber' );

[261] Fix | Delete

$params = $this->_process_custom_fields( $params );

[262] Fix | Delete

[263] Fix | Delete

$params['CustomFields'][] = array( 'Key' => 'Note', 'Value' => $this->SUBSCRIBED_VIA );

[264] Fix | Delete

[265] Fix | Delete

$this->prepare_request( $url, 'POST', false, $params, true );

[266] Fix | Delete

[267] Fix | Delete

return parent::subscribe( $params, $url );

[268] Fix | Delete

}

[269] Fix | Delete

}

[270] Fix | Delete

[271] Fix | Delete