Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

/**

[2] Fix | Delete

* Wrapper for Ontraport'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_Ontraport extends ET_Core_API_Email_Provider {

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* @inheritDoc

[12] Fix | Delete

[13] Fix | Delete

public $FIELDS_URL = 'https://api.ontraport.com/1/Contacts/meta';

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* @inheritDoc

[17] Fix | Delete

[18] Fix | Delete

public $LISTS_URL = 'https://api.ontraport.com/1/objects?objectID=5';

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* @inheritDoc

[22] Fix | Delete

[23] Fix | Delete

public $SUBSCRIBE_URL = 'https://api.ontraport.com/1';

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* @inheritDoc

[27] Fix | Delete

[28] Fix | Delete

public $custom_fields_scope = 'account';

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* @inheritDoc

[32] Fix | Delete

[33] Fix | Delete

public $name = 'Ontraport';

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* @inheritDoc

[37] Fix | Delete

[38] Fix | Delete

public $slug = 'ontraport';

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* @inheritDoc

[42] Fix | Delete

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

[43] Fix | Delete

[44] Fix | Delete

public $uses_oauth = false;

[45] Fix | Delete

[46] Fix | Delete

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

[47] Fix | Delete

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

[48] Fix | Delete

[49] Fix | Delete

$this->_maybe_set_custom_headers();

[50] Fix | Delete

}

[51] Fix | Delete

[52] Fix | Delete

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

[53] Fix | Delete

static $fields = null;

[54] Fix | Delete

[55] Fix | Delete

if ( is_null( $fields ) ) {

[56] Fix | Delete

$this->response_data_key = null;

[57] Fix | Delete

[58] Fix | Delete

parent::_fetch_custom_fields( $list_id, $list );

[59] Fix | Delete

[60] Fix | Delete

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

[61] Fix | Delete

et_debug( $this->get_error_message() );

[62] Fix | Delete

[63] Fix | Delete

return array();

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

$fields = array();

[67] Fix | Delete

$fields_unprocessed = self::$_->array_get( $this->response->DATA, 'data.[0].fields', $fields );

[68] Fix | Delete

[69] Fix | Delete

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

[70] Fix | Delete

if ( in_array( $field_id, array( 'firstname', 'lastname', 'email' ) ) ) {

[71] Fix | Delete

continue;

[72] Fix | Delete

}

[73] Fix | Delete

[74] Fix | Delete

$type = $field['type'];

[75] Fix | Delete

[76] Fix | Delete

$field['field_id'] = $field_id;

[77] Fix | Delete

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

[78] Fix | Delete

[79] Fix | Delete

$fields[ $field_id ] = $this->transform_data_to_our_format( $field, 'custom_field' );

[80] Fix | Delete

}

[81] Fix | Delete

}

[82] Fix | Delete

[83] Fix | Delete

return $fields;

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

protected function _get_subscriber_list_type( $list_id ) {

[87] Fix | Delete

$sequence_key = 'seq:' . $list_id;

[88] Fix | Delete

$campaign_key = 'camp:' . $list_id;

[89] Fix | Delete

[90] Fix | Delete

if ( isset( $this->data['lists'][ $campaign_key ] ) ) {

[91] Fix | Delete

return 'Campaign';

[92] Fix | Delete

}

[93] Fix | Delete

[94] Fix | Delete

if ( isset( $this->data['lists'][ $sequence_key ] ) ) {

[95] Fix | Delete

return 'Sequence';

[96] Fix | Delete

}

[97] Fix | Delete

[98] Fix | Delete

return 'Campaign';

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

protected function _maybe_set_custom_headers() {

[102] Fix | Delete

if ( empty( $this->custom_headers ) && isset( $this->data['api_key'] ) && isset( $this->data['client_id'] ) ) {

[103] Fix | Delete

$this->custom_headers = array(

[104] Fix | Delete

'Api-Appid' => sanitize_text_field( $this->data['client_id'] ),

[105] Fix | Delete

'Api-Key' => sanitize_text_field( $this->data['api_key'] ),

[106] Fix | Delete

);

[107] Fix | Delete

}

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

protected function _prefix_subscriber_lists( $name_prefix, $id_prefix ) {

[111] Fix | Delete

$lists = array();

[112] Fix | Delete

[113] Fix | Delete

foreach ( $this->data['lists'] as $list_id => $list ) {

[114] Fix | Delete

$key = $id_prefix . $list_id;

[115] Fix | Delete

[116] Fix | Delete

if ( ! $list['name'] ) {

[117] Fix | Delete

$list['name'] = $list_id;

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

$lists[ $key ] = $list;

[121] Fix | Delete

$lists[ $key ]['name'] = $name_prefix . $list['name'];

[122] Fix | Delete

$lists[ $key ]['list_id'] = $key;

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

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

[126] Fix | Delete

[127] Fix | Delete

$this->save_data();

[128] Fix | Delete

}

[129] Fix | Delete

[130] Fix | Delete

protected function _process_custom_fields( $args ) {

[131] Fix | Delete

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

[132] Fix | Delete

return $args;

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

$fields = $args['custom_fields'];

[136] Fix | Delete

[137] Fix | Delete

unset( $args['custom_fields'] );

[138] Fix | Delete

[139] Fix | Delete

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

[140] Fix | Delete

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

[141] Fix | Delete

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

[142] Fix | Delete

$value = array_keys( $value );

[143] Fix | Delete

[144] Fix | Delete

if ( 'checkbox' === $this->data['custom_fields'][ $field_id ]['type'] ) {

[145] Fix | Delete

// Determine if checkbox is a single checkbox or a list.

[146] Fix | Delete

// In case of single checkbox pass `1` as a value

[147] Fix | Delete

if ( ! empty( $this->data['custom_fields'][ $field_id ]['options'] ) ) {

[148] Fix | Delete

$value = implode( '*/*', $value );

