Required field support

Author: phpfui

Tool/Generator.php

@@ -87,7 +87,13 @@ public function generateDefinition(string $namespacedClass, array $properties) :
 
 		if (! isset($properties['type']))
 			{
-			return;
+			echo "{$namespacedClass} has no type";
+			if (str_contains($namespacedClass, 'ResendToNonOpenersInput'))
+				{
+				echo 'but assuming object';
+				$properties['type'] = 'object';
+				}
+			echo "\n";
 			}
 
 		$class = \str_replace('_', '', $class);
@@ -99,6 +105,7 @@ public function generateDefinition(string $namespacedClass, array $properties) :
 			$minLength = [];
 			$maxLength = [];
 			$docBlock = [];
+			$required = [];
 			$dollar = '$';
 
 			foreach ($properties['properties'] ?? [] as $name => $details)
@@ -179,6 +186,11 @@ public function generateDefinition(string $namespacedClass, array $properties) :
 					$maxLength[$name] = (int)$details['maxLength'];
 					}
 
+				if (isset($details['required']))
+					{
+					$required = $details['required'];
+					}
+
 				$description = '';
 
 				if (isset($details['description']))
@@ -193,7 +205,7 @@ public function generateDefinition(string $namespacedClass, array $properties) :
 				$type = \str_replace('\\\\', '\\', $type);
 				$docBlock[] = \trim("{$type} {$dollar}{$name} {$description}");
 				}
-			$this->generateFromTemplate($class, ['fields' => $fields, 'minLength' => $minLength, 'maxLength' => $maxLength, ], $docBlock);
+			$this->generateFromTemplate($class, ['fields' => $fields, 'minLength' => $minLength, 'maxLength' => $maxLength, 'requiredFields' => $required], $docBlock);
 			}
 		}
 
@@ -564,8 +576,14 @@ class ~class~ extends {$this->definitionNamespace}\Base
 
 						break;
 					}
-
-				$output .= "\t\t'{$field}' => {$value},\n";
+				if ('string' == \gettype($field))
+					{
+					$output .= "\t\t'{$field}' => {$value},\n";
+					}
+				else
+					{
+					$output .= "\t\t{$value},\n";
+					}
 				}
 
 			$output .= "\n\t];\n";

src/ConstantContact/Definition/Base.php

@@ -19,27 +19,32 @@ abstract class Base
 	protected static array $fields = [];
 
 	/**
-	 * @var array of minimum allowed values. Arrays are size, int and float are values, strings are length.
+	 * @var array<string, int> minimum allowed values. Arrays are size, int and float are values, strings are length.
 	 */
 	protected static array $minLength = [];
 
 	/**
-	 * @var array of maximum allowed values. Arrays are size, int and float are values, strings are length.
+	 * @var array<string, int> maximum allowed values. Arrays are size, int and float are values, strings are length.
 	 */
 	protected static array $maxLength = [];
 
+	/**
+	 * @var array<string> required fields.
+	 */
+	protected static array $requiredFields = [];
+
   /**
-   * $var array of the actual object data
+   * $var array<string, mixed> the actual object data by field name.
    */
 	private array $data = [];
 
   /**
-   * @var array of bool indicating which values are set to reduce data output.
+   * @var array<string, bool> indicates which values are set to reduce data output.
    */
 	private array $setFields = [];
 
 	/**
-	 * @var array of supported scalars
+	 * @var array<string, bool> supported scalars
 	 */
 	private static array $scalars = [
 		'bool' => true,
@@ -241,6 +246,14 @@ public function getData() : array
 		{
 		$result = [];
 
+		foreach (static::$requiredFields as $field)
+			{
+			if (! empty($this->setFields[$field]))
+				{
+				throw new \PHPFUI\ConstantContact\Exception\RequiredField(static::class . "::{$field} is required but not set.");
+				}
+			}
+
 		foreach ($this->data as $field => $value)
 			{
 			if (! empty($this->setFields[$field]))

src/ConstantContact/Exception/RequiredField.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace PHPFUI\ConstantContact\Exception;
+
+class RequiredField extends \PHPFUI\ConstantContact\Exception
+	{
+	}