ModifyNewContentElementWizardItemsEvent

FinalYes

Listeners to this Event will be able to modify the wizard items of the new content element wizard component

Table of Contents

Methods

__construct()  : mixed
getColPos()  : int|null
Provides information about the column position of the button that triggered the wizard.
getPageInfo()  : array<string|int, mixed>
Provides information about the current page making use of the wizard.
getRequest()  : ServerRequestInterface
Provides the request in the state it was provided to the NewContentElementController::wizardAction() method.
getSysLanguage()  : int
Provides information about the language used while triggering the wizard.
getUidPid()  : int
Provides information about the element to position the new element after (uid) or into (pid).
getWizardItem()  : array<string|int, mixed>|null
getWizardItems()  : array<string|int, mixed>
hasWizardItem()  : bool
removeWizardItem()  : bool
setWizardItem()  : void
Add a new wizard item with configuration at a defined position.
setWizardItems()  : void

Methods

__construct()

public __construct(array<string|int, mixed> $wizardItems, array<string|int, mixed> $pageInfo, int|null $colPos, int $sys_language, int $uid_pid, ServerRequestInterface $request) : mixed
Parameters
$wizardItems : array<string|int, mixed>
$pageInfo : array<string|int, mixed>
$colPos : int|null
$sys_language : int
$uid_pid : int
$request : ServerRequestInterface

getColPos()

Provides information about the column position of the button that triggered the wizard.

public getColPos() : int|null
Return values
int|null

getPageInfo()

Provides information about the current page making use of the wizard.

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

getRequest()

Provides the request in the state it was provided to the NewContentElementController::wizardAction() method.

public getRequest() : ServerRequestInterface
Return values
ServerRequestInterface

getSysLanguage()

Provides information about the language used while triggering the wizard.

public getSysLanguage() : int
Return values
int

getUidPid()

Provides information about the element to position the new element after (uid) or into (pid).

public getUidPid() : int
Return values
int

getWizardItem()

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

getWizardItems()

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

hasWizardItem()

public hasWizardItem(string $identifier) : bool
Parameters
$identifier : string
Return values
bool

removeWizardItem()

public removeWizardItem(string $identifier) : bool
Parameters
$identifier : string
Return values
bool

setWizardItem()

Add a new wizard item with configuration at a defined position.

public setWizardItem(string $identifier, array<string|int, mixed> $configuration[, array<string|int, mixed> $position = [] ]) : void

Can also be used to relocate existing items and to modify their configuration.

Parameters
$identifier : string
$configuration : array<string|int, mixed>
$position : array<string|int, mixed> = []

setWizardItems()

public setWizardItems(array<string|int, mixed> $wizardItems) : void
Parameters
$wizardItems : array<string|int, mixed> 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results