Fixes #4

Added and updated library classes to match version 1.3 of the Ecommerce Standards Documents.
squizzdotcom · Mar 3, 2019 · e661028 · e661028
1 parent 4cf207b
commit e661028
Show file tree

Hide file tree

Showing 107 changed files with 8,442 additions and 182 deletions.
diff --git a/src/EcommerceStandardsDocuments/ESDRecordAccountPaymentSurcharge.php b/src/EcommerceStandardsDocuments/ESDRecordAccountPaymentSurcharge.php
@@ -1,6 +1,6 @@
 <?php
 	/**
-	* Copyright (C) 2018 Squizz PTY LTD
+	* Copyright (C) 2019 Squizz PTY LTD
 	* This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 	* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 	* You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.

diff --git a/src/EcommerceStandardsDocuments/ESDRecordAccountPaymentSurchargeTax.php b/src/EcommerceStandardsDocuments/ESDRecordAccountPaymentSurchargeTax.php
@@ -1,6 +1,6 @@
 <?php
 	/**
-	* Copyright (C) 2018 Squizz PTY LTD
+	* Copyright (C) 2019 Squizz PTY LTD
 	* This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 	* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 	* You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.

diff --git a/src/EcommerceStandardsDocuments/ESDRecordAlternateCode.php b/src/EcommerceStandardsDocuments/ESDRecordAlternateCode.php
@@ -1,7 +1,6 @@
 <?php
-
 	/**
-	* Copyright (C) 2017 Squizz PTY LTD
+	* Copyright (C) 2019 Squizz PTY LTD
 	* This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 	* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 	* You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.

diff --git a/src/EcommerceStandardsDocuments/ESDRecordAttachment.php b/src/EcommerceStandardsDocuments/ESDRecordAttachment.php
@@ -0,0 +1,65 @@
+<?php
+	/**
+	* Copyright (C) 2019 Squizz PTY LTD
+	* This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+	* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+	* You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.
+	*/
+	namespace EcommerceStandardsDocuments;
+	use EcommerceStandardsDocuments\ESDocumentConstants;
+
+	/**
+	* Ecommerce Standards Record that holds data for a single attachment file associated to a product, download, or labour.
+	*/
+	class ESDRecordAttachment   
+	{
+		/**
+		* @var string Key that allows the attachment record to be uniquely identified and linked to.
+		*/
+		public $keyAttachmentID = "";
+		/**
+		* @var string Key of the product record that the attachment record is assigned to.
+		*/
+		public $keyProductID = "";
+
+		/**
+		* @var string Key of the download record that the attachment record is assigned to.
+		*/
+		public $keyDownloadID = "";
+
+		/**
+		* @var string Key of the labour record that the attachment record is assigned to.
+		*/
+		public $keyLabourID = "";
+
+		/**
+		* @var string name of the attachment's file
+		*/
+		public $fileName = "";
+
+		/**
+		* @var string extension of the attachment's file
+		*/
+		public $fileExtension = "";
+
+		/**
+		* @var string full file path to location where the attachment file is located
+		*/
+		public $fullFilePath = "";
+
+		/**
+		* @var string Title that allows the attachment to be labelled.
+		*/
+		public $title = "";
+
+		/**
+		* @var string Stores an identifier that is relevant only to the system referencing and storing the record for its own needs.
+		*/
+		public $internalID = "";
+
+		/**
+		* @var int Data Record OPeration. Denotes an operation that may need to be performed on the record when it is being processed. Set null, or set it to one of the ESD_RECORD_OPERATION constants in the ESDocumentConstants class to allow the record to be inserted, updated, deleted, or ignored.
+		*/
+		public $drop = ESDocumentConstants::ESD_RECORD_OPERATION_NA;
+	}
+?>
diff --git a/src/EcommerceStandardsDocuments/ESDRecordAttribute.php b/src/EcommerceStandardsDocuments/ESDRecordAttribute.php
@@ -0,0 +1,50 @@
+<?php
+	/**
+	* Copyright (C) 2019 Squizz PTY LTD
+	* This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+	* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+	* You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.
+	*/
+	namespace EcommerceStandardsDocuments;
+	use EcommerceStandardsDocuments\ESDocumentConstants;
+
+	/**
+	* Ecommerce Standards Record that holds data for a single attribute associated with products, downloads, or labour. Attributes define the fields that can have values set for products, downloads, or labour.
+	*/
+	class ESDRecordAttribute  
+	{
+		/**
+		* @var string Key that allows the attribute record to be uniquely identified and linked to.
+		*/
+		public $keyAttributeID = "";
+
+		/**
+		* @var string name of the attribute
+		*/
+		public $name = "";
+
+		/**
+		* @var string The type of data that can be set as values for the attribute. Set to one the DATA_TYPE constants in the class
+		*/
+		public $dataType = "";
+
+		/**
+		* @var string Stores an identifier that is relevant only to the system referencing and storing the record for its own needs.
+		*/
+		public $internalID = "";
+
+		/**
+		* @var int Data Record OPeration. Denotes an operation that may need to be performed on the record when it is being processed. Set null, or set it to one of the ESD_RECORD_OPERATION constants in the ESDocumentConstants class to allow the record to be inserted, updated, deleted, or ignored.
+		*/
+		public $drop = ESDocumentConstants::ESD_RECORD_OPERATION_NA;
+
+		/**
+		* @var string Attribute Data Type - String
+		*/
+		const DATA_TYPE_STRING = "STRING";
+		/**
+		* @var string Attribute Data Type - Number
+		*/
+		const DATA_TYPE_NUMBER = "NUMBER";
+	}
+?>
diff --git a/src/EcommerceStandardsDocuments/ESDRecordAttributeProfile.php b/src/EcommerceStandardsDocuments/ESDRecordAttributeProfile.php
@@ -0,0 +1,46 @@
+<?php
+	/**
+	* Copyright (C) 2019 Squizz PTY LTD
+	* This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+	* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+	* You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.
+	*/
+	namespace EcommerceStandardsDocuments;
+	use EcommerceStandardsDocuments\ESDocumentConstants;
+
+	/**
+	* Ecommerce Standards Record that holds data for a single attribute profile associated with products. A profile allows any number of attributes to be grouped together.
+	*/
+	class ESDRecordAttributeProfile   
+	{
+		/**
+		* @var string Key that allows the attribute record to be uniquely identified and linked to.
+		*/
+		public $keyAttributeProfileID = "";
+
+		/**
+		* @var string Name of the attribute
+		*/
+		public $name = "";
+
+		/**
+		* @var string Text that describes the attribute profile.
+		*/
+		public $description = "";
+
+		/**
+		* @var string Stores an identifier that is relevant only to the system referencing and storing the record for its own needs.
+		*/
+		public $internalID = "";
+
+		/**
+		* @var int Data Record OPeration. Denotes an operation that may need to be performed on the record when it is being processed. Set null, or set it to one of the ESD_RECORD_OPERATION constants in the ESDocumentConstants class to allow the record to be inserted, updated, deleted, or ignored.
+		*/
+		public $drop = ESDocumentConstants::ESD_RECORD_OPERATION_NA;
+
+		/**
+		* @var ESDRecordAttribute[] List of attributes
+		*/
+		public $attributes = array();
+	}
+?>
diff --git a/src/EcommerceStandardsDocuments/ESDRecordAttributeValue.php b/src/EcommerceStandardsDocuments/ESDRecordAttributeValue.php
@@ -0,0 +1,61 @@
+<?php
+	/**
+	* Copyright (C) 2019 Squizz PTY LTD
+	* This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+	* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+	* You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.
+	*/
+	namespace EcommerceStandardsDocuments;
+	use EcommerceStandardsDocuments\ESDocumentConstants;
+
+	/**
+	* Ecommerce Standards Record that holds data for a single product, download, or labour attribute value.
+	*/
+	class ESDRecordAttributeValue   
+	{
+		/**
+		* @var string Key of the product record that the attribute value is set for.
+		*/
+		public $keyProductID = "";
+
+		/**
+		* @var string Key of the download record that the attribute value is set for.
+		*/
+		public $keyDownloadID = "";
+
+		/**
+		* @var string Key of the labour record that the attribute value is set for.
+		*/
+		public $keyLabourID = "";
+
+		/**
+		* @var string Key of the attribute profile record that the attribute assigned to the value is set to.
+		*/
+		public $keyAttributeProfileID = "";
+
+		/**
+		* @var string Key of the attribute record that the value is set to.
+		*/
+		public $keyAttributeID = "";
+
+		/**
+		* @var string text of the attribute value, if its attribute data type is set to string.
+		*/
+		public $stringValue = "";
+
+		/**
+		* @var double number of the attribute value, if its attribute data type is set to number.
+		*/
+		public $numberValue = 0.0;
+
+		/**
+		* @var string Stores an identifier that is relevant only to the system referencing and storing the record for its own needs.
+		*/
+		public $internalID = "";
+
+		/**
+		* @var int Data Record OPeration. Denotes an operation that may need to be performed on the record when it is being processed. Set null, or set it to one of the ESD_RECORD_OPERATION constants in the ESDocumentConstants class to allow the record to be inserted, updated, deleted, or ignored.
+		*/
+		public $drop = ESDocumentConstants::ESD_RECORD_OPERATION_NA;
+	}
+?>
diff --git a/src/EcommerceStandardsDocuments/ESDRecordCategory.php b/src/EcommerceStandardsDocuments/ESDRecordCategory.php
@@ -0,0 +1,107 @@
+<?php
+	/**
+	* Copyright (C) 2019 Squizz PTY LTD
+	* This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+	* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+	* You should have received a copy of the GNU General Public License along with this program.  If not, see http://www.gnu.org/licenses/.
+	*/
+	namespace EcommerceStandardsDocuments;
+	use EcommerceStandardsDocuments\ESDocumentConstants;
+
+	/**
+	* Ecommerce Standards record that contains data for a single category. A category is a representation of a collection of objects, and can be linked in a hierarchical data structure.
+	*/
+	class ESDRecordCategory   
+	{
+		/**
+		* @var string Key that allows the category record to be uniquely identified and linked to.
+		*/
+		public $keyCategoryID = "";
+
+		/**
+		* @var string Code of the category. May or may not be a unqiue identifier.
+		*/
+		public $categoryCode = "";
+
+		/**
+		* @var string Key of the category record that it is assigned to in a hierarchical data structure.
+		*/
+		public $keyCategoryParentID = "";
+
+		/**
+		* @var string Key of the category tree that the category record may reside within. The category tree defines a collection of categories that can be navigated within.
+		*/
+		public $keyCategoryTreeID = "";
+
+		/**
+		* @var string Name of the category.
+		*/
+		public $name = "";
+
+		/**
+		* @var string First description field of the category. It may contain any text used to describe the category.
+		*/
+		public $description1 = "";
+
+		/**
+		* @var string Second description field of the category. It may contain any text used to describe the category.
+		*/
+		public $description2 = "";
+
+		/**
+		* @var string Third description field of the category. It may contain any text used to describe the category.
+		*/
+		public $description3 = "";
+
+		/**
+		* @var string Fourth description field of the category. It may contain any text used to describe the category.
+		*/
+		public $description4 = "";
+
+		/**
+		* @var string Meta title of the category. This would typically be used in the meta data of a web page.
+		*/
+		public $metaTitle = "";
+
+		/**
+		* @var string A list of words that describe the category. This would typically be used in the meta data of a web page.
+		*/
+		public $metaKeywords = "";
+
+		/**
+		* @var string Meta description the category. This would typically be used in the meta data of a web page.
+		*/
+		public $metaDescription = "";
+
+		/**
+		* @var int Number to order the category by. This may be used to order a number of categories in a hierarchical tree that are all assigned to the same parent category.
+		*/
+		public $ordering = 0;
+
+		/**
+		* @var int Data Record OPeration. Denotes an operation that may need to be performed on the record when it is being processed.
+		* Set null, or set it to one of the ESD_RECORD_OPERATION constants in the ESDocumentConstants class to allow the record to be inserted, updated, deleted, or ignored.
+		*/
+		public $drop = ESDocumentConstants::ESD_RECORD_OPERATION_NA;
+
+		/**
+		* @var string Stores an identifier that is relevant only to the system referencing and storing the record for its own needs.
+		*/
+		public $internalID = "";
+
+		/**
+		* @var string[] List of Key Product IDs, that link any number of Product records to the category.
+		*/
+		public $keyProductIDs = array();
+
+		/**
+		* @var string[] List of Key Download IDs, that link any number of Download records to the category.
+		*/
+		public $keyDownloadIDs = array();
+
+		/**
+		* @var string[] List of Key Labour IDs, that link any number of Labour records to the category.
+		*/
+		public $keyLabourIDs = array();
+	}
+?>