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

Interface Swift_InputByteStream

An abstract means of writing data. Classes implementing this interface may use a subsystem which requires less memory than working with large strings of data.

Direct known implementers

Swift_ByteStream_AbstractFilterableInputStream, Swift_ByteStream_ArrayByteStream, Swift_KeyCache_KeyCacheInputStream, Swift_Plugins_BandwidthMonitorPlugin, Swift_Transport_IoBuffer

Indirect known implementers

Swift_ByteStream_FileByteStream, Swift_KeyCache_SimpleKeyCacheInputStream, Swift_Plugins_ThrottlerPlugin, Swift_Transport_StreamBuffer
Package: Swift\ByteStream
Author: Chris Corbyn
Located at classes/swiftmailer/lib/classes/Swift/InputByteStream.php
Methods summary
public integer
# write( string $bytes )

Writes $bytes to the end of the stream.

Writes $bytes to the end of the stream.

Writing may not happen immediately if the stream chooses to buffer. If you want to write these bytes with immediate effect, call Swift_InputByteStream::commit() after calling write().

This method returns the sequence ID of the write (i.e. 1 for first, 2 for second, etc etc).

Parameters

$bytes

Returns

integer

Throws

Swift_IoException
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
public
# bind( Swift_InputByteStream $is )

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

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

Parameters

$is
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
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
CMS CONTENIDO 4.9.7 API documentation generated by ApiGen