Inline version of KirbyText

[distantnative]

Describe the PR
Adds option for KirbyText to output unwrapped (without wrapping <p> tag) string.
kirbytext($text, false)
->kirbytext(false)

Related issues

• Implements [Cms] $page->field()->kt(false) for kirbytextRaw ideas#93

Todos

• Add unit tests for feature
• Pass all unit tests
• Fix code style issues with CS fixer and composer fix
• Documented on getkirby.com

[lukasbestle]

The additional param is a breaking change as the $data param now moves to third position. I think we should either create a separate method and helper for this behavior or make the params "magic" (so that the order of the additional params doesn't matter).

Also I think we could use Parsedown's line() method instead of stripping the paragraph tags manually. This should be supported down to the markdown component.

[bastianallgeier]

I agree with @lukasbestle.

[distantnative]

Understood and agreed - can't say yet when I will get to rewrite it though.

[distantnative]

@lukasbestle I am wondering whether it is worth the effort to make the parameters "magic". Or if it would be sufficient to move the new parameter to the last position to not create a breaking change. What do you think?

[lukasbestle]

You are right about that. It's probably even harmful as it gets a lot more complex.

I think we should avoid methods with a lot of params in general. We had that in v2 in some places (e.g. the Cookie class) and it was sooo hard to find out which param did what, especially if all of them are boolean. The TCPDF library has the same issue and it drives me crazy every time I have to use it.

So what about a completely separate method for this?

[texnixe]

So what about a completely separate method for this?

Yes, call it ktRaw(), like we called it in our plugins for Kirby 2. Nice and short.

[distantnative]

Ok 👍 separate method it is. And then I will try to solve it at the markdown component level

[lukasbestle]

I'm not sure about the ktRaw name. "Raw" would imply that nothing else is done except parsing KirbyText. But actually Markdown is parsed as usual, just without wrapping tags.

Maybe ktInline()? Slightly longer, but I think it makes it clear what happens. Maybe we can find a way to still use the full kirbytext name for it to avoid having abbreviations all over the code. But kirbytextInline is too long. 🤔

[distantnative]

Hmm yea, I feel like adding anything, even just 1-2 characters to kirbytext could make it too long. Something in the direction of kirbytextline? kirbyphrase?

[texnixe]

I hardly ever use kirbytext() but prefer the short kt(). I will wrap anything that makes kirbytext() even longer into a nice short custom method 😉

[lukasbestle]

I don't think we should introduce an entirely new term for this, that could be quite confusing.
Why not both actually? kirbytextInline() with a short alias ktInline().

@texnixe Do we already have a short kt() helper and/or method? I can't find one in the core.

[distantnative]

@lukasbestle https://github.com/getkirby/kirby/blob/master/src/Cms/AppPlugins.php#L378

[nilshoerrmann]

If you have a long kirbytextinline(), why don‘t you call the shortcut kti()?

[lukasbestle]

👍 for kti!
I think we should also have helpers with the short versions.

[distantnative]

@lukasbestle ping - new version. I still don't like the name to be honest 🙈

[distantnative]

Needs a bit of adaption if this PR gets merged: #1543

[lukasbestle]

Maybe we should also have inline variants of the markdown helper and field method. Not sure about that though.

Otherwise LGTM. 👍

[lukasbestle]

I think we should use camelCase for this: kirbytextInline. Same for all other occurrences.

[distantnative]

Let's wait to hear from @bastianallgeier if all else would be ok, before making that change.

[bastianallgeier]

I kept it like the rest. Otherwise we would need to change kirbyText, kirbyTags, etc. as well.