RetailCRM-Mirror/woocommerce-module
1
0
Fork 0
mirror of synced 2025-04-06 07:13:33 +03:00
Code Issues Projects Releases Wiki Activity

WIP: corporate customers support

Browse source
This commit is contained in:
Pavel 2019-11-12 17:22:14 +03:00
parent 055f8a6f83
commit e2f56ad54f
7 changed files with 1470 additions and 156 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

901
src/include/api/class-wc-retailcrm-client-v5.php
View file

File diff suppressed because it is too large Load diff

8
src/include/api/class-wc-retailcrm-proxy.php
View file

@ -47,6 +47,10 @@ if ( ! class_exists( 'WC_Retailcrm_Proxy' ) ) :
try {
$response = call_user_func_array(array($this->retailcrm, $method), $arguments);
if (is_string($response)) {
return $response;
}
if ($response->isSuccessful()) {
$result = ' Ok';
} else {
@ -57,8 +61,8 @@ if ( ! class_exists( 'WC_Retailcrm_Proxy' ) ) :
);
if (isset($response['errors'])) {
foreach ($response['errors'] as $error) {
$result .= " $error";
foreach ($response['errors'] as $key => $error) {
$result .= " [$key] => $error";
}
}
}

466
src/include/class-wc-retailcrm-customers.php
View file

@ -16,7 +16,7 @@ if (!class_exists('WC_Retailcrm_Customers')) :
const CUSTOMER_ROLE = 'customer';
/** @var bool | WC_Retailcrm_Proxy */
/** @var bool | WC_Retailcrm_Proxy | \WC_Retailcrm_Client_V5 */
protected $retailcrm;
/** @var array */
@ -28,6 +28,18 @@ if (!class_exists('WC_Retailcrm_Customers')) :
/** @var array */
private $customer = array();
/** @var array */
private $customerCorporate = array();
/** @var array */
private $customerCorporateContact = array();
/** @var array */
private $customerCorporateCompany = array();
/** @var array */
private $customerCorporateAddress = array();
/**
* WC_Retailcrm_Customers constructor.
*
@ -42,6 +54,79 @@ if (!class_exists('WC_Retailcrm_Customers')) :
$this->customer_address = $customer_address;
}
/**
* Returns true if corporate customers are enabled and accessible
*
* @param WC_Retailcrm_Client_V5|\WC_Retailcrm_Proxy $apiClient
*
* @return bool
*/
public static function isCorporateEnabledInApi($apiClient)
{
if (is_object($apiClient)) {
$requiredMethods = array(
"/api/customers-corporate",
"/api/customers-corporate/create",
"/api/customers-corporate/fix-external-ids",
"/api/customers-corporate/notes",
"/api/customers-corporate/notes/create",
"/api/customers-corporate/notes/{id}/delete",
"/api/customers-corporate/history",
"/api/customers-corporate/upload",
"/api/customers-corporate/{externalId}",
"/api/customers-corporate/{externalId}/edit"
);
$credentials = $apiClient->credentials();
if ($credentials && isset($credentials['credentials'])) {
$existingMethods = array_filter(
$credentials['credentials'],
function ($val) use ($requiredMethods) {
return in_array($val, $requiredMethods);
}
);
return count($requiredMethods) == count($existingMethods);
}
}
return false;
}
/**
* Is corporate customers enabled in provided API
*
* @return bool
*/
public function isCorporateEnabled()
{
if (!$this->retailcrm) {
return false;
}
return static::isCorporateEnabledInApi($this->retailcrm);
}
/**
* Returns true if provided customer has company name in billing address.
* Note: customer can have company name in address which was added after synchronization.
* In that case customer will not be corporate, but this method will return true.
*
* @param \WC_Customer $customer
*
* @return bool
*/
public static function customerPossiblyCorporate($customer)
{
if (!($customer instanceof WC_Customer)) {
return false;
}
return !empty($customer->get_billing_company());
}
/**
* Upload customers to CRM
*
@ -55,7 +140,9 @@ if (!class_exists('WC_Retailcrm_Customers')) :
}
$users = get_users(array('include' => $ids));
$corporateEnabled = $this->isCorporateEnabled();
$data_customers = array();
$data_corporate = array();
foreach ($users as $user) {
if (!\in_array(self::CUSTOMER_ROLE, $user->roles)) {
@ -63,7 +150,19 @@ if (!class_exists('WC_Retailcrm_Customers')) :
}
$customer = $this->wcCustomerGet($user->ID);
$this->processCustomer($customer);
if ($corporateEnabled && static::customerPossiblyCorporate($customer)) {
$this->processCorporateCustomer($customer);
$data_corporate[] = array(
'customer' => $this->customerCorporate,
'address' => $this->customerCorporateAddress,
'company' => $this->customerCorporateCompany,
'contact' => $this->customerCorporateContact
);
} else {
$this->processCustomer($customer);
$data_customers[] = $this->customer;
}
$data_customers[] = $this->customer;
}
@ -85,6 +184,38 @@ if (!class_exists('WC_Retailcrm_Customers')) :
* @return mixed
*/
public function createCustomer($customer)
{
if ($this->isCorporateEnabled() && static::customerPossiblyCorporate($customer)) {
return $this->createCorporateCustomer($customer);
} else {
return $this->createRegularCustomer($customer);
}
}
/**
* Update customer in CRM
*
* @param $customer
*
* @return void|\WC_Customer
*/
public function updateCustomer($customer)
{
if ($this->isCorporateEnabled() && static::customerPossiblyCorporate($customer)) {
return $this->updateCorporateCustomer($customer);
} else {
return $this->updateRegularCustomer($customer);
}
}
/**
* Create regular customer in CRM
*
* @param int | WC_Customer $customer
*
* @return mixed
*/
public function createRegularCustomer($customer)
{
if (!$this->retailcrm) {
return null;
@ -111,13 +242,13 @@ if (!class_exists('WC_Retailcrm_Customers')) :
}
/**
* Edit customer in CRM
* Edit regular customer in CRM
*
* @param int $customer_id
*
* @return WC_Customer $customer
*/
public function updateCustomer($customer_id)
public function updateRegularCustomer($customer_id)
{
if (!$this->retailcrm) {
return;
@ -133,6 +264,231 @@ if (!class_exists('WC_Retailcrm_Customers')) :
return $customer;
}
/**
* Create corporate customer in CRM
*
* @param int | WC_Customer $customer
*
* @return mixed
*/
public function createCorporateCustomer($customer)
{
if (!$this->retailcrm) {
return null;
}
if (is_int($customer)) {
$customer = $this->wcCustomerGet($customer);
}
if (!$customer instanceof WC_Customer) {
return null;
}
if ($customer->get_role() == self::CUSTOMER_ROLE) {
$this->processCorporateCustomer($customer);
$response = $this->retailcrm->customersCorporateCreate($this->customerCorporate);
return $this->fillCorporateCustomer($response);
}
return null;
}
/**
* Edit customer in CRM
*
* @param int $customer_id
*
* @return WC_Customer|void $customer
*/
public function updateCorporateCustomer($customer_id)
{
if (!$this->retailcrm) {
return;
}
$customer = $this->wcCustomerGet($customer_id);
if ($customer->get_role() == self::CUSTOMER_ROLE){
$this->processCorporateCustomer($customer);
$response = $this->retailcrm->customersCorporateGet($this->customerCorporate['externalId']);
$this->fillCorporateCustomer($response);
}
return $customer;
}
/**
* Fills corporate customer with required data after customer was created or updated.
* Create or update response after sending customer must be passed.
*
* @param \WC_Retailcrm_Response $response
*
* @return \WC_Retailcrm_Customer_Corporate_Response|null
*/
protected function fillCorporateCustomer($response)
{
$customerData = array();
$addressId = 0;
$companyId = 0;
$contactId = 0;
$contactExternalId = '';
if (!$response->isSuccessful()) {
return null;
}
if ($response->offsetExists('customerCorporate') && isset($response['customerCorporate']['id'])) {
$customerData = $response['customerCorporate'];
} else {
$customerData = $response;
}
if (!empty($customerData['id'])) {
$customerData = $this->retailcrm->customersCorporateGet($customerData['id'], 'id');
if ($customerData->isSuccessful() && isset($customerData['customerCorporate'])) {
$this->customerCorporate = $customerData['customerCorporate'];
$customerData = $customerData['customerCorporate'];
// Create main address or obtain existing address
if (empty($customerData['mainAddress'])) {
$addressCreateResponse = $this->retailcrm->customersCorporateAddressesCreate(
$customerData['id'],
$this->customerCorporateAddress,
'id'
);
if ($addressCreateResponse->isSuccessful() && isset($addressCreateResponse['id'])) {
$this->customerCorporateAddress['id'] = $addressCreateResponse['id'];
$addressId = (int) $addressCreateResponse['id'];
}
} else {
$addressEditResponse = $this->retailcrm->customersCorporateAddressesEdit(
$customerData['id'],
$customerData['mainAddress']['id'],
$this->customerCorporateAddress,
'id',
'id'
);
if ($addressEditResponse->isSuccessful() && isset($addressEditResponse['id'])) {
$this->customerCorporateAddress['id'] = $addressEditResponse['id'];
$addressId = (int) $addressEditResponse['id'];
}
}
// Update address in company if address was obtained / created
if (!empty($this->customerCorporateCompany)
&& isset($this->customerCorporateAddress['id'])
) {
$this->customerCorporateCompany['address'] = array(
'id' => $this->customerCorporateAddress['id']
);
}
// Create main company or obtain existing
if (empty($customerData['mainCompany'])) {
$companyCreateResponse = $this->retailcrm->customersCorporateCompaniesCreate(
$customerData['id'],
$this->customerCorporateCompany,
'id'
);
if ($companyCreateResponse->isSuccessful() && isset($companyCreateResponse['id'])) {
$this->customerCorporateCompany['id'] = $companyCreateResponse['id'];
$companyId = (int) $companyCreateResponse['id'];
}
} else {
$companyEditResponse = $this->retailcrm->customersCorporateCompaniesEdit(
$customerData['id'],
$customerData['mainCompany']['id'],
$this->customerCorporateCompany,
'id',
'id'
);
if ($companyEditResponse->isSuccessful() && isset($companyEditResponse['id'])) {
$this->customerCorporateCompany['id'] = $companyEditResponse['id'];
$companyId = (int) $companyEditResponse['id'];
}
}
// Create main customer or obtain existing
if (empty($customerData['mainCustomerContact'])) {
$contactCustomerCreated = false;
$contactCustomerGetResponse =
$this->retailcrm->customersGet($this->customerCorporateContact['externalId']);
if ($contactCustomerGetResponse->isSuccessful() && isset($contactCustomerGetResponse['customer'])) {
$this->customerCorporateContact['id'] = $contactCustomerGetResponse['customer']['id'];
$this->retailcrm->customersEdit($this->customerCorporateContact, 'id');
$contactId = (int) $contactCustomerGetResponse['customer']['id'];
$contactExternalId = $this->customerCorporateContact['externalId'];
$contactCustomerCreated = true;
} else {
$contactCustomerCreateResponse = $this->retailcrm->customersCreate($this->customerCorporateContact);
if ($contactCustomerCreateResponse->isSuccessful() && isset($contactCustomerCreateResponse['id'])) {
$contactId = (int) $contactCustomerCreateResponse['id'];
$contactExternalId = $this->customerCorporateContact['externalId'];
$contactCustomerCreated = true;
}
}
if ($contactCustomerCreated) {
$contactPair = array(
'isMain' => true,
'customer' => array(
'id' => $contactId,
'externalId' => $contactExternalId,
'site' => $this->retailcrm->getSingleSiteForKey()
)
);
// Update company in contact in company was obtained / created
if (!empty($this->customerCorporateContact)
&& isset($this->customerCorporateCompany['id'])
) {
$contactPair['companies'] = array(
array(
'company' => array(
'id' => $this->customerCorporateCompany['id']
)
)
);
}
$this->retailcrm->customersCorporateContactsCreate(
$customerData['id'],
$contactPair,
'id'
);
}
} else {
$this->customerCorporateContact['id'] = $customerData['mainCustomerContact']['customer']['id'];
$this->retailcrm->customersEdit($this->customerCorporateContact, 'id');
$contactId = (int) $this->customerCorporateContact['id'];
$contactExternalId = $this->customerCorporateContact['externalId'];
}
}
return new WC_Retailcrm_Customer_Corporate_Response(
isset($this->customerCorporate['id']) ? $this->customerCorporate['id'] : 0,
$this->customerCorporate['externalId'],
$addressId,
$companyId,
$contactId,
$contactExternalId
);
}
return null;
}
/**
* Process customer
*
@ -165,6 +521,68 @@ if (!class_exists('WC_Retailcrm_Customers')) :
$this->customer = apply_filters('retailcrm_process_customer', $data_customer, $customer);
}
/**
* Process corporate customer
*
* @param WC_Customer $customer
*
* @return void
*/
protected function processCorporateCustomer($customer)
{
$createdAt = $customer->get_date_created();
$firstName = $customer->get_first_name();
$data_contact = array(
'createdAt' => $createdAt->date('Y-m-d H:i:s'),
'firstName' => $firstName ? $firstName : $customer->get_username(),
'lastName' => $customer->get_last_name(),
'email' => $customer->get_email(),
'address' => $this->customer_address->build($customer)->get_data()
);
$data_company = array(
'isMain' => true,
'name' => $customer->get_billing_company()
);
$data_customer = array(
'externalId' => $customer->get_id(),
'nickName' => $data_contact['firstName']
);
if ($customer->get_id() > 0) {
$data_contact['externalId'] = static::getContactPersonExternalId($customer->get_id());
}
if ($customer->get_billing_phone()) {
$data_contact['phones'][] = array(
'number' => $customer->get_billing_phone()
);
}
$this->customerCorporate = apply_filters(
'retailcrm_process_customer_corporate',
$data_customer,
$customer
);
$this->customerCorporateContact = apply_filters(
'retailcrm_process_customer_corporate_contact',
$data_contact,
$customer
);
$this->customerCorporateAddress = apply_filters(
'retailcrm_process_customer_corporate_address',
array_merge(
$data_contact['address'],
array('isMain' => true)
),
$customer
);
$this->customerCorporateCompany = apply_filters(
'retailcrm_process_customer_corporate_company',
$data_company,
$customer
);
}
/**
* @param array $filter
*
@ -195,6 +613,36 @@ if (!class_exists('WC_Retailcrm_Customers')) :
return false;
}
/**
* @param array $filter
*
* @return bool|array
*/
public function searchCorporateCustomer($filter)
{
if (isset($filter['externalId'])) {
$search = $this->retailcrm->customersCorporateGet($filter['externalId']);
} elseif (isset($filter['email'])) {
$search = $this->retailcrm->customersCorporateList(array('email' => $filter['email']));
}
if ($search->isSuccessful()) {
if (isset($search['customersCorporate'])) {
if (empty($search['customersCorporate'])) {
return false;
}
$customer = reset($search['customersCorporate']);
} else {
$customer = $search['customerCorporate'];
}
return $customer;
}
return false;
}
/**
* @param WC_Order $order
*
@ -234,5 +682,15 @@ if (!class_exists('WC_Retailcrm_Customers')) :
{
return $this->customer;
}
public static function getContactPersonExternalId($wpCustomerId)
{
return 'wpcontact_' . $wpCustomerId;
}
public static function getCustomerIdFromContact($contactExternalId)
{
return str_ireplace('wpcontact_', '', $contactExternalId);
}
}
endif;

123
src/include/class-wc-retailcrm-orders.php
View file

@ -115,49 +115,134 @@ if ( ! class_exists( 'WC_Retailcrm_Orders' ) ) :
/**
* Create order
*
* @param $order_id
* @param $order_id
*
* @param bool $forceRegularCustomer
*
* @return mixed
* @throws \Exception
*/
public function orderCreate($order_id)
public function orderCreate($order_id, $forceRegularCustomer = false)
{
if (!$this->retailcrm) {
return null;
}
$isCorporateEnabled = $forceRegularCustomer ? false : WC_Retailcrm_Customers::isCorporateEnabledInApi($this->retailcrm);
$wcOrder = wc_get_order($order_id);
$this->processOrder($wcOrder);
$wpUser = $wcOrder->get_user();
if ($wpUser instanceof WP_User) {
$wpUserId = (int)$wpUser->get('ID');
$foundCustomer = $this->customers->searchCustomer(array(
'externalId' => $wpUserId
));
$wooCustomer = new WC_Customer($wpUserId);
if (empty($foundCustomer)) {
$customerId = $this->customers->createCustomer($wpUserId);
if ($isCorporateEnabled && WC_Retailcrm_Customers::customerPossiblyCorporate($wooCustomer)) {
$foundRegularCustomer = $this->customers->searchCustomer(array(
'externalId' => $wpUserId
));
if (!empty($customerId)) {
$this->order['customer']['id'] = $customerId;
// If regular customer was found - create order with it.
if (!empty($foundRegularCustomer)) {
return $this->orderCreate($order_id, true);
}
$foundCustomer = $this->customers->searchCorporateCustomer(array(
'externalId' => $wpUserId
));
if (empty($foundCustomer)) {
$customerData = $this->customers->createCorporateCustomer($wpUserId);
if ($customerData instanceof WC_Retailcrm_Customer_Corporate_Response) {
if (!empty($customerData->getId())) {
$this->order['customer']['id'] = $customerData->getId();
}
if (!empty($customerData->getContactId())) {
$this->order['contact']['id'] = $customerData->getContactId();
}
if (!empty($customerData->getContactExternalId())) {
$this->order['contact']['externalId'] = $customerData->getContactExternalId();
}
}
} else {
$this->order['customer']['externalId'] = $foundCustomer['externalId'];
if (isset($foundCustomer['mainCustomerContact']['customer']['id'])) {
$this->order['contact']['id'] = $foundCustomer['mainCustomerContact']['customer']['id'];
}
}
} else {
$this->order['customer']['externalId'] = $foundCustomer['externalId'];
$foundCustomer = $this->customers->searchCustomer(array(
'externalId' => $wpUserId
));
if (empty($foundCustomer)) {
$customerId = $this->customers->createRegularCustomer($wpUserId);
if (!empty($customerId)) {
$this->order['customer']['id'] = $customerId;
}
} else {
$this->order['customer']['externalId'] = $foundCustomer['externalId'];
}
}
} else {
$foundCustomer = $this->customers->searchCustomer(array(
'email' => $wcOrder->get_billing_email()
));
$wcCustomer = $this->customers->buildCustomerFromOrderData($wcOrder);
if (empty($foundCustomer)) {
$wcCustomer = $this->customers->buildCustomerFromOrderData($wcOrder);
$customerId = $this->customers->createCustomer($wcCustomer);
if ($isCorporateEnabled && WC_Retailcrm_Customers::customerPossiblyCorporate($wcCustomer)) {
$foundRegularCustomer = $this->customers->searchCustomer(array(
'email' => $wcOrder->get_billing_email()
));
if (!empty($customerId)) {
$this->order['customer']['id'] = $customerId;
// If regular customer was found - create order with it.
if (!empty($foundRegularCustomer)) {
return $this->orderCreate($order_id, true);
}
$foundCustomer = $this->customers->searchCorporateCustomer(array(
'email' => $wcOrder->get_billing_email()
));
if (empty($foundCustomer)) {
$customerData = $this->customers->createCorporateCustomer($wcCustomer);
if ($customerData instanceof WC_Retailcrm_Customer_Corporate_Response) {
if (!empty($customerData->getId())) {
$this->order['customer']['id'] = $customerData->getId();
}
if (!empty($customerData->getContactId())) {
$this->order['contact']['id'] = $customerData->getContactId();
}
if (!empty($customerData->getContactExternalId())) {
$this->order['contact']['externalId'] = $customerData->getContactExternalId();
}
}
} else {
$this->order['customer']['externalId'] = $foundCustomer['externalId'];
if (isset($foundCustomer['mainCustomerContact']['customer']['id'])) {
$this->order['contact']['id'] = $foundCustomer['mainCustomerContact']['customer']['id'];
}
}
} else {
$this->order['customer']['externalId'] = $foundCustomer['externalId'];
$foundCustomer = $this->customers->searchCustomer(array(
'email' => $wcOrder->get_billing_email()
));
if (empty($foundCustomer)) {
$customerId = $this->customers->createRegularCustomer($wcCustomer);
if (!empty($customerId)) {
$this->order['customer']['id'] = $customerId;
}
} else {
$this->order['customer']['externalId'] = $foundCustomer['externalId'];
}
}
}

123
src/include/customer/class-wc-retailcrm-customer-corporate-response.php Normal file
View file

@ -0,0 +1,123 @@
<?php
/**
* PHP version 5.3
*
* @category Integration
* @author RetailCRM <integration@retailcrm.ru>
* @license http://retailcrm.ru Proprietary
* @link http://retailcrm.ru
* @see http://help.retailcrm.ru
*/
if (!class_exists('WC_Retailcrm_Customer_Corporate_Response')) :
/**
* Class WC_Retailcrm_Customer_Corporate_Response
*/
class WC_Retailcrm_Customer_Corporate_Response
{
/**
* @var int $corporateId
*/
private $corporateId;
/**
* @var string $corporateExternalId
*/
private $corporateExternalId;
/**
* @var int $addressId
*/
private $addressId;
/**
* @var int $companyId
*/
private $companyId;
/**
* @var int $contactId
*/
private $contactId;
/**
* @var int $contactExternalId
*/
private $contactExternalId;
/**
* WC_Retailcrm_Customer_Corporate_Response constructor.
*
* @param int $corporateId
* @param string $corporateExternalId
* @param int $addressId
* @param int $companyId
* @param int $contactId
* @param string $contactExternalId
*/
public function __construct(
$corporateId,
$corporateExternalId,
$addressId,
$companyId,
$contactId,
$contactExternalId
) {
$this->corporateId = $corporateId;
$this->corporateExternalId = $corporateExternalId;
$this->addressId = $addressId;
$this->companyId = $companyId;
$this->contactId = $contactId;
$this->contactExternalId = $contactExternalId;
}
/**
* @return int
*/
public function getId()
{
return $this->corporateId;
}
/**
* @return string
*/
public function getExternalId()
{
return $this->corporateExternalId;
}
/**
* @return int
*/
public function getAddressId()
{
return $this->addressId;
}
/**
* @return int
*/
public function getCompanyId()
{
return $this->companyId;
}
/**
* @return int
*/
public function getContactId()
{
return $this->contactId;
}
/**
* @return int
*/
public function getContactExternalId()
{
return $this->contactExternalId;
}
}
endif;

1
src/retailcrm.php
View file

@ -47,6 +47,7 @@ if (!class_exists( 'WC_Integration_Retailcrm')) :
require_once(dirname(__FILE__ ) . '/include/order/class-wc-retailcrm-order-item.php');
require_once(dirname(__FILE__ ) . '/include/order/class-wc-retailcrm-order-address.php');
require_once(dirname(__FILE__ ) . '/include/customer/class-wc-retailcrm-customer-address.php');
require_once(dirname(__FILE__ ) . '/include/customer/class-wc-retailcrm-customer-corporate-response.php');
require_once(dirname(__FILE__ ) . '/include/class-wc-retailcrm-base.php');
require_once(dirname(__FILE__ ) . '/include/functions.php');
add_filter('woocommerce_integrations', array( $this, 'add_integration'));

4
tests/test-wc-retailcrm-customers.php
View file

@ -80,7 +80,7 @@ class WC_Retailcrm_Customers_Test extends WC_Retailcrm_Test_Case_Helper
public function test_create_customer($retailcrm)
{
$retailcrm_customer = $this->getRetailcrmCustomer($retailcrm);
$id = $retailcrm_customer->createCustomer($this->customer->get_id());
$id = $retailcrm_customer->createRegularCustomer($this->customer->get_id());
$customer_send = $retailcrm_customer->getCustomer();
if ($retailcrm) {
@ -103,7 +103,7 @@ class WC_Retailcrm_Customers_Test extends WC_Retailcrm_Test_Case_Helper
public function test_update_customer($retailcrm)
{
$retailcrm_customer = $this->getRetailcrmCustomer($retailcrm);
$customer = $retailcrm_customer->updateCustomer($this->customer->get_id());
$customer = $retailcrm_customer->updateRegularCustomer($this->customer->get_id());
$customer_send = $retailcrm_customer->getCustomer();
if ($retailcrm) {