\DevOwl\HeadlessContentBlocker\plugins\imagePreviewImagePreview

__construct()

__construct(\DevOwl\HeadlessContentBlocker\HeadlessContentBlocker  $headlessContentBlocker)

C'tor.

Parameters

afterSetup()

afterSetup()

The content blocker got setup completely.

init()

init()

Init.

modifyHtmlAfterProcessing()

modifyHtmlAfterProcessing(string  $html)

Allows to modify the HTML after the content blocker has done its job.

Parameters

beforeMatch()

beforeMatch(\DevOwl\HeadlessContentBlocker\matcher\AbstractMatcher  $matcher,\DevOwl\FastHtmlTag\finder\match\AbstractMatch  $match)

Called before a match got found.

Parameters

blockedMatch()

blockedMatch(\DevOwl\HeadlessContentBlocker\BlockedResult  $result,\DevOwl\HeadlessContentBlocker\matcher\AbstractMatcher  $matcher,\DevOwl\FastHtmlTag\finder\match\AbstractMatch  $match)

See `AbstractPlugin`.

Parameters

notBlockedMatch()

notBlockedMatch(\DevOwl\HeadlessContentBlocker\BlockedResult  $result,\DevOwl\HeadlessContentBlocker\matcher\AbstractMatcher  $matcher,\DevOwl\FastHtmlTag\finder\match\AbstractMatch  $match)

Called after a match got not blocked. Opposite of `blockedMatch`.

Parameters

checkResult()

checkResult(\DevOwl\HeadlessContentBlocker\BlockedResult  $result,\DevOwl\HeadlessContentBlocker\matcher\AbstractMatcher  $matcher,\DevOwl\FastHtmlTag\finder\match\AbstractMatch  $match): \DevOwl\HeadlessContentBlocker\BlockedResult

Special case: Read attribute of the original embed URL if it got passed via a custom attribute.

Parameters

Returns

keepAlwaysAttributes()

keepAlwaysAttributes(array<mixed,string>  $keepAttributes,\DevOwl\HeadlessContentBlocker\matcher\AbstractMatcher  $matcher,\DevOwl\FastHtmlTag\finder\match\AbstractMatch  $match): array<mixed,string>

Keep attributes for a specific match.

Parameters

Returns

skipInlineScriptVariableAssignment()

skipInlineScriptVariableAssignment(array<mixed,string>  $names,\DevOwl\HeadlessContentBlocker\matcher\ScriptInlineMatcher  $matcher,\DevOwl\FastHtmlTag\finder\match\ScriptInlineMatch  $match): array<mixed,string>

Skip inline script by variable name.

Parameters

Returns

inlineStyleShouldBeExtracted()

inlineStyleShouldBeExtracted(boolean  $extract,\DevOwl\HeadlessContentBlocker\matcher\StyleInlineMatcher|\DevOwl\HeadlessContentBlocker\matcher\StyleInlineAttributeMatcher  $matcher,\DevOwl\FastHtmlTag\finder\match\StyleInlineMatch|\DevOwl\HeadlessContentBlocker\finder\match\StyleInlineAttributeMatch  $match): boolean

Do not extract blocked rules of a CSS inline script to a second document.

Parameters

Returns

inlineStyleModifyDocuments()

inlineStyleModifyDocuments(\Sabberworm\CSS\CSSList\Document  $document,\Sabberworm\CSS\CSSList\Document  $extractedDocument,\DevOwl\HeadlessContentBlocker\matcher\StyleInlineMatcher|\DevOwl\HeadlessContentBlocker\matcher\StyleInlineAttributeMatcher  $matcher,\DevOwl\FastHtmlTag\finder\match\StyleInlineMatch|\DevOwl\HeadlessContentBlocker\finder\match\StyleInlineAttributeMatch  $match): boolean

Allows to modify blocked CSS documents.

Parameters

Returns

inlineStyleBlockRule()

inlineStyleBlockRule(\DevOwl\HeadlessContentBlocker\BlockedResult  $result,string  $url,\DevOwl\HeadlessContentBlocker\matcher\StyleInlineMatcher|\DevOwl\HeadlessContentBlocker\matcher\StyleInlineAttributeMatcher  $matcher,\DevOwl\FastHtmlTag\finder\match\StyleInlineMatch|\DevOwl\HeadlessContentBlocker\finder\match\StyleInlineAttributeMatch  $match): boolean

Decide if a URL in a CSS rule should be blocked.

Parameters

Returns

visualParent()

visualParent(boolean|string|\DevOwl\HeadlessContentBlocker\number  $visualParent,\DevOwl\HeadlessContentBlocker\matcher\AbstractMatcher  $matcher,\DevOwl\FastHtmlTag\finder\match\AbstractMatch  $match): boolean|string|\DevOwl\HeadlessContentBlocker\number

Set a visual parent for a specific match.

Parameters

Returns

blockableStringExpression()

blockableStringExpression(string  $expression,\DevOwl\HeadlessContentBlocker\AbstractBlockable  $blockable): string

Allows to modify the passed string expression to a blockable.

Parameters

Returns

getHeadlessContentBlocker()

getHeadlessContentBlocker()

Getter.

getWriteJson()

getWriteJson(\DevOwl\HeadlessContentBlocker\plugins\imagePreview\Thumbnail  $thumbnail)

Create the result for the HTML attribute which our unblocker can consume.

Parameters

fetchMetadata()

fetchMetadata(array<mixed,\DevOwl\HeadlessContentBlocker\plugins\imagePreview\Thumbnail>  $thumbnails)

Use multiple mechanism to extract a thumbnail from any URL. It returns an map of URL => thumbnail, and if a thumbnail got not found it is no longer part of the returned map.

Mechanism:

1. Cache
2. Oembed
3. HTML Head Parser and extract thumbnail URL from known meta tags

Parameters

setCache()

setCache(\DevOwl\HeadlessContentBlocker\plugins\imagePreview\ImagePreviewCache  $cache)

Setter.

Parameters

getCache()

getCache()

Getter.

findUrlForSpecialMatch()

findUrlForSpecialMatch(\DevOwl\FastHtmlTag\finder\match\AbstractMatch  $match)

Find an embed URL for a special match.

Parameters

isValidEmbedUrl()

isValidEmbedUrl(string  $embedUrl,boolean  $respectSpecialCases = true)

Check if a given embed URL is valid.

Parameters