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