added validators to check array params

Author: dcblogdev

src/Validators/EmailFolderCopyValidator.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dcblogdev\MsGraph\Validators;
+
+use InvalidArgumentException;
+
+class EmailFolderCopyValidator extends Validator
+{
+    protected static array $allowedParams = [
+        'destinationId',
+    ];
+
+    public static function validate(array $params): array
+    {
+        $validParams = parent::validate($params);
+
+        if (isset($validParams['destinationId']) && ! is_string($validParams['destinationId'])) {
+            throw new InvalidArgumentException('The destinationId must be a string.');
+        }
+
+        return $validParams;
+    }
+}

src/Validators/EmailFolderMoveValidator.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dcblogdev\MsGraph\Validators;
+
+use InvalidArgumentException;
+
+class EmailFolderMoveValidator extends Validator
+{
+    protected static array $allowedParams = [
+        'destinationId',
+    ];
+
+    public static function validate(array $params): array
+    {
+        $validParams = parent::validate($params);
+
+        if (isset($validParams['destinationId']) && ! is_string($validParams['destinationId'])) {
+            throw new InvalidArgumentException('The destinationId must be a string.');
+        }
+
+        return $validParams;
+    }
+}

src/Validators/EmailFolderStoreValidator.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dcblogdev\MsGraph\Validators;
+
+use InvalidArgumentException;
+
+class EmailFolderStoreValidator extends Validator
+{
+    protected static array $allowedParams = [
+        'displayName', 'isHidden',
+    ];
+
+    public static function validate(array $params): array
+    {
+        $validParams = parent::validate($params);
+
+        if (isset($validParams['displayName']) && ! is_string($validParams['displayName'])) {
+            throw new InvalidArgumentException('The displayName must be a string.');
+        }
+
+        if (isset($validParams['isHidden']) && ! is_bool($validParams['isHidden'])) {
+            throw new InvalidArgumentException('The isHidden must be a boolean.');
+        }
+
+        return $validParams;
+    }
+}

src/Validators/EmailFolderUpdateValidator.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dcblogdev\MsGraph\Validators;
+
+use InvalidArgumentException;
+
+class EmailFolderUpdateValidator extends Validator
+{
+    protected static array $allowedParams = [
+        'displayName',
+    ];
+
+    public static function validate(array $params): array
+    {
+        $validParams = parent::validate($params);
+
+        if (isset($validParams['displayName']) && ! is_string($validParams['displayName'])) {
+            throw new InvalidArgumentException('The displayName must be a string.');
+        }
+
+        return $validParams;
+    }
+}

src/Validators/GraphQueryValidator.php

@@ -6,38 +6,9 @@
 
 use InvalidArgumentException;
 
-class GraphQueryValidator
+class GraphQueryValidator extends Validator
 {
-    /**
-     * Allowed query parameters for Microsoft Graph API requests.
-     */
     protected static array $allowedParams = [
         '$top', '$skip', '$filter', '$orderby', '$select', '$expand', '$count', '$search', '$format',
     ];
-
-    /**
-     * Validate and filter query parameters.
-     *
-     * @param  array  $params  Query parameters to validate.
-     * @return array Valid query parameters.
-     *
-     * @throws InvalidArgumentException If invalid parameters are present.
-     */
-    public static function validate(array $params): array
-    {
-        // Filter out invalid parameters
-        $validParams = array_intersect_key($params, array_flip(self::$allowedParams));
-
-        // Identify invalid parameters
-        $invalidParams = array_diff_key($params, $validParams);
-        if (! empty($invalidParams)) {
-            throw new InvalidArgumentException(sprintf(
-                "Invalid query parameters: %s. Allowed parameters: %s.",
-                implode(', ', array_keys($invalidParams)),
-                implode(', ', self::$allowedParams)
-            ));
-        }
-
-        return $validParams;
-    }
 }

src/Validators/Validator.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dcblogdev\MsGraph\Validators;
+
+use InvalidArgumentException;
+
+class Validator
+{
+    protected static array $allowedParams = [];
+
+    /**
+     * Validate and filter parameters.
+     *
+     * @param  array  $params  parameters to validate.
+     * @return array Valid parameters.
+     *
+     * @throws InvalidArgumentException If invalid parameters are present.
+     */
+    public static function validate(array $params): array
+    {
+        $allowedParams = static::$allowedParams;
+
+        // Filter out invalid parameters
+        $validParams = array_intersect_key($params, array_flip($allowedParams));
+
+        // Identify invalid parameters
+        $invalidParams = array_diff_key($params, $validParams);
+        if (! empty($invalidParams)) {
+            throw new InvalidArgumentException(sprintf(
+                'Invalid parameters: %s. Allowed parameters: %s.',
+                implode(', ', array_keys($invalidParams)),
+                implode(', ', $allowedParams)
+            ));
+        }
+
+        return $validParams;
+    }
+}

tests/Validators/EmailFolderCopyValidatorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+use Dcblogdev\MsGraph\Validators\EmailFolderCopyValidator;
+
+test('valid parameters are accepted', function () {
+    $response = EmailFolderCopyValidator::validate([
+        'destinationId' => 'demo'
+    ]);
+
+    expect($response)->toEqual([
+        'destinationId' => 'demo'
+    ]);
+});
+
+test('throws exception for unrecognized parameters', function () {
+    EmailFolderCopyValidator::validate([
+        '$top' => 10,
+    ]);
+})->throws(InvalidArgumentException::class, 'Invalid parameters: $top. Allowed parameters: destinationId.');
+
+test('throws exception if destinationId is not a string', function () {
+    EmailFolderCopyValidator::validate(['destinationId' => 1]);
+})->throws(InvalidArgumentException::class, 'The destinationId must be a string.');
+
+test('allows empty input without throwing an exception', function () {
+    $response = EmailFolderCopyValidator::validate([]);
+    expect($response)->toBe([]);
+});

tests/Validators/EmailFolderMoveValidatorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+use Dcblogdev\MsGraph\Validators\EmailFolderMoveValidator;
+
+test('valid parameters are accepted', function () {
+    $response = EmailFolderMoveValidator::validate([
+        'destinationId' => 'demo',
+    ]);
+
+    expect($response)->toEqual([
+        'destinationId' => 'demo',
+    ]);
+});
+
+test('throws exception for unrecognized parameters', function () {
+    EmailFolderMoveValidator::validate([
+        '$top' => 10,
+    ]);
+})->throws(InvalidArgumentException::class, 'Invalid parameters: $top. Allowed parameters: destinationId.');
+
+test('throws exception if destinationId is not a string', function () {
+    EmailFolderMoveValidator::validate(['destinationId' => 1]);
+})->throws(InvalidArgumentException::class, 'The destinationId must be a string.');
+
+test('allows empty input without throwing an exception', function () {
+    $response = EmailFolderMoveValidator::validate([]);
+    expect($response)->toBe([]);
+});

tests/Validators/EmailFolderStoreValidatorTest.php

@@ -0,0 +1,38 @@
+<?php
+
+use Dcblogdev\MsGraph\Validators\EmailFolderStoreValidator;
+
+test('valid parameters are accepted', function () {
+    $response = EmailFolderStoreValidator::validate([
+        'displayName' => 'demo',
+        'isHidden' => false,
+    ]);
+
+    expect($response)->toEqual([
+        'displayName' => 'demo',
+        'isHidden' => false,
+    ]);
+});
+
+test('throws exception for unrecognized parameters', function () {
+    EmailFolderStoreValidator::validate([
+        '$top' => 10,
+    ]);
+})->throws(InvalidArgumentException::class, 'Invalid parameters: $top. Allowed parameters: displayName, isHidden.');
+
+test('throws exception if displayName is not a string', function () {
+    EmailFolderStoreValidator::validate(['displayName' => 1]);
+})->throws(InvalidArgumentException::class, 'The displayName must be a string.');
+
+test('throws exception if isHidden is not a boolean', function () {
+    EmailFolderStoreValidator::validate(['isHidden' => 'true']);
+})->throws(InvalidArgumentException::class, 'The isHidden must be a boolean.');
+
+test('throws exception if isHidden is an integer', function () {
+    EmailFolderStoreValidator::validate(['isHidden' => 1]);
+})->throws(InvalidArgumentException::class, 'The isHidden must be a boolean.');
+
+test('allows empty input without throwing an exception', function () {
+    $response = EmailFolderStoreValidator::validate([]);
+    expect($response)->toBe([]);
+});

tests/Validators/EmailFolderUpdateValidatorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+use Dcblogdev\MsGraph\Validators\EmailFolderUpdateValidator;
+
+test('valid parameters are accepted', function () {
+    $response = EmailFolderUpdateValidator::validate([
+        'displayName' => 'demo'
+    ]);
+
+    expect($response)->toEqual([
+        'displayName' => 'demo'
+    ]);
+});
+
+test('throws exception for unrecognized parameters', function () {
+    EmailFolderUpdateValidator::validate([
+        '$top' => 10,
+    ]);
+})->throws(InvalidArgumentException::class, 'Invalid parameters: $top. Allowed parameters: displayName.');
+
+test('throws exception if displayName is not a string', function () {
+    EmailFolderUpdateValidator::validate(['displayName' => 1]);
+})->throws(InvalidArgumentException::class, 'The displayName must be a string.');
+
+test('allows empty input without throwing an exception', function () {
+    $response = EmailFolderUpdateValidator::validate([]);
+    expect($response)->toBe([]);
+});