| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351 |
- <?php
- /**
- * Helper class for the MailChimp API.
- *
- * @since 1.5.4
- */
- final class FLBuilderServiceMailChimp extends FLBuilderService {
- /**
- * The ID for this service.
- *
- * @since 1.5.4
- * @var string $id
- */
- public $id = 'mailchimp';
- /**
- * @since 1.5.4
- * @var object $api_instance
- * @access private
- */
- private $api_instance = null;
- /**
- * Get an instance of the API.
- *
- * @since 1.5.4
- * @param string $api_key A valid API key.
- * @return object The API instance.
- */
- public function get_api( $api_key ) {
- if ( $this->api_instance ) {
- return $this->api_instance;
- }
- if ( ! class_exists( 'Mailchimp' ) ) {
- require_once FL_BUILDER_DIR . 'includes/vendor/mailchimp/mailchimp.php';
- }
- $this->api_instance = new Mailchimp( $api_key );
- return $this->api_instance;
- }
- /**
- * Test the API connection.
- *
- * @since 1.5.4
- * @param array $fields {
- * @type string $api_key A valid API key.
- * }
- * @return array{
- * @type bool|string $error The error message or false if no error.
- * @type array $data An array of data used to make the connection.
- * }
- */
- public function connect( $fields = array() ) {
- $response = array(
- 'error' => false,
- 'data' => array(),
- );
- // Make sure we have an API key.
- if ( ! isset( $fields['api_key'] ) || empty( $fields['api_key'] ) ) {
- $response['error'] = __( 'Error: You must provide an API key.', 'fl-builder' );
- } else {
- try {
- $api = $this->get_api( $fields['api_key'] );
- $ping = $api->get( 'ping' );
- if ( ! isset( $ping['health_status'] ) && isset( $ping['title'] ) ) {
- $response['error'] = $ping['title'];
- } else {
- $response['data'] = array(
- 'api_key' => $fields['api_key'],
- );
- }
- } catch ( Exception $e ) {
- $response['error'] = $e->getMessage();
- }
- }
- return $response;
- }
- /**
- * Renders the markup for the connection settings.
- *
- * @since 1.5.4
- * @return string The connection settings markup.
- */
- public function render_connect_settings() {
- ob_start();
- FLBuilder::render_settings_field( 'api_key', array(
- 'row_class' => 'fl-builder-service-connect-row',
- 'class' => 'fl-builder-service-connect-input',
- 'type' => 'text',
- 'label' => __( 'API Key', 'fl-builder' ),
- 'help' => __( 'Your API key can be found in your MailChimp account under Account > Extras > API Keys.', 'fl-builder' ),
- 'preview' => array(
- 'type' => 'none',
- ),
- ));
- return ob_get_clean();
- }
- /**
- * Render the markup for service specific fields.
- *
- * @since 1.5.4
- * @param string $account The name of the saved account.
- * @param object $settings Saved module settings.
- * @return array {
- * @type bool|string $error The error message or false if no error.
- * @type string $html The field markup.
- * }
- */
- public function render_fields( $account, $settings ) {
- $post_data = FLBuilderModel::get_post_data();
- $account_data = $this->get_account_data( $account );
- $response = array(
- 'error' => false,
- 'html' => '',
- );
- // Lists field
- try {
- $api = $this->get_api( $account_data['api_key'] );
- if ( ! isset( $post_data['list_id'] ) ) {
- $lists = $api->getLists();
- $response['html'] .= $this->render_list_field( $lists, $settings );
- }
- } catch ( Exception $e ) {
- $response['error'] = $e->getMessage();
- }
- // Groups field
- try {
- if ( isset( $post_data['list_id'] ) || isset( $settings->list_id ) ) {
- if ( isset( $post_data['list_id'] ) ) {
- $list_id = $post_data['list_id'];
- } else {
- $list_id = $settings->list_id;
- }
- $groups = $api->interestGroupings( $list_id );
- $response['html'] .= $this->render_groups_field( $list_id, $groups, $settings );
- }
- } catch ( Exception $e ) {}
- return $response;
- }
- /**
- * Render markup for the list field.
- *
- * @since 1.5.4
- * @param array $lists List data from the API.
- * @param object $settings Saved module settings.
- * @return string The markup for the list field.
- * @access private
- */
- private function render_list_field( $lists, $settings ) {
- ob_start();
- $options = array(
- '' => __( 'Choose...', 'fl-builder' ),
- );
- if ( is_array( $lists ) && count( $lists ) > 0 ) {
- foreach ( $lists as $list ) {
- $options[ $list['id'] ] = $list['name'];
- }
- }
- FLBuilder::render_settings_field( 'list_id', array(
- 'row_class' => 'fl-builder-service-field-row',
- 'class' => 'fl-builder-service-list-select fl-builder-mailchimp-list-select',
- 'type' => 'select',
- 'label' => _x( 'List', 'An email list from a third party provider.', 'fl-builder' ),
- 'options' => $options,
- 'preview' => array(
- 'type' => 'none',
- ),
- ), $settings);
- return ob_get_clean();
- }
- /**
- * Render markup for the groups field.
- *
- * @since 1.6.0
- * @param string $list_id The ID of the list for this groups.
- * @param array $groups An array of group data.
- * @param object $settings Saved module settings.
- * @return string The markup for the group field.
- * @access private
- */
- private function render_groups_field( $list_id, $groups, $settings ) {
- if ( ! is_array( $groups ) || 0 === count( $groups ) ) {
- return;
- }
- ob_start();
- $options = array(
- '' => __( 'No Group', 'fl-builder' ),
- );
- foreach ( $groups as $group ) {
- foreach ( $group['groups'] as $subgroup ) {
- $options[ $list_id . '_' . $group['id'] . '_' . $subgroup['id'] ] = $group['title'] . ' - ' . $subgroup['name'];
- }
- }
- FLBuilder::render_settings_field( 'groups', array(
- 'row_class' => 'fl-builder-service-field-row',
- 'class' => 'fl-builder-mailchimp-group-select',
- 'type' => 'select',
- 'label' => _x( 'Groups', 'MailChimp list group.', 'fl-builder' ),
- 'multi-select' => true,
- 'options' => $options,
- 'preview' => array(
- 'type' => 'none',
- ),
- ), $settings);
- return ob_get_clean();
- }
- /**
- * Subscribe an email address to MailChimp.
- *
- * @since 1.5.4
- * @param object $settings A module settings object.
- * @param string $email The email to subscribe.
- * @param string $name Optional. The full name of the person subscribing.
- * @return array {
- * @type bool|string $error The error message or false if no error.
- * }
- */
- public function subscribe( $settings, $email, $name = false ) {
- $account_data = $this->get_account_data( $settings->service_account );
- $response = array(
- 'error' => false,
- );
- if ( ! $account_data ) {
- $response['error'] = __( 'There was an error subscribing to MailChimp. The account is no longer connected.', 'fl-builder' );
- } else {
- try {
- $api = $this->get_api( $account_data['api_key'] );
- /**
- * Use this filter to enable double opt-ins for MailChimp integrations.
- * Returning true enables double opt-ins; returning false enables single opt-ins.
- * The default return value for this filter is false.
- * @see fl_builder_mailchimp_double_option
- * @link https://kb.wpbeaverbuilder.com/article/117-plugin-filter-reference
- */
- $double = apply_filters( 'fl_builder_mailchimp_double_option', false );
- $data = array(
- 'email' => $email,
- 'double_optin' => (bool) $double,
- );
- // Name
- if ( $name ) {
- $names = explode( ' ', $name );
- if ( isset( $names[0] ) ) {
- $data['FNAME'] = $names[0];
- $data['LNAME'] = ltrim( str_replace( $names[0], '', $name ) );
- }
- }
- // Groups
- if ( isset( $settings->groups ) && is_array( $settings->groups ) ) {
- $groups = array();
- // Build the array of saved group data.
- for ( $i = 0; $i < count( $settings->groups ); $i++ ) {
- if ( empty( $settings->groups[ $i ] ) ) {
- continue;
- }
- $group_data = explode( '_', $settings->groups[ $i ] );
- if ( $group_data[0] != $settings->list_id ) {
- continue;
- }
- if ( ! isset( $groups[ $group_data[1] ] ) ) {
- $groups[ $group_data[1] ] = array();
- }
- $groups[ $group_data[1] ][] = $group_data[2];
- }
- // Get the subgroup names from the API and add to the $data array.
- if ( count( $groups ) > 0 ) {
- $subgroup_ids = array();
- $groups_result = $api->interestGroupings( $settings->list_id );
- if ( is_array( $groups_result ) && count( $groups_result ) > 0 ) {
- foreach ( $groups_result as $group ) {
- if ( ! isset( $groups[ $group['id'] ] ) ) {
- continue;
- }
- foreach ( $group['groups'] as $subgroup ) {
- if ( in_array( $subgroup['id'], $groups[ $group['id'] ] ) ) {
- $subgroup_ids[ $subgroup['id'] ] = true;
- }
- }
- }
- }
- $data['groups'] = $subgroup_ids;
- }
- }
- $api->subscribe( $settings->list_id, $data );
- if ( $api->getLastError() ) {
- $response['error'] = sprintf(
- __( 'There was an error subscribing to MailChimp. %s', 'fl-builder' ),
- $api->getLastError()
- );
- }
- } catch ( Exception $e ) {
- $response['error'] = $e->getMessage();
- }// Try catch().
- }
- return $response;
- }
- }
|