Excerpts
in package
Class Excerpts
Table of Contents
Properties
- $config : array<string|int, mixed>
- $page : PageInterface|null
Methods
- __construct() : mixed
- Excerpts constructor.
- fireInitializedEvent() : void
- getConfig() : array<string|int, mixed>
- getPage() : PageInterface|null
- processImageExcerpt() : array<string|int, mixed>
- Process an image excerpt
- processLinkExcerpt() : array<string|int, mixed>
- Process a Link excerpt
- processMediaActions() : Medium|Link
- Process media actions
- parseUrl() : array<string|int, mixed>
- Variation of parse_url() which works also with local streams.
Properties
$config
protected
array<string|int, mixed>
$config
$page
protected
PageInterface|null
$page
Methods
__construct()
Excerpts constructor.
public
__construct([PageInterface|null $page = null ][, array<string|int, mixed>|null $config = null ]) : mixed
Parameters
- $page : PageInterface|null = null
- $config : array<string|int, mixed>|null = null
fireInitializedEvent()
public
fireInitializedEvent(object $markdown) : void
Parameters
- $markdown : object
getConfig()
public
getConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>getPage()
public
getPage() : PageInterface|null
Return values
PageInterface|nullprocessImageExcerpt()
Process an image excerpt
public
processImageExcerpt(array<string|int, mixed> $excerpt) : array<string|int, mixed>
Parameters
- $excerpt : array<string|int, mixed>
Return values
array<string|int, mixed>processLinkExcerpt()
Process a Link excerpt
public
processLinkExcerpt(array<string|int, mixed> $excerpt[, string $type = 'link' ]) : array<string|int, mixed>
Parameters
- $excerpt : array<string|int, mixed>
- $type : string = 'link'
Return values
array<string|int, mixed>processMediaActions()
Process media actions
public
processMediaActions(Medium $medium, string|array<string|int, mixed> $url) : Medium|Link
Parameters
- $medium : Medium
- $url : string|array<string|int, mixed>
Return values
Medium|LinkparseUrl()
Variation of parse_url() which works also with local streams.
protected
parseUrl(string $url) : array<string|int, mixed>
Parameters
- $url : string