-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[Config] extracted the xml parsing from XmlUtils::loadFile into XmlUt… #23482
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.
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
Closed
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
64c2efd
[Security] Fix authentication.failure event not dispatched on Account…
chalasr 025dfff
Use rawurlencode() to transform the Cookie into a string
javiereguiluz 676a17e
bug #23461 Use rawurlencode() to transform the Cookie into a string (…
nicolas-grekas c2a6a6e
bug #23256 [Security] Fix authentication.failure event not dispatched…
nicolas-grekas d8f6ab1
[Config] extracted the xml parsing from XmlUtils::loadFile into XmlUt…
Basster 450348a
code style fixes.
Basster 43b2c2f
renamed load to parse, that's more specific.
Basster 533dbb6
make the file test windows compatible
Basster File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,9 +18,12 @@ | |
* | ||
* @author Fabien Potencier <fabien@symfony.com> | ||
* @author Martin Hasoň <martin.hason@gmail.com> | ||
* @author Ole Rößner <ole@roessner.it> | ||
*/ | ||
class XmlUtils | ||
{ | ||
const XML_IS_NOT_VALID_MESSAGE = 'The XML is not valid.'; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. -1 for defining a public constant with this message. We don't do it anywhere in Symfony There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. okay |
||
|
||
/** | ||
* This class should not be instantiated. | ||
*/ | ||
|
@@ -29,22 +32,17 @@ private function __construct() | |
} | ||
|
||
/** | ||
* Loads an XML file. | ||
* Parses an XML string. | ||
* | ||
* @param string $file An XML file path | ||
* @param string $content An XML string | ||
* @param string|callable|null $schemaOrCallable An XSD schema file path, a callable, or null to disable validation | ||
* | ||
* @return \DOMDocument | ||
* | ||
* @throws \InvalidArgumentException When loading of XML file returns error | ||
*/ | ||
public static function loadFile($file, $schemaOrCallable = null) | ||
public static function parse($content, $schemaOrCallable = null) | ||
{ | ||
$content = @file_get_contents($file); | ||
if ('' === trim($content)) { | ||
throw new \InvalidArgumentException(sprintf('File %s does not contain valid XML, it is empty.', $file)); | ||
} | ||
|
||
$internalErrors = libxml_use_internal_errors(true); | ||
$disableEntities = libxml_disable_entity_loader(true); | ||
libxml_clear_errors(); | ||
|
@@ -91,7 +89,7 @@ public static function loadFile($file, $schemaOrCallable = null) | |
if (!$valid) { | ||
$messages = static::getXmlErrors($internalErrors); | ||
if (empty($messages)) { | ||
$messages = array(sprintf('The XML file "%s" is not valid.', $file)); | ||
$messages = array(self::XML_IS_NOT_VALID_MESSAGE); | ||
} | ||
throw new \InvalidArgumentException(implode("\n", $messages), 0, $e); | ||
} | ||
|
@@ -103,6 +101,34 @@ public static function loadFile($file, $schemaOrCallable = null) | |
return $dom; | ||
} | ||
|
||
/** | ||
* Loads an XML file. | ||
* | ||
* @param string $file An XML file path | ||
* @param string|callable|null $schemaOrCallable An XSD schema file path, a callable, or null to disable validation | ||
* | F438 tr>||
* @return \DOMDocument | ||
* | ||
* @throws \InvalidArgumentException When loading of XML file returns error | ||
*/ | ||
public static function loadFile($file, $schemaOrCallable = null) | ||
{ | ||
$content = @file_get_contents($file); | ||
if ('' === trim($content)) { | ||
throw new \InvalidArgumentException(sprintf('File %s does not contain valid XML, it is empty.', $file)); | ||
} | ||
|
||
try { | ||
return static::parse($content, $schemaOrCallable); | ||
} catch (\InvalidArgumentException $ex) { | ||
throw new \InvalidArgumentException( | ||
str_replace(self::XML_IS_NOT_VALID_MESSAGE, sprintf('The XML file "%s" is not valid.', $file), $ex->getMessage()), | ||
$ex->getCode(), | ||
$ex->getPrevious() | ||
); | ||
} | ||
} | ||
|
||
/** | ||
* Converts a \DomElement object to a PHP array. | ||
* | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A better solution is to use
@expectedException
and@expectedExceptionMessage
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just re-used the way it has been done in the other tests in this class. Normally I'd go with the annotations, too.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other tests are written this way, because they try to test multiple cases in the same test. This is a legacy from tests written in the early days of Symfony's usage of PHPUnit.