Join the 1-day Testing & QA Summit featuring 15+ Expert Speakers.Register for FREE! Join TestMu Conference

How to use getDescription method of GherkinDocumentBuilder class

Best Cucumber Common Library code snippet using GherkinDocumentBuilder.getDescription

GherkinDocumentBuilder.php

Source:GherkinDocumentBuilder.php

...102    {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);265        $lineText = preg_replace(266            '/(\\n\\s*)*$/u',267            '',268            $this->joinMatchedTextWithLinebreaks($lineTokens),269        );270        return $lineText;271    }272    private function transformFeatureNode(AstNode $node): ?Feature273    {274        $header = $node->getSingle(AstNode::class, RuleType::FeatureHeader, new AstNode(RuleType::FeatureHeader));275        if (!$header instanceof AstNode) {276            return null;277        }278        $tags = $this->getTags($header);279        $featureLine = $header->getTokenMatch(TokenType::FeatureLine);280        $children = [];281        $background = $node->getSingle(Background::class, RuleType::Background);282        if ($background instanceof Background) {283            $children[] = new FeatureChild(background: $background);284        }285        foreach ($node->getItems(Scenario::class, RuleType::ScenarioDefinition) as $scenario) {286            $children[] = new FeatureChild(scenario: $scenario);287        }288        foreach ($node->getItems(Rule::class, RuleType::Rule) as $rule) {289            $children[] = new FeatureChild($rule, null, null);290        }291        $language = $featureLine->gherkinDialect->getLanguage();292        return new Feature(293            location: $this->getLocation($featureLine, 0),294            tags: $tags,295            language: $language,296            keyword: $featureLine->keyword,297            name: $featureLine->text,298            description: $this->getDescription($header),299            children: $children,300        );301    }302    private function transformRuleNode(AstNode $node): Rule303    {304        $header = $node->getSingle(AstNode::class, RuleType::RuleHeader, new AstNode(RuleType::RuleHeader));305        $ruleLine = $header->getTokenMatch(TokenType::RuleLine);306        $children = [];307        $tags = $this->getTags($header);308        $background = $node->getSingle(Background::class, RuleType::Background);309        if ($background) {310            $children[] = new RuleChild(background: $background);311        }312        $scenarios = $node->getItems(Scenario::class, RuleType::ScenarioDefinition);313        foreach ($scenarios as $scenario) {314            $children[] = new RuleChild(scenario: $scenario);315        }316        return new Rule(317            location: $this->getLocation($ruleLine, 0),318            tags: $tags,319            keyword: $ruleLine->keyword,320            name: $ruleLine->text,321            description: $this->getDescription($header),322            children: $children,323            id: $this->idGenerator->newId(),324        );325    }326    private function transformGherkinDocumentNode(AstNode $node): GherkinDocument327    {328        $feature = $node->getSingle(Feature::class, RuleType::Feature);329        return new GherkinDocument(330            uri: $this->uri,331            feature: $feature,332            comments: $this->comments,333        );334    }335}...

getDescription

Using AI Code Generation

1$builder = new GherkinDocumentBuilder();2$builder->getDescription();3$builder = new GherkinDocumentBuilder();4$builder->getFeature();5$builder = new GherkinDocumentBuilder();6$builder->getFeatureChildren();7$builder = new GherkinDocumentBuilder();8$builder->getFeatureDescription();9$builder = new GherkinDocumentBuilder();10$builder->getFeatureKeyword();11$builder = new GherkinDocumentBuilder();12$builder->getFeatureName();13$builder = new GherkinDocumentBuilder();14$builder->getFeatureTags();15$builder = new GherkinDocumentBuilder();16$builder->getGherkinDialect();17$builder = new GherkinDocumentBuilder();18$builder->getGherkinDialectProvider();19$builder = new GherkinDocumentBuilder();20$builder->getGherkinDocument();21$builder = new GherkinDocumentBuilder();22$builder->getGherkinStep();23$builder = new GherkinDocumentBuilder();24$builder->getGherkinStepArgument();

getDescription

Using AI Code Generation

