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

How to use getTags method of GherkinDocumentBuilder class

Best Gherkin-php code snippet using GherkinDocumentBuilder.getTags

GherkinDocumentBuilder.php

Source:GherkinDocumentBuilder.php

...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),...

getTags

Using AI Code Generation

1require_once ('vendor/autoload.php');2use Behat\Gherkin\Gherkin;3use Behat\Gherkin\Node\FeatureNode;4use Behat\Gherkin\Node\ScenarioNode;5use Behat\Gherkin\Node\StepNode;6use Behat\Gherkin\Node\TableNode;7use Behat\Gherkin\Node\PyStringNode;8use Behat\Gherkin\Node\BackgroundNode;9use Behat\Gherkin\Node\OutlineNode;10use Behat\Gherkin\Node\ExamplesNode;11use Behat\Gherkin\Node\ExampleNode;12use Behat\Gherkin\Node\StepArgument\PyStringNode;13use Behat\Gherkin\Node\StepArgument\TableNode;14use Behat\Gherkin\Node\StepArgument\StepArgumentNode;15use Behat\Gherkin\Node\Argument\ArgumentNode;

getTags

Using AI Code Generation

1$gherkinDocumentBuilder = new GherkinDocumentBuilder();2$gherkinDocument = $gherkinDocumentBuilder->build($path);3$tags = $gherkinDocument->getTags();4foreach ($tags as $tag) {5    echo $tag->getName() . "6";7}8$gherkinDocumentBuilder = new GherkinDocumentBuilder();9$gherkinDocument = $gherkinDocumentBuilder->build($path);10$feature = $gherkinDocument->getFeature();11echo $feature->getName();12$gherkinDocumentBuilder = new GherkinDocumentBuilder();13$gherkinDocument = $gherkinDocumentBuilder->build($path);14$background = $gherkinDocument->getFeature()->getBackground();15echo $background->getName();16$gherkinDocumentBuilder = new GherkinDocumentBuilder();17$gherkinDocument = $gherkinDocumentBuilder->build($path);18$scenarioDefinitions = $gherkinDocument->getFeature()->getScenarioDefinitions();19foreach ($scenarioDefinitions as $scenarioDefinition) {20    echo $scenarioDefinition->getName() . "21";22}23$gherkinDocumentBuilder = new GherkinDocumentBuilder();24$gherkinDocument = $gherkinDocumentBuilder->build($path);25$examples = $gherkinDocument->getFeature()->getScenarioDefinitions()[0]->getExamples();26foreach ($examples as $example) {27    echo $example->getName() . "28";29}30$gherkinDocumentBuilder = new GherkinDocumentBuilder();31$gherkinDocument = $gherkinDocumentBuilder->build($path);32$steps = $gherkinDocument->getFeature()->getScenarioDefinitions()[0]->getSteps();33foreach ($steps as $step) {34    echo $step->getText() . "35";36}

getTags

Using AI Code Generation

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

getTags

Using AI Code Generation

