Overview

Packages

  • CONTENIDO
  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentRssCreator
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
    • ScriptCookieDirective
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob
  • Smarty
    • Cacher
    • Compiler
    • Config
    • Debug
    • PluginsBlock
    • PluginsFilter
    • PluginsFunction
    • PluginsInternal
    • PluginsModifier
    • PluginsModifierCompiler
    • PluginsShared
    • Security
    • Template
    • TemplateResources
  • Swift
    • ByteStream
    • CharacterStream
    • Encoder
    • Events
    • KeyCache
    • Mailer
    • Mime
    • Plugins
    • Transport

Classes

  • Swift_ByteStream_AbstractFilterableInputStream
  • Swift_ByteStream_ArrayByteStream
  • Swift_ByteStream_FileByteStream

Interfaces

  • Swift_FileStream
  • Swift_InputByteStream
  • Swift_OutputByteStream
  • Overview
  • Package
  • Class
  • Todo
  • Download

Class Swift_ByteStream_AbstractFilterableInputStream

Provides the base functionality for an InputStream supporting filters.

Swift_ByteStream_AbstractFilterableInputStream implements Swift_InputByteStream, Swift_Filterable

Direct known subclasses

Swift_ByteStream_FileByteStream, Swift_Transport_StreamBuffer
Abstract
Package: Swift\ByteStream
Author: Chris Corbyn
Located at classes/swiftmailer/lib/classes/Swift/ByteStream/AbstractFilterableInputStream.php
Methods summary
abstract protected
# _commit( string $bytes )

Commit the given bytes to the storage medium immediately.

Commit the given bytes to the storage medium immediately.

Parameters

$bytes
abstract protected
# _flush( )

Flush any buffers/content with immediate effect.

Flush any buffers/content with immediate effect.

public
# addFilter( Swift_StreamFilter $filter, string $key )

Add a StreamFilter to this InputByteStream.

Add a StreamFilter to this InputByteStream.

Parameters

$filter
$key

Implementation of

Swift_Filterable::addFilter()
public
# removeFilter( string $key )

Remove an already present StreamFilter based on its $key.

Remove an already present StreamFilter based on its $key.

Parameters

$key

Implementation of

Swift_Filterable::removeFilter()
public integer
# write( string $bytes )

Writes $bytes to the end of the stream.

Writes $bytes to the end of the stream.

Parameters

$bytes

Returns

integer

Throws

Swift_IoException

Implementation of

Swift_InputByteStream::write()
public
# commit( )

For any bytes that are currently buffered inside the stream, force them off the buffer.

For any bytes that are currently buffered inside the stream, force them off the buffer.

Throws

Swift_IoException

Implementation of

Swift_InputByteStream::commit()
public
# bind( Swift_InputByteStream $is )

Attach $is to this stream. The stream acts as an observer, receiving all data that is written. All Swift_ByteStream_AbstractFilterableInputStream::write() and Swift_ByteStream_AbstractFilterableInputStream::flushBuffers() operations will be mirrored.

Attach $is to this stream. The stream acts as an observer, receiving all data that is written. All Swift_ByteStream_AbstractFilterableInputStream::write() and Swift_ByteStream_AbstractFilterableInputStream::flushBuffers() operations will be mirrored.

Parameters

$is

Implementation of

Swift_InputByteStream::bind()
public
# unbind( Swift_InputByteStream $is )

Remove an already bound stream. If $is is not bound, no errors will be raised. If the stream currently has any buffered data it will be written to $is before unbinding occurs.

Remove an already bound stream. If $is is not bound, no errors will be raised. If the stream currently has any buffered data it will be written to $is before unbinding occurs.

Parameters

$is

Implementation of

Swift_InputByteStream::unbind()
public
# flushBuffers( )

Flush the contents of the stream (empty it) and set the internal pointer to the beginning.

Flush the contents of the stream (empty it) and set the internal pointer to the beginning.

Throws

Swift_IoException

Implementation of

Swift_InputByteStream::flushBuffers()
private
# _filter( $bytes )

Run $bytes through all filters

Run $bytes through all filters

private
# _doWrite( $bytes )

Just write the bytes to the stream

Just write the bytes to the stream

Properties summary
protected integer $_sequence

Write sequence

Write sequence

# 0
private array $_filters

StreamFilters

StreamFilters

# array()
private string $_writeBuffer

A buffer for writing

A buffer for writing

# ''
private array $_mirrors

Bound streams

Bound streams

# array()
CMS CONTENIDO 4.9.7 API documentation generated by ApiGen