Automatisering
AutomatiseringQuery Resolution Action

Query Resolution Action

Wanneer de GraphQL-server een query oplost, triggert hij de volgende action hooks met de GraphQL-respons:

  1. gatographql__executed_query:{$operationName} (alleen als de uit te voeren GraphQL-operatie is opgegeven)
  2. gatographql__executed_query

De action hooks die worden getriggerd zijn:

// Triggered only if the GraphQL operation to execute was provided
do_action(
  "gatographql__executed_query:{$operationName}",
  $response,
  $isInternalExecution,
  $query,
  $variables,
);
 
// Triggered always
do_action(
  'gatographql__executed_query',
  $response,
  $isInternalExecution,
  $operationName,
  $query,
  $variables,
);

De doorgegeven parameters zijn:

  • $response: Een object van klasse PoP\Root\HttpFoundation\Response, dat de GraphQL-respons bevat (inclusief inhoud en headers)
  • $isInternalExecution: true als de query is uitgevoerd via de Internal GraphQL Server (bijv. via klasse GatoGraphQL\InternalGraphQLServer\GraphQLServer), of false anders (bijv. via het enkele endpoint)
  • $operationName: Uitgevoerde GraphQL-operatie (alleen voor de tweede action hook; bij de eerste is deze impliciet in de hooknaam)
  • $query: Uitgevoerde GraphQL-query
  • $variables: Opgegeven GraphQL-variabelen

Voorbeelden

Dankzij de Internal GraphQL Server kunnen we reageren op het oplossen van een GraphQL-query (ongeacht of deze is uitgevoerd tegen de Internal GraphQL Server, het enkele endpoint, een aangepast endpoint of een persisted query), en een andere GraphQL-query uitvoeren tegen de Internal GraphQL Server.

Een voorbeeldworkflow is:

  • Koppel aan de uitvoering van een GraphQL-query, bijvoorbeeld op basis van de naam van de operatie (zoals CreatePost)
  • Stuur een melding naar de beheerder door de mutatie _sendEmail uit te voeren via GatoGraphQL\InternalGraphQLServer\GraphQLServer::executeQuery

Deze PHP-code koppelt 2 GraphQL-query-uitvoeringen aan elkaar:

GraphQLServer::executeQuery(
  <<<GRAPHQL
    mutation CreatePost(
      \$postTitle: String!,
      \$postContent: String!
    ) {
      createPost(input: {
        title: \$postTitle
        contentAs: { html: \$postContent }
      }) {
        status
        errors {
          __typename
          ...on ErrorPayload {
            message
          }
        }
        postID
      }
    }
  GRAPHQL,
  [
    'postTitle' => 'New post',
    'postContent' => 'Some content',
  ],
  'CreatePost'
);
 
add_action(
  "gatographql__executed_query:CreatePost",
  function (Response $response) {
    /** @var string */
    $responseContent = $response->getContent();
    /** @var array<string,mixed> */
    $responseJSON = json_decode($responseContent, true);
    $postID = $responseJSON['data']['createPost']['postID'] ?? null;
    if ($postID === null) {
      // Do nothing
      return;
    }
 
    $post = get_post($postID);
 
    // Execute the chained query!
    GraphQLServer::executeQuery(
      <<<GRAPHQL
        mutation SendEmail(
          \$emailSubject: String!
          \$emailMessage: String!
        ) {
          _sendEmail(
            input: {
              to: "admin@site.com"
              subject: \$emailSubject
              messageAs: {
                html: \$emailMessage
              }
            }
          ) {
            status
          }
        }
      GRAPHQL,
      [
        'emailSubject' => sprintf(__("New post: %s"), $post->post_title),
        'emailMessage' => $post->post_content,
      ]
    );
  }
);