From 26319b888d94d8d963264db25395e756492965dc Mon Sep 17 00:00:00 2001
From: Joan He <johe@magento.com>
Date: Mon, 17 Oct 2016 14:24:35 -0500
Subject: [PATCH] MAGETWO-59444: Create serializer interface and json class in
framework
---
lib/internal/Magento/Framework/Serialize/README.md | 5 +++++
.../Magento/Framework/Serialize/SerializerInterface.php | 9 ++++-----
2 files changed, 9 insertions(+), 5 deletions(-)
create mode 100644 lib/internal/Magento/Framework/Serialize/README.md
diff --git a/lib/internal/Magento/Framework/Serialize/README.md b/lib/internal/Magento/Framework/Serialize/README.md
new file mode 100644
index 00000000000..f724a87bc3b
--- /dev/null
+++ b/lib/internal/Magento/Framework/Serialize/README.md
@@ -0,0 +1,5 @@
+# Serialize
+
+**Serialize** provides *SerializerInterface* and a few serializers to support different kinds of needs of serializing/unserializing of data. Here are list of serializers in this library:
+
+ * **Json** (recommended) - It can be used to serialize string, integer, float, boolean, or array data to json string; it unserializes json string to string, integer, float, boolean, or array. This is the recommended serializer.
\ No newline at end of file
diff --git a/lib/internal/Magento/Framework/Serialize/SerializerInterface.php b/lib/internal/Magento/Framework/Serialize/SerializerInterface.php
index 0f8fc7149b7..d3c856687f4 100644
--- a/lib/internal/Magento/Framework/Serialize/SerializerInterface.php
+++ b/lib/internal/Magento/Framework/Serialize/SerializerInterface.php
@@ -10,17 +10,16 @@ interface SerializerInterface
/**
* Serialize data into string
*
- * @param array|string $data
- * @return string|bool
+ * @param string|integer|float|boolean|array|null $data
+ * @return string|boolean
*/
public function serialize($data);
/**
- * Unserialize the given string into array
+ * Unserialize the given string into data
*
* @param string $string
- * @param int $objectDecodeType
- * @return array
+ * @return string|integer|float|boolean|array|null
*/
public function unserialize($string);
}
--
GitLab