nextcloud / server

lib/private/RichObjectStrings/Validator.php

Indentation +87 added lines, -87 removed lines

@@ -21,91 +21,91 @@
  * @since 11.0.0
  */
 class Validator implements IValidator {
-	protected array $requiredParameters = [];
-
-	public function __construct(
-		protected Definitions $definitions,
-	) {
-	}
-
-	/**
-	 * @param string $subject
-	 * @param array<non-empty-string, RichObjectParameter> $parameters
-	 * @throws InvalidObjectExeption
-	 * @since 11.0.0
-	 */
-	public function validate(string $subject, array $parameters): void {
-		$matches = [];
-		$result = preg_match_all('/\{(' . self::PLACEHOLDER_REGEX . ')\}/', $subject, $matches);
-
-		if ($result === false) {
-			throw new InvalidObjectExeption();
-		}
-
-		if (!empty($matches[1])) {
-			foreach ($matches[1] as $parameter) {
-				if (!isset($parameters[$parameter])) {
-					throw new InvalidObjectExeption('Parameter is undefined');
-				}
-			}
-		}
-
-		foreach ($parameters as $placeholder => $parameter) {
-			if (!\is_string($placeholder) || !preg_match('/^(' . self::PLACEHOLDER_REGEX . ')$/i', $placeholder)) {
-				throw new InvalidObjectExeption('Parameter key is invalid');
-			}
-			if (!\is_array($parameter)) {
-				throw new InvalidObjectExeption('Parameter is malformed');
-			}
-
-			$this->validateParameter($placeholder, $parameter);
-		}
-	}
-
-	/**
-	 * @param array $parameter
-	 * @throws InvalidObjectExeption
-	 */
-	protected function validateParameter(string $placeholder, array $parameter): void {
-		if (!isset($parameter['type'])) {
-			throw new InvalidObjectExeption('Object type is undefined');
-		}
-
-		$definition = $this->definitions->getDefinition($parameter['type']);
-		$requiredParameters = $this->getRequiredParameters($parameter['type'], $definition);
-
-		$missingKeys = array_diff($requiredParameters, array_keys($parameter));
-		if (!empty($missingKeys)) {
-			throw new InvalidObjectExeption('Object for placeholder ' . $placeholder . ' is invalid, missing keys:' . json_encode($missingKeys));
-		}
-
-		foreach ($parameter as $key => $value) {
-			if (!is_string($key)) {
-				Server::get(LoggerInterface::class)->error('Object for placeholder ' . $placeholder . ' is invalid, key ' . $key . ' is not a string');
-			}
-			if (!is_string($value)) {
-				Server::get(LoggerInterface::class)->error('Object for placeholder ' . $placeholder . ' is invalid, value ' . $value . ' for key ' . $key . ' is not a string');
-			}
-		}
-	}
-
-	/**
-	 * @param string $type
-	 * @param array $definition
-	 * @return string[]
-	 */
-	protected function getRequiredParameters(string $type, array $definition): array {
-		if (isset($this->requiredParameters[$type])) {
-			return $this->requiredParameters[$type];
-		}
-
-		$this->requiredParameters[$type] = [];
-		foreach ($definition['parameters'] as $parameter => $data) {
-			if ($data['required']) {
-				$this->requiredParameters[$type][] = $parameter;
-			}
-		}
-
-		return $this->requiredParameters[$type];
-	}
+    protected array $requiredParameters = [];
+
+    public function __construct(
+        protected Definitions $definitions,
+    ) {
+    }
+
+    /**
+     * @param string $subject
+     * @param array<non-empty-string, RichObjectParameter> $parameters
+     * @throws InvalidObjectExeption
+     * @since 11.0.0
+     */
+    public function validate(string $subject, array $parameters): void {
+        $matches = [];
+        $result = preg_match_all('/\{(' . self::PLACEHOLDER_REGEX . ')\}/', $subject, $matches);
+
+        if ($result === false) {
+            throw new InvalidObjectExeption();
+        }
+
+        if (!empty($matches[1])) {
+            foreach ($matches[1] as $parameter) {
+                if (!isset($parameters[$parameter])) {
+                    throw new InvalidObjectExeption('Parameter is undefined');
+                }
+            }
+        }
+
+        foreach ($parameters as $placeholder => $parameter) {
+            if (!\is_string($placeholder) || !preg_match('/^(' . self::PLACEHOLDER_REGEX . ')$/i', $placeholder)) {
+                throw new InvalidObjectExeption('Parameter key is invalid');
+            }
+            if (!\is_array($parameter)) {
+                throw new InvalidObjectExeption('Parameter is malformed');
+            }
+
+            $this->validateParameter($placeholder, $parameter);
+        }
+    }
+
+    /**
+     * @param array $parameter
+     * @throws InvalidObjectExeption
+     */
+    protected function validateParameter(string $placeholder, array $parameter): void {
+        if (!isset($parameter['type'])) {
+            throw new InvalidObjectExeption('Object type is undefined');
+        }
+
+        $definition = $this->definitions->getDefinition($parameter['type']);
+        $requiredParameters = $this->getRequiredParameters($parameter['type'], $definition);
+
+        $missingKeys = array_diff($requiredParameters, array_keys($parameter));
+        if (!empty($missingKeys)) {
+            throw new InvalidObjectExeption('Object for placeholder ' . $placeholder . ' is invalid, missing keys:' . json_encode($missingKeys));
+        }
+
+        foreach ($parameter as $key => $value) {
+            if (!is_string($key)) {
+                Server::get(LoggerInterface::class)->error('Object for placeholder ' . $placeholder . ' is invalid, key ' . $key . ' is not a string');
+            }
+            if (!is_string($value)) {
+                Server::get(LoggerInterface::class)->error('Object for placeholder ' . $placeholder . ' is invalid, value ' . $value . ' for key ' . $key . ' is not a string');
+            }
+        }
+    }
+
+    /**
+     * @param string $type
+     * @param array $definition
+     * @return string[]
+     */
+    protected function getRequiredParameters(string $type, array $definition): array {
+        if (isset($this->requiredParameters[$type])) {
+            return $this->requiredParameters[$type];
+        }
+
+        $this->requiredParameters[$type] = [];
+        foreach ($definition['parameters'] as $parameter => $data) {
+            if ($data['required']) {
+                $this->requiredParameters[$type][] = $parameter;
+            }
+        }
+
+        return $this->requiredParameters[$type];
+    }
 }

