Skip to content

Commit

Permalink
new feature GemRequest->validateStringPosts
Browse files Browse the repository at this point in the history
  • Loading branch information
@roboxon
roboxon committed Apr 16, 2024
1 parent 6f74a12 commit 990f697
Showing 1 changed file with 218 additions and 50 deletions.
268 changes: 218 additions & 50 deletions src/http/GemRequest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,32 +82,31 @@ public function getStartExecutionTime(): float
*/
public function definePostSchema(array $toValidatePost): bool
{
$errors = []; // Initialize an empty array to store errors

foreach ($toValidatePost as $validation_key => $validationString) {
$isRequired = (substr($validation_key, 0, 1) === '?') ? false : true; // Use ternary operator
$validation_key = ltrim($validation_key, '?'); // Remove optional prefix

if ($isRequired && (!isset($this->post[$validation_key]) || empty($this->post[$validation_key]))) {
$errors[] = "Missing required field: $validation_key";
continue; // Skip to the next iteration
}

if (isset($this->post[$validation_key]) && !empty($this->post[$validation_key])) {
$validationResult = $this->checkPostKeyValue($validation_key, $validationString);
if (!$validationResult) {
$errors[] = "Invalid value for field: $validation_key";
}
}
}
if (count($errors) > 0) {
foreach($errors as $error)
{
$this->error .= $error.', '; // Combine errors into a single string
$errors = []; // Initialize an empty array to store errors

foreach ($toValidatePost as $validation_key => $validationString) {
$isRequired = (substr($validation_key, 0, 1) === '?') ? false : true; // Use ternary operator
$validation_key = ltrim($validation_key, '?'); // Remove optional prefix

if ($isRequired && (!isset($this->post[$validation_key]) || empty($this->post[$validation_key]))) {
$errors[] = "Missing required field: $validation_key";
continue; // Skip to the next iteration
}

if (isset($this->post[$validation_key]) && !empty($this->post[$validation_key])) {
$validationResult = $this->checkPostKeyValue($validation_key, $validationString);
if (!$validationResult) {
$errors[] = "Invalid value for field: $validation_key";
}
}
}
return false;
}
return true;
if (count($errors) > 0) {
foreach ($errors as $error) {
$this->error .= $error . ', '; // Combine errors into a single string
}
return false;
}
return true;
}

public function setPostToObject(object $class): bool
Expand All @@ -125,6 +124,175 @@ public function setPostToObject(object $class): bool
return false;
}

/**
* Validates string lengths in a dictionary against min and max constraints.
*
* @param array<string, string> $stringPosts A dictionary where keys are strings and values are strings in the format "key:min-value|max-value" (optional).
* @return bool True if all strings pass validation, False otherwise.
*/
public function validateStringPosts(array $stringPosts): bool
{
foreach ($stringPosts as $key => $value) {
// Check if POST key exists
if (!isset($this->post[$key])) {
$this->error = "Missing POST key '$key'";
return false;
}

$constraints = explode('|', $value);
// Ensure constraints are in the expected format (key:min-value|max-value)
if (count($constraints) !== 2) {
$this->error = "Invalid format for key $key: expected 'key:min-value|max-value'";
return false;
}
$min_condition = $constraints[0];
$max_condition = $constraints[1];

$min = explode('-', $min_condition);
if (count($min) !== 2) {
$min = 0;
} else {
$min = (int)$min[1];
}

$max = explode('-', $max_condition);
if (count($max) !== 2) {
$max = 9999999999;
} else {
$max = (int)$max[1];
}
// Validate string length against min and max constraints (assuming $this->post[$key] is a string)
$stringLength = strlen($this->post[$key]);/** @phpstan-ignore-line */

if (!($min <= $stringLength && $stringLength <= $max)) {
$this->error = "String length for post '$key' is ({$stringLength}) . it is outside the range ({$min}-{$max})";
return false;
}
}

return true;
}

/**
* @param array<string> $postKeys Key-value pairs where key is the POST data key and value is the corresponding object property
* @param object $class The object to populate with POST data
* @return bool True on success, false on failure with an error message set in `$this->error`
*/
public function mapPostToObjectxxx(array $postKeys, object $class): bool
{
foreach ($postKeys as $postKey => $classProperty) {
if (!isset($this->post[$postKey])) {
$this->error = "POST key '$postKey' is not found in request";
return false;
}

if (!property_exists($class, $classProperty)) {
$this->error = "Target Class has no '$classProperty' as property";
return false;
}

$propertyValue = $this->post[$postKey];

// Validate property type
$isValidType = $this->validatePropertyType($classProperty, $propertyValue);
if (!$isValidType) {
$this->error = "Invalid value type for property '$classProperty'";
return false;
}

// Convert value to target type if needed
$convertedValue = $this->convertToTargetType($propertyValue, $classProperty);

try {
$class->$classProperty = $convertedValue;
} catch (\Exception $e) {
$this->error = "Error setting property '$classProperty': " . $e->getMessage();
return false;
}
}

return true;
}