[149] Fix | Delete

$value = "*/*{$value}*/*";

[150] Fix | Delete

} else {

[151] Fix | Delete

$value = '1';

[152] Fix | Delete

}

[153] Fix | Delete

} else {

[154] Fix | Delete

$value = array_pop( $value );

[155] Fix | Delete

}

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

self::$_->array_set( $args, $field_id, $value );

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

return $args;

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

/**

[165] Fix | Delete

* @inheritDoc

[166] Fix | Delete

[167] Fix | Delete

public function get_account_fields() {

[168] Fix | Delete

return array(

[169] Fix | Delete

'api_key' => array(

[170] Fix | Delete

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

[171] Fix | Delete

[172] Fix | Delete

'client_id' => array(

[173] Fix | Delete

'label' => esc_html__( 'APP ID', 'et_core' ),

[174] Fix | Delete

[175] Fix | Delete

);

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

/**

[179] Fix | Delete

* @inheritDoc

[180] Fix | Delete

[181] Fix | Delete

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

[182] Fix | Delete

$keymap = array(

[183] Fix | Delete

'list' => array(

[184] Fix | Delete

'name' => 'name',

[185] Fix | Delete

'list_id' => 'drip_id',

[186] Fix | Delete

'subscribers_count' => 'subscriber_count',

[187] Fix | Delete

[188] Fix | Delete

'subscriber' => array(

[189] Fix | Delete

'name' => 'firstname',

[190] Fix | Delete

'last_name' => 'lastname',

[191] Fix | Delete

'email' => 'email',

[192] Fix | Delete

'custom_fields' => 'custom_fields',

[193] Fix | Delete

[194] Fix | Delete

'custom_field' => array(

[195] Fix | Delete

'field_id' => 'field_id',

[196] Fix | Delete

'type' => 'type',

[197] Fix | Delete

'name' => 'alias',

[198] Fix | Delete

'options' => 'options',

[199] Fix | Delete

[200] Fix | Delete

'custom_field_type' => array(

[201] Fix | Delete

// Us => Them

[202] Fix | Delete

'input' => 'text',

[203] Fix | Delete

'textarea' => 'textlong',

[204] Fix | Delete

'checkbox' => 'list',

[205] Fix | Delete

'select' => 'drop',

[206] Fix | Delete

// Them => Us

[207] Fix | Delete

'text' => 'input',

[208] Fix | Delete

'textlong' => 'textarea',

[209] Fix | Delete

'list' => 'checkbox',

[210] Fix | Delete

'check' => 'checkbox',

[211] Fix | Delete

'drop' => 'select',

[212] Fix | Delete

[213] Fix | Delete

);

[214] Fix | Delete

[215] Fix | Delete

return parent::get_data_keymap( $keymap );

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

/**

[219] Fix | Delete

* @inheritDoc

[220] Fix | Delete

[221] Fix | Delete

public function fetch_subscriber_lists() {

[222] Fix | Delete

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

[223] Fix | Delete

return $this->API_KEY_REQUIRED;

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete

$this->_maybe_set_custom_headers();

[227] Fix | Delete

[228] Fix | Delete

$this->response_data_key = 'data';

[229] Fix | Delete

[230] Fix | Delete

parent::fetch_subscriber_lists();

[231] Fix | Delete

[232] Fix | Delete

$this->_prefix_subscriber_lists( 'Sequence: ', 'seq:' );

[233] Fix | Delete

[234] Fix | Delete

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

[235] Fix | Delete

$url = 'https://api.ontraport.com/1/CampaignBuilderItems';

[236] Fix | Delete

$url = add_query_arg( 'listFields', 'id,name,subs', $url );

[237] Fix | Delete

[238] Fix | Delete

$this->data_keys['list']['list_id'] = 'id';

[239] Fix | Delete

$this->data_keys['list']['subscribers_count'] = 'subs';

[240] Fix | Delete

[241] Fix | Delete

$this->prepare_request( $url );

[242] Fix | Delete

[243] Fix | Delete

$this->response_data_key = 'data';

[244] Fix | Delete

[245] Fix | Delete

$result = parent::fetch_subscriber_lists();

[246] Fix | Delete

[247] Fix | Delete

$this->_prefix_subscriber_lists( 'Campaign: ', 'camp:' );

[248] Fix | Delete

[249] Fix | Delete

$this->data['lists'] = array_merge( $this->data['lists'], $sequences );

[250] Fix | Delete

[251] Fix | Delete

$this->save_data();

[252] Fix | Delete

[253] Fix | Delete

return $result;

[254] Fix | Delete

}

[255] Fix | Delete

[256] Fix | Delete

public function get_subscriber( $email ) {

[257] Fix | Delete

$args = array(

[258] Fix | Delete

'objectID' => '0',

[259] Fix | Delete

'email' => rawurlencode( $email ),

[260] Fix | Delete

);

[261] Fix | Delete

[262] Fix | Delete

$url = add_query_arg( $args, $this->SUBSCRIBE_URL . '/object/getByEmail' );

[263] Fix | Delete

[264] Fix | Delete

$this->prepare_request( $url );

[265] Fix | Delete

$this->make_remote_request();

[266] Fix | Delete

[267] Fix | Delete

return self::$_->array_get( $this->response->DATA, 'data.id', false );

[268] Fix | Delete

}

[269] Fix | Delete

[270] Fix | Delete

/**

[271] Fix | Delete

* @inheritDoc

[272] Fix | Delete

[273] Fix | Delete

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

[274] Fix | Delete

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

[275] Fix | Delete

return $this->API_KEY_REQUIRED;

[276] Fix | Delete

}

[277] Fix | Delete

[278] Fix | Delete

$list_id = $args['list_id'];

[279] Fix | Delete

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

[280] Fix | Delete

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

[281] Fix | Delete

$args['objectID'] = 0;

[282] Fix | Delete

$url = $this->SUBSCRIBE_URL . '/Contacts/saveorupdate';

[283] Fix | Delete

[284] Fix | Delete

// Create or update contact

[285] Fix | Delete

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

[286] Fix | Delete

$this->make_remote_request();

[287] Fix | Delete

[288] Fix | Delete

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

[289] Fix | Delete

return $this->get_error_message();

[290] Fix | Delete

}

[291] Fix | Delete

[292] Fix | Delete

$list_id_parts = explode( ':', $list_id );

[293] Fix | Delete

$list_id = array_pop( $list_id_parts );

[294] Fix | Delete

$data = $this->response->DATA['data'];

[295] Fix | Delete

[296] Fix | Delete

// Subscribe contact to list

[297] Fix | Delete

$url = $this->SUBSCRIBE_URL . '/objects/subscribe';

[298] Fix | Delete

$args = array(

[299] Fix | Delete

'ids' => self::$_->array_get( $data, 'id', $data['attrs']['id'] ),

[300] Fix | Delete

'add_list' => $list_id,

[301] Fix | Delete

'sub_type' => $this->_get_subscriber_list_type( $list_id ),

[302] Fix | Delete

'objectID' => 0,

[303] Fix | Delete

);

[304] Fix | Delete

[305] Fix | Delete

$this->prepare_request( $url, 'PUT', false, $args );

[306] Fix | Delete

[307] Fix | Delete

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

[308] Fix | Delete

}

[309] Fix | Delete

}

[310] Fix | Delete

[311] Fix | Delete