[Live Now] Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Join for FREE! 
How to use transformBackgroundNode method of GherkinDocumentBuilder class
Best Gherkin-php code snippet using GherkinDocumentBuilder.transformBackgroundNode
GherkinDocumentBuilder.php
Source:GherkinDocumentBuilder.php 
...89 RuleType::ScenarioDefinition => $this->transformScenarioDefinitionNode($node),90 RuleType::ExamplesDefinition => $this->transformExamplesDefinitionNode($node),91 RuleType::ExamplesTable => $this->transformExamplesTableNode($node),92 RuleType::DataTable => $this->transformDataTableNode($node),93 Ruletype::Background => $this->transformBackgroundNode($node),94 RuleType::Description => $this->transformDescriptionNode($node),95 RuleType::Feature => $this->transformFeatureNode($node),96 RuleType::Rule => $this->transformRuleNode($node),97 RuleType::GherkinDocument => $this->transformGherkinDocumentNode($node),98 default => $node,99 };100 }101 private function getLocation(TokenMatch $token, int $column): MessageLocation102 {103 $column = ($column === 0) ? $token->location->column : $column;104 return new MessageLocation($token->location->line, $column);105 }106 private function getDescription(AstNode $node): string107 {108 return (string) $node->getSingleUntyped(RuleType::Description, "");109 }110 /** @return list<Step> */111 private function getSteps(AstNode $node): array112 {113 return $node->getitems(Step::class, RuleType::Step);114 }115 /** @return list<TableRow> */116 private function getTableRows(AstNode $node): array117 {118 $rows = array_map(119 fn ($token) => new TableRow($this->getLocation($token, 0), $this->getCells($token), $this->idGenerator->newId()),120 $node->getTokenMatches(TokenType::TableRow),121 );122 $this->ensureCellCount($rows);123 return $rows;124 }125 /** @param list<TableRow> $rows */126 private function ensureCellCount(array $rows): void127 {128 if (!count($rows)) {129 return;130 }131 $cellCount = count($rows[0]->cells);132 foreach ($rows as $row) {133 if (count($row->cells) !== $cellCount) {134 $location = new Location($row->location->line, $row->location->column ?? 0);135 throw new AstBuilderException('inconsistent cell count within the table', $location);136 }137 }138 }139 /**140 * @return list<TableCell>141 */142 private function getCells(TokenMatch $token): array143 {144 return array_map(145 fn ($cellItem) => new TableCell($this->getLocation($token, $cellItem->column), $cellItem->text),146 $token->items,147 );148 }149 /**150 * @return list<Tag>151 */152 private function getTags(AstNode $node): array153 {154 $tagsNode = $node->getSingle(AstNode::class, RuleType::Tags, new AstNode(RuleType::None));155 $tokens = $tagsNode->getTokenMatches(TokenType::TagLine);156 $tags = [];157 foreach ($tokens as $token) {158 foreach ($token->items as $tagItem) {159 $tags[] = new Tag(160 location: $this->getLocation($token, $tagItem->column),161 name: $tagItem->text,162 id: $this->idGenerator->newId(),163 );164 }165 }166 return $tags;167 }168 /**169 * @param array<TokenMatch> $lineTokens170 */171 private function joinMatchedTextWithLinebreaks(array $lineTokens): string172 {173 return join("\n", array_map(fn ($t) => $t->text, $lineTokens));174 }175 private function transformStepNode(AstNode $node): Step176 {177 $stepLine = $node->getTokenMatch(TokenType::StepLine);178 return new Step(179 location: $this->getLocation($stepLine, 0),180 keyword: $stepLine->keyword,181 text: $stepLine->text,182 docString: $node->getSingle(DocString::class, RuleType::DocString),183 dataTable: $node->getSingle(DataTable::class, RuleType::DataTable),184 id: $this->idGenerator->newId(),185 );186 }187 private function transformDocStringNode(AstNode $node): DocString188 {189 $separatorToken = $node->getTokenMatches(TokenType::DocStringSeparator)[0];190 $mediaType = $separatorToken->text;191 $lineTokens = $node->getTokenMatches(TokenType::Other);192 $content = $this->joinMatchedTextWithLinebreaks($lineTokens);193 return new DocString(194 location: $this->getLocation($separatorToken, 0),195 mediaType: $mediaType ?: null, // special case turns '' into null196 content: $content,197 delimiter: $separatorToken->keyword,198 );199 }200 private function transformScenarioDefinitionNode(AstNode $node): ?Scenario201 {202 $scenarioNode = $node->getSingle(AstNode::class, RuleType::Scenario);203 if (null === $scenarioNode) {204 return null;205 }206 $scenarioLine = $scenarioNode->getTokenMatch(TokenType::ScenarioLine);207 return new Scenario(208 location: $this->getLocation($scenarioLine, 0),209 tags: $this->getTags($node),210 keyword: $scenarioLine->keyword,211 name: $scenarioLine->text,212 description: $this->getDescription($scenarioNode),213 steps: $this->getSteps($scenarioNode),214 examples: $scenarioNode->getItems(Examples::class, RuleType::ExamplesDefinition),215 id: $this->idGenerator->newId(),216 );217 }218 private function transformExamplesDefinitionNode(AstNode $node): ?Examples219 {220 $examplesNode = $node->getSingle(AstNode::class, RuleType::Examples);221 if (null === $examplesNode) {222 return null;223 }224 $examplesLine = $examplesNode->getTokenMatch(TokenType::ExamplesLine);225 /** @var list<TableRow>|null $rows */226 $rows = $examplesNode->getSingleUntyped(RuleType::ExamplesTable);227 $tableHeader = is_array($rows) && count($rows) ? $rows[0] : null;228 $tableBody = (is_array($rows) && count($rows) > 0) ? array_slice($rows, 1) : [];229 return new Examples(230 location: $this->getLocation($examplesLine, 0),231 tags: $this->getTags($node),232 keyword: $examplesLine->keyword,233 name: $examplesLine->text,234 description: $this->getDescription($examplesNode),235 tableHeader: $tableHeader,236 tableBody: $tableBody,237 id: $this->idGenerator->newId(),238 );239 }240 private function transformDataTableNode(AstNode $node): DataTable241 {242 $rows = $this->getTableRows($node);243 return new DataTable($rows[0]->location, $rows);244 }245 /** @return list<TableRow> */246 private function transformExamplesTableNode(AstNode $node): array247 {248 return $this->getTableRows($node);249 }250 private function transformBackgroundNode(AstNode $node): Background251 {252 $backgroundLine = $node->getTokenMatch(TokenType::BackgroundLine);253 return new Background(254 location: $this->getLocation($backgroundLine, 0),255 keyword: $backgroundLine->keyword,256 name: $backgroundLine->text,257 description: $this->getDescription($node),258 steps: $this->getSteps($node),259 id: $this->idGenerator->newId(),260 );261 }262 private function transformDescriptionNode(AstNode $node): string263 {264 $lineTokens = $node->getTokenMatches(TokenType::Other);...
transformBackgroundNode
Using AI Code Generation
1$gherkinDocument = GherkinDocumentBuilder::transformBackgroundNode($gherkinDocument);2$gherkinDocument = GherkinDocumentBuilder::transformScenarioNode($gherkinDocument);3$gherkinDocument = GherkinDocumentBuilder::transformScenarioOutlineNode($gherkinDocument);4$gherkinDocument = GherkinDocumentBuilder::transformExamplesNode($gherkinDocument);5$gherkinDocument = GherkinDocumentBuilder::transformStepNode($gherkinDocument);6$gherkinDocument = GherkinDocumentBuilder::transformDataTable($gherkinDocument);7$gherkinDocument = GherkinDocumentBuilder::transformDocString($gherkinDocument);8$gherkinDocument = GherkinDocumentBuilder::transformTags($gherkinDocument);9$gherkinDocument = GherkinDocumentBuilder::transformLocation($gherkinDocument);10$gherkinDocument = GherkinDocumentBuilder::transformComments($gherkinDocument);11$gherkinDocument = GherkinDocumentBuilder::transformComments($gherkinDocument);12$gherkinDocument = GherkinDocumentBuilder::transformTableRow($gherkinDocument);13$gherkinDocument = GherkinDocumentBuilder::transformTableHeader($gherkinDocument);14$gherkinDocument = GherkinDocumentBuilder::transformTableBody($gherkinDocument);
transformBackgroundNode
Using AI Code Generation
1$gherkinDocumentBuilder = new GherkinDocumentBuilder();2$gherkinDocument = $gherkinDocumentBuilder->build($gherkinSource);3$gherkinDocumentBuilder->transformBackgroundNode($gherkinDocument->getFeature()->getBackground());4$gherkinDocumentBuilder = new GherkinDocumentBuilder();5$gherkinDocument = $gherkinDocumentBuilder->build($gherkinSource);6$gherkinDocumentBuilder->transformBackgroundNode($gherkinDocument->getFeature()->getBackground());7$gherkinDocumentBuilder = new GherkinDocumentBuilder();8$gherkinDocument = $gherkinDocumentBuilder->build($gherkinSource);9$gherkinDocumentBuilder->transformBackgroundNode($gherkinDocument->getFeature()->getBackground());10$gherkinDocumentBuilder = new GherkinDocumentBuilder();11$gherkinDocument = $gherkinDocumentBuilder->build($gherkinSource);12$gherkinDocumentBuilder->transformBackgroundNode($gherkinDocument->getFeature()->getBackground());13$gherkinDocumentBuilder = new GherkinDocumentBuilder();14$gherkinDocument = $gherkinDocumentBuilder->build($gherkinSource);15$gherkinDocumentBuilder->transformBackgroundNode($gherkinDocument->getFeature()->getBackground());16$gherkinDocumentBuilder = new GherkinDocumentBuilder();17$gherkinDocument = $gherkinDocumentBuilder->build($gherkinSource);18$gherkinDocumentBuilder->transformBackgroundNode($gherkinDocument->getFeature()->getBackground());19$gherkinDocumentBuilder = new GherkinDocumentBuilder();
transformBackgroundNode
Using AI Code Generation
1$gherkinDocumentBuilder = new GherkinDocumentBuilder();2$gherkinDocumentBuilder->transformBackgroundNode($backgroundNode);3$gherkinDocumentBuilder = new GherkinDocumentBuilder();4$gherkinDocumentBuilder->transformScenarioNode($scenarioNode);5$gherkinDocumentBuilder = new GherkinDocumentBuilder();6$gherkinDocumentBuilder->transformScenarioOutlineNode($scenarioOutlineNode);7$gherkinDocumentBuilder = new GherkinDocumentBuilder();8$gherkinDocumentBuilder->transformExamplesNode($examplesNode);9$gherkinDocumentBuilder = new GherkinDocumentBuilder();10$gherkinDocumentBuilder->transformStepNode($stepNode);11$gherkinDocumentBuilder = new GherkinDocumentBuilder();12$gherkinDocumentBuilder->transformDocStringNode($docStringNode);13$gherkinDocumentBuilder = new GherkinDocumentBuilder();14$gherkinDocumentBuilder->transformDataTableNode($dataTableNode);15$gherkinDocumentBuilder = new GherkinDocumentBuilder();16$gherkinDocumentBuilder->transformCommentNode($commentNode);17$gherkinDocumentBuilder = new GherkinDocumentBuilder();18$gherkinDocumentBuilder->transformTagNode($tagNode);19$gherkinDocumentBuilder = new GherkinDocumentBuilder();20$gherkinDocumentBuilder->transformLocation($location);
transformBackgroundNode
Using AI Code Generation
1require_once 'GherkinDocumentBuilder.php';2$document = GherkinDocumentBuilder::transformBackgroundNode($document);3require_once 'GherkinDocumentBuilder.php';4$document = GherkinDocumentBuilder::transformScenarioNode($document);5require_once 'GherkinDocumentBuilder.php';6$document = GherkinDocumentBuilder::transformScenarioOutlineNode($document);7require_once 'GherkinDocumentBuilder.php';8$document = GherkinDocumentBuilder::transformExamplesNode($document);9require_once 'GherkinDocumentBuilder.php';10$document = GherkinDocumentBuilder::transformStepNode($document);11require_once 'GherkinDocumentBuilder.php';12$document = GherkinDocumentBuilder::transformStepArgument($document);13require_once 'GherkinDocumentBuilder.php';14$document = GherkinDocumentBuilder::transformDataTable($document);15require_once 'GherkinDocumentBuilder.php';16$document = GherkinDocumentBuilder::transformTableRow($document);17require_once 'GherkinDocumentBuilder.php';18$document = GherkinDocumentBuilder::transformTableCell($document);19require_once 'GherkinDocumentBuilder.php';20$document = GherkinDocumentBuilder::transformDocString($document);21require_once 'GherkinDocumentBuilder.php';22$document = GherkinDocumentBuilder::transformTags($document);23require_once 'GherkinDocumentBuilder.php';24$document = GherkinDocumentBuilder::transformComments($document);25require_once 'GherkinDocumentBuilder.php';
transformBackgroundNode
Using AI Code Generation
1$builder = new GherkinDocumentBuilder();2$builder->transformBackgroundNode($backgroundNode);3$builder = new GherkinDocumentBuilder();4$builder->transformBackgroundNode($backgroundNode);5$builder = new GherkinDocumentBuilder();6$builder->transformBackgroundNode($backgroundNode);7$builder = new GherkinDocumentBuilder();8$builder->transformBackgroundNode($backgroundNode);9$builder = new GherkinDocumentBuilder();10$builder->transformBackgroundNode($backgroundNode);11$builder = new GherkinDocumentBuilder();12$builder->transformBackgroundNode($backgroundNode);13$builder = new GherkinDocumentBuilder();14$builder->transformBackgroundNode($backgroundNode);15$builder = new GherkinDocumentBuilder();16$builder->transformBackgroundNode($backgroundNode);17$builder = new GherkinDocumentBuilder();18$builder->transformBackgroundNode($backgroundNode);19$builder = new GherkinDocumentBuilder();20$builder->transformBackgroundNode($backgroundNode);
transformBackgroundNode
Using AI Code Generation
1$builder = new GherkinDocumentBuilder();2$gherkinDocument = $builder->build($feature);3$gherkinDocument->getFeature()->getBackground()->getSteps()[0]->transformBackgroundNode("Given");4$builder = new GherkinDocumentBuilder();5$gherkinDocument = $builder->build($feature);6$gherkinDocument->getFeature()->getBackground()->getSteps()[0]->transformBackgroundNode("When");7$builder = new GherkinDocumentBuilder();8$gherkinDocument = $builder->build($feature);9$gherkinDocument->getFeature()->getBackground()->getSteps()[0]->transformBackgroundNode("Then");10$builder = new GherkinDocumentBuilder();11$gherkinDocument = $builder->build($feature);12$gherkinDocument->getFeature()->getBackground()->getSteps()[0]->transformBackgroundNode("And");13$builder = new GherkinDocumentBuilder();14$gherkinDocument = $builder->build($feature);15$gherkinDocument->getFeature()->getBackground()->getSteps()[0]->transformBackgroundNode("But");16$builder = new GherkinDocumentBuilder();17$gherkinDocument = $builder->build($feature);18$gherkinDocument->getFeature()->getBackground()->getSteps()[0]->transformBackgroundNode("But");19$builder = new GherkinDocumentBuilder();20$gherkinDocument = $builder->build($feature);21$gherkinDocument->getFeature()->getBackground()->getSteps()[0]->transformBackgroundNode("But");22$builder = new GherkinDocumentBuilder();
transformBackgroundNode
Using AI Code Generation
1$documentBuilder = new GherkinDocumentBuilder();2$background = $documentBuilder->transformBackgroundNode($backgroundNode);3$documentBuilder = new GherkinDocumentBuilder();4$background = $documentBuilder->transformBackground($backgroundNode);5$documentBuilder = new GherkinDocumentBuilder();6$background = $documentBuilder->transformBackgroundNode($backgroundNode);7$documentBuilder = new GherkinDocumentBuilder();8$background = $documentBuilder->transformBackground($backgroundNode);9$documentBuilder = new GherkinDocumentBuilder();10$background = $documentBuilder->transformBackgroundNode($backgroundNode);11$documentBuilder = new GherkinDocumentBuilder();12$background = $documentBuilder->transformBackground($backgroundNode);13$documentBuilder = new GherkinDocumentBuilder();14$background = $documentBuilder->transformBackgroundNode($backgroundNode);15$documentBuilder = new GherkinDocumentBuilder();16$background = $documentBuilder->transformBackground($backgroundNode);17$documentBuilder = new GherkinDocumentBuilder();18$background = $documentBuilder->transformBackgroundNode($backgroundNode);
transformBackgroundNode
Using AI Code Generation
1$builder = new GherkinDocumentBuilder();2$builder->transformBackgroundNode($backgroundNode);3BackgroundNode{4 location: Location{5 },6 StepNode{7 location: Location{8 }9 }10}11BackgroundNode{12 location: Location{13 },14 StepNode{15 location: Location{16 }17 }18}19BackgroundNode{20 location: Location{21 },22 StepNode{23 location: Location{24 }25 }26}27BackgroundNode{28 location: Location{29 },30 StepNode{31 location: Location{32 }33 }34}35BackgroundNode{36 location: Location{37 },
transformBackgroundNode
Using AI Code Generation
1$builder = new GherkinDocumentBuilder();2$builder->transformBackgroundNode($backgroundNode);3$builder = new GherkinDocumentBuilder();4$builder->transformScenarioNode($scenarioNode);5$builder = new GherkinDocumentBuilder();6$builder->transformStepNode($stepNode);7$builder = new GherkinDocumentBuilder();8$builder->transformExamplesNode($examplesNode);9$builder = new GherkinDocumentBuilder();10$builder->transformExampleNode($exampleNode);11$builder = new GherkinDocumentBuilder();12$builder->transformTags($tags);13$builder = new GherkinDocumentBuilder();14$builder->transformTag($tag);15$builder = new GherkinDocumentBuilder();16$builder->transformLocation($location);17$builder = new GherkinDocumentBuilder();18$builder->transformDataTable($dataTable);
Automation Testing Tutorials
Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.
LambdaTest Learning Hubs:
- JUnit Tutorial
- TestNG Tutorial
- Webdriver Tutorial
- WebDriverIO Tutorial
- Protractor Tutorial
- Selenium 4 Tutorial
- Jenkins Tutorial
- NUnit Tutorial
- Jest Tutorial
- Playwright Tutorial
- Cypress Tutorial
- PyTest Tutorial
YouTube
You could also refer to video tutorials over LambdaTest YouTube channel to get step by step demonstration from industry experts.
Run Gherkin-php automation tests on LambdaTest cloud grid
Perform automation testing on 3000+ real desktop and mobile devices online.
Most used method in GherkinDocumentBuilder
- build
- startRule
- endRule
- getResult
- reset
- currentNode
- getTransformedNode
- getLocation
- getDescription
- getSteps
- getTableRows
- ensureCellCount
- getCells
- getTags
- joinMatchedTextWithLinebreaks
- transformStepNode
- transformDocStringNode
- transformScenarioDefinitionNode
- transformExamplesDefinitionNode
- transformDataTableNode
- transformExamplesTableNode
- transformBackgroundNode
- transformDescriptionNode
- transformFeatureNode
- transformRuleNode
- transformGherkinDocumentNode
Trigger transformBackgroundNode code on LambdaTest Cloud Grid
Execute automation tests with transformBackgroundNode on a cloud-based Grid of 3000+ real browsers and operating systems for both web and mobile applications.
Test now for FreeTry LambdaTest Now !!
Get 100 minutes of automation test minutes FREE!!
Was this article helpful?
