| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279 |
- <?php
- /**
- * Helper class for the iContact API.
- *
- * @since 1.5.4
- */
- final class FLBuilderServiceIContact extends FLBuilderService {
- /**
- * The ID for this service.
- *
- * @since 1.5.4
- * @var string $id
- */
- public $id = 'icontact';
- /**
- * @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 array $data {
- * @type string $username A valid username.
- * @type string $app_id A valid app ID.
- * @type string $app_password A valid app password.
- * }
- * @return object The API instance.
- */
- public function get_api( $data ) {
- if ( $this->api_instance ) {
- return $this->api_instance;
- }
- if ( ! class_exists( 'iContactApi' ) ) {
- require_once FL_BUILDER_DIR . 'includes/vendor/icontact/iContactApi.php';
- }
- iContactApi::getInstance()->setConfig( $data );
- $this->api_instance = iContactApi::getInstance();
- return $this->api_instance;
- }
- /**
- * Test the API connection.
- *
- * @since 1.5.4
- * @param array $fields {
- * @type string $username A valid username.
- * @type string $app_id A valid app ID.
- * @type string $app_password A valid app password.
- * }
- * @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 a username.
- if ( ! isset( $fields['username'] ) || empty( $fields['username'] ) ) {
- $response['error'] = __( 'Error: You must provide a username.', 'fl-builder' );
- } elseif ( ! isset( $fields['app_id'] ) || empty( $fields['app_id'] ) ) {
- $response['error'] = __( 'Error: You must provide a app ID.', 'fl-builder' );
- } // Make sure we have an app password.
- elseif ( ! isset( $fields['app_password'] ) || empty( $fields['app_password'] ) ) {
- $response['error'] = __( 'Error: You must provide a app password.', 'fl-builder' );
- } // Try to connect and store the connection data.
- else {
- $api = $this->get_api( array(
- 'apiUsername' => $fields['username'],
- 'appId' => $fields['app_id'],
- 'apiPassword' => $fields['app_password'],
- ));
- try {
- $api->getLists();
- $response['data'] = array(
- 'username' => $fields['username'],
- 'app_id' => $fields['app_id'],
- 'app_password' => $fields['app_password'],
- );
- } catch ( Exception $e ) {
- $errors = $api->getErrors();
- $response['error'] = sprintf( __( 'Error: Could not connect to iContact. %s', 'fl-builder' ), $errors[0] );
- }
- }
- 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( 'username', array(
- 'row_class' => 'fl-builder-service-connect-row',
- 'class' => 'fl-builder-service-connect-input',
- 'type' => 'text',
- 'label' => __( 'Username', 'fl-builder' ),
- 'help' => __( 'Your iContact username.', 'fl-builder' ),
- 'preview' => array(
- 'type' => 'none',
- ),
- ));
- FLBuilder::render_settings_field( 'app_id', array(
- 'row_class' => 'fl-builder-service-connect-row',
- 'class' => 'fl-builder-service-connect-input',
- 'type' => 'text',
- 'label' => __( 'App ID', 'fl-builder' ),
- 'help' => __( 'Your iContact app ID.', 'fl-builder' ),
- 'preview' => array(
- 'type' => 'none',
- ),
- ));
- FLBuilder::render_settings_field( 'app_password', array(
- 'row_class' => 'fl-builder-service-connect-row',
- 'class' => 'fl-builder-service-connect-input',
- 'type' => 'text',
- 'label' => __( 'App Password', 'fl-builder' ),
- 'help' => __( 'Your iContact app password.', 'fl-builder' ),
- 'description' => sprintf( __( 'You must <a%1$s>create an app</a> in iContact to obtain an app ID and password. Please see <a%2$s>the iContact docs</a> for complete instructions.', 'fl-builder' ), ' href="https://app.icontact.com/icp/core/registerapp/" target="_blank"', ' href="http://www.icontact.com/developerportal/api-documentation/vocus-register-your-app/" target="_blank"' ),
- '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 ) {
- $account_data = $this->get_account_data( $account );
- $api = $this->get_api( array(
- 'apiUsername' => $account_data['username'],
- 'appId' => $account_data['app_id'],
- 'apiPassword' => $account_data['app_password'],
- ));
- $response = array(
- 'error' => false,
- 'html' => '',
- );
- try {
- $lists = $api->getLists();
- $response['html'] = $this->render_list_field( $lists, $settings );
- } catch ( Exception $e ) {
- $errors = $api->getErrors();
- $response['error'] = sprintf( __( 'Error: Could not connect to iContact. %s', 'fl-builder' ), $errors[0] );
- }
- 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' ),
- );
- foreach ( $lists as $id => $list ) {
- // @codingStandardsIgnoreLine
- $options[ $list->listId ] = $list->name;
- }
- FLBuilder::render_settings_field( 'list_id', array(
- 'row_class' => 'fl-builder-service-field-row',
- 'class' => 'fl-builder-service-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();
- }
- /**
- * Subscribe an email address to iContact.
- *
- * @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 iContact. The account is no longer connected.', 'fl-builder' );
- } else {
- $data = array(
- 'email' => $email,
- );
- $api = $this->get_api( array(
- 'apiUsername' => $account_data['username'],
- 'appId' => $account_data['app_id'],
- 'apiPassword' => $account_data['app_password'],
- ));
- try {
- if ( $name ) {
- $names = explode( ' ', $name );
- $data['first_name'] = null;
- $data['last_name'] = null;
- if ( isset( $names[0] ) ) {
- $data['first_name'] = $names[0];
- }
- if ( isset( $names[1] ) ) {
- $data['last_name'] = $names[1];
- }
- $result = $api->addContact( $data['email'], 'normal', null, $data['first_name'], $data['last_name'] );
- } else {
- $result = $api->addContact( $data['email'] );
- }
- // @codingStandardsIgnoreLine
- $api->subscribeContactToList( $result->contactId, $settings->list_id );
- } catch ( Exception $e ) {
- $errors = $api->getErrors();
- $response['error'] = sprintf( __( 'There was an error subscribing to iContact. %s', 'fl-builder' ), $errors[0] );
- }
- }
- return $response;
- }
- }
|