diff --git a/CHANGELOG.md b/CHANGELOG.md index 496c79f..e5983d2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## 2022-09-30 4.5.0 +* Fix path for js scripts +* Migrating to PHP 7.0. +* Change logic work with ICML catalog: added streaming generation, added generators in the ICML generation process. +* Change logic work with address + ## 2022-09-05 4.4.9 * Fix bug with product tax diff --git a/README.md b/README.md index 663d82d..2473833 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ [![Build Status](https://github.com/retailcrm/woocommerce-module/workflows/woo/badge.svg)](https://github.com/retailcrm/woocommerce-module/actions) [![Coverage](https://img.shields.io/codecov/c/gh/retailcrm/woocommerce-module/master.svg?logo=github)](https://codecov.io/gh/retailcrm/woocommerce-module) [![GitHub release](https://img.shields.io/github/release/retailcrm/woocommerce-module.svg?logo=codecov)](https://github.com/retailcrm/woocommerce-module/releases) -[![PHP version](https://img.shields.io/badge/PHP->=5.4-blue.svg?logo=php)](https://php.net/) +[![PHP version](https://img.shields.io/badge/PHP->=7.0-blue.svg?logo=php)](https://php.net/) Woocommerce-module ================== diff --git a/VERSION b/VERSION index e49188c..ae15394 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -4.4.9 \ No newline at end of file +4.5.0 \ No newline at end of file diff --git a/composer.json b/composer.json index c287da6..afcdb46 100644 --- a/composer.json +++ b/composer.json @@ -10,7 +10,8 @@ ], "minimum-stability": "dev", "require": { - "ext-simplexml": "*" + "ext-simplexml": "*", + "ext-xmlwriter": "*" }, "require-dev": { "ext-json": "*", diff --git a/resources/pot/retailcrm-es_ES.pot b/resources/pot/retailcrm-es_ES.pot index 36b5a15..dcab8f6 100644 --- a/resources/pot/retailcrm-es_ES.pot +++ b/resources/pot/retailcrm-es_ES.pot @@ -339,3 +339,6 @@ msgstr "Borrar" msgid "Cron tasks cleared" msgstr "Trabajos cron borrados" + +msgid "Untitled" +msgstr "Intitulado" \ No newline at end of file diff --git a/resources/pot/retailcrm-ru_RU.pot b/resources/pot/retailcrm-ru_RU.pot index b40b676..375680b 100644 --- a/resources/pot/retailcrm-ru_RU.pot +++ b/resources/pot/retailcrm-ru_RU.pot @@ -348,3 +348,7 @@ msgstr "Очистить" msgid "Cron tasks cleared" msgstr "Cron задачи очищены" + +msgid "Untitled" +msgstr "Без названия" + diff --git a/src/include/abstracts/class-wc-retailcrm-abstract-builder.php b/src/include/abstracts/class-wc-retailcrm-abstract-builder.php index 1c6ad5f..a3651e9 100644 --- a/src/include/abstracts/class-wc-retailcrm-abstract-builder.php +++ b/src/include/abstracts/class-wc-retailcrm-abstract-builder.php @@ -1,6 +1,7 @@ - * @license https://opensource.org/licenses/MIT MIT License - * @link http://retailcrm.ru/docs/Developers/ApiVersion5 - */ - if (!class_exists('WC_Retailcrm_Request')) { include_once(WC_Integration_Retailcrm::checkCustomFile('include/api/class-wc-retailcrm-request.php')); } @@ -20,6 +8,17 @@ if (!class_exists('WC_Retailcrm_Response')) { include_once(WC_Integration_Retailcrm::checkCustomFile('include/api/class-wc-retailcrm-response.php')); } +/** + * PHP version 7.0 + * + * Class WC_Retailcrm_Client_V5 - Api Client V5 class. + * + * @category Integration + * @package WC_Retailcrm_Client + * @author RetailCRM + * @license https://opensource.org/licenses/MIT MIT License + * @link http://retailcrm.ru/docs/Developers/ApiVersion5 + */ class WC_Retailcrm_Client_V5 { protected $client; diff --git a/src/include/api/class-wc-retailcrm-exception-curl.php b/src/include/api/class-wc-retailcrm-exception-curl.php index 9e53624..0117de4 100644 --- a/src/include/api/class-wc-retailcrm-exception-curl.php +++ b/src/include/api/class-wc-retailcrm-exception-curl.php @@ -1,6 +1,7 @@ - * @license https://opensource.org/licenses/MIT MIT License - * @link http://retailcrm.ru/docs/Developers/ApiVersion5 - */ if (!class_exists('WC_Retailcrm_Proxy')) : + /** + * PHP version 7.0 + * + * Class WC_Retailcrm_Proxy - RetailCRM Integration. + * + * @category Integration + * @package WC_Retailcrm_Proxy + * @author RetailCRM + * @license https://opensource.org/licenses/MIT MIT License + * @link http://retailcrm.ru/docs/Developers/ApiVersion5 + */ class WC_Retailcrm_Proxy { protected $retailcrm; diff --git a/src/include/api/class-wc-retailcrm-request.php b/src/include/api/class-wc-retailcrm-request.php index 9fdb45b..82d14d3 100644 --- a/src/include/api/class-wc-retailcrm-request.php +++ b/src/include/api/class-wc-retailcrm-request.php @@ -1,15 +1,4 @@ - * @license https://opensource.org/licenses/MIT MIT License - * @link http://retailcrm.ru/docs/Developers/ApiVersion5 - */ if (!class_exists('WC_Retailcrm_Exception_Curl')) { include_once(WC_Integration_Retailcrm::checkCustomFile('include/api/class-wc-retailcrm-exception-curl.php')); @@ -19,6 +8,17 @@ if (!class_exists('WC_Retailcrm_Response')) { include_once(WC_Integration_Retailcrm::checkCustomFile('include/api/class-wc-retailcrm-response.php')); } +/** + * PHP version 7.0 + * + * Class WC_Retailcrm_Request - Request class. + * + * @category Integration + * @package WC_Retailcrm_Request + * @author RetailCRM + * @license https://opensource.org/licenses/MIT MIT License + * @link http://retailcrm.ru/docs/Developers/ApiVersion5 + */ class WC_Retailcrm_Request { const METHOD_GET = 'GET'; diff --git a/src/include/api/class-wc-retailcrm-response.php b/src/include/api/class-wc-retailcrm-response.php index 6b2576f..48e4c9a 100644 --- a/src/include/api/class-wc-retailcrm-response.php +++ b/src/include/api/class-wc-retailcrm-response.php @@ -1,6 +1,11 @@ - * @license http://retailcrm.ru Proprietary - * @link http://retailcrm.ru - * @see http://help.retailcrm.ru - */ - if (!class_exists('WC_Retailcrm_Base')) { if (!class_exists('WC_Retailcrm_Abstracts_Settings')) { include_once(WC_Integration_Retailcrm::checkCustomFile('include/abstracts/class-wc-retailcrm-abstracts-settings.php')); } + /** + * PHP version 7.0 + * + * Class WC_Retailcrm_Base - Main settings plugin. + * + * @category Integration + * @author RetailCRM + * @license http://retailcrm.ru Proprietary + * @link http://retailcrm.ru + * @see http://help.retailcrm.ru + */ class WC_Retailcrm_Base extends WC_Retailcrm_Abstracts_Settings { /** @var WC_Retailcrm_Proxy|WC_Retailcrm_Client_V5|bool */ diff --git a/src/include/class-wc-retailcrm-customers.php b/src/include/class-wc-retailcrm-customers.php index f0a4211..c6c34a3 100644 --- a/src/include/class-wc-retailcrm-customers.php +++ b/src/include/class-wc-retailcrm-customers.php @@ -1,17 +1,17 @@ - * @license http://retailcrm.ru Proprietary - * @link http://retailcrm.ru - * @see http://help.retailcrm.ru - */ if (!class_exists('WC_Retailcrm_Customers')) : + /** + * PHP version 7.0 + * + * Class WC_Retailcrm_Customers - Allows transfer data customers with CMS. + * + * @category Integration + * @author RetailCRM + * @license http://retailcrm.ru Proprietary + * @link http://retailcrm.ru + * @see http://help.retailcrm.ru + */ class WC_Retailcrm_Customers { /** @var bool | WC_Retailcrm_Proxy | \WC_Retailcrm_Client_V5 */ diff --git a/src/include/class-wc-retailcrm-daemon-collector.php b/src/include/class-wc-retailcrm-daemon-collector.php index cca9b53..670c5a3 100644 --- a/src/include/class-wc-retailcrm-daemon-collector.php +++ b/src/include/class-wc-retailcrm-daemon-collector.php @@ -1,6 +1,11 @@ - * @license http://retailcrm.ru Proprietary - * @link http://retailcrm.ru - * @see http://help.retailcrm.ru - */ if (!class_exists('WC_Retailcrm_Google_Analytics')) { + /** + * PHP version 7.0 + * + * Class WC_Retailcrm_Google_Analytics - Integration with Google Analytics. + * + * @category Integration + * @author RetailCRM + * @license http://retailcrm.ru Proprietary + * @link http://retailcrm.ru + * @see http://help.retailcrm.ru + */ class WC_Retailcrm_Google_Analytics { private static $instance; private $options; diff --git a/src/include/class-wc-retailcrm-history.php b/src/include/class-wc-retailcrm-history.php index 0157a86..96cc2e9 100644 --- a/src/include/class-wc-retailcrm-history.php +++ b/src/include/class-wc-retailcrm-history.php @@ -1,18 +1,17 @@ - * @license http://retailcrm.ru Proprietary - * @link http://retailcrm.ru - * @see http://help.retailcrm.ru - */ - if (!class_exists('WC_Retailcrm_History')) : + /** + * PHP version 7.0 + * + * Class WC_Retailcrm_History - Allows transfer data orders/customers with CRM. + * + * @category Integration + * @author RetailCRM + * @license http://retailcrm.ru Proprietary + * @link http://retailcrm.ru + * @see http://help.retailcrm.ru + */ class WC_Retailcrm_History { const PAGE_LIMIT = 25; diff --git a/src/include/class-wc-retailcrm-icml.php b/src/include/class-wc-retailcrm-icml.php index 4dbbc8a..31d486a 100644 --- a/src/include/class-wc-retailcrm-icml.php +++ b/src/include/class-wc-retailcrm-icml.php @@ -1,25 +1,20 @@ - * @license http://retailcrm.ru Proprietary - * @link http://retailcrm.ru - * @see http://help.retailcrm.ru - */ - if (!class_exists('WC_Retailcrm_Icml')) : + /** + * PHP version 7.0 + * + * Class WC_Retailcrm_Icml - Generate ICML file (catalog). + * + * @category Integration + * @author RetailCRM + * @license http://retailcrm.ru Proprietary + * @link http://retailcrm.ru + * @see http://help.retailcrm.ru + */ class WC_Retailcrm_Icml { - protected $shop; - protected $file; - protected $tmpFile; - - protected $properties = [ + const OFFER_PROPERTIES = [ 'name', 'productName', 'price', @@ -31,19 +26,11 @@ if (!class_exists('WC_Retailcrm_Icml')) : 'productActivity' ]; - protected $xml; - - /** @var SimpleXMLElement $categories */ - protected $categories; - - /** @var SimpleXMLElement $categories */ - protected $offers; - - protected $chunk = 500; - protected $fileLifeTime = 3600; - - /** @var array */ + protected $shop; + protected $file; + protected $tmpFile; protected $settings; + protected $icmlWriter; /** * WC_Retailcrm_Icml constructor. @@ -51,410 +38,125 @@ if (!class_exists('WC_Retailcrm_Icml')) : */ public function __construct() { - $this->settings = get_option(WC_Retailcrm_Base::$option_key); - $this->shop = get_bloginfo('name'); - $this->file = ABSPATH . 'simla.xml'; - $this->tmpFile = sprintf('%s.tmp', $this->file); + $this->shop = get_bloginfo('name'); + $this->file = ABSPATH . 'simla.xml'; + $this->tmpFile = sprintf('%s.tmp', $this->file); + $this->settings = get_option(WC_Retailcrm_Base::$option_key); + $this->icmlWriter = new WC_Retailcrm_Icml_Writer($this->tmpFile); } /** - * Generate file + * Generate ICML catalog. */ public function generate() { - $categories = $this->get_wc_categories_taxonomies(); + $this->icmlWriter->writeHead($this->shop); - if (file_exists($this->tmpFile)) { - if (filectime($this->tmpFile) + $this->fileLifeTime < time()) { - unlink($this->tmpFile); - $this->writeHead(); - } - } else { - $this->writeHead(); + $categories = $this->prepareCategories(); + + if (empty($categories)) { + writeBaseLogs('Can`t get categories!'); + return; } - try { - if (!empty($categories)) { - $this->writeCategories($categories); - unset($categories); - } + $this->icmlWriter->writeCategories($categories); - $status_args = $this->checkPostStatuses(); - $this->get_wc_products_taxonomies($status_args); + $offers = $this->prepareOffers(); - $dom = dom_import_simplexml(simplexml_load_file($this->tmpFile))->ownerDocument; - - $dom->formatOutput = true; - - $formatted = $dom->saveXML(); - - unset($dom, $this->xml); - - file_put_contents($this->tmpFile, $formatted); - rename($this->tmpFile, $this->file); - } catch (Exception $e) { - unlink($this->tmpFile); - } - } - - /** - * Load tmp data - * - * @return \SimpleXMLElement - */ - private function loadXml() - { - return new SimpleXMLElement( - $this->tmpFile, - LIBXML_NOENT | LIBXML_NOCDATA | LIBXML_COMPACT | LIBXML_PARSEHUGE, - true - ); - } - - /** - * Generate xml header - */ - private function writeHead() - { - $string = sprintf( - '%s', - current_time('Y-m-d H:i:s'), - html_entity_decode($this->shop) - ); - - file_put_contents($this->tmpFile, $string, LOCK_EX); - } - - /** - * Write categories in file - * - * @param $categories - */ - private function writeCategories($categories) - { - $chunkCategories = array_chunk($categories, $this->chunk); - foreach ($chunkCategories as $categories) { - $this->xml = $this->loadXml(); - - $this->categories = $this->xml->shop->categories; - $this->addCategories($categories); - - $this->xml->asXML($this->tmpFile); + if (empty($offers)) { + writeBaseLogs('Can`t get offers!'); + return; } - unset($this->categories); + $this->icmlWriter->writeOffers($offers); + + $this->icmlWriter->writeEnd(); + $this->icmlWriter->formatXml($this->tmpFile); + + rename($this->tmpFile, $this->file); } /** - * Write products in file - * - * @param $offers - */ - private function writeOffers($offers) - { - $chunkOffers = array_chunk($offers, $this->chunk); - foreach ($chunkOffers as $offers) { - $this->xml = $this->loadXml(); - - $this->offers = $this->xml->shop->offers; - $this->addOffers($offers); - - $this->xml->asXML($this->tmpFile); - } - - unset($this->offers); - } - - /** - * Add categories - * - * @param $categories - */ - private function addCategories($categories) - { - $categories = self::filterRecursive($categories); - - foreach ($categories as $category) { - if (!array_key_exists('name', $category) || !array_key_exists('id', $category)) { - continue; - } - - /** @var SimpleXMLElement $e */ - /** @var SimpleXMLElement $cat */ - - $cat = $this->categories; - $e = $cat->addChild('category'); - - $e->addAttribute('id', $category['id']); - - if (array_key_exists('parentId', $category) && $category['parentId'] > 0) { - $e->addAttribute('parentId', $category['parentId']); - } - - $e->addChild('name', $category['name']); - - if (array_key_exists('picture', $category)) { - $e->addChild('picture', $category['picture']); - } - } - } - - /** - * Add offers - * - * @param $offers - */ - private function addOffers($offers) - { - $offers = self::filterRecursive($offers); - - foreach ($offers as $key => $offer) { - if (!array_key_exists('id', $offer)) { - continue; - } - - $e = $this->offers->addChild('offer'); - - $e->addAttribute('id', $offer['id']); - - if (!array_key_exists('productId', $offer) || empty($offer['productId'])) { - $offer['productId'] = $offer['id']; - } - $e->addAttribute('productId', $offer['productId']); - - if (!empty($offer['quantity'])) { - $e->addAttribute('quantity', (int) $offer['quantity']); - } else { - $e->addAttribute('quantity', 0); - } - - if (isset($offer['categoryId']) && $offer['categoryId']) { - if (is_array($offer['categoryId'])) { - foreach ($offer['categoryId'] as $categoryId) { - $e->addChild('categoryId', $categoryId); - } - } else { - $e->addChild('categoryId', $offer['categoryId']); - } - } - - if (!array_key_exists('name', $offer) || empty($offer['name'])) { - $offer['name'] = 'Без названия'; - } - - if (!array_key_exists('productName', $offer) || empty($offer['productName'])) { - $offer['productName'] = $offer['name']; - } - - if (array_key_exists('picture', $offer) && !empty($offer['picture'])) { - foreach ($offer['picture'] as $urlImage) { - $e->addChild('picture', $urlImage); - } - } - - unset($offer['id'], $offer['productId'], $offer['categoryId'], $offer['quantity'], $offer['picture']); - array_walk($offer, [$this, 'setOffersProperties'], $e); - - if (array_key_exists('params', $offer) && !empty($offer['params'])) { - array_walk($offer['params'], [$this, 'setOffersParams'], $e); - } - - if (array_key_exists('dimensions', $offer)) { - $e->addChild('dimensions', $offer['dimensions']); - } - - if (array_key_exists('weight', $offer)) { - $e->addChild('weight', $offer['weight']); - } - - if (array_key_exists('tax', $offer)) { - $e->addChild('vatRate', $offer['tax']); - } - - unset($offers[$key]); - } - } - - /** - * Set offer properties - * - * @param $value - * @param $key - * @param $e - */ - private function setOffersProperties($value, $key, &$e) - { - if (in_array($key, $this->properties) && $key != 'params') { - /** @var SimpleXMLElement $e */ - $e->addChild($key, htmlspecialchars($value)); - } - } - - /** - * Set offer params - * - * @param $value - * @param $key - * @param $e - */ - private function setOffersParams($value, $key, &$e) - { - if ( - array_key_exists('code', $value) && - array_key_exists('name', $value) && - array_key_exists('value', $value) && - !empty($value['code']) && - !empty($value['name']) && - !empty($value['value']) - ) { - /** @var SimpleXMLElement $e */ - $param = $e->addChild('param', htmlspecialchars($value['value'])); - $param->addAttribute('code', $value['code']); - $param->addAttribute('name', substr(htmlspecialchars($value['name']), 0, 200)); - unset($key); - } - } - - /** - * Filter result array - * - * @param $haystack - * - * @return mixed - */ - public static function filterRecursive($haystack) - { - foreach ($haystack as $key => $value) { - if (is_array($value)) { - $haystack[$key] = self::filterRecursive($haystack[$key]); - } - - if ( - is_null($haystack[$key]) - || $haystack[$key] === '' - || (is_array($haystack[$key]) && count($haystack[$key]) == 0) - ) { - unset($haystack[$key]); - } elseif (!is_array($value)) { - $haystack[$key] = trim($value); - } - } - - return $haystack; - } - - /** - * Get WC products + * Prepare WC offers for write. * * @return void */ - private function get_wc_products_taxonomies($status_args) + private function prepareOffers() { - if (!$status_args) { - $status_args = ['publish']; + $productStatuses = $this->getProductStatuses(); + + if (!$productStatuses) { + $productStatuses = ['publish']; } - $attribute_taxonomies = wc_get_attribute_taxonomies(); - $product_attributes = []; + $page = 1; + $offerAttributes = $this->getOfferAttributes(); - foreach ($attribute_taxonomies as $product_attribute) { - $attribute_id = wc_attribute_taxonomy_name_by_id(intval($product_attribute->attribute_id)); - $product_attributes[$attribute_id] = $product_attribute->attribute_label; - } + do { + $products = wc_get_products( + [ + 'limit' => 1000, + 'status' => $productStatuses, + 'page' => $page, + 'paginate' => true, + ] + ); - $full_product_list = []; - - $products = wc_get_products( - [ - 'limit' => -1, - 'status' => $status_args - ] - ); - - foreach ($products as $offer) { - $type = $offer->get_type(); - - if (strpos($type, 'variable') !== false || strpos($type, 'variation') !== false) { - foreach ($offer->get_children() as $child_id) { - $child_product = wc_get_product($child_id); - if (!$child_product) { - continue; - } - - $this->setOffer($full_product_list, $product_attributes, $child_product, $offer); - } - } else { - $this->setOffer($full_product_list, $product_attributes, $offer); + if (empty($products)) { + writeBaseLogs('Can`t get products!'); + return; } - } - if (isset($full_product_list) && $full_product_list) { - $this->writeOffers($full_product_list); - unset($full_product_list); - } + foreach ($products->products as $offer) { + $type = $offer->get_type(); + + if (strpos($type, 'variable') !== false || strpos($type, 'variation') !== false) { + foreach ($offer->get_children() as $childId) { + $childProduct = wc_get_product($childId); + + if (!$childProduct) { + continue; + } + + yield $this->getOffer($offerAttributes, $childProduct, $offer); + } + } else { + yield $this->getOffer($offerAttributes, $offer); + } + } + + $page++; + } while ($page <= $products->max_num_pages); } /** - * Get WC categories + * Get WC offer attributes. * * @return array */ - private function get_wc_categories_taxonomies() + private function getOfferAttributes() { - $categories = []; - $taxonomy = 'product_cat'; - $orderby = 'parent'; - $show_count = 0; // 1 for yes, 0 for no - $pad_counts = 0; // 1 for yes, 0 for no - $hierarchical = 1; // 1 for yes, 0 for no - $title = ''; - $empty = 0; + $offerAttributes = []; + $attributeTaxonomies = wc_get_attribute_taxonomies(); - $args = [ - 'taxonomy' => $taxonomy, - 'orderby' => $orderby, - 'show_count' => $show_count, - 'pad_counts' => $pad_counts, - 'hierarchical' => $hierarchical, - 'title_li' => $title, - 'hide_empty' => $empty - ]; - - $wcatTerms = get_categories($args); - - foreach ($wcatTerms as $term) { - $category = [ - 'id' => $term->term_id, - 'parentId' => $term->parent, - 'name' => $term->name - ]; - - $thumbnail_id = function_exists('get_term_meta') - ? get_term_meta($term->term_id, 'thumbnail_id', true) - : get_woocommerce_term_meta($term->term_id, 'thumbnail_id', true); - $picture = wp_get_attachment_url($thumbnail_id); - - if ($picture) { - $category['picture'] = $picture; - } - - $categories[] = $category; + foreach ($attributeTaxonomies as $productAttribute) { + $attributeId = wc_attribute_taxonomy_name_by_id(intval($productAttribute->attribute_id)); + $offerAttributes[$attributeId] = $productAttribute->attribute_label; } - return $categories; + return $offerAttributes; } /** - * Set offer for icml catalog + * Get offer for ICML catalog * - * @param array $full_product_list - * @param array $product_attributes + * @param array $productAttributes * @param WC_Product $product * @param bool | WC_Product_Variable $parent * - * @return void + * @return array */ - private function setOffer(&$full_product_list, $product_attributes, $product, $parent = false) + private function getOffer(array $productAttributes, WC_Product $product, $parent = false) { $idImages = array_merge([$product->get_image_id()], $product->get_gallery_image_ids()); @@ -482,12 +184,12 @@ if (!class_exists('WC_Retailcrm_Icml')) : $params = []; if (!empty($attributes)) { - foreach ($attributes as $attribute_name => $attribute) { - $attributeValue = $product->get_attribute($attribute_name); + foreach ($attributes as $attributeName => $attribute) { + $attributeValue = $product->get_attribute($attributeName); if ($attribute['is_visible'] == 1 && !empty($attributeValue)) { $params[] = [ - 'code' => $attribute_name, - 'name' => $product_attributes[$attribute_name], + 'code' => $attributeName, + 'name' => $productAttributes[$attributeName], 'value' => $attributeValue ]; } @@ -550,10 +252,10 @@ if (!class_exists('WC_Retailcrm_Icml')) : } if (isset($this->settings['product_description'])) { - $productDescription = $this->getDescription($product); + $productDescription = $this->getOfferDescription($product); if (empty($productDescription) && $parent instanceof WC_Product_Variable) { - $this->getDescription($parent); + $this->getOfferDescription($parent); } if ($productDescription != '') { @@ -572,43 +274,91 @@ if (!class_exists('WC_Retailcrm_Icml')) : ); if (isset($productData)) { - $full_product_list[] = $productData; + return $productData; } - - unset($productData); } /** - * Get product statuses + * Get product statuses. * * @return array */ - private function checkPostStatuses() + private function getProductStatuses() { - $status_args = []; + $statuses = []; foreach (get_post_statuses() as $key => $value) { if (isset($this->settings['p_' . $key]) && $this->settings['p_' . $key] == WC_Retailcrm_Base::YES) { - $status_args[] = $key; + $statuses[] = $key; } } - return $status_args; + return $statuses; } /** - * Get product description + * Get offer description. * * @param WC_Product | WC_Product_Variable $product WC product. * * @return string */ - private function getDescription($product) + private function getOfferDescription($product) { return $this->settings['product_description'] == 'full' ? $product->get_description() : $product->get_short_description(); } - } + /** + * Prepare WC categories for write. + * + * @return array + */ + private function prepareCategories() + { + $categories = []; + $taxonomy = 'product_cat'; + $orderby = 'parent'; + $show_count = 0; // 1 for yes, 0 for no + $pad_counts = 0; // 1 for yes, 0 for no + $hierarchical = 1; // 1 for yes, 0 for no + $title = ''; + $empty = 0; + + $args = [ + 'taxonomy' => $taxonomy, + 'orderby' => $orderby, + 'show_count' => $show_count, + 'pad_counts' => $pad_counts, + 'hierarchical' => $hierarchical, + 'title_li' => $title, + 'hide_empty' => $empty + ]; + + $wcTerms = get_categories($args); + + foreach ($wcTerms as $term) { + $category = [ + 'id' => $term->term_id, + 'parentId' => $term->parent, + 'name' => $term->name + ]; + + $thumbnailId = function_exists('get_term_meta') + ? get_term_meta($term->term_id, 'thumbnail_id', true) + : get_woocommerce_term_meta($term->term_id, 'thumbnail_id', true); + + $picture = wp_get_attachment_url($thumbnailId); + + if ($picture) { + $category['picture'] = $picture; + } + + $categories[] = $category; + } + + return $categories; + } + } endif; diff --git a/src/include/class-wc-retailcrm-inventories.php b/src/include/class-wc-retailcrm-inventories.php index ccccc65..d526d96 100644 --- a/src/include/class-wc-retailcrm-inventories.php +++ b/src/include/class-wc-retailcrm-inventories.php @@ -1,17 +1,17 @@ - * @license http://retailcrm.ru Proprietary - * @link http://retailcrm.ru - * @see http://help.retailcrm.ru - */ if (!class_exists('WC_Retailcrm_Inventories')) : + /** + * PHP version 7.0 + * + * Class WC_Retailcrm_Inventories - Allows manage stocks. + * + * @category Integration + * @author RetailCRM + * @license http://retailcrm.ru Proprietary + * @link http://retailcrm.ru + * @see http://help.retailcrm.ru + */ class WC_Retailcrm_Inventories { /** @var WC_Retailcrm_Client_V5 */ diff --git a/src/include/class-wc-retailcrm-orders.php b/src/include/class-wc-retailcrm-orders.php index 6ee45b8..1977b9d 100644 --- a/src/include/class-wc-retailcrm-orders.php +++ b/src/include/class-wc-retailcrm-orders.php @@ -1,17 +1,17 @@ - * @license http://retailcrm.ru Proprietary - * @link http://retailcrm.ru - * @see http://help.retailcrm.ru - */ if (!class_exists('WC_Retailcrm_Orders')) : + /** + * PHP version 7.0 + * + * Class WC_Retailcrm_Orders - Allows transfer data orders with CMS. + * + * @category Integration + * @author RetailCRM + * @license http://retailcrm.ru Proprietary + * @link http://retailcrm.ru + * @see http://help.retailcrm.ru + */ class WC_Retailcrm_Orders { /** @var bool|WC_Retailcrm_Proxy|WC_Retailcrm_Client_V5 */ diff --git a/src/include/class-wc-retailcrm-plugin.php b/src/include/class-wc-retailcrm-plugin.php index d307268..1e9bdac 100644 --- a/src/include/class-wc-retailcrm-plugin.php +++ b/src/include/class-wc-retailcrm-plugin.php @@ -1,6 +1,7 @@ - * @license http://retailcrm.ru Proprietary - * @link http://retailcrm.ru - * @see http://help.retailcrm.ru - */ if (class_exists('WC_Retailcrm_Uploader') === false) { + /** + * PHP version 7.0 + * + * Class WC_Retailcrm_Uploader - Allows upload archival orders/customers in CRM. + * + * @category Integration + * @author RetailCRM + * @license http://retailcrm.ru Proprietary + * @link http://retailcrm.ru + * @see http://help.retailcrm.ru + */ class WC_Retailcrm_Uploader { const RETAILCRM_COUNT_OBJECT_UPLOAD = 50; diff --git a/src/include/components/class-wc-retailcrm-customer-switcher.php b/src/include/components/class-wc-retailcrm-customer-switcher.php index 3b4fe77..6afd466 100644 --- a/src/include/components/class-wc-retailcrm-customer-switcher.php +++ b/src/include/components/class-wc-retailcrm-customer-switcher.php @@ -1,6 +1,7 @@ - * @license http://retailcrm.ru Proprietary - * @link http://retailcrm.ru - * @see http://help.retailcrm.ru - */ if (!class_exists('WC_Retailcrm_Logger') && class_exists('WC_Log_Levels')) : + /** + * PHP version 7.0 + * + * Class WC_Retailcrm_Logger - Allows display important debug information. + * + * @category Integration + * @author RetailCRM + * @license http://retailcrm.ru Proprietary + * @link http://retailcrm.ru + * @see http://help.retailcrm.ru * @codeCoverageIgnore */ class WC_Retailcrm_Logger diff --git a/src/include/customer/class-wc-retailcrm-customer-address.php b/src/include/customer/class-wc-retailcrm-customer-address.php index 0e85f96..2d191bb 100644 --- a/src/include/customer/class-wc-retailcrm-customer-address.php +++ b/src/include/customer/class-wc-retailcrm-customer-address.php @@ -1,6 +1,7 @@ + * @license http://retailcrm.ru Proprietary + * @link http://retailcrm.ru + * @see http://help.retailcrm.ru + */ + class WC_Retailcrm_Icml_Writer + { + private $writer; + + public function __construct($tmpFile) + { + $this->writer = new \XMLWriter(); + $this->writer->openUri($tmpFile); + } + + /** + * Write HEAD in ICML catalog. + * + * @param string $shop + * + * @return void + */ + public function writeHead(string $shop) + { + $this->writer->startDocument('1.0', 'UTF-8'); + $this->writer->startElement('yml_catalog'); // start + $this->writer->writeAttribute('date', date('Y-m-d H:i:s')); + $this->writer->startElement('shop'); // start + $this->writer->WriteElement('name', $shop); + } + + /** + * Write categories in ICML catalog. + * + * @param array $categories + * + * @return void + */ + public function writeCategories(array $categories) + { + $this->writer->startElement('categories'); // start + + $this->addCategories($categories); + + $this->writer->endElement(); // end + } + + /** + * Add category in ICML catalog. + * + * @param array $categories + * + * @return void + */ + private function addCategories(array $categories) + { + foreach ($categories as $category) { + if (!array_key_exists('name', $category) || !array_key_exists('id', $category)) { + continue; + } + + $this->writer->startElement('category'); // start + + $this->writer->writeAttribute('id', $category['id']); + + if (array_key_exists('parentId', $category) && 0 < $category['parentId']) { + $this->writer->writeAttribute('parentId', $category['parentId']); + } + + $this->writer->writeElement('name', $category['name']); + + if (array_key_exists('picture', $category) && $category['picture']) { + $this->writer->writeElement('picture', $category['picture']); + } + + $this->writer->endElement(); // end + } + } + + /** + * Write offers in ICML catalog. + * + * @return void + */ + public function writeOffers($offers) + { + $this->writer->startElement('offers'); // start + + $this->addOffers($offers); + + $this->writer->endElement(); // end + } + + /** + * Add offer in ICML catalog. + * + * @return void + */ + private function addOffers($offers) + { + foreach ($offers as $offer) { + if (!array_key_exists('id', $offer)) { + continue; + } + + $this->writer->startElement('offer'); // start + + if (!array_key_exists('productId', $offer) || empty($offer['productId'])) { + $offer['productId'] = $offer['id']; + } + + $this->writer->writeAttribute('id', $offer['id']); + $this->writer->writeAttribute('productId', $offer['productId']); + $this->writer->writeAttribute('quantity', (int) $offer['quantity'] ?? 0); + + if (isset($offer['categoryId'])) { + if (is_array($offer['categoryId'])) { + foreach ($offer['categoryId'] as $categoryId) { + $this->writer->writeElement('categoryId', $categoryId); + } + } else { + $this->writer->writeElement('categoryId', $offer['$categoryId']); + } + } + + if (!empty($offer['picture'])) { + foreach ($offer['picture'] as $urlImage) { + $this->writer->writeElement('picture', $urlImage); + } + } + + if (empty($offer['name'])) { + $offer['name'] = __('Untitled', 'retailcrm'); + } + + if (empty($offer['productName'])) { + $offer['productName'] = $offer['name']; + } + + unset($offer['id'], $offer['productId'], $offer['categoryId'], $offer['quantity'], $offer['picture']); + + $this->writeOffersProperties($offer); + + if (!empty($offer['params'])) { + $this->writeOffersParams($offer['params']); + } + + if (!empty($offer['dimensions'])) { + $this->writer->writeElement('dimensions', $offer['dimensions']); + } + + if (!empty($offer['weight'])) { + $this->writer->writeElement('weight', $offer['weight']); + } + + if (!empty($offer['tax'])) { + $this->writer->writeElement('vatRate', $offer['tax']); + } + + $this->writer->endElement(); // end + } + } + + /** + * Set offer properties. + * + * @param array $offerProperties + * + * @return void + */ + private function writeOffersProperties(array $offerProperties) + { + foreach ($offerProperties as $key => $value) { + if (!in_array($key, WC_Retailcrm_Icml::OFFER_PROPERTIES)) { + continue; + } + + if (is_array($value)) { + foreach ($value as $element) { + $this->writer->writeElement($key, $element); + } + } else { + $this->writer->writeElement($key, $value); + } + } + } + + /** + * Set offer params. + * + * @param array $offerParams + * + * @return void + */ + private function writeOffersParams(array $offerParams) + { + foreach ($offerParams as $param) { + if ( + empty($param['code']) + || empty($param['name']) + || empty($param['value']) + ) { + continue; + } + + $this->writer->startElement('param'); // start + + $this->writer->writeAttribute('code', $param['code']); + $this->writer->writeAttribute('name', $param['name']); + $this->writer->text($param['value']); + + $this->writer->endElement(); // end + } + } + + /** + * Write end tags in ICML catalog. + * + * @return void + */ + public function writeEnd() + { + $this->writer->endElement(); // end + $this->writer->endElement(); // end + $this->writer->endDocument(); + } + + /** + * Save ICML catalog. + * + * @return void + */ + public function formatXml($tmpfile) + { + $dom = dom_import_simplexml(simplexml_load_file($tmpfile))->ownerDocument; + $dom->formatOutput = true; + $formatted = $dom->saveXML(); + + unset($dom, $this->writer); + + file_put_contents($tmpfile, $formatted); + } + } +endif; diff --git a/src/include/interfaces/class-wc-retailcrm-builder-interface.php b/src/include/interfaces/class-wc-retailcrm-builder-interface.php index d3abfb9..8b27fb6 100644 --- a/src/include/interfaces/class-wc-retailcrm-builder-interface.php +++ b/src/include/interfaces/class-wc-retailcrm-builder-interface.php @@ -1,6 +1,7 @@ wcCustomer = $wcCustomer; $this->wcOrder = $wcOrder; - if ((!is_null($this->wcCustomer) && !($this->wcCustomer instanceof WC_Customer)) + if ( + (!is_null($this->wcCustomer) && !($this->wcCustomer instanceof WC_Customer)) || !($this->wcOrder instanceof WC_Order) ) { throw new \InvalidArgumentException(sprintf('Incorrect data provided to %s', __CLASS__)); diff --git a/src/include/models/class-wc-retailcrm-customer-switcher-state.php b/src/include/models/class-wc-retailcrm-customer-switcher-state.php index 26a69ce..b323175 100644 --- a/src/include/models/class-wc-retailcrm-customer-switcher-state.php +++ b/src/include/models/class-wc-retailcrm-customer-switcher-state.php @@ -1,6 +1,7 @@ $action, 'plugin' => $pluginSlug - ), + ], admin_url( 'update.php' ) ), $action.'_'.$pluginSlug @@ -205,5 +206,5 @@ if (!class_exists( 'WC_Integration_Retailcrm')) : $plugin->register_activation_hook(); $plugin->register_deactivation_hook(); - add_action('plugins_loaded', array('WC_Integration_Retailcrm', 'get_instance'), 0); + add_action('plugins_loaded', ['WC_Integration_Retailcrm', 'get_instance'], 0); endif; diff --git a/src/uninstall.php b/src/uninstall.php index e7878dc..62e7508 100644 --- a/src/uninstall.php +++ b/src/uninstall.php @@ -16,7 +16,7 @@ * * @link https://wordpress.org/plugins/woo-retailcrm/ * - * @version 4.4.9 + * @version 4.5.0 * * @package RetailCRM */ diff --git a/tests/abstracts/test-wc-retailcrm-abstract-builder.php b/tests/abstracts/test-wc-retailcrm-abstract-builder.php index 5d0a476..15ae18f 100644 --- a/tests/abstracts/test-wc-retailcrm-abstract-builder.php +++ b/tests/abstracts/test-wc-retailcrm-abstract-builder.php @@ -1,6 +1,7 @@