ImporterStep
in package
Step of the import process.
Table of Contents
- $active : bool
- $key : string
- $label : string
- $subSteps : array<string|int, mixed>
- $value : array<string|int, mixed>
- __construct() : mixed
- Constructor.
- addSubStep() : void
- Adds a sub-step.
- getKey() : string
- Returns the key.
- getLabel() : string
- Returns the label.
- getSubSteps() : array<string|int, ImporterStep>
- Returns the sub-steps.
- getValue() : array<string|int, mixed>
- Returns the value.
- isActive() : bool
- Returns if this step should be executed.
- setActive() : void
- Sets if this step should be executed.
Properties
$active
private
bool
$active
= false
$key
private
string
$key
$label
private
string
$label
$subSteps
private
array<string|int, mixed>
$subSteps
= []
substeps
$value
private
array<string|int, mixed>
$value
value
Methods
__construct()
Constructor.
public
__construct(string $label, string $key, array<string|int, mixed> $value) : mixed
Parameters
- $label : string
-
label
- $key : string
-
key
- $value : array<string|int, mixed>
-
value
Return values
mixed —addSubStep()
Adds a sub-step.
public
addSubStep(ImporterStep $subStep) : void
Parameters
- $subStep : ImporterStep
-
sub-step
Return values
void —getKey()
Returns the key.
public
getKey() : string
Return values
string —key
getLabel()
Returns the label.
public
getLabel() : string
Return values
string —label
getSubSteps()
Returns the sub-steps.
public
getSubSteps() : array<string|int, ImporterStep>
Return values
array<string|int, ImporterStep> —sub-steps
getValue()
Returns the value.
public
getValue() : array<string|int, mixed>
Return values
array<string|int, mixed> —value
isActive()
Returns if this step should be executed.
public
isActive() : bool
Return values
bool —active
setActive()
Sets if this step should be executed.
public
setActive(bool $active) : void
Parameters
- $active : bool
-
active