Config Class Reference

Inheritance diagram for Config:

Data Structures
class	GraphQlReaderTest

Public Member Functions
	__construct (DataInterface $data, ConfigElementFactoryInterface $configElementFactory, QueryFields $queryFields)
	getConfigElement (string $configElementName)
	getDeclaredTypeNames ()

Detailed Description

Provides access to typing information for a configured GraphQL schema.

Definition at line 18 of file Config.php.

Constructor & Destructor Documentation

__construct()

__construct	(	DataInterface	$data,
		ConfigElementFactoryInterface	$configElementFactory,
		QueryFields	$queryFields
	)

Parameters

DataInterface	$data
ConfigElementFactoryInterface	$configElementFactory
QueryFields	$queryFields

Definition at line 40 of file Config.php.

      {
        $this->configData = $data;
        $this->configElementFactory = $configElementFactory;
        $this->queryFields = $queryFields;
    }

Member Function Documentation

getConfigElement()

getConfigElement

(

string

$configElementName

)

Get a data object with data pertaining to a GraphQL type's structural makeup.

Parameters

string

$configElementName

Returns

ConfigElementInterface

Exceptions

Implements ConfigInterface.

Definition at line 58 of file Config.php.

                                                                : ConfigElementInterface
    {
        $data = $this->configData->get($configElementName);
        if (!isset($data['type'])) {
            throw new \LogicException(
                sprintf('Config element "%s" is not declared in GraphQL schema', $configElementName)
            );
        }

        $fieldsInQuery = $this->queryFields->getFieldsUsedInQuery();
        if (isset($data['fields']) && !empty($fieldsInQuery)) {
            foreach ($data['fields'] as $fieldName => $fieldConfig) {
                if (!isset($fieldsInQuery[$fieldName])) {
                    unset($data['fields'][$fieldName]);
                }
            }
        }

        return $this->configElementFactory->createFromConfigData($data);
    }

getDeclaredTypeNames()

getDeclaredTypeNames

(

)

Return all type names declared in a GraphQL schema's configuration.

Returns

string[]

Implements ConfigInterface.

Definition at line 84 of file Config.php.

                                           : array
    {
        $types = [];
        foreach ($this->configData->get(null) as $item) {
            if (isset($item['type']) && $item['type'] == 'graphql_type') {
                $types[] = $item['name'];
            }
        }
        return $types;
    }

---

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

• vendor/magento/framework/GraphQl/Config.php