Skip to content

fix: allow properties named "schema" #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
martin-helmich merged 1 commit into from
Sep 2, 2025
Merged

fix: allow properties named "schema" #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Generator/Generator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ public function generateValidateMethod(): MethodGenerator
MethodGenerator::FLAG_PUBLIC | MethodGenerator::FLAG_STATIC,
'$validator = ' . $newValidatorClassExpr . ';' . "\n" .
'$input = is_array($input) ? \\JsonSchema\\Validator::arrayToObjectRecursive($input) : $input;' . "\n" .
'$validator->validate($input, self::$schema);' . "\n\n" .
'$validator->validate($input, self::$internalValidationSchema);' . "\n\n" .
'if (!$validator->isValid() && !$return) {' . "\n" .
($this->generatorRequest->isAtLeastPHP("7.0") ?
' $errors = array_map(function(array $e): string {' . "\n" :
Expand Down Expand Up @@ -355,7 +355,7 @@ public function generateSetterMethod(PropertyInterface $property): MethodGenerat
$setterValidation = "";
} else {
$setterValidation = "\$validator = new \JsonSchema\Validator();
\$validator->validate(\$$name, self::\$schema['properties']['$key']);
\$validator->validate(\$$name, self::\$internalValidationSchema['properties']['$key']);
if (!\$validator->isValid()) {
throw new \InvalidArgumentException(\$validator->getErrors()[0]['message']);
}
Expand Down
2 changes: 1 addition & 1 deletion src/Generator/SchemaToClass.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public function schemaToClass(GeneratorRequest $req): void
throw new GeneratorException("cannot generate class for types other than 'object'");
}

