Documentation

HtmlBlockInterface extends ContentBlockInterface

Interface HtmlBlockInterface

Table of Contents

Methods

__construct()  : mixed
__toString()  : string
addBlock()  : $this
addFramework()  : $this
addHtml()  : bool
addInlineModule()  : bool
Shortcut for writing addInlineScript(['type' => 'module', 'content' => ...]).
addInlineScript()  : bool
addInlineStyle()  : bool
addLink()  : bool
addModule()  : bool
Shortcut for writing addScript(['type' => 'module', 'src' => ...]).
addScript()  : bool
addStyle()  : bool
build()  : void
create()  : static
fromArray()  : ContentBlockInterface
getAssets()  : array<string|int, mixed>
getChecksum()  : string
getFrameworks()  : array<string|int, mixed>
getHtml()  : array<string|int, mixed>
getId()  : string
getLinks()  : array<string|int, mixed>
getScripts()  : array<string|int, mixed>
getStyles()  : array<string|int, mixed>
getToken()  : string
setChecksum()  : $this
setContent()  : $this
toArray()  : array<string|int, mixed>
toString()  : string

Methods

__construct()

public __construct([string|null $id = null ]) : mixed
Parameters
$id : string|null = null

addFramework()

public addFramework(string $framework) : $this
Parameters
$framework : string
Return values
$this

addHtml()

public addHtml(string $html[, int $priority = 0 ][, string $location = 'bottom' ]) : bool
Parameters
$html : string
$priority : int = 0
$location : string = 'bottom'
Return values
bool

addInlineModule()

Shortcut for writing addInlineScript(['type' => 'module', 'content' => ...]).

public addInlineModule(string|array<string|int, mixed> $element[, int $priority = 0 ][, string $location = 'head' ]) : bool
Parameters
$element : string|array<string|int, mixed>
$priority : int = 0
$location : string = 'head'
Return values
bool

addInlineScript()

public addInlineScript(string|array<string|int, mixed> $element[, int $priority = 0 ][, string $location = 'head' ]) : bool
Parameters
$element : string|array<string|int, mixed>
$priority : int = 0
$location : string = 'head'
Return values
bool

addInlineStyle()

public addInlineStyle(string|array<string|int, mixed> $element[, int $priority = 0 ][, string $location = 'head' ]) : bool
Parameters
$element : string|array<string|int, mixed>
$priority : int = 0
$location : string = 'head'
Return values
bool
public addLink(array<string|int, mixed> $element[, int $priority = 0 ][, string $location = 'head' ]) : bool
Parameters
$element : array<string|int, mixed>
$priority : int = 0
$location : string = 'head'
Return values
bool

addModule()

Shortcut for writing addScript(['type' => 'module', 'src' => ...]).

public addModule(string|array<string|int, mixed> $element[, int $priority = 0 ][, string $location = 'head' ]) : bool
Parameters
$element : string|array<string|int, mixed>
$priority : int = 0
$location : string = 'head'
Return values
bool

addScript()

public addScript(string|array<string|int, mixed> $element[, int $priority = 0 ][, string $location = 'head' ]) : bool
Parameters
$element : string|array<string|int, mixed>
$priority : int = 0
$location : string = 'head'
Return values
bool

addStyle()

public addStyle(string|array<string|int, mixed> $element[, int $priority = 0 ][, string $location = 'head' ]) : bool
Parameters
$element : string|array<string|int, mixed>
$priority : int = 0
$location : string = 'head'
Tags
example

$block->addStyle('assets/js/my.js');

example

$block->addStyle(['href' => 'assets/js/my.js', 'media' => 'screen']);

Return values
bool

build()

public build(array<string|int, mixed> $serialized) : void
Parameters
$serialized : array<string|int, mixed>

create()

public static create([string|null $id = null ]) : static
Parameters
$id : string|null = null
Return values
static

getAssets()

public getAssets() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFrameworks()

public getFrameworks() : array<string|int, mixed>
Return values
array<string|int, mixed>

getHtml()

public getHtml([string $location = 'bottom' ]) : array<string|int, mixed>
Parameters
$location : string = 'bottom'
Return values
array<string|int, mixed>
public getLinks([string $location = 'head' ]) : array<string|int, mixed>
Parameters
$location : string = 'head'
Return values
array<string|int, mixed>

getScripts()

public getScripts([string $location = 'head' ]) : array<string|int, mixed>
Parameters
$location : string = 'head'
Return values
array<string|int, mixed>

getStyles()

public getStyles([string $location = 'head' ]) : array<string|int, mixed>
Parameters
$location : string = 'head'
Return values
array<string|int, mixed>

setChecksum()

public setChecksum(string $checksum) : $this
Parameters
$checksum : string
Return values
$this

setContent()

public setContent(string $content) : $this
Parameters
$content : string
Return values
$this

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

        
On this page

Search results