PHP Класс GraphQL\Language\Parser

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( Source $source, array $options = [] ) Parser constructor.
any ( integer $openKind, callable $parseFn, integer $closeKind ) : array Returns a possibly empty list of parse nodes, determined by the parseFn. This list begins with a lex token of openKind and ends with a lex token of closeKind. Advances the parser to the next lex token after the closing token.
expect ( string $kind ) : Token If the next token is of the given kind, return that token after advancing the parser. Otherwise, do not change the parser state and return false.
expectKeyword ( string $value ) : Token If the next token is a keyword with the given value, return that token after advancing the parser. Otherwise, do not change the parser state and return false.
loc ( Token $startToken ) : Location | null Returns a location object, used to identify the place in the source that created a given parsed object.
many ( $openKind, $parseFn, $closeKind ) : array Returns a non-empty list of parse nodes, determined by the parseFn. This list begins with a lex token of openKind and ends with a lex token of closeKind. Advances the parser to the next lex token after the closing token.
parse ( Source | string $source, array $options = [] ) : DocumentNode Available options:
parseArgument ( ) : ArgumentNode
parseArgumentDefs ( ) : InputValueDefinitionNode[]
parseArguments ( ) : ArgumentNode[]
parseArray ( boolean $isConst ) : ListValueNode
parseConstValue ( ) : BooleanValueNode | EnumValueNode | FloatValueNode | IntValueNode | StringValueNode | VariableNode
parseDefinition ( ) : OperationDefinitionNode | FragmentDefinitionNode | GraphQL\Language\AST\TypeSystemDefinitionNode
parseDirective ( ) : DirectiveNode
parseDirectiveDefinition ( ) : DirectiveDefinitionNode DirectiveDefinition : - directive @ Name ArgumentsDefinition? on DirectiveLocations
parseDirectiveLocations ( ) : NameNode[]
parseDirectives ( ) : DirectiveNode[]
parseDocument ( ) : DocumentNode Implements the parsing rules in the Document section.
parseEnumTypeDefinition ( ) : EnumTypeDefinitionNode
parseEnumValueDefinition ( ) : EnumValueDefinitionNode
parseField ( ) : FieldNode
parseFieldDefinition ( ) : FieldDefinitionNode
parseFragment ( ) : FragmentSpreadNode | InlineFragmentNode
parseFragmentDefinition ( ) : FragmentDefinitionNode
parseFragmentName ( ) : NameNode
parseImplementsInterfaces ( ) : NamedTypeNode[]
parseInputObjectTypeDefinition ( ) : InputObjectTypeDefinitionNode
parseInputValueDef ( ) : InputValueDefinitionNode
parseInterfaceTypeDefinition ( ) : InterfaceTypeDefinitionNode
parseName ( ) : NameNode Converts a name lex token into a name parse node.
parseNamedType ( )
parseObject ( $isConst ) : ObjectValueNode
parseObjectField ( $isConst ) : ObjectFieldNode
parseObjectTypeDefinition ( ) : ObjectTypeDefinitionNode
parseOperationDefinition ( ) : OperationDefinitionNode
parseOperationType ( ) : string
parseOperationTypeDefinition ( ) : OperationTypeDefinitionNode
parseScalarTypeDefinition ( ) : ScalarTypeDefinitionNode
parseSchemaDefinition ( ) : SchemaDefinitionNode
parseSelection ( ) : mixed Selection : - Field - FragmentSpread - InlineFragment
parseSelectionSet ( ) : SelectionSetNode
parseType ( Source | string $source, array $options = [] ) : ListTypeNode | NameNode | NonNullTypeNode Given a string containing a GraphQL Type (ex. [Int!]), parse the AST for that type.
parseTypeExtensionDefinition ( ) : TypeExtensionDefinitionNode
parseTypeReference ( ) : ListTypeNode | NameNode | NonNullTypeNode Handles the Type: TypeName, ListType, and NonNullType parsing rules.
parseTypeSystemDefinition ( ) : GraphQL\Language\AST\TypeSystemDefinitionNode TypeSystemDefinition : - SchemaDefinition - TypeDefinition - TypeExtensionDefinition - DirectiveDefinition
parseUnionMembers ( ) : NamedTypeNode[] UnionMembers : - NamedType - UnionMembers | NamedType
parseUnionTypeDefinition ( ) : UnionTypeDefinitionNode
parseValue ( Source | string $source, array $options = [] ) : BooleanValueNode | EnumValueNode | FloatValueNode | IntValueNode | ListValueNode | ObjectValueNode | StringValueNode | VariableNode Given a string containing a GraphQL value (ex. [42]), parse the AST for that value.
parseValueLiteral ( $isConst ) : BooleanValueNode | EnumValueNode | FloatValueNode | IntValueNode | StringValueNode | VariableNode | ListValueNode | ObjectValueNode | NullValueNode Value[Const] : - [~Const] Variable - IntValue - FloatValue - StringValue - BooleanValue - NullValue - EnumValue - ListValue[?Const] - ObjectValue[?Const]
parseVariable ( ) : VariableNode
parseVariableDefinition ( ) : VariableDefinitionNode
parseVariableDefinitions ( ) : VariableDefinitionNode[]
parseVariableValue ( ) : BooleanValueNode | EnumValueNode | FloatValueNode | IntValueNode | ListValueNode | ObjectValueNode | StringValueNode | VariableNode
peek ( $kind ) : boolean Determines if the next token is of a given kind
skip ( $kind ) : boolean If the next token is of the given kind, return true after advancing the parser. Otherwise, do not change the parser state and return false.
unexpected ( Token $atToken = null ) : SyntaxError

