Overview

Packages

  • akismet
  • None
  • PHP
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • plugins
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Signatures
    • Signed
    • Transport
  • wa-apps
    • blog
      • actions
        • backend
        • blog
        • comment
        • cron
        • design
        • frontend
        • page
        • plugin
        • post
      • api
        • v1
      • cli
      • layout
      • model
      • plugin
        • aksimet
        • category
        • emailsubscription
        • favorite
        • gravatar
        • import
        • markdown
        • myposts
        • tag
        • troll
      • settings
    • checklists
      • backend
      • json
    • contacts
      • backend
    • developer
    • dummy
    • guestbook
    • guestbook2
    • photos
      • album
      • api
        • v1
      • backend
      • design
      • dialog
      • frontend
      • page
      • photo
      • plugin
        • comment
        • imageeffects
        • import
        • publicgallery
        • watermark
      • search
      • settings
      • stack
      • tag
      • upload
    • site
      • backend
      • blocks
      • config
      • design
      • domains
      • files
      • frontend
      • helper
      • layout
      • pages
      • routing
      • setting
    • stickies
      • api
        • v1
      • sheet
      • stiky
  • wa-plugin
    • payment
    • shipping
    • sms
  • wa-plugins
    • shipping
      • usps
  • wa-system
    • API
    • Auth
      • Adapters
    • Autoload
    • Cache
      • Adapter
    • Captcha
    • Config
    • Contact
    • controller
    • currency
    • database
    • datetime
    • design
    • event
    • exception
    • files
    • image
    • layout
    • locale
    • log
    • mail
    • page
      • action
      • model
    • payment
    • plugin
    • request
    • response
    • routing
    • shipping
    • sms
    • storage
    • user
    • util
    • validator
    • view
    • webasyst
      • api
      • backend
      • cli
      • config
      • layout
      • login
      • model
      • password
      • payment
      • profile
      • settings
      • shipment
    • widget
    • workflow
  • waPlugins
    • Payment
  • webasyst
    • wa-system
      • helper

Classes

  • Swift_FailoverTransport
  • Swift_LoadBalancedTransport
  • Swift_MailTransport
  • Swift_Plugins_Loggers_ArrayLogger
  • Swift_Plugins_Loggers_EchoLogger
  • Swift_SendmailTransport
  • Swift_SmtpTransport
  • Swift_Transport_AbstractSmtpTransport
  • Swift_Transport_Esmtp_Auth_CramMd5Authenticator
  • Swift_Transport_Esmtp_Auth_LoginAuthenticator
  • Swift_Transport_Esmtp_Auth_NTLMAuthenticator
  • Swift_Transport_Esmtp_Auth_PlainAuthenticator
  • Swift_Transport_Esmtp_Auth_XOAuth2Authenticator
  • Swift_Transport_Esmtp_AuthHandler
  • Swift_Transport_EsmtpTransport
  • Swift_Transport_FailoverTransport
  • Swift_Transport_LoadBalancedTransport
  • Swift_Transport_MailTransport
  • Swift_Transport_SendmailTransport
  • Swift_Transport_SimpleMailInvoker
  • Swift_Transport_StreamBuffer

Interfaces

  • Swift_Plugins_Logger
  • Swift_Transport
  • Swift_Transport_Esmtp_Authenticator
  • Swift_Transport_EsmtpHandler
  • Swift_Transport_IoBuffer
  • Swift_Transport_MailInvoker
  • Swift_Transport_SmtpAgent

Exceptions

  • Swift_Plugins_Pop_Pop3Exception
  • Swift_TransportException
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class Swift_Transport_StreamBuffer

A generic IoBuffer implementation supporting remote sockets and local processes.

Swift_ByteStream_AbstractFilterableInputStream implements Swift_InputByteStream, Swift_Filterable
Extended by Swift_Transport_StreamBuffer implements Swift_Transport_IoBuffer
Package: Swift\Transport
Author: Chris Corbyn
Located at wa-system/vendors/swift/classes/Swift/Transport/StreamBuffer.php
Methods summary
public
# __construct( Swift_ReplacementFilterFactory $replacementFactory )

