ConfigInterface.php 942 Bytes
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
declare(strict_types=1);

namespace Magento\Framework\GraphQl;

use Magento\Framework\GraphQl\Config\ConfigElementInterface;

/**
 * Access all GraphQL type information declared in the schema's configuration.
 *
 * Data includes types, interfaces they implement, their arguments, and fields.
 */
interface ConfigInterface
{
    /**
     * Get config element as an object by its name.
     *
     * @param string $configElementName
     * @return ConfigElementInterface
     */
    public function getConfigElement(string $configElementName) : ConfigElementInterface;

    /**
     * Return all type names declared in a GraphQL schema's configuration and their type.
     *
     * Format is ['name' => 'example value', 'type' = 'example value']
     *
     * @return array $types
     */
    public function getDeclaredTypes() : array;
}