includes/http/MWCallbackStream.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20
  21 use GuzzleHttp\Psr7\StreamDecoratorTrait;
  22 use GuzzleHttp\Psr7\Utils;
  23 use Psr\Http\Message\StreamInterface;
  24
  25 /**
  26  * Callback-aware stream.  Allows using a callback function to receive data in contexts where
  27  * a PSR-7 stream is required.  This was created so that GuzzleHttpRequest can support our
  28  * "callback" option, for backward compatibility.  Newer code that uses GuzzleHttpRequest
  29  * should consider using the "sink" option instead.
  30  *
  31  * @internal for use by GuzzleHttpRequest only
  32  * @since 1.33
  33  * @property StreamInterface $stream Defined in StreamDecoratorTrait via `@property`, not read
  34  *  by phan
  35  */
  36 class MWCallbackStream implements StreamInterface {
  37         use StreamDecoratorTrait;
  38
  39         /** @var callable */
  40         private $callback;
  41
  42         /** @var StreamInterface */
  43         protected $stream;
  44
  45         public function __construct( callable $cb ) {
  46                 $this->stream = Utils::streamFor();
  47                 $this->callback = $cb;
  48         }
  49
  50         public function write( $string ) {
  51                 return call_user_func( $this->callback, $this, $string );
  52         }
  53 }