1$gherkinDocumentBuilder = new GherkinDocumentBuilder();2$gherkinDocumentBuilder->getDescription();3$gherkinDocumentBuilder = new GherkinDocumentBuilder();4$gherkinDocumentBuilder->getTags();5$gherkinDocumentBuilder = new GherkinDocumentBuilder();6$gherkinDocumentBuilder->getScenarios();7$gherkinDocumentBuilder = new GherkinDocumentBuilder();8$gherkinDocumentBuilder->getSteps();9$gherkinDocumentBuilder = new GherkinDocumentBuilder();10$gherkinDocumentBuilder->getExamples();11$gherkinDocumentBuilder = new GherkinDocumentBuilder();12$gherkinDocumentBuilder->getTable();13$gherkinDocumentBuilder = new GherkinDocumentBuilder();14$gherkinDocumentBuilder->getDocString();15$gherkinDocumentBuilder = new GherkinDocumentBuilder();16$gherkinDocumentBuilder->getBackground();17$gherkinDocumentBuilder = new GherkinDocumentBuilder();18$gherkinDocumentBuilder->getRule();19$gherkinDocumentBuilder = new GherkinDocumentBuilder();20$gherkinDocumentBuilder->getRules();21$gherkinDocumentBuilder = new GherkinDocumentBuilder();22$gherkinDocumentBuilder->getLanguage();

getDescription

Using AI Code Generation

1$gherkinDocumentBuilder = new GherkinDocumentBuilder();2$gherkinDocument = $gherkinDocumentBuilder->getDescription($featurePath);3echo $gherkinDocument->getDescription();4$gherkinDocumentBuilder = new GherkinDocumentBuilder();5$gherkinDocument = $gherkinDocumentBuilder->getTags($featurePath);6echo $gherkinDocument->getTags();7$gherkinDocumentBuilder = new GherkinDocumentBuilder();8$gherkinDocument = $gherkinDocumentBuilder->getFeatureChildren($featurePath);9echo $gherkinDocument->getFeatureChildren();10$gherkinDocumentBuilder = new GherkinDocumentBuilder();11$gherkinDocument = $gherkinDocumentBuilder->getBackground($featurePath);12echo $gherkinDocument->getBackground();13$gherkinDocumentBuilder = new GherkinDocumentBuilder();14$gherkinDocument = $gherkinDocumentBuilder->getScenario($featurePath);15echo $gherkinDocument->getScenario();16$gherkinDocumentBuilder = new GherkinDocumentBuilder();17$gherkinDocument = $gherkinDocumentBuilder->getScenarioOutline($featurePath);18echo $gherkinDocument->getScenarioOutline();19$gherkinDocumentBuilder = new GherkinDocumentBuilder();20$gherkinDocument = $gherkinDocumentBuilder->getExamples($featurePath);21echo $gherkinDocument->getExamples();22$gherkinDocumentBuilder = new GherkinDocumentBuilder();23$gherkinDocument = $gherkinDocumentBuilder->getSteps($featurePath);

getDescription

Using AI Code Generation

1$gherkinDocumentBuilder = new GherkinDocumentBuilder();2$gherkinDocumentBuilder->getDescription();3Recommended Posts: PHP | GherkinDocumentBuilder::setFeature() Method4PHP | GherkinDocumentBuilder::getFeature() Method5PHP | GherkinDocumentBuilder::setComments() Method6PHP | GherkinDocumentBuilder::getComments() Method7PHP | GherkinDocumentBuilder::setTags() Method8PHP | GherkinDocumentBuilder::getTags() Method9PHP | GherkinDocumentBuilder::setLanguage() Method10PHP | GherkinDocumentBuilder::getLanguage() Method11PHP | GherkinDocumentBuilder::setKeyword() Method12PHP | GherkinDocumentBuilder::getKeyword() Method13PHP | GherkinDocumentBuilder::setLocation() Method14PHP | GherkinDocumentBuilder::getLocation() Method15PHP | GherkinDocumentBuilder::setRule() Method16PHP | GherkinDocumentBuilder::getRule() Method17PHP | GherkinDocumentBuilder::setChildren() Method18PHP | GherkinDocumentBuilder::getChildren() Method19PHP | GherkinDocumentBuilder::setScenario() Method20PHP | GherkinDocumentBuilder::getScenario() Method21PHP | GherkinDocumentBuilder::setSteps() Method22PHP | GherkinDocumentBuilder::getSteps() Method23PHP | GherkinDocumentBuilder::setExamples() Method24PHP | GherkinDocumentBuilder::getExamples() Method25PHP | GherkinDocumentBuilder::setTableBody() Method26PHP | GherkinDocumentBuilder::getTableBody() Method27PHP | GherkinDocumentBuilder::setTableRow() Method28PHP | GherkinDocumentBuilder::getTableRow() Method29PHP | GherkinDocumentBuilder::setTableCell() Method30PHP | GherkinDocumentBuilder::getTableCell() Method31PHP | GherkinDocumentBuilder::setTableHeader() Method32PHP | GherkinDocumentBuilder::getTableHeader() Method33PHP | GherkinDocumentBuilder::setDocString() Method34PHP | GherkinDocumentBuilder::getDocString() Method35PHP | GherkinDocumentBuilder::setMediaType() Method36PHP | GherkinDocumentBuilder::getMediaType() Method37PHP | GherkinDocumentBuilder::setContent() Method

