mirror of
https://github.com/retailcrm/graphql-php.git
synced 2025-04-03 12:43:31 +03:00
8747ff8954
This RFC adds a new form of `StringValue`, the multi-line string, similar to that found in Python and Scala. A multi-line string starts and ends with a triple-quote: ``` """This is a triple-quoted string and it can contain multiple lines""" ``` Multi-line strings are useful for typing literal bodies of text where new lines should be interpretted literally. In fact, the only escape sequence used is `\"""` and `\` is otherwise allowed unescaped. This is beneficial when writing documentation within strings which may reference the back-slash often: ``` """ In a multi-line string \n and C:\\ are unescaped. """ ``` The primary value of multi-line strings are to write long-form input directly in query text, in tools like GraphiQL, and as a prerequisite to another pending RFC to allow docstring style documentation in the Schema Definition Language. Ref: graphql/graphql-js#926
61 lines
No EOL
1.8 KiB
PHP
61 lines
No EOL
1.8 KiB
PHP
<?php
|
|
namespace GraphQL\Utils;
|
|
|
|
class BlockString {
|
|
/**
|
|
* Produces the value of a block string from its parsed raw value, similar to
|
|
* Coffeescript's block string, Python's docstring trim or Ruby's strip_heredoc.
|
|
*
|
|
* This implements the GraphQL spec's BlockStringValue() static algorithm.
|
|
*/
|
|
public static function value($rawString) {
|
|
// Expand a block string's raw value into independent lines.
|
|
$lines = preg_split("/\\r\\n|[\\n\\r]/", $rawString);
|
|
|
|
// Remove common indentation from all lines but first.
|
|
$commonIndent = null;
|
|
$linesLength = count($lines);
|
|
|
|
for ($i = 1; $i < $linesLength; $i++) {
|
|
$line = $lines[$i];
|
|
$indent = self::leadingWhitespace($line);
|
|
|
|
if (
|
|
$indent < mb_strlen($line) &&
|
|
($commonIndent === null || $indent < $commonIndent)
|
|
) {
|
|
$commonIndent = $indent;
|
|
if ($commonIndent === 0) {
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($commonIndent) {
|
|
for ($i = 1; $i < $linesLength; $i++) {
|
|
$line = $lines[$i];
|
|
$lines[$i] = mb_substr($line, $commonIndent);
|
|
}
|
|
}
|
|
|
|
// Remove leading and trailing blank lines.
|
|
while (count($lines) > 0 && trim($lines[0], " \t") === '') {
|
|
array_shift($lines);
|
|
}
|
|
while (count($lines) > 0 && trim($lines[count($lines) - 1], " \t") === '') {
|
|
array_pop($lines);
|
|
}
|
|
|
|
// Return a string of the lines joined with U+000A.
|
|
return implode("\n", $lines);
|
|
}
|
|
|
|
private static function leadingWhitespace($str) {
|
|
$i = 0;
|
|
while ($i < mb_strlen($str) && ($str[$i] === ' ' || $str[$i] === '\t')) {
|
|
$i++;
|
|
}
|
|
|
|
return $i;
|
|
}
|
|
} |