RetailCRM-Mirror/graphql-php
1
0
Fork 0
mirror of https://github.com/retailcrm/graphql-php.git synced 2024-11-29 00:25:17 +03:00
Code Issues Projects Releases Wiki Activity

Deployed ec09856 with MkDocs version: 0.17.3

Browse Source
This commit is contained in:
Vladimir Razuvaev 2018-04-20 17:39:52 +08:00
parent 7a4040d16a
commit d201004e2a
32 changed files with 495 additions and 159 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

210
404.html Executable file
View File

@ -0,0 +1,210 @@
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="/img/favicon.ico">
<title>graphql-php</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="/css/theme.css" type="text/css" />
<link rel="stylesheet" href="/css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="/css/highlight.css">
<script src="/js/jquery-2.1.1.min.js"></script>
<script src="/js/modernizr-2.8.3.min.js"></script>
<script type="text/javascript" src="/js/highlight.pack.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href="/" class="icon icon-home"> graphql-php</a>
<div role="search">
<form id ="rtd-search-form" class="wy-form" action="/search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1">
<a class="" href="/">About</a>
</li>
<li class="toctree-l1">
<a class="" href="/getting-started/">Getting Started</a>
</li>
<li class="toctree-l1">
<a class="" href="/complementary-tools/">Complementary Tools</a>
</li>
<li class="toctree-l1">
<span class="caption-text">Type Definitions</span>
<ul class="subnav">
<li class="">
<a class="" href="/type-system/">Introduction</a>
</li>
<li class="">
<a class="" href="/type-system/object-types/">Object Types</a>
</li>
<li class="">
<a class="" href="/type-system/scalar-types/">Scalar Types</a>
</li>
<li class="">
<a class="" href="/type-system/enum-types/">Enumeration Types</a>
</li>
<li class="">
<a class="" href="/type-system/lists-and-nonnulls/">Lists and Non-Null</a>
</li>
<li class="">
<a class="" href="/type-system/interfaces/">Interfaces</a>
</li>
<li class="">
<a class="" href="/type-system/unions/">Unions</a>
</li>
<li class="">
<a class="" href="/type-system/input-types/">Mutations and Input Types</a>
</li>
<li class="">
<a class="" href="/type-system/directives/">Directives</a>
</li>
<li class="">
<a class="" href="/type-system/schema/">Schema</a>
</li>
<li class="">
<a class="" href="/type-system/type-language/">Using Type Language</a>
</li>
</ul>
</li>
<li class="toctree-l1">
<a class="" href="/executing-queries/">Executing Queries</a>
</li>
<li class="toctree-l1">
<a class="" href="/data-fetching/">Fetching Data</a>
</li>
<li class="toctree-l1">
<a class="" href="/error-handling/">Handling Errors</a>
</li>
<li class="toctree-l1">
<a class="" href="/security/">Security</a>
</li>
<li class="toctree-l1">
<a class="" href="/how-it-works/">How it works</a>
</li>
<li class="toctree-l1">
<a class="" href="/reference/">Class Reference</a>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="/">graphql-php</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="/">Docs</a> &raquo;</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<h1 id="404-page-not-found">404</h1>
<p><strong>Page not found</strong></p>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
</span>
</div>
<script>var base_url = '';</script>
<script src="/js/theme.js"></script>
<script src="/search/require.js"></script>
<script src="/search/search.js"></script>
</body>
</html>

5
complementary-tools/index.html
View File

@ -190,7 +190,7 @@
<h1 id="integrations">Integrations</h1> <h1 id="integrations">Integrations</h1>
<ul> <ul>
<li><a href="https://github.com/ivome/graphql-relay-php">Integration with Relay</a></li> <li><a href="https://github.com/ivome/graphql-relay-php">Integration with Relay</a></li>
<li><a href="https://github.com/Folkloreatelier/laravel-graphql">Integration with Laravel 5</a> + <a href="https://github.com/nuwave/laravel-graphql-relay">Relay Helpers for Laravel</a></li> <li><a href="https://github.com/Folkloreatelier/laravel-graphql">Integration with Laravel 5</a> + <a href="https://github.com/nuwave/laravel-graphql-relay">Relay Helpers for Laravel</a> + <a href="https://github.com/nuwave/lighthouse">Nuwave Lighthouse</a></li>
<li><a href="https://github.com/overblog/GraphQLBundle">Symfony Bundle</a> by Overblog</li> <li><a href="https://github.com/overblog/GraphQLBundle">Symfony Bundle</a> by Overblog</li>
<li>Out of the box integration with any PSR-7 compatible framework (like <a href="http://slimframework.com">Slim</a> or <a href="http://zendframework.github.io/zend-expressive/">Zend Expressive</a>) via <a href="../executing-queries.md/#using-server">Standard Server</a></li> <li>Out of the box integration with any PSR-7 compatible framework (like <a href="http://slimframework.com">Slim</a> or <a href="http://zendframework.github.io/zend-expressive/">Zend Expressive</a>) via <a href="../executing-queries.md/#using-server">Standard Server</a></li>
</ul> </ul>
@ -251,7 +251,10 @@
</span> </span>
</div> </div>
<script>var base_url = '..';</script>
<script src="../js/theme.js"></script> <script src="../js/theme.js"></script>
<script src="../search/require.js"></script>
<script src="../search/search.js"></script>
</body> </body>
</html> </html>

