ScenarioOptionBuilder extends BaseBuilder
Table of Contents
Properties
- $agreements : mixed
Methods
- __construct() : mixed
- addAgreements() : $this
- Add agreements to the prepared object.
- addCallbackMode() : $this
- Use callback mode.
- addCaptcha() : $this
- Add captcha to the prepared object.
- addDealCategory() : $this
- Deal category.
- addDealDuplicateMode() : $this
- Deal Duplicate mode
- addDependency() : ScenarioOptionBuilder
- addDocumentScheme() : $this
- Document scheme version.
- addDuplicateMode() : $this
- Duplicate mode.
- addField() : $this
- Add field to be displayed on the web from page.
- addFields() : $this
- Multiple adding fields to be displayed on the web form page.
- addPresetField() : $this
- Adding preset fields.
- addPresetSupport() : $this
- addRecaptcha() : $this
- Add recaptcha to the prepared object.
- addResponsibleCheckWorkTimeMode() : $this
- Responsible check work time.
- addResponsibleUsers() : $this
- Responsible users
- addResult() : $this
- This block determining web form behaviour after it will be sent.
- prepare() : array<string|int, mixed>
- Preparing web form options to built final scenario
- setButtonCaption() : $this
- Add sending button caption
- usePayment() : $this
Properties
$agreements
public
static mixed
$agreements
Methods
__construct()
public
__construct() : mixed
addAgreements()
Add agreements to the prepared object.
public
addAgreements([bool $use = false ]) : $this
Parameters
- $use : bool = false
Return values
$thisaddCallbackMode()
Use callback mode.
public
addCallbackMode(bool $use) : $this
Parameters
- $use : bool
Return values
$thisaddCaptcha()
Add captcha to the prepared object.
public
addCaptcha([bool $use = false ]) : $this
Parameters
- $use : bool = false
Return values
$thisaddDealCategory()
Deal category.
public
addDealCategory(int $category) : $this
Parameters
- $category : int
Return values
$thisaddDealDuplicateMode()
Deal Duplicate mode
public
addDealDuplicateMode(bool $mode) : $this
Parameters
- $mode : bool
Return values
$thisaddDependency()
public
addDependency(DependencyItem $dependencyItem) : ScenarioOptionBuilder
Parameters
- $dependencyItem : DependencyItem
Return values
ScenarioOptionBuilderaddDocumentScheme()
Document scheme version.
public
addDocumentScheme(int $schemeVersion) : $this
Parameters
- $schemeVersion : int
Return values
$thisaddDuplicateMode()
Duplicate mode.
public
addDuplicateMode(string $mode) : $this
Parameters
- $mode : string
Return values
$thisaddField()
Add field to be displayed on the web from page.
public
addField(array<string|int, mixed> $field) : $this
Parameters
- $field : array<string|int, mixed>
Return values
$thisaddFields()
Multiple adding fields to be displayed on the web form page.
public
addFields([array<string|int, mixed> $fields = [] ]) : $this
Parameters
- $fields : array<string|int, mixed> = []
Return values
$thisaddPresetField()
Adding preset fields.
public
addPresetField(array<string|int, mixed> $field) : $this
Parameters
- $field : array<string|int, mixed>
Return values
$thisaddPresetSupport()
public
addPresetSupport() : $this
Return values
$thisaddRecaptcha()
Add recaptcha to the prepared object.
public
addRecaptcha([bool $use = false ]) : $this
Parameters
- $use : bool = false
Return values
$thisaddResponsibleCheckWorkTimeMode()
Responsible check work time.
public
addResponsibleCheckWorkTimeMode(bool $mode) : $this
Parameters
- $mode : bool
Return values
$thisaddResponsibleUsers()
Responsible users
public
addResponsibleUsers(array<string|int, mixed> $userIds) : $this
Parameters
- $userIds : array<string|int, mixed>
Return values
$thisaddResult()
This block determining web form behaviour after it will be sent.
public
addResult(string|null $successCaption, string|null $failureCaption[, bool $refill = false ]) : $this
Parameters
- $successCaption : string|null
- $failureCaption : string|null
- $refill : bool = false
Return values
$thisprepare()
Preparing web form options to built final scenario
public
prepare(array<string|int, mixed> &$options) : array<string|int, mixed>
Parameters
- $options : array<string|int, mixed>
Return values
array<string|int, mixed>setButtonCaption()
Add sending button caption
public
setButtonCaption(string|null $caption) : $this
Parameters
- $caption : string|null
Return values
$thisusePayment()
public
usePayment([bool $use = false ]) : $this
Parameters
- $use : bool = false