www.aleph1.co.uk Git - yaffs-website/blob - vendor/behat/behat/src/Behat/Testwork/Specification/Locator/SpecificationLocator.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Behat Testwork.
   5  * (c) Konstantin Kudryashov <ever.zet@gmail.com>
   6  *
   7  * For the full copyright and license information, please view the LICENSE
   8  * file that was distributed with this source code.
   9  */
  10
  11 namespace Behat\Testwork\Specification\Locator;
  12
  13 use Behat\Testwork\Specification\SpecificationFinder;
  14 use Behat\Testwork\Specification\SpecificationIterator;
  15 use Behat\Testwork\Suite\Suite;
  16
  17 /**
  18  * Provides a custom way to locate specification by provided suite and locator string.
  19  *
  20  * @see SpecificationFinder
  21  *
  22  * @author Konstantin Kudryashov <ever.zet@gmail.com>
  23  */
  24 interface SpecificationLocator
  25 {
  26     /**
  27      * Returns array of strings representing examples of supported specification locators.
  28      *
  29      * @return string[]
  30      */
  31     public function getLocatorExamples();
  32
  33     /**
  34      * Locates specifications and wraps them into iterator.
  35      *
  36      * @param Suite  $suite
  37      * @param string $locator
  38      *
  39      * @return SpecificationIterator
  40      */
  41     public function locateSpecifications(Suite $suite, $locator);
  42 }