Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. AbstractStream.php

class AbstractStream

A stream supporting remote sockets and local processes.

@author Fabien Potencier <fabien@symfony.com> @author Nicolas Grekas <p@tchwork.com> @author Chris Corbyn

@internal

Hierarchy

  • class \Symfony\Component\Mailer\Transport\Smtp\Stream\AbstractStream

Expanded class hierarchy of AbstractStream

3 files declare their use of AbstractStream
EsmtpTransport.php in vendor/symfony/mailer/Transport/Smtp/EsmtpTransport.php
SendmailTransport.php in vendor/symfony/mailer/Transport/SendmailTransport.php
SmtpTransport.php in vendor/symfony/mailer/Transport/Smtp/SmtpTransport.php

File

vendor/symfony/mailer/Transport/Smtp/Stream/AbstractStream.php, line 25

Namespace

Symfony\Component\Mailer\Transport\Smtp\Stream
View source
abstract class AbstractStream {
    
    /** @var resource|null */
    protected $stream;
    
    /** @var resource|null */
    protected $in;
    
    /** @var resource|null */
    protected $out;
    protected $err;
    private string $debug = '';
    public function write(string $bytes, bool $debug = true) : void {
        if ($debug) {
            $timestamp = (new \DateTimeImmutable())->format('Y-m-d\\TH:i:s.up');
            foreach (explode("\n", trim($bytes)) as $line) {
                $this->debug .= \sprintf("[%s] > %s\n", $timestamp, $line);
            }
        }
        $bytesToWrite = \strlen($bytes);
        $totalBytesWritten = 0;
        while ($totalBytesWritten < $bytesToWrite) {
            $bytesWritten = @fwrite($this->in, substr($bytes, $totalBytesWritten));
            if (false === $bytesWritten || 0 === $bytesWritten) {
                throw new TransportException('Unable to write bytes on the wire.');
            }
            $totalBytesWritten += $bytesWritten;
        }
    }
    
    /**
     * Flushes the contents of the stream (empty it) and set the internal pointer to the beginning.
     */
    public function flush() : void {
        fflush($this->in);
    }
    
    /**
     * Performs any initialization needed.
     */
    public abstract function initialize() : void;
    public function terminate() : void {
        $this->stream = $this->err = $this->out = $this->in = null;
    }
    public function readLine() : string {
        if (feof($this->out)) {
            return '';
        }
        $line = @fgets($this->out);
        if ('' === $line || false === $line) {
            $metas = stream_get_meta_data($this->out);
            if ($metas['timed_out']) {
                throw new TransportException(\sprintf('Connection to "%s" timed out.', $this->getReadConnectionDescription()));
            }
            if ($metas['eof']) {
                throw new TransportException(\sprintf('Connection to "%s" has been closed unexpectedly.', $this->getReadConnectionDescription()));
            }
            if (false === $line) {
                throw new TransportException(\sprintf('Unable to read from connection to "%s": ', $this->getReadConnectionDescription()) . error_get_last()['message']);
            }
        }
        $this->debug .= \sprintf('[%s] < %s', (new \DateTimeImmutable())->format('Y-m-d\\TH:i:s.up'), $line);
        return $line;
    }
    public function getDebug() : string {
        $debug = $this->debug;
        $this->debug = '';
        return $debug;
    }
    public static function replace(string $from, string $to, iterable $chunks) : \Generator {
        if ('' === $from) {
            yield from $chunks;
            return;
        }
        $carry = '';
        $fromLen = \strlen($from);
        foreach ($chunks as $chunk) {
            if ('' === ($chunk = $carry . $chunk)) {
                continue;
            }
            if (str_contains($chunk, $from)) {
                $chunk = explode($from, $chunk);
                $carry = array_pop($chunk);
                (yield implode($to, $chunk) . $to);
            }
            else {
                $carry = $chunk;
            }
            if (\strlen($carry) > $fromLen) {
                (yield substr($carry, 0, -$fromLen));
                $carry = substr($carry, -$fromLen);
            }
        }
        if ('' !== $carry) {
            (yield $carry);
        }
    }
    protected abstract function getReadConnectionDescription() : string;

}

Members

Title Sort descending Modifiers Object type Summary Overrides
AbstractStream::$debug private property
AbstractStream::$err protected property
AbstractStream::$in protected property @var resource|null
AbstractStream::$out protected property @var resource|null
AbstractStream::$stream protected property @var resource|null
AbstractStream::flush public function Flushes the contents of the stream (empty it) and set the internal pointer to the beginning.
AbstractStream::getDebug public function
AbstractStream::getReadConnectionDescription abstract protected function 2
AbstractStream::initialize abstract public function Performs any initialization needed. 2
AbstractStream::readLine public function
AbstractStream::replace public static function
AbstractStream::terminate public function 2
AbstractStream::write public function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal