4 * This file is part of the Behat Testwork.
5 * (c) Konstantin Kudryashov <ever.zet@gmail.com>
7 * For the full copyright and license information, please view the LICENSE
8 * file that was distributed with this source code.
11 namespace Behat\Testwork\Specification\Locator;
13 use Behat\Testwork\Specification\SpecificationFinder;
14 use Behat\Testwork\Specification\SpecificationIterator;
15 use Behat\Testwork\Suite\Suite;
18 * Provides a custom way to locate specification by provided suite and locator string.
20 * @see SpecificationFinder
22 * @author Konstantin Kudryashov <ever.zet@gmail.com>
24 interface SpecificationLocator
27 * Returns array of strings representing examples of supported specification locators.
31 public function getLocatorExamples();
34 * Locates specifications and wraps them into iterator.
37 * @param string $locator
39 * @return SpecificationIterator
41 public function locateSpecifications(Suite $suite, $locator);