Skip to content

Add property name in draft-3 required error #430

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

Closed
wants to merge 7 commits into from
Closed

Add property name in draft-3 required error #430

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c8dab75
Update error message for draft-3 required error
sunspikes Jun 2, 2017
e751344
Pass property name for draft-3 required error
sunspikes Jun 2, 2017
a51699f
Merge pull request #1 from sunspikes/sunspikes-patch-1
sunspikes Jun 2, 2017
681b821
Removing the REQUIRED_D3 constant
sunspikes Jun 2, 2017
378c675
Changing the property name access to use end
sunspikes Jun 2, 2017
63dfb85
Update UndefinedConstraint.php
sunspikes Jun 2, 2017
c950d2d
Reverting to use intermediate variable
sunspikes Jun 2, 2017
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
2 changes: 1 addition & 1 deletion src/JsonSchema/ConstraintError.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ public function getMessage()
self::NOT => 'Matched a schema which it should not',
self::ONE_OF => 'Failed to match exactly one schema',
self::REQUIRED => 'The property %s is required',
self::REQUIRED_D3 => 'Is missing and it is required',
self::REQUIRED_D3 => 'The property %s is required',
Copy link
Contributor

@erayd erayd Jun 2, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line is redundant - there's already an identical message template on line 95 (REQUIRED), so IMO it makes more sense to just use that.

self::REQUIRES => 'The presence of the property %s requires that %s also be present',
self::PATTERN => 'Does not match the regex pattern %s',
self::PREGEX_INVALID => 'The pattern %s is invalid',
Expand Down
3 changes: 2 additions & 1 deletion src/JsonSchema/Constraints/UndefinedConstraint.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,8 @@ protected function validateCommonProperties(&$value, $schema = null, JsonPointer
} elseif (isset($schema->required) && !is_array($schema->required)) {
// Draft 3 - Required attribute - e.g. "foo": {"type": "string", "required": true}
if ($schema->required && $value instanceof self) {
$this->addError(ConstraintError::REQUIRED_D3(), $path);
$propertyName = current($path->getPropertyPaths());
Copy link
Contributor

@erayd erayd Jun 2, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use end() rather than current() - current() makes assumptions about the state of the internal pointer on the returned array, which could result in hard-to-find bugs if the pointer code is changed at a later date.

$this->addError(ConstraintError::REQUIRED_D3(), $path, array('property' => $propertyName));
}
}
}
Expand Down