Iteracja i Manipulacja Wartościami Pól
Dodanie meta-dyrektyw do schematu GraphQL, służących do iterowania i manipulowania elementami wartości pól tablicowych i obiektowych:
@underArrayItem@underJSONObjectProperty@underEachArrayItem@underEachJSONObjectProperty@objectClone
@underArrayItem
@underArrayItem sprawia, że zagnieżdżona dyrektywa jest stosowana do konkretnego elementu tablicy.
W poniższym zapytaniu tylko pierwszy element tablicy z nazwami kategorii jest przekształcany na wielkie litery:
query {
posts {
categoryNames
@underArrayItem(index: 0)
@strUpperCase
}
}...dając w wyniku:
{
"data": {
"posts": {
"categoryNames": [
"NEWS",
"sports"
]
}
}
}@underJSONObjectProperty
@underJSONObjectProperty sprawia, że zagnieżdżona dyrektywa otrzymuje wpis z odpytywanego obiektu JSON.
Ta dyrektywa jest szczególnie przydatna do wyodrębniania i manipulowania żądanymi danymi po odpytaniu zewnętrznego API, które najprawdopodobniej będzie posiadać generyczny typ JSONObject (jak przy użyciu pola funkcji _sendJSONObjectItemHTTPRequest z rozszerzenia HTTP Client).
W poniższym zapytaniu pobieramy obiekt JSON pochodzący z WP REST API i używamy @underJSONObjectProperty, aby manipulować właściwością type odpowiedzi, przekształcając ją na wielkie litery:
query {
postData: _sendJSONObjectItemHTTPRequest(input: {
url: "https://newapi.getpop.org/wp-json/wp/v2/posts/1/?_fields=id,type,title,date"
})
@underJSONObjectProperty(by: { key: "type" })
@strUpperCase
}To spowoduje:
{
"data": {
"postData": {
"id": 1,
"date": "2019-08-02T07:53:57",
"type": "POST",
"title": {
"rendered": "Hello world!"
}
}
}
}Oprócz przyjmowania "key" wskazującego na właściwość znajdującą się na pierwszym poziomie obiektu JSON, ta dyrektywa może również przyjmować "path", aby nawigować wewnątrz struktury obiektu, używając . jako separatora między poziomami.
W poniższym zapytaniu endpoint WP REST API dla wpisu dostarcza właściwość "title.rendered". Możemy przejść do tego konkretnego podelementu i przekształcić go na format title case:
query {
postData: _sendJSONObjectItemHTTPRequest(input: {
url: "https://newapi.getpop.org/wp-json/wp/v2/posts/1/?_fields=id,type,title,date"
})
@underJSONObjectProperty(by: { path: "title.rendered" })
@strTitleCase
}To spowoduje:
{
"data": {
"postData": {
"id": 1,
"date": "2019-08-02T07:53:57",
"type": "post",
"title": {
"rendered": "HELLO WORLD!"
}
}
}
}@underEachArrayItem
@underEachArrayItem iteruje po elementach tablicy danego pola w odpytywanej encji i wykonuje zagnieżdżone dyrektywy na każdym z nich.
Na przykład pole Post.categoryNames jest typu [String]. Używając @underEachArrayItem, możemy iterować nazwy kategorii i stosować do nich dyrektywę @strTranslate.
W tym zapytaniu kategorie wpisu są tłumaczone z angielskiego na francuski:
query {
posts {
id
title
categoryNames
@underEachArrayItem
@strTranslate(
from: "en",
to: "fr"
)
}
}...dając w wyniku:
{
"data": {
"posts": [
{
"id": 662,
"title": "Explaining the privacy policy",
"categoryNames": [
"Non classé"
]
},
{
"id": 28,
"title": "HTTP caching improves performance",
"categoryNames": [
"Avancé"
]
},
{
"id": 25,
"title": "Public or Private API mode, for extra security",
"categoryNames": [
"Ressource",
"Blog",
"Avancé"
]
}
]
}
}@underEachArrayItem może przekazywać zarówno indeks, jak i wartość iterowanego elementu jako zmienną dynamiczną do zagnieżdżonych dyrektyw, za pomocą argumentów dyrektyw passIndexOnwardsAs i passValueOnwardsAs.
To zapytanie demonstruje użycie zmiennych dynamicznych $index i $value:
{
_echo(value: ["first", "second", "third"])
@underEachArrayItem(
passIndexOnwardsAs: "index"
passValueOnwardsAs: "value"
)
@applyField(
name: "_echo"
arguments: {
value: {
index: $index,
value: $value
}
},
setResultInResponse: true
)
}Wynik jest następujący:
{
"data": {
"_echo": [
{
"index": 0,
"value": "first"
},
{
"index": 1,
"value": "second"
},
{
"index": 2,
"value": "third"
}
]
}
}@underEachArrayItem może również ograniczać pozycje tablicy, po których dokonywana jest iteracja, za pomocą parametru filter->by, który może przyjmować wpis include lub exclude.
To zapytanie:
{
including: _echo([
"first",
"second",
"third"
])
@underEachArrayItem(
filter: {
by: {
include: [0, 2]
}
}
)
@strUpperCase
excluding: _echo([
"first",
"second",
"third"
])
@underEachArrayItem(
filter: {
by: {
exclude: [0, 2]
}
}
)
@strUpperCase
}...daje w wyniku:
{
"data": {
"including": [
"FIRST",
"second",
"THIRD"
],
"excluding": [
"first",
"SECOND",
"third"
]
}
}@underEachJSONObjectProperty
@underEachJSONObjectProperty działa podobnie do @underEachArrayItem, ale operuje na elementach JSONObject.
W tym zapytaniu iterujemy wszystkie wpisy w obiekcie JSON i zastępujemy każdy wpis null pustym ciągiem znaków:
{
_echo(
value: {
first: "hello",
second: "world",
third: null
}
)
@underEachJSONObjectProperty
@default(value: "")
}...dając w wyniku:
{
"data": {
"_echo": {
"first": "hello",
"second": "world",
"third": ""
}
}
}@underEachJSONObjectProperty może przekazywać klucz i wartość, po których iteruje, jako zmienną dynamiczną do zagnieżdżonych dyrektyw, za pomocą argumentów dyrektyw passKeyOnwardsAs i passValueOnwardsAs.
To zapytanie demonstruje użycie zmiennych dynamicznych $key i $value:
{
_echo(value: {
uno: "first",
dos: "second",
tres: "third"
})
@underEachJSONObjectProperty(
passKeyOnwardsAs: "key"
passValueOnwardsAs: "value"
)
@applyField(
name: "_echo"
arguments: {
value: {
key: $key,
value: $value
}
},
setResultInResponse: true
)
}Wynik jest następujący:
{
"data": {
"_echo": {
"uno": {
"key": "uno",
"value": "first"
},
"dos": {
"key": "dos",
"value": "second"
},
"tres": {
"key": "tres",
"value": "third"
}
}
}
}@underEachJSONObjectProperty może również ograniczać klucze obiektu JSON, po których dokonywana jest iteracja, za pomocą parametru filter->by, który może przyjmować wpis includeKeys lub excludeKeys.
To zapytanie:
{
includingKeys: _echo(value: {
uno: "first",
dos: "second",
tres: "third"
})
@underEachJSONObjectProperty(
filter: {
by: {
includeKeys: ["uno", "tres"]
}
}
)
@strUpperCase
excludingKeys: _echo(value: {
uno: "first",
dos: "second",
tres: "third"
})
@underEachJSONObjectProperty(
filter: {
by: {
excludeKeys: ["uno", "tres"]
}
}
)
@strUpperCase
}...daje w wyniku:
{
"data": {
"includingKeys": {
"uno": "FIRST",
"dos": "second",
"tres": "THIRD"
},
"excludingKeys": {
"uno": "first",
"dos": "SECOND",
"tres": "third"
}
}
}@objectClone
Obiekty JSON mogą być dostępne przez referencję w resolverach pól (a nie przez kopiowanie/duplikowanie obiektu). W takim przypadku modyfikacja obiektu JSON będzie widoczna dla wszystkich pól, które pobierają ten obiekt JSON.
Tak jest w przypadku pola Block.attributes:
{
posts {
blocks(filterBy: { include: "core/heading" } ) {
attributes
}
}
}...które daje w wyniku:
{
"data": {
"posts": [
{
"blocks": [
{
"attributes": {
"content": "Image Block (Full width)",
"level": 2
}
},
{
"attributes": {
"content": "Gallery Block",
"level": 2
}
}
]
}
]
}
}W poniższym zapytaniu, podczas gdy originalAttributes po prostu pobiera atrybuty, transformedAttributes również przetłumaczy właściwość content na francuski:
{
posts {
blocks(filterBy: { include: "core/heading" } ) {
originalAttributes: attributes
transformedAttributes: attributes
@underJSONObjectProperty(by: { key: "content" })
@strTranslate(to: "fr")
}
}
}Jednak ponieważ odpytywana encja Block odwołuje się do tego samego obiektu JSON zarówno w originalAttributes, jak i transformedAttributes, transformacje wykonane przez drugie pole będą również wpływać na pierwsze (niezależnie od kolejności, w jakiej pojawiają się w zapytaniu).
W rezultacie oba pola są tłumaczone na francuski:
{
"data": {
"posts": [
{
"blocks": [
{
"originalAttributes": {
"content": "Bloc d'image (pleine largeur)",
"level": 2
},
"transformedAttributes": {
"content": "Bloc d'image (pleine largeur)",
"level": 2
}
},
{
"originalAttributes": {
"content": "Bloc Galerie",
"level": 2
},
"transformedAttributes": {
"content": "Bloc Galerie",
"level": 2
}
}
]
}
]
}
}Możemy uniknąć tego problemu, dodając dyrektywę @objectClone do pola transformedAttributes, aby modyfikacje były wykonywane na sklonowanym obiekcie JSON:
{
posts {
blocks(filterBy: { include: "core/heading" } ) {
originalAttributes: attributes
transformedAttributes: attributes
@objectClone
@underJSONObjectProperty(by: { key: "content" })
@strTranslate(to: "fr")
}
}
}...dając w wyniku:
{
"data": {
"posts": [
{
"blocks": [
{
"originalAttributes": {
"content": "Image Block (Full width)",
"level": 2
},
"transformedAttributes": {
"content": "Bloc d'image (pleine largeur)",
"level": 2
}
},
{
"originalAttributes": {
"content": "Gallery Block",
"level": 2
},
"transformedAttributes": {
"content": "Bloc Galerie",
"level": 2
}
}
]
}
]
}
}Dodatkowe przykłady
W tym zapytaniu @underEachArrayItem opakowuje @underJSONObjectProperty, który z kolei opakowuje @strUpperCase, przekształcając właściwość "title.rendered" na wielkie litery, dla wielu wpisów pobranych za pomocą WP REST API:
query {
postListData: _sendJSONObjectCollectionHTTPRequest(
url: "https://newapi.getpop.org/wp-json/wp/v2/posts/?per_page=3&_fields=id,type,title,date"
)
@underEachArrayItem
@underJSONObjectProperty(by: { path: "title.rendered" })
@strUpperCase
}...dając w wyniku:
{
"data": {
"postListData": [
{
"id": 1692,
"date": "2022-04-26T10:10:08",
"type": "post",
"title": {
"rendered": "MY BLOGROLL"
}
},
{
"id": 1657,
"date": "2020-12-21T08:24:18",
"type": "post",
"title": {
"rendered": "A TALE OF TWO CITIES – TEASER"
}
},
{
"id": 1499,
"date": "2019-08-08T02:49:36",
"type": "post",
"title": {
"rendered": "COPE WITH WORDPRESS: POST DEMO CONTAINING PLENTY OF BLOCKS"
}
}
]
}
}