ValidForm Builder API Documentation

ValidWizard extends ValidForm
in package

ValidWizard class - Create multiple pages with formfields and next - previous buttons

Note: Make sure you also include validwizard.js when using ValidWizard. This javascript library is not required when you're not using ValidWizard.

Example; Create a ValidWizard instance

// The signature is exactly the same as with ValidForm
$objForm = new ValidWizard(
    "awesome-wizard",
    "Please fill out my cool wizard",
    "/stuff",
    array(
        // When no 'nextLabel' meta is set, defaults to 'Next →'
        "nextLabel" => "Move on →",
        // When no 'previousLabel' meta is set, defaults to '← Previous'
        "previousLabel" => "Retreat!"
    )
);

Example 2; Add a page

$objForm->addPage(
    "personal-details",
    "Personal Details"
);
Tags
author

Felix Langfeldt [email protected]

author

Robin van Baalen [email protected]

version
5.3.0

Table of Contents

Methods

getAction()  : string
getCurrentPage()  : int
getDefaults()  : array<string|int, mixed>
getDescription()  : string
getDisplayErrors()  : bool
getElements()  : Collection
getJsEvents()  : array<string|int, mixed>
getMainAlert()  : string
getMeta()  : array<string|int, mixed>
getName()  : string
getNextLabel()  : string
getNoValuesMessage()  : string
getPageCount()  : int
getPreviousLabel()  : string
getRequiredStyle()  : string
getSubmitLabel()  : string
setAction()  : void
setCachedFields()  : void
setDescription()  : void
setDisplayErrors()  : void
setElements()  : void
setJsEvents()  : void
setMainAlert()  : void
setMeta()  : void
setName()  : void
setNextLabel()  : void
setNoValuesMessage()  : void
setPreviousLabel()  : void
setRequiredStyle()  : void
setSubmitLabel()  : void
setUniqueId()  : void
setUseCsrfProtection()  : void

Methods

getAction()

public getAction() : string

getAction() Returns the value of $__action

Return values
string

getCurrentPage()

public getCurrentPage() : int

getCurrentPage() Returns the current page counter

Return values
int

getDefaults()

public getDefaults() : array<string|int, mixed>

getDefaults() Returns the value of $__defaults

Return values
array<string|int, mixed>

getDescription()

public getDescription() : string

getDescription() Returns the value of $__description

Return values
string

getDisplayErrors()

public getDisplayErrors() : bool

getDisplayErrors() Returns the value of $__displayerrors

Return values
bool

getJsEvents()

public getJsEvents() : array<string|int, mixed>

getJsEvents() Returns the value of $__jsevents

Return values
array<string|int, mixed>

getMainAlert()

public getMainAlert() : string

getMainAlert() Returns the main alertof this ValidForm instance

Return values
string

getMeta()

public getMeta() : array<string|int, mixed>

getMeta() Returns the value of $__meta

Return values
array<string|int, mixed>

getName()

public getName() : string

getName() Returns the name of this ValidForm instance

Return values
string

getNextLabel()

public getNextLabel() : string

getNextLabel() Returns the label of the next button

Return values
string

getNoValuesMessage()

public getNoValuesMessage() : string

getNoValuesMessage() Returns the value of $__novaluesmessage

Return values
string

getPageCount()

public getPageCount() : int

getPageCount() Returns the number of pages in the wizard

Return values
int

getPreviousLabel()

public getPreviousLabel() : string

getPreviousLabel() Returns the label of the previous button

Return values
string

getRequiredStyle()

public getRequiredStyle() : string

getRequiredStyle() Returns the value of $__requiredstyle

Return values
string

getSubmitLabel()

public getSubmitLabel() : string

getSubmitLabel() Returns the value of $__submitlabel

Return values
string

setAction()

public setAction() : void

setAction(string $strFormAction) Overwrites the value of $__action

setCachedFields()

public setCachedFields() : void

setCachedFields(Collection $objCollection) Overwrites the value of $__cachedfields. Not recommended for API use*

setDescription()

public setDescription() : void

setDescription(string $strDescription) Overwrites the value of $__description

setDisplayErrors()

public setDisplayErrors() : void

setDisplayErrors(bool $arrJsEvents) Overwrites the value of $__displayerrors. Not recommended* use instead.

setElements()

public setElements() : void

setElements(Collection $objCollection) Overwrites the internal elements collection.

setJsEvents()

public setJsEvents() : void

setJsEvents(array $arrJsEvents) Overwrites the value of $__jsevents.

setMainAlert()

public setMainAlert() : void

setMainAlert(string $strMainAlert) Overwrites the main alert of this ValidForm instance

setMeta()

public setMeta() : void

setMeta(array $arrMeta) Overwrites the value of $__meta

setName()

public setName() : void

setName(string $strName) Overwrites the name of this ValidForm instance

setNextLabel()

public setNextLabel() : void

setNextLabel($strLabel) Sets the label of the next button

setNoValuesMessage()

public setNoValuesMessage() : void

setNoValuesMessage(string $strNoValuesMessage) Overwrites the value of $__novaluesmessage.

setPreviousLabel()

public setPreviousLabel() : void

setPreviousLabel($strLabel) Sets the label of the previous button

setRequiredStyle()

public setRequiredStyle() : void

setRequiredStyle(string $strRequiredStyle) Overwrites the value of $__requiredstyle.

setSubmitLabel()

public setSubmitLabel() : void

setSubmitLabel(string $strSubmitLabel) Overwrites the value of $__submitlabel

setUniqueId()

public setUniqueId() : void

setUniqueId(string $strUniqueId) Overwrites the value of $__uniqueid.

setUseCsrfProtection()

public setUseCsrfProtection() : void

setUseCsrfProtection(boolean $value) Overwrites the value of $__usecsrfprotection


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results