/**
* Validates if a value matches the expected type for a property.
*
* @param string|null $propertyType The expected type of the property (e.g., "string", "int", "MyClass")
* @param mixed $value The value to validate
* @return bool True if the value matches the property type, false otherwise
*/
private function validatePropertyType(?string $propertyType, mixed $value): bool
{
if ($propertyType === null) {
// Allow any type if property type is not specified
return true;
}

switch ($propertyType) {
case 'string':
return is_string($value);
case 'int':
return is_numeric($value) && is_int($value); // Ensure integer type
case 'float':
return is_float($value);
case 'bool':
return is_bool($value);
case 'array':
return is_array($value);
default:
$this->error = "unsupported type";
return false;
}
}

/**
* Attempts to convert a value to the target type, if possible.
*
* @param mixed $value The value to convert
* @return mixed The converted value or the original value if conversion is not possible
* @throws \InvalidArgumentException If conversion fails due to incompatible types
*/
private function convertToTargetType(mixed $value, string|null $targetType): mixed
{

if (is_null($targetType)) {
// Allow any type if no target type specified
return $value;
}

switch ($targetType) {
case 'int':
if (is_numeric($value)) {
return (int) $value; // Convert to integer
}
break;
case 'float':
if (is_numeric($value)) {
return (float) $value; // Convert to float
}
break;
case 'bool':
if (is_string($value) && in_array(strtolower($value), ['true', 'false', '1', '0'])) {
return (bool) $value; // Convert to boolean
}
break;
case 'string':
// String is the default type, no conversion needed
return $value;
default:
// Handle custom object types (optional)
if (class_exists($targetType)) {
// Implement logic to convert to the custom object type (if possible)
// You might need additional libraries or custom conversion functions here
$this->error = "Conversion to object type '$targetType' not supported";
} else {
$this->error = "Unsupported target type: '$targetType'";
}
}

throw new \InvalidArgumentException("Could not convert value to target type: '$targetType'");
}

public function forwardToRemoteApi(string $remoteApiUrl): JsonResponse
{
$jsonResponse = new JsonResponse();
Expand Down Expand Up @@ -164,31 +332,31 @@ public function forwardToRemoteApi(string $remoteApiUrl): JsonResponse
}

private function checkPostKeyValue(string $key, string $validation): bool
{
// General validation (assumed in checkValidationTypes)
if (!$this->checkValidationTypes($validation)) {
return false;
}
// Specific data type validation (using a dictionary for readability)
$validationMap = [
'string' => is_string($this->post[$key]),
'int' => is_numeric($this->post[$key]),
'float' => is_float($this->post[$key]),
'bool' => is_bool($this->post[$key]),
'array' => is_array($this->post[$key]),
'json' => (JsonHelper::validateJson($this->post[$key]) ? true : false),
'email' => filter_var($this->post[$key], FILTER_VALIDATE_EMAIL) !== false, // Explicit false check for email
];
// Validate data type based on validationMap
$result = isset($validationMap[$validation]) ? $validationMap[$validation] : false;
if (!$result) {
$this->error = "The field '$key' must be of type '$validation'"; // More specific error message
}
return $result;
{
// General validation (assumed in checkValidationTypes)
if (!$this->checkValidationTypes($validation)) {
return false;
}

// Specific data type validation (using a dictionary for readability)
$validationMap = [
'string' => is_string($this->post[$key]),
'int' => is_numeric($this->post[$key]),
'float' => is_float($this->post[$key]),
'bool' => is_bool($this->post[$key]),
'array' => is_array($this->post[$key]),
'json' => (JsonHelper::validateJson($this->post[$key]) ? true : false),
'email' => filter_var($this->post[$key], FILTER_VALIDATE_EMAIL) !== false, // Explicit false check for email
];

// Validate data type based on validationMap
$result = isset($validationMap[$validation]) ? $validationMap[$validation] : false;

if (!$result) {
$this->error = "The field '$key' must be of type '$validation'"; // More specific error message
}

return $result;
}

private function checkValidationTypes(string $validationString): bool
Expand Down

0 comments on commit 990f697

Please sign in to comment.