Added support for PhpProperty on enums, allowing consumers to specify different field names

Author: sommmen

CHANGELOG.md

@@ -1,3 +1,6 @@
+# vNext
+- Added support for PhpProperty on enums, allowing consumers to specify different field names
+
 # 1.0.0
 
 This is just 0.11.0 packaged as a new version to mark it as stable.

PhpSerializerNET.Test/DataTypes/IntEnumWithPropertyName.cs

@@ -0,0 +1,19 @@
+/**
+  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/.
+**/
+
+namespace PhpSerializerNET.Test.DataTypes;
+
+public enum IntEnumWithPropertyName {
+
+	[PhpProperty("a")]
+	A = 1,
+
+	[PhpProperty("c")]
+	B = 13,
+
+	// No prop name
+	C,
+}

PhpSerializerNET.Test/Deserialize/EnumDeserialization.cs

@@ -37,6 +37,24 @@ public void DeserializeFromString() {
 			);
 		}
 
+		[TestMethod]
+		public void DeserializeFromStringWithPropertyName() {
+			Assert.AreEqual(
+				IntEnumWithPropertyName.A,
+				PhpSerialization.Deserialize<IntEnumWithPropertyName>("s:1:\"a\";")
+			);
+
+			Assert.AreEqual(
+				IntEnumWithPropertyName.B,
+				PhpSerialization.Deserialize<IntEnumWithPropertyName>("s:1:\"c\";")
+			);
+
+			Assert.AreEqual(
+				IntEnumWithPropertyName.C,
+				PhpSerialization.Deserialize<IntEnumWithPropertyName>("s:1:\"C\";")
+			);
+		}
+
 		[TestMethod]
 		public void DeserializeToNullable() {
 			LongEnum? result = PhpSerialization.Deserialize<LongEnum?>("i:1;");

PhpSerializerNET/PhpDeserializer.cs

@@ -246,21 +246,24 @@ private object DeserializeTokenFromSimpleType(Type givenType, PhpSerializeToken
 			if (targetType.IsEnum) {
 				// Enums are converted by name if the token is a string and by underlying value if they are not
 
+				if (token.Value == "" && this._options.EmptyStringToDefault) {
+					return Activator.CreateInstance(targetType);
+				}
+
 				if (token.Type != PhpSerializerType.String) {
 					return Enum.Parse(targetType, token.Value);
 				}
+
 				var foundFieldInfo = targetType
 					.GetFields()
-					.FirstOrDefault(y => y.Name == token.Value);
+					.Select(fieldInfo => new { fieldInfo, phpPropertyAttribute = fieldInfo.GetCustomAttribute<PhpPropertyAttribute>() })
+					.FirstOrDefault(c => c.fieldInfo.Name == token.Value || c.phpPropertyAttribute != null && c.phpPropertyAttribute.Name == token.Value)
+					?.fieldInfo;
 
 				if (foundFieldInfo == null) {
-					if (_options.EmptyStringToDefault) {
-						return Activator.CreateInstance(targetType);
-					} else {
 						throw new DeserializationException(
 							$"Exception encountered while trying to assign '{token.Value}' to type '{targetType.Name}'. " +
 							$"The value could not be matched to an enum member.");
-					}
 				}
 
 				return foundFieldInfo.GetRawConstantValue();