From 64d2fac32560bc97b3f5e7363cfd501d6bcfc7ba Mon Sep 17 00:00:00 2001 From: Awilum Date: Wed, 4 May 2022 18:36:12 +0300 Subject: [PATCH] chore(shortcodes): update descriptions --- src/flextype/core/Parsers/Shortcodes/EntriesShortcode.php | 2 +- src/flextype/core/Parsers/Shortcodes/RawShortcode.php | 2 +- src/flextype/core/Parsers/Shortcodes/RegistryShortcode.php | 2 +- src/flextype/core/Parsers/Shortcodes/UrlShortcode.php | 3 ++- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/src/flextype/core/Parsers/Shortcodes/EntriesShortcode.php b/src/flextype/core/Parsers/Shortcodes/EntriesShortcode.php index 96e5fa2f..3f0cfdec 100644 --- a/src/flextype/core/Parsers/Shortcodes/EntriesShortcode.php +++ b/src/flextype/core/Parsers/Shortcodes/EntriesShortcode.php @@ -24,7 +24,7 @@ use function entries; use function parsers; use function registry; -// Shortcode: [entries-fetch id="entry-id" field="field-name" default="default-value"] +// Shortcode: [entries-fetch id="STRING" field="STRING" default="STRING"] parsers()->shortcodes()->addHandler('entries-fetch', static function (ShortcodeInterface $s) { if (! registry()->get('flextype.settings.parsers.shortcodes.shortcodes.entries.enabled')) { return ''; diff --git a/src/flextype/core/Parsers/Shortcodes/RawShortcode.php b/src/flextype/core/Parsers/Shortcodes/RawShortcode.php index 6217e3bd..ad518b32 100644 --- a/src/flextype/core/Parsers/Shortcodes/RawShortcode.php +++ b/src/flextype/core/Parsers/Shortcodes/RawShortcode.php @@ -22,7 +22,7 @@ use Thunder\Shortcode\Shortcode\ShortcodeInterface; use function parsers; -// Shortcode: [raw] +// Shortcode: [raw] shortcodes to escape [/raw] parsers()->shortcodes()->addHandler('raw', static function (ShortcodeInterface $s) { return $s->getContent(); }); diff --git a/src/flextype/core/Parsers/Shortcodes/RegistryShortcode.php b/src/flextype/core/Parsers/Shortcodes/RegistryShortcode.php index 51b598f7..26fca449 100644 --- a/src/flextype/core/Parsers/Shortcodes/RegistryShortcode.php +++ b/src/flextype/core/Parsers/Shortcodes/RegistryShortcode.php @@ -21,7 +21,7 @@ use Thunder\Shortcode\Shortcode\ShortcodeInterface; use function parsers; use function registry; -// Shortcode: [registry-get id="item-id" default="default-value"] +// Shortcode: [registry-get id="STRING" default="STRING"] parsers()->shortcodes()->addHandler('registry-get', static function (ShortcodeInterface $s) { if (! registry()->get('flextype.settings.parsers.shortcodes.shortcodes.registry.enabled')) { return ''; diff --git a/src/flextype/core/Parsers/Shortcodes/UrlShortcode.php b/src/flextype/core/Parsers/Shortcodes/UrlShortcode.php index 20928b3e..c5434be6 100644 --- a/src/flextype/core/Parsers/Shortcodes/UrlShortcode.php +++ b/src/flextype/core/Parsers/Shortcodes/UrlShortcode.php @@ -57,7 +57,8 @@ parsers()->shortcodes()->addHandler('getUriString', static function () { return getUriString(); }); -// Shortcode: [urlFor routeName="route-name" data='{"foo": "Foo"}' queryParams='{"foo": "Foo"}'] +// Shortcode: [urlFor routeName="STRING" data="STRING(JSON)" queryParams="STRING(JSON)"] +// Example: [urlFor routeName="route-name" data='{"foo": "Foo"}' queryParams='{"foo": "Foo"}'] parsers()->shortcodes()->addHandler('urlFor', static function (ShortcodeInterface $s) { if (! registry()->get('flextype.settings.parsers.shortcodes.shortcodes.url.enabled')) { return '';