1$gherkinDocumentBuilder = new GherkinDocumentBuilder();2$gherkinDocument = $gherkinDocumentBuilder->getGherkinDocument("path to feature file");3$tags = $gherkinDocumentBuilder->getTags($gherkinDocument);4print_r($tags);5Array ( [0] => Array ( [name] => @tag1 [location] => Array ( [line] => 1 [column] => 1 ) ) [1] => Array ( [name] => @tag2 [location] => Array ( [line] => 2 [column] => 1 ) ) )6public function getFeature(GherkinDocument $gherkinDocument): Feature7$gherkinDocumentBuilder = new GherkinDocumentBuilder();8$gherkinDocument = $gherkinDocumentBuilder->getGherkinDocument("path to feature file");9$feature = $gherkinDocumentBuilder->getFeature($gherkinDocument);10print_r($feature);11Array ( [tags] => Array ( [0] => Array ( [name] => @tag1 [location] => Array ( [line] => 1 [column] => 1 ) ) [1] => Array ( [name] => @tag2 [location] => Array ( [line] => 2 [column] => 1 ) ) ) [location] => Array ( [line] => 3 [column] => 1 ) [language] => en [keyword] => Feature [name] => Feature name [description] => Array ( [0] => Array ( [location] => Array ( [line] => 4 [column] => 3 ) [value] => description ) ) [children] => Array ( [0] => Array ( [background] => Array ( [tags] => Array ( ) [location] => Array ( [line] => 6 [column] => 1 ) [keyword] => Background [name] => Background name [description] => Array ( [0] => Array ( [location] => Array (

getTags

Using AI Code Generation

1$builder = new GherkinDocumentBuilder();2$builder->getTags($feature);3$builder = new GherkinDocumentBuilder();4$builder->getTags($scenario);5$builder = new GherkinDocumentBuilder();6$builder->getTags($scenario_outline);7$builder = new GherkinDocumentBuilder();8$builder->getTags($examples);9$builder = new GherkinDocumentBuilder();10$builder->getTags($step);11$builder = new GherkinDocumentBuilder();12$builder->getTags($table);13$builder = new GherkinDocumentBuilder();14$builder->getTags($table_row);15$builder = new GherkinDocumentBuilder();16$builder->getTags($doc_string);17$builder = new GherkinDocumentBuilder();18$builder->getTags($comment);19$builder = new GherkinDocumentBuilder();20$builder->getTags($language);21$builder = new GherkinDocumentBuilder();22$builder->getTags($feature_child);23$builder = new GherkinDocumentBuilder();24$builder->getTags($scenario_child);25$builder = new GherkinDocumentBuilder();

getTags

Using AI Code Generation

1$gherkinDocument = new GherkinDocumentBuilder();2$gherkinDocument->getTags($feature);3$gherkinDocument = new GherkinDocumentBuilder();4$gherkinDocument->getTags($scenario);5$gherkinDocument = new GherkinDocumentBuilder();6$gherkinDocument->getTags($scenarioOutline);7$gherkinDocument = new GherkinDocumentBuilder();8$gherkinDocument->getTags($examples);9$gherkinDocument = new GherkinDocumentBuilder();10$gherkinDocument->getTags($step);11$gherkinDocument = new GherkinDocumentBuilder();12$gherkinDocument->getTags($background);13$gherkinDocument = new GherkinDocumentBuilder();14$gherkinDocument->getTags($rule);15$gherkinDocument = new GherkinDocumentBuilder();16$gherkinDocument->getTags($comment);17$gherkinDocument = new GherkinDocumentBuilder();18$gherkinDocument->getTags($dataTable);19$gherkinDocument = new GherkinDocumentBuilder();20$gherkinDocument->getTags($docString);21$gherkinDocument = new GherkinDocumentBuilder();22$gherkinDocument->getTags($language);

getTags

Using AI Code Generation

1$builder = new GherkinDocumentBuilder();2$document = $builder->getGherkinDocument($path);3$tags = $builder->getTags($document, $path);4print_r($tags);5$builder = new GherkinDocumentBuilder();6$document = $builder->getGherkinDocument($path);7$tags = $builder->getTags($document, $path);8print_r($tags);9$builder = new GherkinDocumentBuilder();10$document = $builder->getGherkinDocument($path);11$tags = $builder->getTags($document, $path);12print_r($tags);13$builder = new GherkinDocumentBuilder();14$document = $builder->getGherkinDocument($path);15$tags = $builder->getTags($document, $path);16print_r($tags);17$builder = new GherkinDocumentBuilder();18$document = $builder->getGherkinDocument($path);19$tags = $builder->getTags($document, $path);20print_r($tags);21$builder = new GherkinDocumentBuilder();22$document = $builder->getGherkinDocument($path);23$tags = $builder->getTags($document, $path);24print_r($tags);25$builder = new GherkinDocumentBuilder();26$document = $builder->getGherkinDocument($path);27$tags = $builder->getTags($document, $path);28print_r($tags);29$builder = new GherkinDocumentBuilder();30$document = $builder->getGherkinDocument($path);31$tags = $builder->getTags($document, $path);32print_r($tags);

getTags

Using AI Code Generation

1$builder = new GherkinDocumentBuilder();2$document = $builder->getTags($path);3var_dump($document);4array(2) {5  string(9) "@tag1"6  string(9) "@tag2"7}

getTags

Using AI Code Generation

1$feature = $document->getFeature();2$tags = $feature->getTags();3foreach($tags as $tag){4    echo $tag->getName().'5';6}

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.