www.aleph1.co.uk Git - yaffs-website/blob - vendor/behat/behat/src/Behat/Testwork/Output/Printer/OutputPrinter.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\Printer;
  12
  13 /**
  14  * Isolates all console/filesystem writing.
  15  *
  16  * @author Konstantin Kudryashov <ever.zet@gmail.com>
  17  */
  18 interface OutputPrinter
  19 {
  20     /**
  21      * @deprecated since 3.1, to be removed in 4.0
  22      */
  23     const VERBOSITY_NORMAL       = 1;
  24     /**
  25      * @deprecated since 3.1, to be removed in 4.0
  26      */
  27     const VERBOSITY_VERBOSE      = 2;
  28     /**
  29      * @deprecated since 3.1, to be removed in 4.0
  30      */
  31     const VERBOSITY_VERY_VERBOSE = 3;
  32     /**
  33      * @deprecated since 3.1, to be removed in 4.0
  34      */
  35     const VERBOSITY_DEBUG        = 4;
  36
  37     /**
  38      * Sets output path.
  39      *
  40      * @param string $path
  41      */
  42     public function setOutputPath($path);
  43
  44     /**
  45      * Returns output path.
  46      *
  47      * @return null|string
  48      *
  49      * @deprecated since 3.1, to be removed in 4.0
  50      */
  51     public function getOutputPath();
  52
  53     /**
  54      * Sets output styles.
  55      *
  56      * @param array $styles
  57      */
  58     public function setOutputStyles(array $styles);
  59
  60     /**
  61      * Returns output styles.
  62      *
  63      * @return array
  64      *
  65      * @deprecated since 3.1, to be removed in 4.0
  66      */
  67     public function getOutputStyles();
  68
  69     /**
  70      * Forces output to be decorated.
  71      *
  72      * @param Boolean $decorated
  73      */
  74     public function setOutputDecorated($decorated);
  75
  76     /**
  77      * Returns output decoration status.
  78      *
  79      * @return null|Boolean
  80      *
  81      * @deprecated since 3.1, to be removed in 4.0
  82      */
  83     public function isOutputDecorated();
  84
  85     /**
  86      * Sets output verbosity level.
  87      *
  88      * @param integer $level
  89      */
  90     public function setOutputVerbosity($level);
  91
  92     /**
  93      * Returns output verbosity level.
  94      *
  95      * @return integer
  96      *
  97      * @deprecated since 3.1, to be removed in 4.0
  98      */
  99     public function getOutputVerbosity();
 100
 101     /**
 102      * Writes message(s) to output stream.
 103      *
 104      * @param string|array $messages message or array of messages
 105      */
 106     public function write($messages);
 107
 108     /**
 109      * Writes newlined message(s) to output stream.
 110      *
 111      * @param string|array $messages message or array of messages
 112      */
 113     public function writeln($messages = '');
 114
 115     /**
 116      * Clear output stream, so on next write formatter will need to init (create) it again.
 117      */
 118     public function flush();
 119 }