GraphiQLMenuPage::getResponse() - Code Metrics - Inspection of "Support GraphiQL Explorer in admin" - GraphQLAPI/graphql-api-for-wp - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( be2bcd...c77520 )

by Leonardo

created 2020-09-19 07:47 UTC

GraphiQLMenuPage::getResponse() A

↳ Parent: GraphiQLMenuPage

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
ccs	0
cts	0
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	2

<?php

declare(strict_types=1);

namespace GraphQLAPI\GraphQLAPI\Admin\MenuPages;

use GraphQLAPI\GraphQLAPI\General\EndpointHelpers;
use GraphQLAPI\GraphQLAPI\Facades\ModuleRegistryFacade;
use GraphQLAPI\GraphQLAPI\Admin\MenuPages\AbstractMenuPage;
use PoP\ComponentModel\Facades\Instances\InstanceManagerFacade;
use GraphQLAPI\GraphQLAPI\Clients\AdminGraphiQLWithExplorerClient;
use GraphQLAPI\GraphQLAPI\Admin\MenuPages\EnqueueReactMenuPageTrait;
use GraphQLAPI\GraphQLAPI\ModuleResolvers\ClientFunctionalityModuleResolver;

/**
 * GraphiQL page
 */
class GraphiQLMenuPage extends AbstractMenuPage
{
    use EnqueueReactMenuPageTrait;
    use GraphQLAPIMenuPageTrait;

    protected function useGraphiQLExplorer(): bool
    {
        $moduleRegistry = ModuleRegistryFacade::getInstance();
        return $moduleRegistry->isModuleEnabled(ClientFunctionalityModuleResolver::GRAPHIQL_EXPLORER);
    }

    protected function getGraphiQLWithExplorerClientHTML(): string
    {
        $instanceManager = InstanceManagerFacade::getInstance();
        /**
         * @var AdminGraphiQLWithExplorerClient
         */
        $client = $instanceManager->getInstance(AdminGraphiQLWithExplorerClient::class);
        return $client->getClientHTML();
    }

    public function print(): void
    {
        if (!$this->useGraphiQLExplorer()) {
            ?>
            <div id="graphiql" class="graphiql-client">
                <p>
                    <?php echo __('Loading...', 'graphql-api') ?>
                    <!--span class="spinner is-active" style="float: none;"></span-->
                </p>
            </div>
            <?php
        } else {
            $htmlContent = $this->getGraphiQLWithExplorerClientHTML();
            // Extract the HTML inside <body>
            $matches = [];
            preg_match('/<body>(.*?)<\/body>/', $htmlContent, $matches);
            echo $matches[1];
        }
    }

    /**
     * Override, because this is the default page, so it is invoked
     * with the menu slug wp-admin/admin.php?page=graphql_api,
     * and not the menu page slug wp-admin/admin.php?page=graphql_api_graphiql
     *
     * @return string
     */
    public function getScreenID(): string
    {
        return $this->getMenuName();
    }

    public function getMenuPageSlug(): string
    {
        return 'graphiql';
    }

    /**
     * Enqueue the required assets and initialize the localized scripts
     *
     * @return void
     */
    protected function enqueueAssets(): void
    {
        parent::enqueueAssets();

        $useGraphiQLExplorer = $this->useGraphiQLExplorer();

        // CSS
        \wp_enqueue_style(
            'graphql-api-graphiql-client',
            \GRAPHQL_API_URL . 'assets/css/graphiql-client.css',
            array(),
            \GRAPHQL_API_VERSION
        );

        // JS: execute them all in the footer
        $this->enqueueReactAssets(true);

        if (!$useGraphiQLExplorer) {
            \wp_enqueue_style(
                'graphql-api-graphiql',
                \GRAPHQL_API_URL . 'assets/css/vendors/graphiql.min.css',
                array(),
                \GRAPHQL_API_VERSION
            );
            \wp_enqueue_script(
                'graphql-api-graphiql',
                \GRAPHQL_API_URL . 'assets/js/vendors/graphiql.min.js',
                array('graphql-api-react-dom'),
                \GRAPHQL_API_VERSION,
                true
            );
            \wp_enqueue_script(
                'graphql-api-graphiql-client',
                \GRAPHQL_API_URL . 'assets/js/graphiql-client.js',
                array('graphql-api-graphiql'),
                \GRAPHQL_API_VERSION,
                true
            );

            // Load data into the script
            \wp_localize_script(
                'graphql-api-graphiql-client',
                'graphQLByPoPGraphiQLSettings',
                array(
                    'nonce' => \wp_create_nonce('wp_rest'),
                    'endpoint' => EndpointHelpers::getAdminGraphQLEndpoint(),
                    'defaultQuery' => $this->getDefaultQuery(),
                    'response' => $this->getResponse(),
                )
            );
        } else {
            // Print the HTML from the Client
            $htmlContent = $this->getGraphiQLWithExplorerClientHTML();
            // Extract the JS/CSS assets from the <head>
            $matches = [];
            preg_match('/<head>(.*?)<\/head>/', $htmlContent, $matches);
            $headHTMLContent = $matches[1];
            preg_match_all('/<link[^>]+href="([^">]+)"/', $headHTMLContent, $matches);
            $cssFileURLs = $matches[1];
            foreach ($cssFileURLs as $index => $cssFileURL) {
                \wp_enqueue_style(
                    'graphql-api-graphiql-with-explorer-'.$index,
                    $cssFileURL,
                    array(),
                    \GRAPHQL_API_VERSION
                );
            }
            preg_match_all('/<script[^>]+src="([^">]+)"/', $headHTMLContent, $matches);
            $jsFileURLs = $matches[1];
            foreach ($jsFileURLs as $index => $jsFileURL) {
                \wp_enqueue_script(
                    'graphql-api-graphiql-with-explorer-'.$index,
                    $jsFileURL,
                    array(),
                    \GRAPHQL_API_VERSION,
                    true
                );
            }

            // Override styles for the admin, so load last
            \wp_enqueue_style(
                'graphql-api-graphiql-with-explorer-client',
                \GRAPHQL_API_URL . 'assets/css/graphiql-with-explorer-client.css',
                array(),
                \GRAPHQL_API_VERSION
            );
        }
    }

