Heratio Framework API Reference

LandingPageService
in package

Landing Page Service

Business logic for landing page builder

Table of Contents

Methods

__construct()  : mixed
addBlock()  : array<string|int, mixed>
Add block to page
createPage()  : array<string|int, mixed>
Create new page
deleteBlock()  : array<string|int, mixed>
Delete block
deletePage()  : array<string|int, mixed>
Delete page
duplicateBlock()  : array<string|int, mixed>
Duplicate block
getAllPages()  : Collection
Get all pages for listing
getBlockTypes()  : Collection
Get all block types for palette
getLandingPageForDisplay()  : array<string|int, mixed>|null
Get landing page for display
getPageForEditor()  : array<string|int, mixed>|null
Get page for editing
publish()  : array<string|int, mixed>
Publish page
reorderBlocks()  : array<string|int, mixed>
Reorder blocks
restoreVersion()  : array<string|int, mixed>
Restore version
saveDraft()  : array<string|int, mixed>
Save draft
toggleBlockVisibility()  : array<string|int, mixed>
Toggle block visibility
updateBlock()  : array<string|int, mixed>
Update block configuration
updatePage()  : array<string|int, mixed>
Update page

Methods

addBlock()

Add block to page

public addBlock(int $pageId, int $blockTypeId[, array<string|int, mixed>|null $config = null ][, int|null $userId = null ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$pageId : int
$blockTypeId : int
$config : array<string|int, mixed>|null = null
$userId : int|null = null
$options : array<string|int, mixed> = []
Return values
array<string|int, mixed>

createPage()

Create new page

public createPage(array<string|int, mixed> $data[, int|null $userId = null ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$userId : int|null = null
Return values
array<string|int, mixed>

deleteBlock()

Delete block

public deleteBlock(int $blockId[, int|null $userId = null ]) : array<string|int, mixed>
Parameters
$blockId : int
$userId : int|null = null
Return values
array<string|int, mixed>

deletePage()

Delete page

public deletePage(int $pageId[, int|null $userId = null ]) : array<string|int, mixed>
Parameters
$pageId : int
$userId : int|null = null
Return values
array<string|int, mixed>

duplicateBlock()

Duplicate block

public duplicateBlock(int $blockId[, int|null $userId = null ]) : array<string|int, mixed>
Parameters
$blockId : int
$userId : int|null = null
Return values
array<string|int, mixed>

getAllPages()

Get all pages for listing

public getAllPages([bool $activeOnly = false ]) : Collection
Parameters
$activeOnly : bool = false
Return values
Collection

getBlockTypes()

Get all block types for palette

public getBlockTypes() : Collection
Return values
Collection

getLandingPageForDisplay()

Get landing page for display

public getLandingPageForDisplay([string|null $slug = null ]) : array<string|int, mixed>|null
Parameters
$slug : string|null = null
Return values
array<string|int, mixed>|null

getPageForEditor()

Get page for editing

public getPageForEditor(int $pageId) : array<string|int, mixed>|null
Parameters
$pageId : int
Return values
array<string|int, mixed>|null

publish()

Publish page

public publish(int $pageId[, int|null $userId = null ]) : array<string|int, mixed>
Parameters
$pageId : int
$userId : int|null = null
Return values
array<string|int, mixed>

reorderBlocks()

Reorder blocks

public reorderBlocks(int $pageId, array<string|int, mixed> $blockOrder[, int|null $userId = null ]) : array<string|int, mixed>
Parameters
$pageId : int
$blockOrder : array<string|int, mixed>
$userId : int|null = null
Return values
array<string|int, mixed>

restoreVersion()

Restore version

public restoreVersion(int $versionId[, int|null $userId = null ]) : array<string|int, mixed>
Parameters
$versionId : int
$userId : int|null = null
Return values
array<string|int, mixed>

saveDraft()

Save draft

public saveDraft(int $pageId[, int|null $userId = null ][, string|null $notes = null ]) : array<string|int, mixed>
Parameters
$pageId : int
$userId : int|null = null
$notes : string|null = null
Return values
array<string|int, mixed>

toggleBlockVisibility()

Toggle block visibility

public toggleBlockVisibility(int $blockId[, int|null $userId = null ]) : array<string|int, mixed>
Parameters
$blockId : int
$userId : int|null = null
Return values
array<string|int, mixed>

updateBlock()

Update block configuration

public updateBlock(int $blockId, array<string|int, mixed> $data[, int|null $userId = null ]) : array<string|int, mixed>
Parameters
$blockId : int
$data : array<string|int, mixed>
$userId : int|null = null
Return values
array<string|int, mixed>

updatePage()

Update page

public updatePage(int $pageId, array<string|int, mixed> $data[, int|null $userId = null ]) : array<string|int, mixed>
Parameters
$pageId : int
$data : array<string|int, mixed>
$userId : int|null = null
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results