www.aleph1.co.uk Git - yaffs-website/blob - vendor/behat/behat/src/Behat/Behat/Context/Annotation/AnnotationReader.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Behat.
   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\Behat\Context\Annotation;
  12
  13 use Behat\Behat\Context\Reader\AnnotatedContextReader;
  14 use Behat\Testwork\Call\Callee;
  15 use ReflectionMethod;
  16
  17 /**
  18  * Reads custom annotation of a provided context method into a Callee.
  19  *
  20  * @see AnnotatedContextReader
  21  *
  22  * @author Konstantin Kudryashov <ever.zet@gmail.com>
  23  */
  24 interface AnnotationReader
  25 {
  26     /**
  27      * Reads all callees associated with a provided method.
  28      *
  29      * @param string           $contextClass
  30      * @param ReflectionMethod $method
  31      * @param string           $docLine
  32      * @param string           $description
  33      *
  34      * @return null|Callee
  35      */
  36     public function readCallee($contextClass, ReflectionMethod $method, $docLine, $description);
  37 }