phpBB API Documentation
Class

phpbb\textformatter\s9e\link_helper

class link_helper

Methods

bool cleanup_tag(Tag $tag, Parser $parser)

Clean up and invalidate a LINK_TEXT tag if applicable
bool generate_link_text_tag(Tag $tag, Parser $parser)

Create a LINK_TEXT tag inside of a link
bool truncate_local_url(Tag $tag, string $board_url)

Remove the board's root URL from a the start of a string
bool truncate_text(Tag $tag)

Truncate the replacement text set in a LINK_TEXT tag

Details

at line 28
public bool cleanup_tag(Tag $tag, Parser $parser)

Clean up and invalidate a LINK_TEXT tag if applicable

Will invalidate the tag if its replacement text is the same as the original text and would have no visible effect

Parameters

Tag $tag LINK_TEXT tag
Parser $parser Parser

Return Value

bool Whether the tag is valid

at line 45
public bool generate_link_text_tag(Tag $tag, Parser $parser)

Create a LINK_TEXT tag inside of a link

Meant to only apply to linkified URLs and [url] BBCodes without a parameter

Parameters

Tag $tag URL tag (start tag)
Parser $parser Parser

Return Value

bool Always true to indicate that the tag is valid

at line 89
public bool truncate_local_url(Tag $tag, string $board_url)

Remove the board's root URL from a the start of a string

Parameters

Tag $tag LINK_TEXT tag
string $board_url Forum's root URL (with trailing slash)

Return Value

bool Always true to indicate that the tag is valid

at line 106
public bool truncate_text(Tag $tag)

Truncate the replacement text set in a LINK_TEXT tag

Parameters

Tag $tag LINK_TEXT tag

Return Value

bool Always true to indicate that the tag is valid