www.aleph1.co.uk Git - yaffs-website/blob - vendor/behat/behat/src/Behat/Testwork/Output/Formatter.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\Output;
  12
  13 use Behat\Testwork\Output\Printer\OutputPrinter;
  14 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  15
  16 /**
  17  * Represents Testwork output formatter.
  18  *
  19  * @see OutputManager
  20  *
  21  * @author Konstantin Kudryashov <ever.zet@gmail.com>
  22  */
  23 interface Formatter extends EventSubscriberInterface
  24 {
  25     /**
  26      * Returns formatter name.
  27      *
  28      * @return string
  29      */
  30     public function getName();
  31
  32     /**
  33      * Returns formatter description.
  34      *
  35      * @return string
  36      */
  37     public function getDescription();
  38
  39     /**
  40      * Returns formatter output printer.
  41      *
  42      * @return OutputPrinter
  43      */
  44     public function getOutputPrinter();
  45
  46     /**
  47      * Sets formatter parameter.
  48      *
  49      * @param string $name
  50      * @param mixed  $value
  51      */
  52     public function setParameter($name, $value);
  53
  54     /**
  55      * Returns parameter name.
  56      *
  57      * @param string $name
  58      *
  59      * @return mixed
  60      */
  61     public function getParameter($name);
  62 }