sanitizer truncate - some parameter are ignored

[Klenkes]

Short description of the issue

Using $sanitizer->truncate like this:
wire('sanitizer')->truncate($item->body, $maxLength=200);
wire('sanitizer')->truncate($item->body, 200, array('underlineHeadlines' => false));

Expected behavior

In PW 3.0.123 the result was pure text with no HTML tags and no linebreaks, ready to be used for example in a search results page

Actual behavior

underlineHeadlines is used(true), so that every headline is followed by ===(h2) or ---(h3)
It used to work correctly in PW 3.0.123 but not anymore in 3.0.143

Related forum post with more description and screenshots(by me)

https://processwire.com/talk/topic/22491-sanitizer-truncate-inserts-as-breaks/
older post:
https://processwire.com/talk/topic/22190-truncate-leads-to-crazy-link-leftovers/
Could be on to the source of the problem:
https://processwire.com/talk/topic/22491-sanitizer-truncate-inserts-as-breaks/?do=findComment&comment=192949

Versions

PW 3.0.123 = okay
PW 3.0.143 = not okay
PHP 5.6 up to 7.2

[adrianbj]

I came across this recently as well. As a workaround, this works:

$sanitizer->truncate($sanitizer->textarea(

[Klenkes]

True, but there are still some residual ellipses for each heading that has been removed. This can't be right.

And since I am in my _func.php I have to use:
wire('sanitizer')->truncate( wire('sanitizer')->textarea($item->body, array('maxLength' => 200)) ) . '...';

[ryancramerdesign]

Thanks @Klenkes I've pushed a fix for this issue, though the issue is not that "some parameter ignored" because 'underlineHeadlines' is not a documented option/param for the truncate() method. The problem was instead that it wasn't properly applying (by disabling) that option when having the markupToText() strip markup. I have updated it so that it is now properly disabling options that shouldn't appear in truncate/collapse calls.

Regarding the ellipsis appearing between headlines or headline + other text: that is the correct behavior. It can however be adjusted with the 'collapseLinesWith' option. Though that's an option I would not recommend disabling unless you have some other kind of punctuation accommodating it. Otherwise it can result in creating sentences that aren't meant to be merged, creating unusual, awkward, gibberish or humorous combinations that appear as full sentences but aren't in the source markup.

[Klenkes]

Regarding the ellipsis appearing between headlines
You are right. Switching this off could be unintentionally funny...

[Klenkes]

Seems to work fine now.