Spacing +5 added lines, -5 removed lines

@@ -36,7 +36,7 @@ 
 	 */
 	public function validate(string $subject, array $parameters): void {
 		$matches = [];
-		$result = preg_match_all('/\{(' . self::PLACEHOLDER_REGEX . ')\}/', $subject, $matches);
+		$result = preg_match_all('/\{('.self::PLACEHOLDER_REGEX.')\}/', $subject, $matches);
 
 		if ($result === false) {
 			throw new InvalidObjectExeption();
@@ -51,7 +51,7 @@ 
 		}
 
 		foreach ($parameters as $placeholder => $parameter) {
-			if (!\is_string($placeholder) || !preg_match('/^(' . self::PLACEHOLDER_REGEX . ')$/i', $placeholder)) {
+			if (!\is_string($placeholder) || !preg_match('/^('.self::PLACEHOLDER_REGEX.')$/i', $placeholder)) {
 				throw new InvalidObjectExeption('Parameter key is invalid');
 			}
 			if (!\is_array($parameter)) {
@@ -76,15 +76,15 @@ 
 
 		$missingKeys = array_diff($requiredParameters, array_keys($parameter));
 		if (!empty($missingKeys)) {
-			throw new InvalidObjectExeption('Object for placeholder ' . $placeholder . ' is invalid, missing keys:' . json_encode($missingKeys));
+			throw new InvalidObjectExeption('Object for placeholder '.$placeholder.' is invalid, missing keys:'.json_encode($missingKeys));
 		}
 
 		foreach ($parameter as $key => $value) {
 			if (!is_string($key)) {
-				Server::get(LoggerInterface::class)->error('Object for placeholder ' . $placeholder . ' is invalid, key ' . $key . ' is not a string');
+				Server::get(LoggerInterface::class)->error('Object for placeholder '.$placeholder.' is invalid, key '.$key.' is not a string');
 			}
 			if (!is_string($value)) {
-				Server::get(LoggerInterface::class)->error('Object for placeholder ' . $placeholder . ' is invalid, value ' . $value . ' for key ' . $key . ' is not a string');
+				Server::get(LoggerInterface::class)->error('Object for placeholder '.$placeholder.' is invalid, value '.$value.' for key '.$key.' is not a string');
 			}
 		}
 	}

tests/lib/RichObjectStrings/ValidatorTest.php

Indentation +77 added lines, -77 removed lines

@@ -13,88 +13,88 @@
 use Test\TestCase;
 
 class ValidatorTest extends TestCase {
-	public function testValidate(): void {
-		$v = new Validator(new Definitions());
-		$v->validate('test', []);
-		$v->validate('test {string1} test {foo} test {bar}.', [
-			'string1' => [
-				'type' => 'user',
-				'id' => 'johndoe',
-				'name' => 'John Doe',
-			],
-			'foo' => [
-				'type' => 'user-group',
-				'id' => 'sample',
-				'name' => 'Sample Group',
-			],
-			'bar' => [
-				'type' => 'file',
-				'id' => '42',
-				'name' => 'test.txt',
-				'path' => 'path/to/test.txt',
-			],
-		]);
-		$this->addToAssertionCount(2);
+    public function testValidate(): void {
+        $v = new Validator(new Definitions());
+        $v->validate('test', []);
+        $v->validate('test {string1} test {foo} test {bar}.', [
+            'string1' => [
+                'type' => 'user',
+                'id' => 'johndoe',
+                'name' => 'John Doe',
+            ],
+            'foo' => [
+                'type' => 'user-group',
+                'id' => 'sample',
+                'name' => 'Sample Group',
+            ],
+            'bar' => [
+                'type' => 'file',
+                'id' => '42',
+                'name' => 'test.txt',
+                'path' => 'path/to/test.txt',
+            ],
+        ]);
+        $this->addToAssertionCount(2);
 
-		$v->validate('test {string1} test.', [
-			'string1' => [
-				'type' => 'user',
-				'id' => 'johndoe',
-				'name' => 'John Doe',
-				'key' => 123,
-			],
-		]);
+        $v->validate('test {string1} test.', [
+            'string1' => [
+                'type' => 'user',
+                'id' => 'johndoe',
+                'name' => 'John Doe',
+                'key' => 123,
+            ],
+        ]);
 
-		$v->validate('test {string1} test.', [
-			'string1' => [
-				'type' => 'user',
-				'id' => 'johndoe',
-				'name' => 'John Doe',
-				456 => 'value',
-			],
-		]);
-	}
+        $v->validate('test {string1} test.', [
+            'string1' => [
+                'type' => 'user',
+                'id' => 'johndoe',
+                'name' => 'John Doe',
+                456 => 'value',
+            ],
+        ]);
+    }
 
-	public static function dataValidateParameterKeys(): array {
-		return [
-			'not a string' => ['key' => 0, 'throws' => 'Parameter key is invalid'],
-			'@ is not allowed' => ['key' => 'user@0', 'throws' => 'Parameter key is invalid'],
-			'? is not allowed' => ['key' => 'user?0', 'throws' => 'Parameter key is invalid'],
-			'slash is not allowed' => ['key' => 'user/0', 'throws' => 'Parameter key is invalid'],
-			'backslash is not allowed' => ['key' => 'user\\0', 'throws' => 'Parameter key is invalid'],
-			'hash is not allowed' => ['key' => 'user#0', 'throws' => 'Parameter key is invalid'],
-			'space is not allowed' => ['key' => 'user 0', 'throws' => 'Parameter key is invalid'],
-			'has to start with letter, but is number' => ['key' => '0abc', 'throws' => 'Parameter key is invalid'],
-			'has to start with letter, but is dot' => ['key' => '.abc', 'throws' => 'Parameter key is invalid'],
-			'has to start with letter, but is slash' => ['key' => '-abc', 'throws' => 'Parameter key is invalid'],
-			'has to start with letter, but is underscore' => ['key' => '_abc', 'throws' => 'Parameter key is invalid'],
-			['key' => 'user-0', 'throws' => null],
-			['key' => 'user_0', 'throws' => null],
-			['key' => 'user.0', 'throws' => null],
-			['key' => 'a._-0', 'throws' => null],
-		];
-	}
+    public static function dataValidateParameterKeys(): array {
+        return [
+            'not a string' => ['key' => 0, 'throws' => 'Parameter key is invalid'],
+            '@ is not allowed' => ['key' => 'user@0', 'throws' => 'Parameter key is invalid'],
+            '? is not allowed' => ['key' => 'user?0', 'throws' => 'Parameter key is invalid'],
+            'slash is not allowed' => ['key' => 'user/0', 'throws' => 'Parameter key is invalid'],
+            'backslash is not allowed' => ['key' => 'user\\0', 'throws' => 'Parameter key is invalid'],
+            'hash is not allowed' => ['key' => 'user#0', 'throws' => 'Parameter key is invalid'],
+            'space is not allowed' => ['key' => 'user 0', 'throws' => 'Parameter key is invalid'],
+            'has to start with letter, but is number' => ['key' => '0abc', 'throws' => 'Parameter key is invalid'],
+            'has to start with letter, but is dot' => ['key' => '.abc', 'throws' => 'Parameter key is invalid'],
+            'has to start with letter, but is slash' => ['key' => '-abc', 'throws' => 'Parameter key is invalid'],
+            'has to start with letter, but is underscore' => ['key' => '_abc', 'throws' => 'Parameter key is invalid'],
+            ['key' => 'user-0', 'throws' => null],
+            ['key' => 'user_0', 'throws' => null],
+            ['key' => 'user.0', 'throws' => null],
+            ['key' => 'a._-0', 'throws' => null],
+        ];
+    }
 
-	/**
-	 * @dataProvider dataValidateParameterKeys
-	 */
-	public function testValidateParameterKeys(mixed $key, ?string $throws): void {
+    /**
+     * @dataProvider dataValidateParameterKeys
+     */
+    public function testValidateParameterKeys(mixed $key, ?string $throws): void {
 
-		if ($throws !== null) {
-			$this->expectExceptionMessage($throws);
-		}
+        if ($throws !== null) {
+            $this->expectExceptionMessage($throws);
+        }
 
-		$v = new Validator(new Definitions());
-		$v->validate('{' . $key . '}', [
-			$key => [
-				'type' => 'highlight',
-				'id' => 'identifier',
-				'name' => 'Display name',
-			],
-		]);
+        $v = new Validator(new Definitions());
+        $v->validate('{' . $key . '}', [
+            $key => [
+                'type' => 'highlight',
+                'id' => 'identifier',
+                'name' => 'Display name',
+            ],
+        ]);
 
-		if ($throws === null) {
-			$this->addToAssertionCount(1);
-		}
-	}
+        if ($throws === null) {
+            $this->addToAssertionCount(1);
+        }
+    }
 }