Bitrix API

Engine

Class Engine

Table of Contents

Constants

BLOCK_PLACE_ATTR  = 'data-bx-block-editor-place'
BLOCK_PLACE_ATTR_DEF_VALUE  = 'body'
CONTENT_JSON  = 1
CONTENT_SLICE  = 0
STYLIST_TAG_ATTR  = 'data-bx-stylist-container'

Methods

__construct()  : mixed
Engine constructor.
create()  : static
Create instance.
fill()  : bool
Fill document by content.
fillHtmlTemplate()  : string
Fill HTML template by content.
getDocument()  : mixed
getHtml()  : mixed
isSupported()  : bool
Check string for the presence of slices.
setBlockContent()  : $this
Set block content.
setContent()  : Engine
Set content string.
setDocument()  : $this
Set document.
setEncoding()  : $this
Set encoding.
setHtml()  : $this
Set html.

Constants

BLOCK_PLACE_ATTR

public mixed BLOCK_PLACE_ATTR = 'data-bx-block-editor-place'

BLOCK_PLACE_ATTR_DEF_VALUE

public mixed BLOCK_PLACE_ATTR_DEF_VALUE = 'body'

CONTENT_JSON

public mixed CONTENT_JSON = 1

CONTENT_SLICE

public mixed CONTENT_SLICE = 0

STYLIST_TAG_ATTR

public mixed STYLIST_TAG_ATTR = 'data-bx-stylist-container'

Methods

__construct()

Engine constructor.

public __construct([Document|null $document = null ]) : mixed
Parameters
$document : Document|null = null

Template document.

create()

Create instance.

public static create([Document|null $document = null ]) : static
Parameters
$document : Document|null = null

Template document.

Return values
static

fill()

Fill document by content.

public fill() : bool
Return values
bool

fillHtmlTemplate()

Fill HTML template by content.

public static fillHtmlTemplate(string $htmlTemplate, string $content[, string $encoding = null ]) : string
Parameters
$htmlTemplate : string

Html template.

$content : string

Content.

$encoding : string = null

Encoding.

Return values
string

getDocument()

public getDocument() : mixed

getHtml()

public getHtml() : mixed

isSupported()

Check string for the presence of slices.

public static isSupported(string $string) : bool
Parameters
$string : string

String.

Return values
bool

setBlockContent()

Set block content.

public setBlockContent(BlockContent $blockContent) : $this
Parameters
$blockContent : BlockContent

Block content.

Return values
$this

setContent()

Set content string.

public setContent(string $string) : Engine
Parameters
$string : string

Content string.

Return values
Engine

setDocument()

Set document.

public setDocument(Document $document) : $this
Parameters
$document : Document

Template document.

Return values
$this

setEncoding()

Set encoding.

public setEncoding([string|null $encoding = null ]) : $this
Parameters
$encoding : string|null = null

Encoding.

Return values
$this

setHtml()

Set html.

public setHtml(string $html) : $this
Parameters
$html : string

Html.

Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results