getDescription

Using AI Code Generation

1$gherkinDocumentBuilder = new GherkinDocumentBuilder();2$gherkinDocument = $gherkinDocumentBuilder->getDescription($path);3var_dump($gherkinDocument);4$gherkinDocumentBuilder = new GherkinDocumentBuilder();5$gherkinDocument = $gherkinDocumentBuilder->getSteps($path);6var_dump($gherkinDocument);7$gherkinDocumentBuilder = new GherkinDocumentBuilder();8$gherkinDocument = $gherkinDocumentBuilder->getScenario($path);9var_dump($gherkinDocument);10$gherkinDocumentBuilder = new GherkinDocumentBuilder();11$gherkinDocument = $gherkinDocumentBuilder->getScenarioOutline($path);12var_dump($gherkinDocument);13$gherkinDocumentBuilder = new GherkinDocumentBuilder();14$gherkinDocument = $gherkinDocumentBuilder->getExamples($path);15var_dump($gherkinDocument);16$gherkinDocumentBuilder = new GherkinDocumentBuilder();17$gherkinDocument = $gherkinDocumentBuilder->getStep($path);18var_dump($gherkinDocument);19$gherkinDocumentBuilder = new GherkinDocumentBuilder();20$gherkinDocument = $gherkinDocumentBuilder->getTags($path);21var_dump($gherkinDocument);22$gherkinDocumentBuilder = new GherkinDocumentBuilder();23$gherkinDocument = $gherkinDocumentBuilder->getBackground($path);24var_dump($gherkinDocument

getDescription

Using AI Code Generation

1$gherkinDocumentBuilder = new GherkinDocumentBuilder();2$gherkinDocumentBuilder->getDescription();3GherkinDocumentBuilder::getFeature() Method in PHP4GherkinDocumentBuilder::getBackground() Method in PHP5GherkinDocumentBuilder::getScenario() Method in PHP6GherkinDocumentBuilder::getExamples() Method in PHP7GherkinDocumentBuilder::getSteps() Method in PHP8GherkinDocumentBuilder::getTags() Method in PHP9GherkinDocumentBuilder::getComments() Method in PHP10GherkinDocumentBuilder::getLanguage() Method in PHP11GherkinDocumentBuilder::getKeyword() Method in PHP12GherkinDocumentBuilder::getUri() Method in PHP13GherkinDocumentBuilder::getScenarioDefinition() Method in PHP14GherkinDocumentBuilder::getStep() Method in PHP15GherkinDocumentBuilder::getExample() Method in PHP16GherkinDocumentBuilder::getTableRow() Method in PHP17GherkinDocumentBuilder::getTableCell() Method in PHP18GherkinDocumentBuilder::getDocString() Method in PHP19GherkinDocumentBuilder::getDataTable() Method in PHP20GherkinDocumentBuilder::getDocStringContent() Method in PHP21GherkinDocumentBuilder::getDocStringDelimiter() Method in PHP22GherkinDocumentBuilder::getDocStringContentType() Method in PHP23GherkinDocumentBuilder::getDataTableRow() Method in PHP24GherkinDocumentBuilder::getDataTableCell() Method in PHP25GherkinDocumentBuilder::getScenarioOutline() Method in PHP26GherkinDocumentBuilder::getExamples() Method in PHP27GherkinDocumentBuilder::getExamplesTable() Method in PHP28GherkinDocumentBuilder::getExamplesTableRow() Method in PHP29GherkinDocumentBuilder::getExamplesTableCell() Method in PHP30GherkinDocumentBuilder::getRule() Method in PHP31GherkinDocumentBuilder::getRuleHeader() Method in PHP32GherkinDocumentBuilder::getRuleElement() Method in PHP33GherkinDocumentBuilder::getBackground() Method in PHP34GherkinDocumentBuilder::getScenario() Method in PHP

getDescription

Using AI Code Generation

1$document = $builder->getDescription('2.php');2echo $document;3$document = $builder->getDescription('2.php');4echo $document;5$document = $builder->getDescription('2.php');6echo $document;7$document = $builder->getDescription('2.php');8echo $document;9$document = $builder->getDescription('2.php');10echo $document;11$document = $builder->getDescription('2.php');12echo $document;13$document = $builder->getDescription('2.php');14echo $document;15$document = $builder->getDescription('2.php');16echo $document;17$document = $builder->getDescription('2.php');18echo $document;19$document = $builder->getDescription('2.php');20echo $document;21$document = $builder->getDescription('2.php');22echo $document;23$document = $builder->getDescription('2.php');24echo $document;

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.