OutlineNode
in package
implements
ScenarioInterface
Represents Gherkin Outline.
Tags
Table of Contents
Interfaces
- ScenarioInterface
- Gherkin scenario interface.
Properties
- $examples : null|array<string|int, ExampleNode>
- $keyword : string
- $line : int
- $steps : array<string|int, StepNode>
- $tables : ExampleTableNode|array<string|int, ExampleTableNode>
- $tags : array<string|int, string>
- $title : string
Methods
- __construct() : mixed
- Initializes outline.
- getExamples() : array<string|int, ExampleNode>
- Returns list of examples for the outline.
- getExampleTable() : ExampleTableNode
- Builds and returns examples table for the outline.
- getExampleTables() : array<string|int, ExampleTableNode>
- Returns examples tables array for the outline.
- getKeyword() : string
- Returns outline keyword.
- getLine() : int
- Returns outline declaration line number.
- getNodeType() : string
- Returns node type string
- getSteps() : array<string|int, StepNode>
- Returns outline steps.
- getTags() : array<string|int, string>
- Returns outline tags (including inherited from feature).
- getTitle() : null|string
- Returns outline title.
- hasExamples() : bool
- Checks if outline has examples.
- hasSteps() : bool
- Checks if outline has steps.
- hasTag() : bool
- Checks if outline is tagged with tag.
- hasTags() : bool
- Checks if outline has tags (both inherited from feature and own).
- createExamples() : array<string|int, ExampleNode>
- Creates examples for this outline using examples table.
Properties
$examples
private
null|array<string|int, ExampleNode>
$examples
$keyword
private
string
$keyword
$line
private
int
$line
$steps
private
array<string|int, StepNode>
$steps
$tables
private
ExampleTableNode|array<string|int, ExampleTableNode>
$tables
$tags
private
array<string|int, string>
$tags
$title
private
string
$title
Methods
__construct()
Initializes outline.
public
__construct(null|string $title, array<string|int, string> $tags, array<string|int, StepNode> $steps, ExampleTableNode|array<string|int, ExampleTableNode> $tables, string $keyword, int $line) : mixed
Parameters
- $title : null|string
- $tags : array<string|int, string>
- $steps : array<string|int, StepNode>
- $tables : ExampleTableNode|array<string|int, ExampleTableNode>
- $keyword : string
- $line : int
getExamples()
Returns list of examples for the outline.
public
getExamples() : array<string|int, ExampleNode>
Return values
array<string|int, ExampleNode>getExampleTable()
Builds and returns examples table for the outline.
public
getExampleTable() : ExampleTableNode
WARNING: it returns a merged table with tags lost.
Tags
Return values
ExampleTableNodegetExampleTables()
Returns examples tables array for the outline.
public
getExampleTables() : array<string|int, ExampleTableNode>
Return values
array<string|int, ExampleTableNode>getKeyword()
Returns outline keyword.
public
getKeyword() : string
Return values
stringgetLine()
Returns outline declaration line number.
public
getLine() : int
Return values
intgetNodeType()
Returns node type string
public
getNodeType() : string
Return values
stringgetSteps()
Returns outline steps.
public
getSteps() : array<string|int, StepNode>
Return values
array<string|int, StepNode>getTags()
Returns outline tags (including inherited from feature).
public
getTags() : array<string|int, string>
Return values
array<string|int, string>getTitle()
Returns outline title.
public
getTitle() : null|string
Return values
null|stringhasExamples()
Checks if outline has examples.
public
hasExamples() : bool
Return values
boolhasSteps()
Checks if outline has steps.
public
hasSteps() : bool
Return values
boolhasTag()
Checks if outline is tagged with tag.
public
hasTag(string $tag) : bool
Parameters
- $tag : string
Return values
boolhasTags()
Checks if outline has tags (both inherited from feature and own).
public
hasTags() : bool
Return values
boolcreateExamples()
Creates examples for this outline using examples table.
protected
createExamples() : array<string|int, ExampleNode>