$schemaProperty = new PropertyGenerator("schema", $schema, PropertyGenerator::FLAG_PRIVATE | PropertyGenerator::FLAG_STATIC);
$schemaProperty = new PropertyGenerator("internalValidationSchema", $schema, PropertyGenerator::FLAG_PRIVATE | PropertyGenerator::FLAG_STATIC);
$schemaProperty->setDocBlock(new DocBlockGenerator(
"Schema used to validate input for creating instances of this class",
null,
Expand Down
4 changes: 2 additions & 2 deletions src/Spec/Specification.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class Specification
*
* @var array
*/
private static array $schema = [
private static array $internalValidationSchema = [
'required' => [
'files',
],
Expand Down Expand Up @@ -269,7 +269,7 @@ public static function validateInput(array|object $input, bool $return = false)
{
$validator = new \JsonSchema\Validator();
$input = is_array($input) ? \JsonSchema\Validator::arrayToObjectRecursive($input) : $input;
$validator->validate($input, self::$schema);
$validator->validate($input, self::$internalValidationSchema);

if (!$validator->isValid() && !$return) {
$errors = array_map(function(array $e): string {
Expand Down
12 changes: 6 additions & 6 deletions src/Spec/SpecificationFilesItem.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class SpecificationFilesItem
*
* @var array
*/
private static array $schema = [
private static array $internalValidationSchema = [
'required' => [
'input',
'className',
Expand Down Expand Up @@ -104,7 +104,7 @@ public function getTargetNamespace() : ?string
public function withInput(string $input) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($input, self::$schema['properties']['input']);
$validator->validate($input, self::$internalValidationSchema['properties']['input']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand All @@ -122,7 +122,7 @@ public function withInput(string $input) : self
public function withClassName(string $className) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($className, self::$schema['properties']['className']);
$validator->validate($className, self::$internalValidationSchema['properties']['className']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand All @@ -140,7 +140,7 @@ public function withClassName(string $className) : self
public function withTargetDirectory(string $targetDirectory) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($targetDirectory, self::$schema['properties']['targetDirectory']);
$validator->validate($targetDirectory, self::$internalValidationSchema['properties']['targetDirectory']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand All @@ -158,7 +158,7 @@ public function withTargetDirectory(string $targetDirectory) : self
public function withTargetNamespace(string $targetNamespace) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($targetNamespace, self::$schema['properties']['targetNamespace']);
$validator->validate($targetNamespace, self::$internalValidationSchema['properties']['targetNamespace']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand Down Expand Up @@ -238,7 +238,7 @@ public static function validateInput(array|object $input, bool $return = false)
{
$validator = new \JsonSchema\Validator();
$input = is_array($input) ? \JsonSchema\Validator::arrayToObjectRecursive($input) : $input;
$validator->validate($input, self::$schema);
$validator->validate($input, self::$internalValidationSchema);

if (!$validator->isValid() && !$return) {
$errors = array_map(function(array $e): string {
Expand Down
12 changes: 6 additions & 6 deletions src/Spec/SpecificationOptions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class SpecificationOptions
*
* @var array
*/
private static array $schema = [
private static array $internalValidationSchema = [
'properties' => [
'disableStrictTypes' => [
'type' => 'boolean',
Expand Down Expand Up @@ -134,7 +134,7 @@ public function getNewValidatorClassExpr() : string
public function withDisableStrictTypes(bool $disableStrictTypes) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($disableStrictTypes, self::$schema['properties']['disableStrictTypes']);
$validator->validate($disableStrictTypes, self::$internalValidationSchema['properties']['disableStrictTypes']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand Down Expand Up @@ -163,7 +163,7 @@ public function withoutDisableStrictTypes() : self
public function withTreatValuesWithDefaultAsOptional(bool $treatValuesWithDefaultAsOptional) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($treatValuesWithDefaultAsOptional, self::$schema['properties']['treatValuesWithDefaultAsOptional']);
$validator->validate($treatValuesWithDefaultAsOptional, self::$internalValidationSchema['properties']['treatValuesWithDefaultAsOptional']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand Down Expand Up @@ -192,7 +192,7 @@ public function withoutTreatValuesWithDefaultAsOptional() : self
public function withInlineAllofReferences(bool $inlineAllofReferences) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($inlineAllofReferences, self::$schema['properties']['inlineAllofReferences']);
$validator->validate($inlineAllofReferences, self::$internalValidationSchema['properties']['inlineAllofReferences']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand Down Expand Up @@ -244,7 +244,7 @@ public function withoutTargetPHPVersion() : self
public function withNewValidatorClassExpr(string $newValidatorClassExpr) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($newValidatorClassExpr, self::$schema['properties']['newValidatorClassExpr']);
$validator->validate($newValidatorClassExpr, self::$internalValidationSchema['properties']['newValidatorClassExpr']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand Down Expand Up @@ -355,7 +355,7 @@ public static function validateInput(array|object $input, bool $return = false)
{
$validator = new \JsonSchema\Validator();
$input = is_array($input) ? \JsonSchema\Validator::arrayToObjectRecursive($input) : $input;
$validator->validate($input, self::$schema);
$validator->validate($input, self::$internalValidationSchema);

if (!$validator->isValid() && !$return) {
$errors = array_map(function(array $e): string {
Expand Down
8 changes: 4 additions & 4 deletions tests/Generator/Fixtures/AdditionalProps/Output/Foo.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class Foo
*
* @var array
*/
private static array $schema = [
private static array $internalValidationSchema = [
'type' => 'object',
'properties' => [
'name' => [
Expand Down Expand Up @@ -66,7 +66,7 @@ public function getParams() : ?array
public function withName(string $name) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($name, self::$schema['properties']['name']);
$validator->validate($name, self::$internalValidationSchema['properties']['name']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand Down Expand Up @@ -95,7 +95,7 @@ public function withoutName() : self
public function withParams(array $params) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($params, self::$schema['properties']['params']);
$validator->validate($params, self::$internalValidationSchema['properties']['params']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand Down Expand Up @@ -177,7 +177,7 @@ public static function validateInput(array|object $input, bool $return = false)
{
$validator = new \JsonSchema\Validator();
$input = is_array($input) ? \JsonSchema\Validator::arrayToObjectRecursive($input) : $input;
$validator->validate($input, self::$schema);
$validator->validate($input, self::$internalValidationSchema);

if (!$validator->isValid() && !$return) {
$errors = array_map(function(array $e): string {
Expand Down
10 changes: 5 additions & 5 deletions tests/Generator/Fixtures/AllOfRef/Output/Foo.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class Foo
*
* @var array
*/
private static array $schema = [
private static array $internalValidationSchema = [
'required' => [
'city',
'street',
Expand Down Expand Up @@ -89,7 +89,7 @@ public function getCountry() : string
public function withCity(string $city) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($city, self::$schema['properties']['city']);
$validator->validate($city, self::$internalValidationSchema['properties']['city']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand All @@ -107,7 +107,7 @@ public function withCity(string $city) : self
public function withStreet(string $street) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($street, self::$schema['properties']['street']);
$validator->validate($street, self::$internalValidationSchema['properties']['street']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand All @@ -125,7 +125,7 @@ public function withStreet(string $street) : self
public function withCountry(string $country) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($country, self::$schema['properties']['country']);
$validator->validate($country, self::$internalValidationSchema['properties']['country']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand Down Expand Up @@ -187,7 +187,7 @@ public static function validateInput(array|object $input, bool $return = false)
{
$validator = new \JsonSchema\Validator();
$input = is_array($input) ? \JsonSchema\Validator::arrayToObjectRecursive($input) : $input;
$validator->validate($input, self::$schema);
$validator->validate($input, self::$internalValidationSchema);

if (!$validator->isValid() && !$return) {
$errors = array_map(function(array $e): string {
Expand Down
8 changes: 4 additions & 4 deletions tests/Generator/Fixtures/Basic/Output/Foo.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class Foo
*
* @var array
*/
private static array $schema = [
private static array $internalValidationSchema = [
'required' => [
'foo_bar',
],
Expand Down Expand Up @@ -66,7 +66,7 @@ public function getFooBar() : string
public function withFoo(string $foo) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($foo, self::$schema['properties']['foo']);
$validator->validate($foo, self::$internalValidationSchema['properties']['foo']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand Down Expand Up @@ -95,7 +95,7 @@ public function withoutFoo() : self
public function withFooBar(string $fooBar) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($fooBar, self::$schema['properties']['foo_bar']);
$validator->validate($fooBar, self::$internalValidationSchema['properties']['foo_bar']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand Down Expand Up @@ -160,7 +160,7 @@ public static function validateInput(array|object $input, bool $return = false)
{
$validator = new \JsonSchema\Validator();
$input = is_array($input) ? \JsonSchema\Validator::arrayToObjectRecursive($input) : $input;
$validator->validate($input, self::$schema);
$validator->validate($input, self::$internalValidationSchema);

if (!$validator->isValid() && !$return) {
$errors = array_map(function(array $e): string {
Expand Down
8 changes: 4 additions & 4 deletions tests/Generator/Fixtures/DefaultValue/Output/Foo.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class Foo
*
* @var array
*/
private static array $schema = [
private static array $internalValidationSchema = [
'required' => [

],
Expand Down Expand Up @@ -68,7 +68,7 @@ public function getSkip() : int
public function withLimit(int $limit) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($limit, self::$schema['properties']['limit']);
$validator->validate($limit, self::$internalValidationSchema['properties']['limit']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand Down Expand Up @@ -97,7 +97,7 @@ public function withoutLimit() : self
public function withSkip(int $skip) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($skip, self::$schema['properties']['skip']);
$validator->validate($skip, self::$internalValidationSchema['properties']['skip']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand Down Expand Up @@ -179,7 +179,7 @@ public static function validateInput(array|object $input, bool $return = false)
{
$validator = new \JsonSchema\Validator();
$input = is_array($input) ? \JsonSchema\Validator::arrayToObjectRecursive($input) : $input;
$validator->validate($input, self::$schema);
$validator->validate($input, self::$internalValidationSchema);

if (!$validator->isValid() && !$return) {
$errors = array_map(function(array $e): string {
Expand Down
8 changes: 4 additions & 4 deletions tests/Generator/Fixtures/DefaultValueAsOptional/Output/Foo.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class Foo
*
* @var array
*/
private static array $schema = [
private static array $internalValidationSchema = [
'required' => [

],
Expand Down Expand Up @@ -68,7 +68,7 @@ public function getSkip() : int
public function withLimit(int $limit) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($limit, self::$schema['properties']['limit']);
$validator->validate($limit, self::$internalValidationSchema['properties']['limit']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand All @@ -86,7 +86,7 @@ public function withLimit(int $limit) : self
public function withSkip(int $skip) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($skip, self::$schema['properties']['skip']);
$validator->validate($skip, self::$internalValidationSchema['properties']['skip']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand Down Expand Up @@ -153,7 +153,7 @@ public static function validateInput(array|object $input, bool $return = false)
{
$validator = new \JsonSchema\Validator();
$input = is_array($input) ? \JsonSchema\Validator::arrayToObjectRecursive($input) : $input;
$validator->validate($input, self::$schema);
$validator->validate($input, self::$internalValidationSchema);

if (!$validator->isValid() && !$return) {
$errors = array_map(function(array $e): string {
Expand Down
8 changes: 4 additions & 4 deletions tests/Generator/Fixtures/DuplicateWithDifferentCasing/Output/Foo.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class Foo
*
* @var array
*/
private static array $schema = [
private static array $internalValidationSchema = [
'required' => [
'fooBar',
],
Expand Down Expand Up @@ -79,7 +79,7 @@ public function getBar() : ?string
public function withFooBar(string $fooBar) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($fooBar, self::$schema['properties']['fooBar']);
$validator->validate($fooBar, self::$internalValidationSchema['properties']['fooBar']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand All @@ -98,7 +98,7 @@ public function withFooBar(string $fooBar) : self
public function withBar(string $bar) : self
{
$validator = new \JsonSchema\Validator();
$validator->validate($bar, self::$schema['properties']['bar']);
$validator->validate($bar, self::$internalValidationSchema['properties']['bar']);
if (!$validator->isValid()) {
throw new \InvalidArgumentException($validator->getErrors()[0]['message']);
}
Expand Down Expand Up @@ -182,7 +182,7 @@ public static function validateInput(array|object $input, bool $return = false)
{
$validator = new \JsonSchema\Validator();
$input = is_array($input) ? \JsonSchema\Validator::arrayToObjectRecursive($input) : $input;
$validator->validate($input, self::$schema);
$validator->validate($input, self::$internalValidationSchema);

if (!$validator->isValid() && !$return) {
$errors = array_map(function(array $e): string {
Expand Down
Loading