    protected function getResponse(): string
    {
        return '';
        // return \__('Click the "Execute Query" button, or press Ctrl+Enter (Command+Enter in Mac)', 'graphql-api');
    }

    protected function getDefaultQuery(): string
    {
        return <<<EOT
# Welcome to GraphiQL
#
# GraphiQL is an in-browser tool for writing, validating, and
# testing GraphQL queries.
#
# Type queries into this side of the screen, and you will see intelligent
# typeaheads aware of the current GraphQL type schema and live syntax and
# validation errors highlighted within the text.
#
# GraphQL queries typically start with a "{" character. Lines that starts
# with a # are ignored.
#
# An example GraphQL query might look like:
#
#   {
#     field(arg: "value") {
#       subField
#     }
#   }
#
# Run the query (at any moment):
#
#   Ctrl-Enter (or press the play button above)
#

query {
  posts(limit:3) {
    id
    title
    date(format:"d/m/Y")
    url
    author {
      id
      name
      url
    }
    tags {
      name
    }
    featuredImage {
      src
    }
  }
}

EOT;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace GraphQLAPI\GraphQLAPI\Admin\MenuPages;
6
7			use GraphQLAPI\GraphQLAPI\General\EndpointHelpers;
8			use GraphQLAPI\GraphQLAPI\Facades\ModuleRegistryFacade;
9			use GraphQLAPI\GraphQLAPI\Admin\MenuPages\AbstractMenuPage;
10			use PoP\ComponentModel\Facades\Instances\InstanceManagerFacade;
11			use GraphQLAPI\GraphQLAPI\Clients\AdminGraphiQLWithExplorerClient;
12			use GraphQLAPI\GraphQLAPI\Admin\MenuPages\EnqueueReactMenuPageTrait;
13			use GraphQLAPI\GraphQLAPI\ModuleResolvers\ClientFunctionalityModuleResolver;
14
15			/**
16			* GraphiQL page
17			*/
18			class GraphiQLMenuPage extends AbstractMenuPage
19			{
20			use EnqueueReactMenuPageTrait;
21			use GraphQLAPIMenuPageTrait;
22
23			protected function useGraphiQLExplorer(): bool
24			{
25			$moduleRegistry = ModuleRegistryFacade::getInstance();
26			return $moduleRegistry->isModuleEnabled(ClientFunctionalityModuleResolver::GRAPHIQL_EXPLORER);
27			}
28
29			protected function getGraphiQLWithExplorerClientHTML(): string
30			{
31			$instanceManager = InstanceManagerFacade::getInstance();
32			/**
33			* @var AdminGraphiQLWithExplorerClient
34			*/
35			$client = $instanceManager->getInstance(AdminGraphiQLWithExplorerClient::class);
36			return $client->getClientHTML();
37			}
38
39			public function print(): void
40			{
41			if (!$this->useGraphiQLExplorer()) {
42			?>
43			<div id="graphiql" class="graphiql-client">
44			<p>
45			<?php echo __('Loading...', 'graphql-api') ?>
46			<!--span class="spinner is-active" style="float: none;"></span-->
47			</p>
48			</div>
49			<?php
50			} else {
51			$htmlContent = $this->getGraphiQLWithExplorerClientHTML();
52			// Extract the HTML inside <body>
53			$matches = [];
54			preg_match('/<body>(.*?)<\/body>/', $htmlContent, $matches);
55			echo $matches[1];
56			}
57			}
58
59			/**
60			* Override, because this is the default page, so it is invoked
61			* with the menu slug wp-admin/admin.php?page=graphql_api,
62			* and not the menu page slug wp-admin/admin.php?page=graphql_api_graphiql
63			*
64			* @return string
65			*/
66			public function getScreenID(): string
67			{
68			return $this->getMenuName();
69			}
70
71			public function getMenuPageSlug(): string
72			{
73			return 'graphiql';
74			}
75
76			/**
77			* Enqueue the required assets and initialize the localized scripts
78			*
79			* @return void
80			*/
81			protected function enqueueAssets(): void
82			{
83			parent::enqueueAssets();
84
85			$useGraphiQLExplorer = $this->useGraphiQLExplorer();
86
87			// CSS
88			\wp_enqueue_style(
89			'graphql-api-graphiql-client',
90			\GRAPHQL_API_URL . 'assets/css/graphiql-client.css',
91			array(),
92			\GRAPHQL_API_VERSION
93			);
94
95			// JS: execute them all in the footer
96			$this->enqueueReactAssets(true);
97
98			if (!$useGraphiQLExplorer) {
99			\wp_enqueue_style(
100			'graphql-api-graphiql',
101			\GRAPHQL_API_URL . 'assets/css/vendors/graphiql.min.css',
102			array(),
103			\GRAPHQL_API_VERSION
104			);
105			\wp_enqueue_script(
106			'graphql-api-graphiql',
107			\GRAPHQL_API_URL . 'assets/js/vendors/graphiql.min.js',
108			array('graphql-api-react-dom'),
109			\GRAPHQL_API_VERSION,
110			true
111			);
112			\wp_enqueue_script(
113			'graphql-api-graphiql-client',
114			\GRAPHQL_API_URL . 'assets/js/graphiql-client.js',
115			array('graphql-api-graphiql'),
116			\GRAPHQL_API_VERSION,
117			true
118			);
119
120			// Load data into the script
121			\wp_localize_script(
122			'graphql-api-graphiql-client',
123			'graphQLByPoPGraphiQLSettings',
124			array(
125			'nonce' => \wp_create_nonce('wp_rest'),
126			'endpoint' => EndpointHelpers::getAdminGraphQLEndpoint(),
127			'defaultQuery' => $this->getDefaultQuery(),
128			'response' => $this->getResponse(),
129			)
130			);
131			} else {
132			// Print the HTML from the Client
133			$htmlContent = $this->getGraphiQLWithExplorerClientHTML();
134			// Extract the JS/CSS assets from the <head>
135			$matches = [];
136			preg_match('/<head>(.*?)<\/head>/', $htmlContent, $matches);
137			$headHTMLContent = $matches[1];
138			preg_match_all('/<link[^>]+href="([^">]+)"/', $headHTMLContent, $matches);
139			$cssFileURLs = $matches[1];
140			foreach ($cssFileURLs as $index => $cssFileURL) {
141			\wp_enqueue_style(
142			'graphql-api-graphiql-with-explorer-'.$index,
143			$cssFileURL,
144			array(),
145			\GRAPHQL_API_VERSION
146			);
147			}
148			preg_match_all('/<script[^>]+src="([^">]+)"/', $headHTMLContent, $matches);
149			$jsFileURLs = $matches[1];
150			foreach ($jsFileURLs as $index => $jsFileURL) {
151			\wp_enqueue_script(
152			'graphql-api-graphiql-with-explorer-'.$index,
153			$jsFileURL,
154			array(),
155			\GRAPHQL_API_VERSION,
156			true
157			);
158			}
159
160			// Override styles for the admin, so load last
161			\wp_enqueue_style(
162			'graphql-api-graphiql-with-explorer-client',
163			\GRAPHQL_API_URL . 'assets/css/graphiql-with-explorer-client.css',
164			array(),
165			\GRAPHQL_API_VERSION
166			);
167			}
168			}
169
170			protected function getResponse(): string
171			{
172			return '';
173			// return \__('Click the "Execute Query" button, or press Ctrl+Enter (Command+Enter in Mac)', 'graphql-api');
174			}
175
176			protected function getDefaultQuery(): string
177			{
178			return <<<EOT
179			# Welcome to GraphiQL
180			#
181			# GraphiQL is an in-browser tool for writing, validating, and
182			# testing GraphQL queries.
183			#
184			# Type queries into this side of the screen, and you will see intelligent
185			# typeaheads aware of the current GraphQL type schema and live syntax and
186			# validation errors highlighted within the text.
187			#
188			# GraphQL queries typically start with a "{" character. Lines that starts
189			# with a # are ignored.
190			#
191			# An example GraphQL query might look like:
192			#
193			# {
194			# field(arg: "value") {
195			# subField
196			# }
197			# }
198			#
199			# Run the query (at any moment):
200			#
201			# Ctrl-Enter (or press the play button above)
202			#
203
204			query {
205			posts(limit:3) {
206			id
207			title
208			date(format:"d/m/Y")
209			url
210			author {
211			id
212			name
213			url
214			}
215			tags {
216			name
217			}
218			featuredImage {
219			src
220			}
221			}
222			}
223
224			EOT;
225			}
226			}
227

GraphQLAPI / graphql-api-for-wp

GitHub Access Token became invalid

Push — master ( be2bcd...c77520 )

GraphiQLMenuPage::getResponse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like