1
css/theme_extra.css
View File

@ -191,3 +191,4 @@ td, th {
border: 1px solid #e1e4e5 !important; /* csslint allow: important */ border: 1px solid #e1e4e5 !important; /* csslint allow: important */
border-collapse: collapse; border-collapse: collapse;
} }

3
data-fetching/index.html
View File

@ -475,7 +475,10 @@ $promise-&gt;then(function(ExecutionResult $result) {
</span> </span>
</div> </div>
<script>var base_url = '..';</script>
<script src="../js/theme.js"></script> <script src="../js/theme.js"></script>
<script src="../search/require.js"></script>
<script src="../search/search.js"></script>
</body> </body>
</html> </html>

3
error-handling/index.html
View File

@ -401,7 +401,10 @@ echo json_encode($body);
</span> </span>
</div> </div>
<script>var base_url = '..';</script>
<script src="../js/theme.js"></script> <script src="../js/theme.js"></script>
<script src="../search/require.js"></script>
<script src="../search/search.js"></script>
</body> </body>
</html> </html>

5
executing-queries/index.html
View File

@ -313,7 +313,7 @@ $psrResponse = new SomePsr7ResponseImplementation(json_encode($result));
<p>PSR-7 is useful when you want to integrate the server into existing framework:</p> <p>PSR-7 is useful when you want to integrate the server into existing framework:</p>
<ul> <ul>
<li><a href="https://laravel.com/docs/5.1/requests#psr7-requests">PSR-7 for Laravel</a></li> <li><a href="https://laravel.com/docs/5.1/requests#psr7-requests">PSR-7 for Laravel</a></li>
<li><a href="https://symfony.com/doc/current/request/psr7.html">Symfony PSR-7 Bridge</a></li> <li><a href="https://symfony.com/doc/current/components/psr7.html">Symfony PSR-7 Bridge</a></li>
<li><a href="https://www.slimframework.com/docs/concepts/value-objects.html">Slim</a></li> <li><a href="https://www.slimframework.com/docs/concepts/value-objects.html">Slim</a></li>
<li><a href="http://zendframework.github.io/zend-expressive/">Zend Expressive</a></li> <li><a href="http://zendframework.github.io/zend-expressive/">Zend Expressive</a></li>
</ul> </ul>
@ -515,7 +515,10 @@ $server = new StandardServer([
</span> </span>
</div> </div>
<script>var base_url = '..';</script>
<script src="../js/theme.js"></script> <script src="../js/theme.js"></script>
<script src="../search/require.js"></script>
<script src="../search/search.js"></script>
</body> </body>
</html> </html>

3
getting-started/index.html
View File

@ -344,7 +344,10 @@ It is quite close to real-world GraphQL hierarchies. Follow instructions and try
</span> </span>
</div> </div>
<script>var base_url = '..';</script>
<script src="../js/theme.js"></script> <script src="../js/theme.js"></script>
<script src="../search/require.js"></script>
<script src="../search/search.js"></script>
</body> </body>
</html> </html>

3
how-it-works/index.html
View File

@ -263,7 +263,10 @@ and only <strong>errors</strong> key will be presented.</p>
</span> </span>
</div> </div>
<script>var base_url = '..';</script>
<script src="../js/theme.js"></script> <script src="../js/theme.js"></script>
<script src="../search/require.js"></script>
<script src="../search/search.js"></script>
</body> </body>
</html> </html>

11
index.html
View File

@ -61,7 +61,7 @@
<li><a class="toctree-l3" href="#current-status">Current Status</a></li> <li><a class="toctree-l3" href="#current-status">Current Status</a></li>
<li><a class="toctree-l3" href="#github">Github</a></li> <li><a class="toctree-l3" href="#github">GitHub</a></li>
</ul> </ul>
@ -232,7 +232,7 @@ existing PHP frameworks, add support for Relay, etc.</p>
<a href="type-system/type-language/">Schema Language parser</a> and <a href="type-system/type-language/">Schema Language parser</a> and
<a href="reference/#graphqlutilsschemaprinter">Schema printer</a>.</p> <a href="reference/#graphqlutilsschemaprinter">Schema printer</a>.</p>
<p>Ready for real-world usage. </p> <p>Ready for real-world usage. </p>
<h2 id="github">Github</h2> <h2 id="github">GitHub</h2>
<p>Project source code is <a href="https://github.com/webonyx/graphql-php">hosted on GitHub</a>.</p> <p>Project source code is <a href="https://github.com/webonyx/graphql-php">hosted on GitHub</a>.</p>
</div> </div>
@ -273,12 +273,15 @@ existing PHP frameworks, add support for Relay, etc.</p>
</span> </span>
</div> </div>
<script>var base_url = '.';</script>
<script src="./js/theme.js"></script> <script src="./js/theme.js"></script>
<script src="./search/require.js"></script>
<script src="./search/search.js"></script>
</body> </body>
</html> </html>
<!-- <!--
MkDocs version : 0.16.3 MkDocs version : 0.17.3
Build Date UTC : 2018-01-19 06:58:38 Build Date UTC : 2018-04-20 09:39:50
--> -->

17
js/theme.js
View File

@ -11,6 +11,23 @@ $( document ).ready(function() {
$("[data-toggle='rst-versions']").toggleClass("shift"); $("[data-toggle='rst-versions']").toggleClass("shift");
}); });
// Keyboard navigation
document.addEventListener("keydown", function(e) {
if ($(e.target).is(':input')) return true;
var key = e.which || e.keyCode || window.event && window.event.keyCode;
var page;
switch (key) {
case 39: // right arrow
page = $('[role="navigation"] a:contains(Next):first').prop('href');
break;
case 37: // left arrow
page = $('[role="navigation"] a:contains(Previous):first').prop('href');
break;
default: break;
}
if (page) window.location.href = page;
});
$(document).on('click', "[data-toggle='rst-current-version']", function() { $(document).on('click', "[data-toggle='rst-current-version']", function() {
$("[data-toggle='rst-versions']").toggleClass("shift-up"); $("[data-toggle='rst-versions']").toggleClass("shift-up");
}); });

132
reference/index.html
View File

@ -152,7 +152,7 @@
<li class="toctree-l2"><a href="#graphqltypedefinitionresolveinfo">GraphQL\Type\Definition\ResolveInfo</a></li> <li class="toctree-l2"><a href="#graphqltypedefinitionresolveinfo">GraphQL\Type\Definition\ResolveInfo</a></li>
<li class="toctree-l2"><a href="#graphqltypedefinitiondirectivelocation">GraphQL\Type\Definition\DirectiveLocation</a></li> <li class="toctree-l2"><a href="#graphqllanguagedirectivelocation">GraphQL\Language\DirectiveLocation</a></li>
<li class="toctree-l2"><a href="#graphqltypeschemaconfig">GraphQL\Type\SchemaConfig</a></li> <li class="toctree-l2"><a href="#graphqltypeschemaconfig">GraphQL\Type\SchemaConfig</a></li>
@ -417,7 +417,7 @@ static function float()
<pre><code class="php">/** <pre><code class="php">/**
* @api * @api
* @param ObjectType|InterfaceType|UnionType|ScalarType|InputObjectType|EnumType|ListOfType|NonNull $wrappedType * @param Type|ObjectType|InterfaceType|UnionType|ScalarType|InputObjectType|EnumType|ListOfType|NonNull $wrappedType
* @return ListOfType * @return ListOfType
*/ */
static function listOf($wrappedType) static function listOf($wrappedType)
@ -471,6 +471,14 @@ static function isCompositeType($type)
static function isAbstractType($type) static function isAbstractType($type)
</code></pre> </code></pre>
<pre><code class="php">/**
* @api
* @param Type $type
* @return bool
*/
static function isType($type)
</code></pre>
<pre><code class="php">/** <pre><code class="php">/**
* @api * @api
* @param Type $type * @param Type $type
@ -611,26 +619,26 @@ public $variableValues;
function getFieldSelection($depth = 0) function getFieldSelection($depth = 0)
</code></pre> </code></pre>
<h1 id="graphqltypedefinitiondirectivelocation">GraphQL\Type\Definition\DirectiveLocation</h1> <h1 id="graphqllanguagedirectivelocation">GraphQL\Language\DirectiveLocation</h1>
<p>List of available directive locations</p> <p>List of available directive locations</p>
<p><strong>Class Constants:</strong> </p> <p><strong>Class Constants:</strong> </p>
<pre><code class="php">const IFACE = &quot;INTERFACE&quot;; <pre><code class="php">const QUERY = &quot;QUERY&quot;;
const SUBSCRIPTION = &quot;SUBSCRIPTION&quot;;
const FRAGMENT_SPREAD = &quot;FRAGMENT_SPREAD&quot;;
const QUERY = &quot;QUERY&quot;;
const MUTATION = &quot;MUTATION&quot;; const MUTATION = &quot;MUTATION&quot;;
const SUBSCRIPTION = &quot;SUBSCRIPTION&quot;;
const FIELD = &quot;FIELD&quot;;
const FRAGMENT_DEFINITION = &quot;FRAGMENT_DEFINITION&quot;; const FRAGMENT_DEFINITION = &quot;FRAGMENT_DEFINITION&quot;;
const INPUT_OBJECT = &quot;INPUT_OBJECT&quot;; const FRAGMENT_SPREAD = &quot;FRAGMENT_SPREAD&quot;;
const INLINE_FRAGMENT = &quot;INLINE_FRAGMENT&quot;; const INLINE_FRAGMENT = &quot;INLINE_FRAGMENT&quot;;
const UNION = &quot;UNION&quot;; const SCHEMA = &quot;SCHEMA&quot;;
const SCALAR = &quot;SCALAR&quot;; const SCALAR = &quot;SCALAR&quot;;
const OBJECT = &quot;OBJECT&quot;;
const FIELD_DEFINITION = &quot;FIELD_DEFINITION&quot;; const FIELD_DEFINITION = &quot;FIELD_DEFINITION&quot;;
const ARGUMENT_DEFINITION = &quot;ARGUMENT_DEFINITION&quot;; const ARGUMENT_DEFINITION = &quot;ARGUMENT_DEFINITION&quot;;
const IFACE = &quot;INTERFACE&quot;;
const UNION = &quot;UNION&quot;;
const ENUM = &quot;ENUM&quot;; const ENUM = &quot;ENUM&quot;;
const OBJECT = &quot;OBJECT&quot;;
const ENUM_VALUE = &quot;ENUM_VALUE&quot;; const ENUM_VALUE = &quot;ENUM_VALUE&quot;;
const FIELD = &quot;FIELD&quot;; const INPUT_OBJECT = &quot;INPUT_OBJECT&quot;;
const SCHEMA = &quot;SCHEMA&quot;;
const INPUT_FIELD_DEFINITION = &quot;INPUT_FIELD_DEFINITION&quot;; const INPUT_FIELD_DEFINITION = &quot;INPUT_FIELD_DEFINITION&quot;;
</code></pre> </code></pre>
@ -662,7 +670,7 @@ static function create(array $options = [])
* @param ObjectType $query * @param ObjectType $query
* @return SchemaConfig * @return SchemaConfig
*/ */
function setQuery(GraphQL\Type\Definition\ObjectType $query) function setQuery($query)
</code></pre> </code></pre>
<pre><code class="php">/** <pre><code class="php">/**
@ -670,7 +678,7 @@ function setQuery(GraphQL\Type\Definition\ObjectType $query)
* @param ObjectType $mutation * @param ObjectType $mutation
* @return SchemaConfig * @return SchemaConfig
*/ */
function setMutation(GraphQL\Type\Definition\ObjectType $mutation) function setMutation($mutation)
</code></pre> </code></pre>
<pre><code class="php">/** <pre><code class="php">/**
@ -678,7 +686,7 @@ function setMutation(GraphQL\Type\Definition\ObjectType $mutation)
* @param ObjectType $subscription * @param ObjectType $subscription
* @return SchemaConfig * @return SchemaConfig
*/ */
function setSubscription(GraphQL\Type\Definition\ObjectType $subscription) function setSubscription($subscription)
</code></pre> </code></pre>
<pre><code class="php">/** <pre><code class="php">/**
@ -877,6 +885,17 @@ function getDirectives()
function getDirective($name) function getDirective($name)
</code></pre> </code></pre>
<pre><code class="php">/**
* Validates schema.
*
* This operation requires full schema scan. Do not use in production environment.
*
* @api
* @return InvariantViolation[]|Error[]
*/
function validate()
</code></pre>
<pre><code class="php">/** <pre><code class="php">/**
* Validates schema. * Validates schema.
* *
@ -902,10 +921,25 @@ function assertValid()
* in the source that they correspond to. This configuration flag * in the source that they correspond to. This configuration flag
* disables that behavior for performance or testing.) * disables that behavior for performance or testing.)
* *
* experimentalFragmentVariables: boolean,
* (If enabled, the parser will understand and parse variable definitions
* contained in a fragment definition. They'll be represented in the
* `variableDefinitions` field of the FragmentDefinitionNode.
*
* The syntax is identical to normal, query-defined variables. For example:
*
* fragment A($var: Boolean = false) on T {
* ...
* }
*
* Note: this feature is experimental and may change or be removed in the
* future.)
*
* @api * @api
* @param Source|string $source * @param Source|string $source
* @param array $options * @param array $options
* @return DocumentNode * @return DocumentNode
* @throws SyntaxError
*/ */
static function parse($source, array $options = []) static function parse($source, array $options = [])
</code></pre> </code></pre>
@ -1122,7 +1156,12 @@ const UNION_TYPE_DEFINITION = &quot;UnionTypeDefinition&quot;;
const ENUM_TYPE_DEFINITION = &quot;EnumTypeDefinition&quot;; const ENUM_TYPE_DEFINITION = &quot;EnumTypeDefinition&quot;;
const ENUM_VALUE_DEFINITION = &quot;EnumValueDefinition&quot;; const ENUM_VALUE_DEFINITION = &quot;EnumValueDefinition&quot;;
const INPUT_OBJECT_TYPE_DEFINITION = &quot;InputObjectTypeDefinition&quot;; const INPUT_OBJECT_TYPE_DEFINITION = &quot;InputObjectTypeDefinition&quot;;
const TYPE_EXTENSION_DEFINITION = &quot;TypeExtensionDefinition&quot;; const SCALAR_TYPE_EXTENSION = &quot;ScalarTypeExtension&quot;;
const OBJECT_TYPE_EXTENSION = &quot;ObjectTypeExtension&quot;;
const INTERFACE_TYPE_EXTENSION = &quot;InterfaceTypeExtension&quot;;
const UNION_TYPE_EXTENSION = &quot;UnionTypeExtension&quot;;
const ENUM_TYPE_EXTENSION = &quot;EnumTypeExtension&quot;;
const INPUT_OBJECT_TYPE_EXTENSION = &quot;InputObjectTypeExtension&quot;;
const DIRECTIVE_DEFINITION = &quot;DirectiveDefinition&quot;; const DIRECTIVE_DEFINITION = &quot;DirectiveDefinition&quot;;
</code></pre> </code></pre>
@ -1473,8 +1512,7 @@ function getPath()
<p>Warnings can be suppressed (individually or all) if required. <p>Warnings can be suppressed (individually or all) if required.
Also it is possible to override warning handler (which is <strong>trigger_error()</strong> by default)</p> Also it is possible to override warning handler (which is <strong>trigger_error()</strong> by default)</p>
<p><strong>Class Constants:</strong> </p> <p><strong>Class Constants:</strong> </p>
<pre><code class="php">const WARNING_NAME = 1; <pre><code class="php">const WARNING_ASSIGN = 2;
const WARNING_ASSIGN = 2;
const WARNING_CONFIG = 4; const WARNING_CONFIG = 4;
const WARNING_FULL_SCHEMA_SCAN = 8; const WARNING_FULL_SCHEMA_SCAN = 8;
const WARNING_CONFIG_DEPRECATION = 16; const WARNING_CONFIG_DEPRECATION = 16;
@ -1504,7 +1542,7 @@ static function setWarningHandler(callable $warningHandler = null)
* @api * @api
* @param bool|int $suppress * @param bool|int $suppress
*/ */
static function suppress($suppress = false) static function suppress($suppress = true)
</code></pre> </code></pre>
<pre><code class="php">/** <pre><code class="php">/**
@ -1518,7 +1556,7 @@ static function suppress($suppress = false)
* @api * @api
* @param bool|int $enable * @param bool|int $enable
*/ */
static function enable($enable = false) static function enable($enable = true)
</code></pre> </code></pre>
<h1 id="graphqlerrorclientaware">GraphQL\Error\ClientAware</h1> <h1 id="graphqlerrorclientaware">GraphQL\Error\ClientAware</h1>
@ -1819,7 +1857,7 @@ function setPersistentQueryLoader(callable $persistentQueryLoader)
* @param bool|int $set * @param bool|int $set
* @return $this * @return $this
*/ */
function setDebug($set = false) function setDebug($set = true)
</code></pre> </code></pre>
<pre><code class="php">/** <pre><code class="php">/**
@ -2034,13 +2072,19 @@ See <a href="../type-system/type-language/">section in docs</a> for details.</p>
* Given that AST it constructs a GraphQL\Type\Schema. The resulting schema * Given that AST it constructs a GraphQL\Type\Schema. The resulting schema
* has no resolve methods, so execution will use default resolvers. * has no resolve methods, so execution will use default resolvers.
* *
* Accepts options as a second argument:
*
* - commentDescriptions:
* Provide true to use preceding comments as the description.
*
*
* @api * @api
* @param DocumentNode $ast * @param DocumentNode $ast
* @param callable $typeConfigDecorator * @param array $options
* @return Schema * @return Schema
* @throws Error * @throws Error
*/ */
static function buildAST(GraphQL\Language\AST\DocumentNode $ast, callable $typeConfigDecorator = null) static function buildAST(GraphQL\Language\AST\DocumentNode $ast, array $options = [])
</code></pre> </code></pre>
<pre><code class="php">/** <pre><code class="php">/**
@ -2049,10 +2093,10 @@ static function buildAST(GraphQL\Language\AST\DocumentNode $ast, callable $typeC
* *
* @api * @api
* @param DocumentNode|Source|string $source * @param DocumentNode|Source|string $source
* @param callable $typeConfigDecorator * @param array $options
* @return Schema * @return Schema
*/ */
static function build($source, callable $typeConfigDecorator = null) static function build($source, array $options = [])
</code></pre> </code></pre>
<h1 id="graphqlutilsast">GraphQL\Utils\AST</h1> <h1 id="graphqlutilsast">GraphQL\Utils\AST</h1>
@ -2151,6 +2195,31 @@ static function astFromValue($value, GraphQL\Type\Definition\InputType $type)
static function valueFromAST($valueNode, GraphQL\Type\Definition\InputType $type, $variables = null) static function valueFromAST($valueNode, GraphQL\Type\Definition\InputType $type, $variables = null)
</code></pre> </code></pre>
<pre><code class="php">/**
* Produces a PHP value given a GraphQL Value AST.
*
* Unlike `valueFromAST()`, no type is provided. The resulting JavaScript value
* will reflect the provided GraphQL value AST.
*
* | GraphQL Value | PHP Value |
* | -------------------- | ------------- |
* | Input Object | Assoc Array |
* | List | Array |
* | Boolean | Boolean |
* | String | String |
* | Int / Float | Int / Float |
* | Enum | Mixed |
* | Null | null |
*
* @api
* @param Node $valueNode
* @param array|null $variables
* @return mixed
* @throws \Exception
*/
static function valueFromASTUntyped($valueNode, array $variables = null)
</code></pre>
<pre><code class="php">/** <pre><code class="php">/**
* Returns type definition for given AST Type node * Returns type definition for given AST Type node
* *
@ -2158,7 +2227,7 @@ static function valueFromAST($valueNode, GraphQL\Type\Definition\InputType $type
* @param Schema $schema * @param Schema $schema
* @param NamedTypeNode|ListTypeNode|NonNullTypeNode $inputTypeNode * @param NamedTypeNode|ListTypeNode|NonNullTypeNode $inputTypeNode
* @return Type * @return Type
* @throws InvariantViolation * @throws \Exception
*/ */
static function typeFromAST(GraphQL\Type\Schema $schema, $inputTypeNode) static function typeFromAST(GraphQL\Type\Schema $schema, $inputTypeNode)
</code></pre> </code></pre>
@ -2178,11 +2247,15 @@ static function getOperation(GraphQL\Language\AST\DocumentNode $document, $opera
<p>Given an instance of Schema, prints it in GraphQL type language.</p> <p>Given an instance of Schema, prints it in GraphQL type language.</p>
<p><strong>Class Methods:</strong> </p> <p><strong>Class Methods:</strong> </p>
<pre><code class="php">/** <pre><code class="php">/**
* Accepts options as a second argument:
*
* - commentDescriptions:
* Provide true to use preceding comments as the description.
* @api * @api
* @param Schema $schema * @param Schema $schema
* @return string * @return string
*/ */
static function doPrint(GraphQL\Type\Schema $schema) static function doPrint(GraphQL\Type\Schema $schema, array $options = [])
</code></pre> </code></pre>
<pre><code class="php">/** <pre><code class="php">/**
@ -2190,7 +2263,7 @@ static function doPrint(GraphQL\Type\Schema $schema)
* @param Schema $schema * @param Schema $schema
* @return string * @return string
*/ */
static function printIntrosepctionSchema(GraphQL\Type\Schema $schema) static function printIntrosepctionSchema(GraphQL\Type\Schema $schema, array $options = [])
</code></pre> </code></pre>
</div> </div>
@ -2231,7 +2304,10 @@ static function printIntrosepctionSchema(GraphQL\Type\Schema $schema)
</span> </span>
</div> </div>
<script>var base_url = '..';</script>
<script src="../js/theme.js"></script> <script src="../js/theme.js"></script>
<script src="../search/require.js"></script>
<script src="../search/search.js"></script>
</body> </body>
</html> </html>

6
search.html
View File

@ -18,9 +18,6 @@
<script src="./js/jquery-2.1.1.min.js"></script> <script src="./js/jquery-2.1.1.min.js"></script>
<script src="./js/modernizr-2.8.3.min.js"></script> <script src="./js/modernizr-2.8.3.min.js"></script>
<script type="text/javascript" src="./js/highlight.pack.js"></script> <script type="text/javascript" src="./js/highlight.pack.js"></script>
<script>var base_url = '.';</script>
<script data-main="./mkdocs/js/search.js" src="./mkdocs/js/require.js"></script>
</head> </head>
@ -211,7 +208,10 @@
</span> </span>
</div> </div>
<script>var base_url = '.';</script>
<script src="./js/theme.js"></script> <script src="./js/theme.js"></script>
<script src="./search/require.js"></script>
<script src="./search/search.js"></script>
</body> </body>
</html> </html>

0
mkdocs/js/lunr.min.js → search/lunr.min.js vendored
View File

0
mkdocs/js/mustache.min.js → search/mustache.min.js vendored
View File

0
mkdocs/js/require.js → search/require.js
View File

0
mkdocs/js/search-results-template.mustache → search/search-results-template.mustache
View File

12
mkdocs/js/search.js → search/search.js
View File

@ -1,8 +1,12 @@
require.config({
baseUrl: base_url + "/search/"
});
require([ require([
base_url + '/mkdocs/js/mustache.min.js', 'mustache.min',
base_url + '/mkdocs/js/lunr.min.js', 'lunr.min',
'text!search-results-template.mustache', 'text!search-results-template.mustache',
'text!../search_index.json', 'text!search_index.json',
], function (Mustache, lunr, results_template, data) { ], function (Mustache, lunr, results_template, data) {
"use strict"; "use strict";
@ -83,6 +87,6 @@ require([
search(); search();
} }
search_input.addEventListener("keyup", search); if (search_input){search_input.addEventListener("keyup", search);}
}); });

49
mkdocs/search_index.json → search/search_index.json
View File

File diff suppressed because one or more lines are too long

0
mkdocs/js/text.js → search/text.js
View File

3
security/index.html
View File

@ -308,7 +308,10 @@ GraphQL::executeQuery(/*...*/);
</span> </span>
</div> </div>
<script>var base_url = '..';</script>
<script src="../js/theme.js"></script> <script src="../js/theme.js"></script>
<script src="../search/require.js"></script>
<script src="../search/search.js"></script>
</body> </body>
</html> </html>

40
sitemap.xml
View File

@ -4,7 +4,7 @@
<url> <url>
<loc>/</loc> <loc>/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -12,7 +12,7 @@
<url> <url>
<loc>/getting-started/</loc> <loc>/getting-started/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -20,7 +20,7 @@
<url> <url>
<loc>/complementary-tools/</loc> <loc>/complementary-tools/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -29,67 +29,67 @@
<url> <url>
<loc>/type-system/</loc> <loc>/type-system/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>/type-system/object-types/</loc> <loc>/type-system/object-types/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>/type-system/scalar-types/</loc> <loc>/type-system/scalar-types/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>/type-system/enum-types/</loc> <loc>/type-system/enum-types/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>/type-system/lists-and-nonnulls/</loc> <loc>/type-system/lists-and-nonnulls/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>/type-system/interfaces/</loc> <loc>/type-system/interfaces/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>/type-system/unions/</loc> <loc>/type-system/unions/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>/type-system/input-types/</loc> <loc>/type-system/input-types/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>/type-system/directives/</loc> <loc>/type-system/directives/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>/type-system/schema/</loc> <loc>/type-system/schema/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
<url> <url>
<loc>/type-system/type-language/</loc> <loc>/type-system/type-language/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -98,7 +98,7 @@
<url> <url>
<loc>/executing-queries/</loc> <loc>/executing-queries/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -106,7 +106,7 @@
<url> <url>
<loc>/data-fetching/</loc> <loc>/data-fetching/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -114,7 +114,7 @@
<url> <url>
<loc>/error-handling/</loc> <loc>/error-handling/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -122,7 +122,7 @@
<url> <url>
<loc>/security/</loc> <loc>/security/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -130,7 +130,7 @@
<url> <url>
<loc>/how-it-works/</loc> <loc>/how-it-works/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>
@ -138,7 +138,7 @@
<url> <url>
<loc>/reference/</loc> <loc>/reference/</loc>
<lastmod>2018-01-19</lastmod> <lastmod>2018-04-20</lastmod>
<changefreq>daily</changefreq> <changefreq>daily</changefreq>
</url> </url>

5
type-system/directives/index.html
View File

@ -219,9 +219,9 @@ in field resolvers to modify the output depending on those directives or perform
<p>In <strong>graphql-php</strong> custom directive is an instance of <code>GraphQL\Type\Definition\Directive</code> <p>In <strong>graphql-php</strong> custom directive is an instance of <code>GraphQL\Type\Definition\Directive</code>
(or one of its subclasses) which accepts an array of following options:</p> (or one of its subclasses) which accepts an array of following options:</p>
<pre><code class="php">&lt;?php <pre><code class="php">&lt;?php
use GraphQL\Language\DirectiveLocation;
use GraphQL\Type\Definition\Type; use GraphQL\Type\Definition\Type;
use GraphQL\Type\Definition\Directive; use GraphQL\Type\Definition\Directive;
use GraphQL\Type\Definition\DirectiveLocation;
use GraphQL\Type\Definition\FieldArgument; use GraphQL\Type\Definition\FieldArgument;
$trackDirective = new Directive([ $trackDirective = new Directive([
@ -286,7 +286,10 @@ $trackDirective = new Directive([
</span> </span>
</div> </div>
<script>var base_url = '../..';</script>
<script src="../../js/theme.js"></script> <script src="../../js/theme.js"></script>
<script src="../../search/require.js"></script>
<script src="../../search/search.js"></script>
</body> </body>
</html> </html>

3
type-system/enum-types/index.html
View File

@ -446,7 +446,10 @@ $heroType = new ObjectType([
</span> </span>
</div> </div>
<script>var base_url = '../..';</script>
<script src="../../js/theme.js"></script> <script src="../../js/theme.js"></script>
<script src="../../search/require.js"></script>
<script src="../../search/search.js"></script>
</body> </body>
</html> </html>

3
type-system/index.html
View File

@ -347,7 +347,10 @@ type definitions.</p>
</span> </span>
</div> </div>
<script>var base_url = '..';</script>
<script src="../js/theme.js"></script> <script src="../js/theme.js"></script>
<script src="../search/require.js"></script>
<script src="../search/search.js"></script>
</body> </body>
</html> </html>

3
type-system/input-types/index.html
View File

@ -440,7 +440,10 @@ resolver as <code>$args['filters']</code></p>
</span> </span>
</div> </div>
<script>var base_url = '../..';</script>
<script src="../../js/theme.js"></script> <script src="../../js/theme.js"></script>
<script src="../../search/require.js"></script>
<script src="../../search/search.js"></script>
</body> </body>
</html> </html>

3
type-system/interfaces/index.html
View File

@ -394,7 +394,10 @@ than single <strong>resolveType</strong> call. So it is recommended to define <s
</span> </span>
</div> </div>
<script>var base_url = '../..';</script>
<script src="../../js/theme.js"></script> <script src="../../js/theme.js"></script>
<script src="../../search/require.js"></script>
<script src="../../search/search.js"></script>
</body> </body>
</html> </html>

3
type-system/lists-and-nonnulls/index.html
View File

@ -287,7 +287,10 @@ nullable parent field which will be set to <strong>null</strong>).</p>
</span> </span>
</div> </div>
<script>var base_url = '../..';</script>
<script src="../../js/theme.js"></script> <script src="../../js/theme.js"></script>
<script src="../../search/require.js"></script>
<script src="../../search/search.js"></script>
</body> </body>
</html> </html>

3
type-system/object-types/index.html
View File

@ -535,7 +535,10 @@ public property <strong>$config</strong>. Use it to implement app-level mappings
</span> </span>
</div> </div>
<script>var base_url = '../..';</script>
<script src="../../js/theme.js"></script> <script src="../../js/theme.js"></script>
<script src="../../search/require.js"></script>
<script src="../../search/search.js"></script>
</body> </body>
</html> </html>

3
type-system/scalar-types/index.html
View File

@ -356,7 +356,10 @@ $emailType = new CustomScalarType([
</span> </span>
</div> </div>
<script>var base_url = '../..';</script>
<script src="../../js/theme.js"></script> <script src="../../js/theme.js"></script>
<script src="../../search/require.js"></script>
<script src="../../search/search.js"></script>
</body> </body>
</html> </html>

3
type-system/schema/index.html
View File

@ -450,7 +450,10 @@ try {
</span> </span>
</div> </div>
<script>var base_url = '../..';</script>
<script src="../../js/theme.js"></script> <script src="../../js/theme.js"></script>
<script src="../../search/require.js"></script>
<script src="../../search/search.js"></script>
</body> </body>
</html> </html>

31
type-system/type-language/index.html
View File

@ -114,9 +114,6 @@
<li class="toctree-l3"><a href="#defining-your-schema">Defining your schema</a></li> <li class="toctree-l3"><a href="#defining-your-schema">Defining your schema</a></li>
<li class="toctree-l3"><a href="#defining-resolvers">Defining resolvers</a></li>
<li class="toctree-l3"><a href="#performance-considerations">Performance considerations</a></li> <li class="toctree-l3"><a href="#performance-considerations">Performance considerations</a></li>
@ -220,30 +217,9 @@ $contents = file_get_contents('schema.graphql');
$schema = BuildSchema::build($contents); $schema = BuildSchema::build($contents);
</code></pre> </code></pre>
<p>By default, such schema is created without any resolvers. As a result, it doesn't support <strong>Interfaces</strong> and <strong>Unions</strong> <p>By default, such schema is created without any resolvers.</p>
because it is impossible to resolve actual implementations during execution.</p> <p>We have to rely on <a href="../../data-fetching/#default-field-resolver">default field resolver</a> and <strong>root value</strong> in
<p>Also, we have to rely on <a href="../../data-fetching/#default-field-resolver">default field resolver</a> and <strong>root value</strong> in
order to execute a query against this schema.</p> order to execute a query against this schema.</p>
<h1 id="defining-resolvers">Defining resolvers</h1>
<p>Since 0.10.0</p>
<p>In order to enable <strong>Interfaces</strong>, <strong>Unions</strong> and custom field resolvers you can pass the second argument:
<strong>type config decorator</strong> to schema builder. </p>
<p>It accepts default type config produced by the builder and is expected to add missing options like
<a href="../interfaces/#configuration-options"><strong>resolveType</strong></a> for interface types or
<a href="../object-types/#configuration-options"><strong>resolveField</strong></a> for object types.</p>
<pre><code class="php">&lt;?php
use GraphQL\Utils\BuildSchema;
$typeConfigDecorator = function($typeConfig, $typeDefinitionNode) {
$name = $typeConfig['name'];
// ... add missing options to $typeConfig based on type $name
return $typeConfig;
};
$contents = file_get_contents('schema.graphql');
$schema = BuildSchema::build($contents, $typeConfigDecorator);
</code></pre>
<h1 id="performance-considerations">Performance considerations</h1> <h1 id="performance-considerations">Performance considerations</h1>
<p>Since 0.10.0</p> <p>Since 0.10.0</p>
<p>Method <strong>build()</strong> produces a <a href="../schema/#lazy-loading-of-types">lazy schema</a> <p>Method <strong>build()</strong> produces a <a href="../schema/#lazy-loading-of-types">lazy schema</a>
@ -310,7 +286,10 @@ $schema = BuildSchema::build($document, $typeConfigDecorator);
</span> </span>
</div> </div>
<script>var base_url = '../..';</script>
<script src="../../js/theme.js"></script> <script src="../../js/theme.js"></script>
<script src="../../search/require.js"></script>
<script src="../../search/search.js"></script>
</body> </body>
</html> </html>

3
type-system/unions/index.html
View File

@ -290,7 +290,10 @@ $searchResultType = new UnionType([
</span> </span>
</div> </div>
<script>var base_url = '../..';</script>
<script src="../../js/theme.js"></script> <script src="../../js/theme.js"></script>
<script src="../../search/require.js"></script>
<script src="../../search/search.js"></script>
</body> </body>
</html> </html>