Описание методов

__construct() публичный Метод

Parser constructor.
public __construct ( Source $source, array $options = [] )
$source Source
$options array

any() публичный Метод

Returns a possibly empty list of parse nodes, determined by the parseFn. This list begins with a lex token of openKind and ends with a lex token of closeKind. Advances the parser to the next lex token after the closing token.
public any ( integer $openKind, callable $parseFn, integer $closeKind ) : array
$openKind integer
$parseFn callable
$closeKind integer
Результат array

expect() публичный Метод

If the next token is of the given kind, return that token after advancing the parser. Otherwise, do not change the parser state and return false.
public expect ( string $kind ) : Token
$kind string
Результат Token

expectKeyword() публичный Метод

If the next token is a keyword with the given value, return that token after advancing the parser. Otherwise, do not change the parser state and return false.
public expectKeyword ( string $value ) : Token
$value string
Результат Token

loc() публичный Метод

Returns a location object, used to identify the place in the source that created a given parsed object.
public loc ( Token $startToken ) : Location | null
$startToken Token
Результат GraphQL\Language\AST\Location | null

many() публичный Метод

Returns a non-empty list of parse nodes, determined by the parseFn. This list begins with a lex token of openKind and ends with a lex token of closeKind. Advances the parser to the next lex token after the closing token.
public many ( $openKind, $parseFn, $closeKind ) : array
$openKind
$parseFn
$closeKind
Результат array

parse() публичный статический Метод

noLocation: boolean, (By default, the parser creates AST nodes that know the location in the source that they correspond to. This configuration flag disables that behavior for performance or testing.)
public static parse ( Source | string $source, array $options = [] ) : DocumentNode
$source Source | string
$options array
Результат GraphQL\Language\AST\DocumentNode

parseArgument() публичный Метод

public parseArgument ( ) : ArgumentNode
Результат GraphQL\Language\AST\ArgumentNode

parseArgumentDefs() публичный Метод

public parseArgumentDefs ( ) : InputValueDefinitionNode[]
Результат GraphQL\Language\AST\InputValueDefinitionNode[]

parseArguments() публичный Метод

public parseArguments ( ) : ArgumentNode[]
Результат GraphQL\Language\AST\ArgumentNode[]

parseArray() публичный Метод

public parseArray ( boolean $isConst ) : ListValueNode
$isConst boolean
Результат GraphQL\Language\AST\ListValueNode

parseConstValue() публичный Метод

public parseConstValue ( ) : BooleanValueNode | EnumValueNode | FloatValueNode | IntValueNode | StringValueNode | VariableNode
Результат GraphQL\Language\AST\BooleanValueNode | GraphQL\Language\AST\EnumValueNode | GraphQL\Language\AST\FloatValueNode | GraphQL\Language\AST\IntValueNode | GraphQL\Language\AST\StringValueNode | GraphQL\Language\AST\VariableNode

parseDefinition() публичный Метод

public parseDefinition ( ) : OperationDefinitionNode | FragmentDefinitionNode | GraphQL\Language\AST\TypeSystemDefinitionNode
Результат GraphQL\Language\AST\OperationDefinitionNode | GraphQL\Language\AST\FragmentDefinitionNode | GraphQL\Language\AST\TypeSystemDefinitionNode

parseDirective() публичный Метод

public parseDirective ( ) : DirectiveNode
Результат GraphQL\Language\AST\DirectiveNode

parseDirectiveDefinition() публичный Метод

DirectiveDefinition : - directive @ Name ArgumentsDefinition? on DirectiveLocations
public parseDirectiveDefinition ( ) : DirectiveDefinitionNode
Результат GraphQL\Language\AST\DirectiveDefinitionNode

parseDirectiveLocations() публичный Метод

public parseDirectiveLocations ( ) : NameNode[]
Результат GraphQL\Language\AST\NameNode[]

parseDirectives() публичный Метод

