Document IPhpObject and fix #23.

Author: StringEpsilon

CHANGELOG.md

@@ -22,6 +22,8 @@
 
 **Serialization:**
 - Added support for serializing `PhpDynamicObject` and `ExpandoObject`. 
+- Always serialize implementations of `IPhpObject` using object notation.
+	**This is technically a breaking change**, but it was always intended to work that way.
 
 # 0.9.0:
 

PhpSerializerNET.Test/Serialize/IPhpObjectSerialization.cs

@@ -0,0 +1,25 @@
+/**
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+**/
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace PhpSerializerNET.Test {
+	[TestClass]
+	public class IPhpObjectSerializationTest {
+		public class MyPhpObject : IPhpObject {
+			public string GetClassName() => "MyPhpObject";
+			public void SetClassName(string className) {}
+			public string Foo {get;set;}
+		}
+
+		[TestMethod]
+		public void SerializeIPhpObject() {
+			Assert.AreEqual( // strings:
+				"O:11:\"MyPhpObject\":1:{s:3:\"Foo\";s:0:\"\";}",
+				PhpSerialization.Serialize( new MyPhpObject() {Foo =""})
+			);
+		}
+	}
+}

PhpSerializerNET.Test/SerializeObjects.cs

@@ -25,6 +25,7 @@ public void ExplicitToClassWithMappingAttributes() {
 			);
 		}
 
+
 		[TestMethod]
 		public void SerializeList() {
 			Assert.AreEqual( // strings:

PhpSerializerNET/PhpSerializer.cs

@@ -162,8 +162,7 @@ private string SerializeComplex(object input) {
 				default: {
 						var inputType = input.GetType();
 
-						if (inputType.GetCustomAttribute<PhpClass>() != null) // TODO: add option.
-						{
+						if (typeof(IPhpObject).IsAssignableFrom(inputType) || inputType.GetCustomAttribute<PhpClass>() != null) {
 							return this.SerializeToObject(input);
 						}
 

PhpSerializerNET/PhpTokenizer.cs

@@ -4,7 +4,6 @@ This Source Code Form is subject to the terms of the Mozilla Public
   file, You can obtain one at http://mozilla.org/MPL/2.0/.
 **/
 
-using System.Linq;
 using System.Text;
 
 namespace PhpSerializerNET {

docs/Types/IPhpObject.md

@@ -4,12 +4,24 @@
 
 # Interface IPhpObject
 
+The interface is for manipulating the class name of an object in regards to the serialized data. I.E. the `stdClass` in `O:8:\"stdClass":0:{}`.
+
+Please note that for serializatin, any types that implement IPhpObject will always be serialized using object notation.
+
 ## Methods
 
 ### SetClassName
 
-**TODO.**
+Set the class name of the object for serialization. Is also used internally when deserializing an object that implements this interface.
+
+**Parameters:** 
+- `string` - The class name to set.
+**Returns:** *void*
 
 ### GetClassName
 
-**TODO.**
+Get the class name that was specified in the serialization data of the object.
+
+**Parameters:** *None*.
+**Returns:** `string` - The class name.
+

docs/Types/PhpDateTime.md

@@ -29,7 +29,7 @@ This method has no effect, because PhpDateTime always has a fixed classname.
 Implementation of [`IPhpObject.GetClassName`](./IPhpObject.md#GetClassName).
 This method always returns "DateTime".
 
-**Parameters:** None.
+**Parameters:** *None*.
 
 **Returns:** `string` - Always "DateTime"