tests/Util/Intercept.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Test\Util;
  23
  24 use php_user_filter;
  25
  26 /**
  27  * Output Interceptor for STDOUT to prevent outputing to the console
  28  * Instead the $cache variable will get filled with the output
  29  *
  30  * @package Friendica\Test\Util
  31  */
  32 class Intercept extends php_user_filter
  33 {
  34         /**
  35          * @var string The cache which holds the current output of STDOUT
  36          */
  37         public static $cache = '';
  38
  39         /** @noinspection PhpMissingParentCallCommonInspection */
  40         public function filter($in, $out, &$consumed, $closing)
  41         {
  42                 while ($bucket = stream_bucket_make_writeable($in)) {
  43                         self::$cache .= $bucket->data;
  44                         $consumed += $bucket->datalen;
  45                         stream_bucket_append($out, $bucket);
  46                 }
  47                 return PSFS_FEED_ME;
  48         }
  49
  50         /**
  51          * Registers the interceptor and prevents therefore the output to STDOUT
  52          */
  53         public static function setUp() {
  54                 stream_filter_register("intercept", Intercept::class);
  55                 stream_filter_append(STDOUT, "intercept");
  56                 stream_filter_append(STDERR, "intercept");
  57         }
  58
  59         /**
  60          * Resets the cache
  61          */
  62         public static function reset() {
  63                 self::$cache = '';
  64         }
  65 }