diff --git a/modules/splashsync/splashsync.php b/modules/splashsync/splashsync.php index de2688e0..2b124079 100644 --- a/modules/splashsync/splashsync.php +++ b/modules/splashsync/splashsync.php @@ -441,6 +441,7 @@ public function hookDisplayBackOfficeFooter() if (is_file($bufferFile) && function_exists("json_encode")) { file_put_contents($bufferFile, json_encode(array())); } + //====================================================================// // Render Footer return $this->display(__FILE__, 'footer.tpl'); diff --git a/modules/splashsync/src/Configurators/MarketplaceVendorConfigurator.php b/modules/splashsync/src/Configurators/MarketplaceVendorConfigurator.php index 17979d38..5004bb6d 100644 --- a/modules/splashsync/src/Configurators/MarketplaceVendorConfigurator.php +++ b/modules/splashsync/src/Configurators/MarketplaceVendorConfigurator.php @@ -47,6 +47,7 @@ public function overrideDescription(string $objectType, array $description): arr "enable_push_deleted" => 0, )); } + //====================================================================// // Other Types => NO Sync return array_replace_recursive($description, array( diff --git a/modules/splashsync/src/Objects/Address/ObjectsListTrait.php b/modules/splashsync/src/Objects/Address/ObjectsListTrait.php index a9e85e32..12459e07 100644 --- a/modules/splashsync/src/Objects/Address/ObjectsListTrait.php +++ b/modules/splashsync/src/Objects/Address/ObjectsListTrait.php @@ -67,6 +67,7 @@ public function objectsList(string $filter = null, array $params = array()): arr $sqlFilter .= " OR LOWER( c.name ) LIKE LOWER( '%".pSQL($filter)."%') "; $sql->where($sqlFilter); } + //====================================================================// // Execute Generic Search return $this->getObjectsListGenericData($sql, "lastname", $params); diff --git a/modules/splashsync/src/Objects/Core/ConfiguratorAwareTrait.php b/modules/splashsync/src/Objects/Core/ConfiguratorAwareTrait.php index b01335b8..6abd2797 100644 --- a/modules/splashsync/src/Objects/Core/ConfiguratorAwareTrait.php +++ b/modules/splashsync/src/Objects/Core/ConfiguratorAwareTrait.php @@ -37,6 +37,7 @@ public function description(): array if (!class_exists($configuratorClass) || !is_subclass_of($configuratorClass, AbstractConfigurator::class)) { return $description; } + //====================================================================// // Apply Overrides & Return Object Description Array return (new $configuratorClass())->overrideDescription(static::getType(), $description); diff --git a/modules/splashsync/src/Objects/Core/MultishopObjectTrait.php b/modules/splashsync/src/Objects/Core/MultishopObjectTrait.php index 61697c31..601958b8 100644 --- a/modules/splashsync/src/Objects/Core/MultishopObjectTrait.php +++ b/modules/splashsync/src/Objects/Core/MultishopObjectTrait.php @@ -48,6 +48,7 @@ public function fields(): array //====================================================================// // Load Core Fields from All Shop Context $fields = MSF::loadFields($this->coreFields()); + //====================================================================// // Redo Override Fields from Local Configurator return Splash::configurator()->overrideFields(self::getType(), $fields); @@ -114,6 +115,7 @@ public function get(string $objectId, array $fields): ?array if (!empty($objectData) && !isset($objectData["id"])) { $objectData["id"] = $objectId; } + //====================================================================// // Return Object Data of False return empty($objectData) ? null : $objectData; @@ -199,6 +201,7 @@ public function getAllShopsData(string $objectId, array $fieldsList): ?array MSM::setContext(); $allShopData = $this->coreGet($objectId, $allShopFields); } + //====================================================================// // Object Not Found => Exit return is_array($allShopData) ? $allShopData : null; @@ -259,6 +262,7 @@ public function getMsfUpdateFields(string $type) if (!Shop::isFeatureActive()) { return null; } + //====================================================================// // Return Updated Fields return $this->updateFields[$type] ?? array(); diff --git a/modules/splashsync/src/Objects/Core/ObjectsListCommonsTrait.php b/modules/splashsync/src/Objects/Core/ObjectsListCommonsTrait.php index 6e5feb1c..97a0a078 100644 --- a/modules/splashsync/src/Objects/Core/ObjectsListCommonsTrait.php +++ b/modules/splashsync/src/Objects/Core/ObjectsListCommonsTrait.php @@ -45,6 +45,7 @@ protected function getObjectListTotal(string $sql) if (Db::getInstance()->getNumberError()) { return Splash::log()->errTrace(Db::getInstance()->getMsgError()); } + //====================================================================// // Compute Total Number of Results return Db::getInstance()->numRows(); diff --git a/modules/splashsync/src/Objects/CreditNote/HooksTrait.php b/modules/splashsync/src/Objects/CreditNote/HooksTrait.php index 9cde83e9..f8386e47 100644 --- a/modules/splashsync/src/Objects/CreditNote/HooksTrait.php +++ b/modules/splashsync/src/Objects/CreditNote/HooksTrait.php @@ -102,6 +102,7 @@ private function hookactionCreditNote(OrderSlip $order, string $action, string $ if (empty($objectId)) { Splash::log()->err("ErrLocalTpl", "CreditNote", __FUNCTION__, "Unable to Read Order Slip Id."); } + //====================================================================// // Commit Update For Invoice return $this->doCommit("CreditNote", (string) $objectId, $action, $comment); diff --git a/modules/splashsync/src/Objects/CreditNote/ItemsTrait.php b/modules/splashsync/src/Objects/CreditNote/ItemsTrait.php index 4355fd22..b2c5c2b7 100644 --- a/modules/splashsync/src/Objects/CreditNote/ItemsTrait.php +++ b/modules/splashsync/src/Objects/CreditNote/ItemsTrait.php @@ -318,6 +318,7 @@ private function getShippingPrice() if ($this->hasCustomerCartRule()) { $price = $taxPercent = 0; } + //====================================================================// // Build Price Array return self::prices()->encode( @@ -342,6 +343,7 @@ private function getCarrierName(): string if (!isset($this->carrier) || empty($this->carrier->name)) { return $this->spl->l("Delivery"); } + //====================================================================// // Return Carrier Name return $this->carrier->name; diff --git a/modules/splashsync/src/Objects/Order/HooksTrait.php b/modules/splashsync/src/Objects/Order/HooksTrait.php index 93f4e9de..244e167b 100644 --- a/modules/splashsync/src/Objects/Order/HooksTrait.php +++ b/modules/splashsync/src/Objects/Order/HooksTrait.php @@ -190,6 +190,7 @@ private function hookactionInvoice(object $order, string $action, string $commen if (empty($objectId)) { Splash::log()->err("ErrLocalTpl", "Invoice", __FUNCTION__, "Unable to Read Order Invoice Id."); } + //====================================================================// // Commit Update For Invoice return $this->doCommit("Invoice", (string) $objectId, $action, $comment); diff --git a/modules/splashsync/src/Objects/Order/ItemsTrait.php b/modules/splashsync/src/Objects/Order/ItemsTrait.php index 6c05c491..718a5e9e 100644 --- a/modules/splashsync/src/Objects/Order/ItemsTrait.php +++ b/modules/splashsync/src/Objects/Order/ItemsTrait.php @@ -452,6 +452,7 @@ private function getShippingPrice() } else { $taxPercent = 0; } + //====================================================================// // Build Price Array return self::prices()->encode( @@ -476,6 +477,7 @@ private function getCarrierName(): string if (!isset($this->carrier) || empty($this->carrier->name)) { return $this->spl->l("Delivery"); } + //====================================================================// // Return Carrier Name return $this->carrier->name; diff --git a/modules/splashsync/src/Objects/Order/ObjectsListTrait.php b/modules/splashsync/src/Objects/Order/ObjectsListTrait.php index 1d6313a6..fb3b4084 100644 --- a/modules/splashsync/src/Objects/Order/ObjectsListTrait.php +++ b/modules/splashsync/src/Objects/Order/ObjectsListTrait.php @@ -59,6 +59,7 @@ public function objectsList(string $filter = null, array $params = array()): arr $where .= " OR LOWER( o.date_add ) LIKE LOWER( '%".pSQL($filter)."%') "; $sql->where($where); } + //====================================================================// // Execute Generic Search return $this->getObjectsListGenericData($sql, "order_date", $params); diff --git a/modules/splashsync/src/Objects/Order/PrimaryTrait.php b/modules/splashsync/src/Objects/Order/PrimaryTrait.php index 7bb555bf..6cd11ec7 100644 --- a/modules/splashsync/src/Objects/Order/PrimaryTrait.php +++ b/modules/splashsync/src/Objects/Order/PrimaryTrait.php @@ -69,6 +69,7 @@ public function getByPrimary(array $keys): ?string if (1 != count($result) || empty($result[0]['id'])) { return null; } + //====================================================================// // Result Found return $result[0]['id']; diff --git a/modules/splashsync/src/Objects/Order/StatusTrait.php b/modules/splashsync/src/Objects/Order/StatusTrait.php index 38df2180..b2b1b8d7 100644 --- a/modules/splashsync/src/Objects/Order/StatusTrait.php +++ b/modules/splashsync/src/Objects/Order/StatusTrait.php @@ -246,6 +246,7 @@ private function getSplashStatus(): string if ($this->object->hasBeenPaid()) { return "OrderProcessing"; } + //====================================================================// // Default Status => Order is Closed & Delivered // Used for Orders imported to Prestashop that do not have Prestashop Status diff --git a/modules/splashsync/src/Objects/Order/TrackingTrait.php b/modules/splashsync/src/Objects/Order/TrackingTrait.php index 0fb8f738..536bdb79 100644 --- a/modules/splashsync/src/Objects/Order/TrackingTrait.php +++ b/modules/splashsync/src/Objects/Order/TrackingTrait.php @@ -160,6 +160,7 @@ private function getOrderTrackingUrl(): string if (empty($trackingNumber)) { return ""; } + //====================================================================// // Return Carrier Tracking Url return str_replace("@", $trackingNumber, $this->carrier->url); diff --git a/modules/splashsync/src/Objects/Product/AttributeTrait.php b/modules/splashsync/src/Objects/Product/AttributeTrait.php index 8743a8dd..997a46b1 100644 --- a/modules/splashsync/src/Objects/Product/AttributeTrait.php +++ b/modules/splashsync/src/Objects/Product/AttributeTrait.php @@ -211,6 +211,7 @@ public function deleteAttribute(): bool if (!empty($attrList)) { return true; } + //====================================================================// // Also Delete Product From DataBase return $this->object->delete(); diff --git a/modules/splashsync/src/Objects/Product/CRUDTrait.php b/modules/splashsync/src/Objects/Product/CRUDTrait.php index df35a099..78038804 100644 --- a/modules/splashsync/src/Objects/Product/CRUDTrait.php +++ b/modules/splashsync/src/Objects/Product/CRUDTrait.php @@ -211,6 +211,7 @@ public function delete(string $objectId): bool if ($this->AttributeId) { return $this->deleteAttribute(); } + //====================================================================// // Else Delete Product From DataBase return $this->object->delete(); diff --git a/modules/splashsync/src/Objects/Product/HooksTrait.php b/modules/splashsync/src/Objects/Product/HooksTrait.php index 2bdf434a..be4133a8 100644 --- a/modules/splashsync/src/Objects/Product/HooksTrait.php +++ b/modules/splashsync/src/Objects/Product/HooksTrait.php @@ -184,6 +184,7 @@ public function hookActionUpdateQuantity(array $params): bool array_push($unikId, $productId); } } + //====================================================================// // Commit Update For Product return $this->doCommit("Product", $unikId, SPL_A_UPDATE, $this->l('Product Stock Updated on Prestashop')); @@ -269,6 +270,7 @@ private function hookActionProduct($product, $action, $comment) if (empty($idList)) { return true; } + //====================================================================// // Commit Update For Product return $this->doCommit("Product", $idList, $action, $comment); diff --git a/modules/splashsync/src/Objects/Product/IdEncoderTrait.php b/modules/splashsync/src/Objects/Product/IdEncoderTrait.php index 85535af1..ec126f47 100644 --- a/modules/splashsync/src/Objects/Product/IdEncoderTrait.php +++ b/modules/splashsync/src/Objects/Product/IdEncoderTrait.php @@ -61,6 +61,7 @@ public static function getUnikIdStatic($productId, $attributeId): string return (string) $productId.'@@'.(string) $attributeId; } } + //====================================================================// // Generate Standard Id return (string) ($productId + ($attributeId << 20)); @@ -109,6 +110,7 @@ private static function decodeIdsStatic($uniqueId) 'aId' => (int) $decoded[1], ); } + //====================================================================// // Standard Id Decoder return array( diff --git a/modules/splashsync/src/Objects/Product/ImagesTrait.php b/modules/splashsync/src/Objects/Product/ImagesTrait.php index b3979898..bbbd2a65 100644 --- a/modules/splashsync/src/Objects/Product/ImagesTrait.php +++ b/modules/splashsync/src/Objects/Product/ImagesTrait.php @@ -229,6 +229,7 @@ protected function buildInfo($imageId): ArrayObject _PS_PROD_IMG_DIR_.$objectImage->getImgFolder(), $publicUrl->getImageLink($imageName, (string) $imageId) ); + //====================================================================// // Encode Image Information Array return new ArrayObject( diff --git a/modules/splashsync/src/Objects/Product/PrimaryTrait.php b/modules/splashsync/src/Objects/Product/PrimaryTrait.php index 68ba88bc..ba4e3cf2 100644 --- a/modules/splashsync/src/Objects/Product/PrimaryTrait.php +++ b/modules/splashsync/src/Objects/Product/PrimaryTrait.php @@ -84,6 +84,7 @@ public function getByPrimary(array $keys): ?string if (1 != count($result)) { return null; } + //====================================================================// // Result Found return (string) $this->getUnikId( diff --git a/modules/splashsync/src/Objects/Product/Variants/CRUDTrait.php b/modules/splashsync/src/Objects/Product/Variants/CRUDTrait.php index 066cfe62..be617fd7 100644 --- a/modules/splashsync/src/Objects/Product/Variants/CRUDTrait.php +++ b/modules/splashsync/src/Objects/Product/Variants/CRUDTrait.php @@ -97,6 +97,7 @@ private function createVariantProduct(array $objectData): ?Product if (!$product || !$this->createAttribute()) { return null; } + //====================================================================// // Return Product return $product; diff --git a/modules/splashsync/src/Objects/ThirdParty/CRUDTrait.php b/modules/splashsync/src/Objects/ThirdParty/CRUDTrait.php index 4553eec6..5d63b55f 100644 --- a/modules/splashsync/src/Objects/ThirdParty/CRUDTrait.php +++ b/modules/splashsync/src/Objects/ThirdParty/CRUDTrait.php @@ -73,6 +73,7 @@ public function create(): ?Customer if (empty($this->in["email"])) { return Splash::log()->errNull("ErrLocalFieldMissing", __CLASS__, __FUNCTION__, "email"); } + //====================================================================// // Create Empty Customer return new Customer(); diff --git a/modules/splashsync/src/Objects/ThirdParty/HooksTrait.php b/modules/splashsync/src/Objects/ThirdParty/HooksTrait.php index 95b05466..daf20da4 100644 --- a/modules/splashsync/src/Objects/ThirdParty/HooksTrait.php +++ b/modules/splashsync/src/Objects/ThirdParty/HooksTrait.php @@ -91,6 +91,7 @@ private function hookactionCustomer($customer, $action, $comment) if (empty($customerId)) { Splash::log()->err("ErrLocalTpl", __CLASS__, __FUNCTION__, "Unable to Read Customer Id."); } + //====================================================================// // Commit Update For Product return $this->doCommit("ThirdParty", $customerId, $action, $comment); diff --git a/modules/splashsync/src/Objects/ThirdParty/MainTrait.php b/modules/splashsync/src/Objects/ThirdParty/MainTrait.php index 292cc399..5855f287 100644 --- a/modules/splashsync/src/Objects/ThirdParty/MainTrait.php +++ b/modules/splashsync/src/Objects/ThirdParty/MainTrait.php @@ -403,6 +403,7 @@ private function getCompanyName(): string if (!empty($this->object->company)) { return $this->object->company; } + //====================================================================// // Generic FallBack Mode return "Prestashop(".$this->object->id.")"; diff --git a/modules/splashsync/src/Objects/ThirdParty/PrimaryTrait.php b/modules/splashsync/src/Objects/ThirdParty/PrimaryTrait.php index abaf7def..3d84cdfd 100644 --- a/modules/splashsync/src/Objects/ThirdParty/PrimaryTrait.php +++ b/modules/splashsync/src/Objects/ThirdParty/PrimaryTrait.php @@ -69,6 +69,7 @@ public function getByPrimary(array $keys): ?string if (1 != count($result) || empty($result[0]['id'])) { return null; } + //====================================================================// // Result Found return $result[0]['id']; diff --git a/modules/splashsync/src/Services/AttributesManager.php b/modules/splashsync/src/Services/AttributesManager.php index 1e487d04..b31442df 100644 --- a/modules/splashsync/src/Services/AttributesManager.php +++ b/modules/splashsync/src/Services/AttributesManager.php @@ -86,6 +86,7 @@ public static function getGroupById(int $groupId): ?AttributeGroup //====================================================================// // Ensure Loading of Attribute Group List self::getAllGroups(); + //====================================================================// // Return Attribute Group return self::$groups[$groupId] ?? null; @@ -223,6 +224,7 @@ public static function getAttributeById(AttributeGroup $group, int $attributeId) if (is_null(self::$attributes)) { return null; } + //====================================================================// // Return Attribute Values return self::$attributes[$group->id][$attributeId] ?? null; diff --git a/modules/splashsync/src/Services/DiscountsManager.php b/modules/splashsync/src/Services/DiscountsManager.php index 1ce1b9d0..0028f06a 100644 --- a/modules/splashsync/src/Services/DiscountsManager.php +++ b/modules/splashsync/src/Services/DiscountsManager.php @@ -59,6 +59,7 @@ public static function isFeatureActive(): bool if (empty(Splash::configuration()->PsUseAdvancedDiscounts)) { return false; } + //====================================================================// // Check if Storage Table Exists return self::hasStorageTable(); @@ -285,6 +286,7 @@ private static function getCoreDiscountPrice($object, Currency $currency) } else { $taxPercent = 0; } + //====================================================================// // Build Price Array return self::prices()->encode( diff --git a/modules/splashsync/src/Services/MultiShopFieldsManager.php b/modules/splashsync/src/Services/MultiShopFieldsManager.php index d807303a..b8af1570 100644 --- a/modules/splashsync/src/Services/MultiShopFieldsManager.php +++ b/modules/splashsync/src/Services/MultiShopFieldsManager.php @@ -347,6 +347,7 @@ private static function getMsfFieldId(array $coreField, int $shopId): string if (!self::isListField($coreField['type'])) { return self::MSF_PREFIX.$shopId."_".$coreField['id']; } + //====================================================================// // This is a List Field return self::fieldName($coreField['id']) diff --git a/modules/splashsync/src/Services/MultiShopManager.php b/modules/splashsync/src/Services/MultiShopManager.php index d765c77a..39b0742b 100644 --- a/modules/splashsync/src/Services/MultiShopManager.php +++ b/modules/splashsync/src/Services/MultiShopManager.php @@ -96,6 +96,7 @@ public static function isFeatureActive($force = false): bool if (!empty(Splash::input("SPLASH_TRAVIS"))) { return true; } + //====================================================================// // Check if Splash Multi-Shop Feature is Active return !empty(Splash::configuration()->PsUseMultiShopParser); diff --git a/modules/splashsync/src/Services/OrderStatusManager.php b/modules/splashsync/src/Services/OrderStatusManager.php index 0c2a9640..47f0c722 100644 --- a/modules/splashsync/src/Services/OrderStatusManager.php +++ b/modules/splashsync/src/Services/OrderStatusManager.php @@ -165,6 +165,7 @@ public static function isKnown(int $psStateId): bool //====================================================================// // Load List of Known PS States $knowStates = self::getKnownStatus(); + //====================================================================// // PS State is Known return isset($knowStates[$psStateId]); diff --git a/modules/splashsync/src/Services/PmAdvancedPack.php b/modules/splashsync/src/Services/PmAdvancedPack.php index e47b43c3..6ccc89d1 100644 --- a/modules/splashsync/src/Services/PmAdvancedPack.php +++ b/modules/splashsync/src/Services/PmAdvancedPack.php @@ -73,6 +73,7 @@ public static function isAdvancedPack($productId) if (!self::isFeatureActive()) { return false; } + //====================================================================// // Check if Product Id is on List return in_array($productId, self::getIdsPacks(), true); diff --git a/modules/splashsync/tests/L10MsfProductsTest.php b/modules/splashsync/tests/L10MsfProductsTest.php index 98a3842c..ee4dfafc 100644 --- a/modules/splashsync/tests/L10MsfProductsTest.php +++ b/modules/splashsync/tests/L10MsfProductsTest.php @@ -185,6 +185,7 @@ private function getShopDataSet(array $field, int $shopId): array $shopId ); } + //====================================================================// // Simple Fields return MSF::encodeData( @@ -216,6 +217,7 @@ private function isAllowedForTesting(array $sequence): bool if ("Product" != $sequence["1"]) { return false; } + //====================================================================// // Ensure Field is R/W Field return $this->isAllowedFieldForTesting($sequence["2"]);