studio-variable/designtopack
3
0
Fork 0
Code Issues 7 Pull requests Projects Releases Packages Wiki Activity Actions

test

Browse source
This commit is contained in:
isUnknown 2024-10-16 17:32:15 +02:00
parent 4b6540dfcd
commit 965c015c2c
22 changed files with 396 additions and 299 deletions
Download patch file Download diff file Expand all files Collapse all files

16
public/site/plugins/helpers/index.php Normal file
View file

@ -0,0 +1,16 @@
<?php
function getFileData($file) {
$data = [
'url' => $file->url(),
'uuid' => (string) $file->uuid(),
'name' => $file->filename(),
];
if ($file->description()->exists()) {
$data['description'] = $file->description();
$data['tags'] = $file->tags()->split();
};
return $data;
}

466
public/site/plugins/kql/README.md
View file

@ -16,21 +16,21 @@ Given a POST request to: `/api/query`
```json
{
"query": "page('photography').children",
"select": {
"url": true,
"title": true,
"text": "page.text.markdown",
"images": {
"query": "page.images",
"select": {
"url": true
}
"query": "page('photography').children",
"select": {
"url": true,
"title": true,
"text": "page.text.markdown",
"images": {
"query": "page.moodboard",
"select": {
"url": true
}
}
},
"pagination": {
"limit": 10
}
},
"pagination": {
"limit": 10
}
}
```
@ -39,48 +39,48 @@ Given a POST request to: `/api/query`
```json
{
"code": 200,
"result": {
"data": [
{
"url": "https://example.com/photography/trees",
"title": "Trees",
"text": "Lorem <strong>ipsum</strong> …",
"images": [
{
"url": "https://example.com/media/pages/photography/trees/1353177920-1579007734/cheesy-autumn.jpg"
},
{
"url": "https://example.com/media/pages/photography/trees/1940579124-1579007734/last-tree-standing.jpg"
},
{
"url": "https://example.com/media/pages/photography/trees/3506294441-1579007734/monster-trees-in-the-fog.jpg"
}
]
},
{
"url": "https://example.com/photography/sky",
"title": "Sky",
"text": "<h1>Dolor sit amet</h1> …",
"images": [
{
"url": "https://example.com/media/pages/photography/sky/183363500-1579007734/blood-moon.jpg"
},
{
"url": "https://example.com/media/pages/photography/sky/3904851178-1579007734/coconut-milkyway.jpg"
}
]
}
],
"pagination": {
"page": 1,
"pages": 1,
"offset": 0,
"limit": 10,
"total": 2
}
},
"status": "ok"
"code": 200,
"result": {
"data": [
{
"url": "https://example.com/photography/trees",
"title": "Trees",
"text": "Lorem <strong>ipsum</strong> …",
"images": [
{
"url": "https://example.com/media/pages/photography/trees/1353177920-1579007734/cheesy-autumn.jpg"
},
{
"url": "https://example.com/media/pages/photography/trees/1940579124-1579007734/last-tree-standing.jpg"
},
{
"url": "https://example.com/media/pages/photography/trees/3506294441-1579007734/monster-trees-in-the-fog.jpg"
}
]
},
{
"url": "https://example.com/photography/sky",
"title": "Sky",
"text": "<h1>Dolor sit amet</h1> …",
"images": [
{
"url": "https://example.com/media/pages/photography/sky/183363500-1579007734/blood-moon.jpg"
},
{
"url": "https://example.com/media/pages/photography/sky/3904851178-1579007734/coconut-milkyway.jpg"
}
]
}
],
"pagination": {
"page": 1,
"pages": 1,
"offset": 0,
"limit": 10,
"total": 2
}
},
"status": "ok"
}
```
@ -124,23 +124,24 @@ const username = "apiuser";
const password = "strong-secret-api-password";
const headers = {
Authorization: "Basic " + Buffer.from(`${username}:${password}`).toString("base64"),
"Content-Type": "application/json",
Accept: "application/json",
Authorization:
"Basic " + Buffer.from(`${username}:${password}`).toString("base64"),
"Content-Type": "application/json",
Accept: "application/json",
};
const response = await fetch(api, {
method: "post",
body: JSON.stringify({
query: "page('notes').children",
select: {
title: true,
text: "page.text.kirbytext",
slug: true,
date: "page.date.toDate('d.m.Y')",
},
}),
headers,
method: "post",
body: JSON.stringify({
query: "page('notes').children",
select: {
title: true,
text: "page.text.kirbytext",
slug: true,
date: "page.date.toDate('d.m.Y')",
},
}),
headers,
});
console.log(await response.json());
@ -158,11 +159,11 @@ When you don't pass the select option, Kirby will try to come up with the most u
```js
const response = await fetch(api, {
method: "post",
body: JSON.stringify({
query: "site.title",
}),
headers,
method: "post",
body: JSON.stringify({
query: "site.title",
}),
headers,
});
console.log(await response.json());
@ -185,11 +186,11 @@ console.log(await response.json());
```js
const response = await fetch(api, {
method: "post",
body: JSON.stringify({
query: "site.children",
}),
headers,
method: "post",
body: JSON.stringify({
query: "site.children",
}),
headers,
});
console.log(await response.json());
@ -220,11 +221,11 @@ Queries can even execute field methods.
```js
const response = await fetch(api, {
method: "post",
body: JSON.stringify({
query: "site.title.upper",
}),
headers,
method: "post",
body: JSON.stringify({
query: "site.title.upper",
}),
headers,
});
console.log(await response.json());
@ -253,12 +254,12 @@ To include a property or field in your results, list them as an array. Check out
```js
const response = await fetch(api, {
method: "post",
body: JSON.stringify({
query: "site.children",
select: ["title", "url"],
}),
headers,
method: "post",
body: JSON.stringify({
query: "site.children",
select: ["title", "url"],
}),
headers,
});
console.log(await response.json());
@ -311,15 +312,15 @@ You can also use the object notation and pass true for each key/property you wan
```js
const response = await fetch(api, {
method: "post",
body: JSON.stringify({
query: "site.children",
select: {
title: true,
url: true,
},
}),
headers,
method: "post",
body: JSON.stringify({
query: "site.children",
select: {
title: true,
url: true,
},
}),
headers,
});
console.log(await response.json());
@ -368,14 +369,14 @@ Instead of passing true, you can also pass a string query to specify what you wa
```js
const response = await fetch(api, {
method: "post",
body: JSON.stringify({
query: "site.children",
select: {
title: "page.title",
},
}),
headers,
method: "post",
body: JSON.stringify({
query: "site.children",
select: {
title: "page.title",
},
}),
headers,
});
console.log(await response.json());
@ -409,14 +410,14 @@ console.log(await response.json());
```js
const response = await fetch(api, {
method: "post",
body: JSON.stringify({
query: "site.children",
select: {
title: "page.title.upper",
},
}),
headers,
method: "post",
body: JSON.stringify({
query: "site.children",
select: {
title: "page.title.upper",
},
}),
headers,
});
console.log(await response.json());
@ -452,19 +453,19 @@ String queries are a perfect way to create aliases or return variations of the s
```js
const response = await fetch(api, {
method: "post",
body: JSON.stringify({
query: "page('notes').children",
select: {
title: "page.title",
upperCaseTitle: "page.title.upper",
lowerCaseTitle: "page.title.lower",
guid: "page.id",
date: "page.date.toDate('d.m.Y')",
timestamp: "page.date.toTimestamp",
},
}),
headers,
method: "post",
body: JSON.stringify({
query: "page('notes').children",
select: {
title: "page.title",
upperCaseTitle: "page.title.upper",
lowerCaseTitle: "page.title.lower",
guid: "page.id",
date: "page.date.toDate('d.m.Y')",
timestamp: "page.date.toTimestamp",
},
}),
headers,
});
console.log(await response.json());
@ -504,15 +505,15 @@ With such string queries you can of course also include nested data
```js
const response = await fetch(api, {
method: "post",
body: JSON.stringify({
query: "page('photography').children",
select: {
title: "page.title",
images: "page.images",
},
}),
headers,
method: "post",
body: JSON.stringify({
query: "page('photography').children",
select: {
title: "page.title",
images: "page.moodboard",
},
}),
headers,
});
console.log(await response.json());
@ -554,20 +555,20 @@ You can also pass an object with a `query` and a `select` option
```js
const response = await fetch(api, {
method: "post",
body: JSON.stringify({
query: "page('photography').children",
select: {
title: "page.title",
images: {
query: "page.images",
method: "post",
body: JSON.stringify({
query: "page('photography').children",
select: {
filename: true,
title: "page.title",
images: {
query: "page.moodboard",
select: {
filename: true,
},
},
},
},
},
}),
headers,
}),
headers,
});
console.log(await response.json());
@ -623,17 +624,17 @@ You can specify a custom limit with the limit option. The default limit for coll
```js
const response = await fetch(api, {
method: "post",
body: JSON.stringify({
query: "page('notes').children",
pagination: {
limit: 5,
},
select: {
title: "page.title",
},
}),
headers,
method: "post",
body: JSON.stringify({
query: "page('notes').children",
pagination: {
limit: 5,
},
select: {
title: "page.title",
},
}),
headers,
});
console.log(await response.json());
@ -683,18 +684,18 @@ You can jump to any page in the resultset with the `page` option.
```js
const response = await fetch(api, {
method: "post",
body: JSON.stringify({
query: "page('notes').children",
pagination: {
page: 2,
limit: 5,
},
select: {
title: "page.title",
},
}),
headers,
method: "post",
body: JSON.stringify({
query: "page('notes').children",
pagination: {
page: 2,
limit: 5,
},
select: {
title: "page.title",
},
}),
headers,
});
console.log(await response.json());
@ -735,24 +736,24 @@ Pagination settings also work for subqueries.
```js
const response = await fetch(api, {
method: "post",
body: JSON.stringify({
query: "page('photography').children",
select: {
title: "page.title",
images: {
query: "page.images",
pagination: {
page: 2,
limit: 5,
},
method: "post",
body: JSON.stringify({
query: "page('photography').children",
select: {
filename: true,
title: "page.title",
images: {
query: "page.moodboard",
pagination: {
page: 2,
limit: 5,
},
select: {
filename: true,
},
},
},
},
},
}),
headers,
}),
headers,
});
console.log(await response.json());
@ -764,41 +765,41 @@ With the power of selects and subqueries you can basically query the entire site
```js
const response = await fetch(api, {
method: "post",
body: JSON.stringify({
query: "site",
select: {
title: "site.title",
url: "site.url",
notes: {
query: "page('notes').children.listed",
method: "post",
body: JSON.stringify({
query: "site",
select: {
title: true,
url: true,
date: "page.date.toDate('d.m.Y')",
text: "page.text.kirbytext",
},
},
photography: {
query: "page('photography').children.listed",
select: {
title: true,
images: {
query: "page.images",
select: {
url: true,
alt: true,
caption: "file.caption.kirbytext",
title: "site.title",
url: "site.url",
notes: {
query: "page('notes').children.listed",
select: {
title: true,
url: true,
date: "page.date.toDate('d.m.Y')",
text: "page.text.kirbytext",
},
},
photography: {
query: "page('photography').children.listed",
select: {
title: true,
images: {
query: "page.moodboard",
select: {
url: true,
alt: true,
caption: "file.caption.kirbytext",
},
},
},
},
about: {
text: "page.text.kirbytext",
},
},
},
},
about: {
text: "page.text.kirbytext",
},
},
}),
headers,
}),
headers,
});
console.log(await response.json());
@ -966,19 +967,20 @@ KQL only offers access to data in your site. It does not support any mutations.
## Plugins
- [KQL + 11ty](https://github.com/getkirby/eleventykit)
- [KQL + Nuxt](https://nuxt-kql.jhnn.dev)
- [KQL + 11ty](https://github.com/getkirby/eleventykit)
- [KQL + Nuxt](https://nuxt-kql.jhnn.dev)
## What's Kirby?
- **[getkirby.com](https://getkirby.com)** – Get to know the CMS.
- **[Try it](https://getkirby.com/try)** – Take a test ride with our online demo. Or download one of our kits to get started.
- **[Documentation](https://getkirby.com/docs/guide)** – Read the official guide, reference and cookbook recipes.
- **[Issues](https://github.com/getkirby/kirby/issues)** – Report bugs and other problems.
- **[Feedback](https://feedback.getkirby.com)** – You have an idea for Kirby? Share it.
- **[Forum](https://forum.getkirby.com)** – Whenever you get stuck, don't hesitate to reach out for questions and support.
- **[Discord](https://chat.getkirby.com)** – Hang out and meet the community.
- **[Mastodon](https://mastodon.social/@getkirby)** – Spread the word.
- **[Instagram](https://www.instagram.com/getkirby/)** – Share your creations: #madewithkirby.
- **[getkirby.com](https://getkirby.com)** – Get to know the CMS.
- **[Try it](https://getkirby.com/try)** – Take a test ride with our online demo. Or download one of our kits to get started.
- **[Documentation](https://getkirby.com/docs/guide)** – Read the official guide, reference and cookbook recipes.
- **[Issues](https://github.com/getkirby/kirby/issues)** – Report bugs and other problems.
- **[Feedback](https://feedback.getkirby.com)** – You have an idea for Kirby? Share it.
- **[Forum](https://forum.getkirby.com)** – Whenever you get stuck, don't hesitate to reach out for questions and support.
- **[Discord](https://chat.getkirby.com)** – Hang out and meet the community.
- **[Mastodon](https://mastodon.social/@getkirby)** – Spread the word.
- **[Instagram](https://www.instagram.com/getkirby/)** – Share your creations: #madewithkirby.
---