public parseDirectives ( ) : DirectiveNode[]
Результат GraphQL\Language\AST\DirectiveNode[]

parseDocument() публичный Метод

Implements the parsing rules in the Document section.
public parseDocument ( ) : DocumentNode
Результат GraphQL\Language\AST\DocumentNode

parseEnumTypeDefinition() публичный Метод

public parseEnumTypeDefinition ( ) : EnumTypeDefinitionNode
Результат GraphQL\Language\AST\EnumTypeDefinitionNode

parseEnumValueDefinition() публичный Метод

public parseEnumValueDefinition ( ) : EnumValueDefinitionNode
Результат GraphQL\Language\AST\EnumValueDefinitionNode

parseField() публичный Метод

public parseField ( ) : FieldNode
Результат GraphQL\Language\AST\FieldNode

parseFieldDefinition() публичный Метод

public parseFieldDefinition ( ) : FieldDefinitionNode
Результат GraphQL\Language\AST\FieldDefinitionNode

parseFragment() публичный Метод

public parseFragment ( ) : FragmentSpreadNode | InlineFragmentNode
Результат GraphQL\Language\AST\FragmentSpreadNode | GraphQL\Language\AST\InlineFragmentNode

parseFragmentDefinition() публичный Метод

public parseFragmentDefinition ( ) : FragmentDefinitionNode
Результат GraphQL\Language\AST\FragmentDefinitionNode

parseFragmentName() публичный Метод

public parseFragmentName ( ) : NameNode
Результат GraphQL\Language\AST\NameNode

parseImplementsInterfaces() публичный Метод

public parseImplementsInterfaces ( ) : NamedTypeNode[]
Результат GraphQL\Language\AST\NamedTypeNode[]

parseInputObjectTypeDefinition() публичный Метод

public parseInputObjectTypeDefinition ( ) : InputObjectTypeDefinitionNode
Результат GraphQL\Language\AST\InputObjectTypeDefinitionNode

parseInputValueDef() публичный Метод

public parseInputValueDef ( ) : InputValueDefinitionNode
Результат GraphQL\Language\AST\InputValueDefinitionNode

parseInterfaceTypeDefinition() публичный Метод

public parseInterfaceTypeDefinition ( ) : InterfaceTypeDefinitionNode
Результат GraphQL\Language\AST\InterfaceTypeDefinitionNode

parseName() публичный Метод

Converts a name lex token into a name parse node.
public parseName ( ) : NameNode
Результат GraphQL\Language\AST\NameNode

parseNamedType() публичный Метод

public parseNamedType ( )

parseObject() публичный Метод

public parseObject ( $isConst ) : ObjectValueNode
$isConst
Результат GraphQL\Language\AST\ObjectValueNode

parseObjectField() публичный Метод

public parseObjectField ( $isConst ) : ObjectFieldNode
$isConst
Результат GraphQL\Language\AST\ObjectFieldNode

parseObjectTypeDefinition() публичный Метод

public parseObjectTypeDefinition ( ) : ObjectTypeDefinitionNode
Результат GraphQL\Language\AST\ObjectTypeDefinitionNode

parseOperationDefinition() публичный Метод

public parseOperationDefinition ( ) : OperationDefinitionNode
Результат GraphQL\Language\AST\OperationDefinitionNode

parseOperationType() публичный Метод

public parseOperationType ( ) : string
Результат string

parseOperationTypeDefinition() публичный Метод

public parseOperationTypeDefinition ( ) : OperationTypeDefinitionNode
Результат GraphQL\Language\AST\OperationTypeDefinitionNode

parseScalarTypeDefinition() публичный Метод

public parseScalarTypeDefinition ( ) : ScalarTypeDefinitionNode
Результат GraphQL\Language\AST\ScalarTypeDefinitionNode

parseSchemaDefinition() публичный Метод

public parseSchemaDefinition ( ) : SchemaDefinitionNode
Результат GraphQL\Language\AST\SchemaDefinitionNode

parseSelection() публичный Метод

Selection : - Field - FragmentSpread - InlineFragment
public parseSelection ( ) : mixed
Результат mixed

parseSelectionSet() публичный Метод

public parseSelectionSet ( ) : SelectionSetNode
Результат GraphQL\Language\AST\SelectionSetNode

parseType() публичный статический Метод

Throws GraphQLError if a syntax error is encountered. This is useful within tools that operate upon GraphQL Types directly and in isolation of complete GraphQL documents. Consider providing the results to the utility function: typeFromAST().
public static parseType ( Source | string $source, array $options = [] ) : ListTypeNode | NameNode | NonNullTypeNode
$source Source | string
$options array
Результат GraphQL\Language\AST\ListTypeNode | GraphQL\Language\AST\NameNode | GraphQL\Language\AST\NonNullTypeNode

parseTypeExtensionDefinition() публичный Метод

public parseTypeExtensionDefinition ( ) : TypeExtensionDefinitionNode
Результат GraphQL\Language\AST\TypeExtensionDefinitionNode

parseTypeReference() публичный Метод

Handles the Type: TypeName, ListType, and NonNullType parsing rules.
public parseTypeReference ( ) : ListTypeNode | NameNode | NonNullTypeNode
Результат GraphQL\Language\AST\ListTypeNode | GraphQL\Language\AST\NameNode | GraphQL\Language\AST\NonNullTypeNode

parseTypeSystemDefinition() публичный Метод

TypeDefinition : - ScalarTypeDefinition - ObjectTypeDefinition - InterfaceTypeDefinition - UnionTypeDefinition - EnumTypeDefinition - InputObjectTypeDefinition
public parseTypeSystemDefinition ( ) : GraphQL\Language\AST\TypeSystemDefinitionNode
Результат GraphQL\Language\AST\TypeSystemDefinitionNode

parseUnionMembers() публичный Метод

UnionMembers : - NamedType - UnionMembers | NamedType
public parseUnionMembers ( ) : NamedTypeNode[]
Результат GraphQL\Language\AST\NamedTypeNode[]

parseUnionTypeDefinition() публичный Метод

public parseUnionTypeDefinition ( ) : UnionTypeDefinitionNode
Результат GraphQL\Language\AST\UnionTypeDefinitionNode

parseValue() публичный статический Метод

Throws GraphQLError if a syntax error is encountered. This is useful within tools that operate upon GraphQL Values directly and in isolation of complete GraphQL documents. Consider providing the results to the utility function: valueFromAST().
public static parseValue ( Source | string $source, array $options = [] ) : BooleanValueNode | EnumValueNode | FloatValueNode | IntValueNode | ListValueNode | ObjectValueNode | StringValueNode | VariableNode
$source Source | string
$options array
Результат GraphQL\Language\AST\BooleanValueNode | GraphQL\Language\AST\EnumValueNode | GraphQL\Language\AST\FloatValueNode | GraphQL\Language\AST\IntValueNode | GraphQL\Language\AST\ListValueNode | GraphQL\Language\AST\ObjectValueNode | GraphQL\Language\AST\StringValueNode | GraphQL\Language\AST\VariableNode

parseValueLiteral() публичный Метод

BooleanValue : one of true false NullValue : null EnumValue : Name but not true, false or null
public parseValueLiteral ( $isConst ) : BooleanValueNode | EnumValueNode | FloatValueNode | IntValueNode | StringValueNode | VariableNode | ListValueNode | ObjectValueNode | NullValueNode
$isConst
Результат GraphQL\Language\AST\BooleanValueNode | GraphQL\Language\AST\EnumValueNode | GraphQL\Language\AST\FloatValueNode | GraphQL\Language\AST\IntValueNode | GraphQL\Language\AST\StringValueNode | GraphQL\Language\AST\VariableNode | GraphQL\Language\AST\ListValueNode | GraphQL\Language\AST\ObjectValueNode | GraphQL\Language\AST\NullValueNode

parseVariable() публичный Метод

public parseVariable ( ) : VariableNode
Результат GraphQL\Language\AST\VariableNode

parseVariableDefinition() публичный Метод

public parseVariableDefinition ( ) : VariableDefinitionNode
Результат GraphQL\Language\AST\VariableDefinitionNode

parseVariableDefinitions() публичный Метод

public parseVariableDefinitions ( ) : VariableDefinitionNode[]
Результат GraphQL\Language\AST\VariableDefinitionNode[]

parseVariableValue() публичный Метод

public parseVariableValue ( ) : BooleanValueNode | EnumValueNode | FloatValueNode | IntValueNode | ListValueNode | ObjectValueNode | StringValueNode | VariableNode
Результат GraphQL\Language\AST\BooleanValueNode | GraphQL\Language\AST\EnumValueNode | GraphQL\Language\AST\FloatValueNode | GraphQL\Language\AST\IntValueNode | GraphQL\Language\AST\ListValueNode | GraphQL\Language\AST\ObjectValueNode | GraphQL\Language\AST\StringValueNode | GraphQL\Language\AST\VariableNode

peek() публичный Метод

Determines if the next token is of a given kind
public peek ( $kind ) : boolean
$kind
Результат boolean

skip() публичный Метод

If the next token is of the given kind, return true after advancing the parser. Otherwise, do not change the parser state and return false.
public skip ( $kind ) : boolean
$kind
Результат boolean

unexpected() публичный Метод

public unexpected ( Token $atToken = null ) : SyntaxError
$atToken Token
Результат GraphQL\Error\SyntaxError