Contentserv PHP API

CSActiveScriptStep
in package

API Object that encapsulates the most atomic scripting step that must be executed in a unit

Tags
since

CS15.0

access

public

Table of Contents

__construct()  : mixed
The Constructor
getData()  : string|array<string|int, mixed>
Returns data that was stored with this step
getID()  : string
Returns the ID of the Step
getPreviousStep()  : CSActiveScriptStep
Returns the next step if available
getStepPosition()  : int
Tells the position of the step within its list
getValue()  : string
Returns a data value
isFirstStep()  : bool
Tells if the step is the first within its list
isLastStep()  : bool
Tells if the step is the last within its list

Methods

__construct()

The Constructor

public __construct(mixed $sStepID, array<string|int, string> $aData, CSActiveScriptStepList $oStepList) : mixed
Parameters
$sStepID : mixed
$aData : array<string|int, string>

any data that should be available with this step

$oStepList : CSActiveScriptStepList

the step list that contains this step

Tags
Return values
mixed —

getData()

Returns data that was stored with this step

public getData() : string|array<string|int, mixed>
Tags
Return values
string|array<string|int, mixed> —

the data for this step

getID()

Returns the ID of the Step

public getID() : string
Tags
Return values
string —

the ID

getStepPosition()

Tells the position of the step within its list

public getStepPosition() : int
Tags
Return values
int —

the Step Position within the list, starting from 0 to sizeof(steps) -1

getValue()

Returns a data value

public getValue(string $name) : string
Parameters
$name : string

the name that is the key in the data array

Tags
Return values
string —

the value

isFirstStep()

Tells if the step is the first within its list

public isFirstStep() : bool
Tags
Return values
bool —

true if the step is the first step for this job

isLastStep()

Tells if the step is the last within its list

public isLastStep() : bool
Tags
Return values
bool —

true if the step is the last step for this job


        

        
    




    

    

                

    

        

            
Search results