Create a new StreamBuffer using $replacementFactory for transformations.

Create a new StreamBuffer using $replacementFactory for transformations.

Parameters

$replacementFactory
Swift_ReplacementFilterFactory
$replacementFactory
public
# initialize( array $params )

Perform any initialization needed, using the given $params.

Perform any initialization needed, using the given $params.

Parameters will vary depending upon the type of IoBuffer used.

Parameters

$params
array
$params

Implementation of

Swift_Transport_IoBuffer::initialize()
public
# setParam( string $param, mixed $value )

Set an individual param on the buffer (e.g. switching to SSL).

Set an individual param on the buffer (e.g. switching to SSL).

Parameters

$param
string
$param
$value
mixed
$value

Implementation of

Swift_Transport_IoBuffer::setParam()
public
# startTLS( )
public
# terminate( )

Perform any shutdown logic needed.

Perform any shutdown logic needed.

Implementation of

Swift_Transport_IoBuffer::terminate()
public
# setWriteTranslations( array $replacements )

Set an array of string replacements which should be made on data written to the buffer.

Set an array of string replacements which should be made on data written to the buffer.

This could replace LF with CRLF for example.

Parameters

$replacements
string[]
$replacements

Implementation of

Swift_Transport_IoBuffer::setWriteTranslations()
public string
# readLine( integer $sequence )

Get a line of output (including any CRLF).

Get a line of output (including any CRLF).

The $sequence number comes from any writes and may or may not be used depending upon the implementation.

Parameters

$sequence
integer
$sequence of last write to scan from

Returns

string

Throws

Swift_IoException

Implementation of

Swift_Transport_IoBuffer::readLine()
public string|boolean
# read( integer $length )

Reads $length bytes from the stream into a string and moves the pointer through the stream by $length.

Reads $length bytes from the stream into a string and moves the pointer through the stream by $length.

If less bytes exist than are requested the remaining bytes are given instead. If no bytes are remaining at all, boolean false is returned.

Parameters

$length
integer
$length

Returns

string|boolean

Throws

Swift_IoException

Implementation of

Swift_OutputByteStream::read()
public boolean
# setReadPointer( integer $byteOffset )

Not implemented

Not implemented

Parameters

$byteOffset
integer
$byteOffset

Returns

boolean

Throws

Swift_IoException

Implementation of

Swift_OutputByteStream::setReadPointer()
protected
# _flush( )

Flush the stream contents

Flush the stream contents

protected
# _commit( string $bytes )

Write this bytes to the stream

Write this bytes to the stream

Parameters

$bytes
string
$bytes
private
# _establishSocketConnection( )

Establishes a connection to a remote server.

Establishes a connection to a remote server.

private
# _establishProcessConnection( )

Opens a process for input/output.

Opens a process for input/output.

private
# _getReadConnectionDescription( )
Methods inherited from Swift_ByteStream_AbstractFilterableInputStream
addFilter(), bind(), commit(), flushBuffers(), removeFilter(), unbind(), write()
Constants inherited from Swift_Transport_IoBuffer
TYPE_PROCESS, TYPE_SOCKET
Properties summary
private mixed $_stream
#

A primary socket

A primary socket

private mixed $_in
#

The input stream

The input stream

private mixed $_out
#

The output stream

The output stream

private array $_params array()
#

Buffer initialization parameters

Buffer initialization parameters

private mixed $_replacementFactory
#

The ReplacementFilterFactory

The ReplacementFilterFactory

private array $_translations array()
#

Translations performed on data being streamed into the buffer

Translations performed on data being streamed into the buffer

Properties inherited from Swift_ByteStream_AbstractFilterableInputStream
$_sequence
My fork of Webasyst Framework API documentation generated by ApiGen 2.8.0