GraphQlReader Class Reference

Inheritance diagram for GraphQlReader:

Public Member Functions
	__construct (FileResolverInterface $fileResolver, TypeReaderComposite $typeReader, $fileName=self::GRAPHQL_SCHEMA_FILE, $defaultScope='global')
	read ($scope=null)

Data Fields
const	GRAPHQL_PLACEHOLDER_FIELD_NAME = 'placeholder_graphql_field'
const	GRAPHQL_SCHEMA_FILE = 'schema.graphqls'

Detailed Description

Reads *.graphqls files from modules and combines the results as array to be used with a library to configure objects

Definition at line 17 of file GraphQlReader.php.

Constructor & Destructor Documentation

__construct()

__construct	(	FileResolverInterface	$fileResolver,
		TypeReaderComposite	$typeReader,
			$fileName = self::GRAPHQL_SCHEMA_FILE,
			$defaultScope = 'global'
	)

Parameters

FileResolverInterface	$fileResolver
TypeReaderComposite	$typeReader
string	$fileName
string	$defaultScope

Definition at line 51 of file GraphQlReader.php.

      {
        $this->fileResolver = $fileResolver;
        $this->typeReader = $typeReader;
        $this->defaultScope = $defaultScope;
        $this->fileName = $fileName;
    }

Member Function Documentation

read()

read

(

$scope = null

)

{Read configuration scope

Parameters

string | null

$scope

Returns

array

}

Compatible with

See also

GraphQlReader::parseTypes

Implements ReaderInterface.

Definition at line 66 of file GraphQlReader.php.

                                        : array
    {
        $results = [];
        $scope = $scope ?: $this->defaultScope;
        $schemaFiles = $this->fileResolver->get($this->fileName, $scope);
        if (!count($schemaFiles)) {
            return $results;
        }

        $knownTypes = [];
        foreach ($schemaFiles as $partialSchemaContent) {
            $partialSchemaTypes = $this->parseTypes($partialSchemaContent);

            // Keep declarations from current partial schema, add missing declarations from all previously read schemas
            $knownTypes = $partialSchemaTypes + $knownTypes;
            $schemaContent = implode("\n", $knownTypes);

            $partialResults = $this->readPartialTypes($schemaContent);

            $results = array_replace_recursive($results, $partialResults);
        }

        $results = $this->copyInterfaceFieldsToConcreteTypes($results);
        return $results;
    }

Field Documentation

GRAPHQL_PLACEHOLDER_FIELD_NAME

const GRAPHQL_PLACEHOLDER_FIELD_NAME = 'placeholder_graphql_field'

Definition at line 19 of file GraphQlReader.php.

GRAPHQL_SCHEMA_FILE

const GRAPHQL_SCHEMA_FILE = 'schema.graphqls'

Definition at line 21 of file GraphQlReader.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/GraphQlSchemaStitching/GraphQlReader.php