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_ByteStream_AbstractFilterableInputStream
  • Swift_ByteStream_ArrayByteStream
  • Swift_ByteStream_FileByteStream
  • Swift_ByteStream_TemporaryFileByteStream

Interfaces

  • Swift_FileStream
  • Swift_InputByteStream
  • Swift_OutputByteStream
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class Swift_ByteStream_ArrayByteStream

Allows reading and writing of bytes to and from an array.

Swift_ByteStream_ArrayByteStream implements Swift_InputByteStream, Swift_OutputByteStream
Package: Swift\ByteStream
Author: Chris Corbyn
Located at wa-system/vendors/swift/classes/Swift/ByteStream/ArrayByteStream.php
Methods summary
public
# __construct( mixed $stack = null )

Create a new ArrayByteStream.

Create a new ArrayByteStream.

If $stack is given the stream will be populated with the bytes it contains.

Parameters

$stack
mixed
$stack of bytes in string or array form, optional
public string
# 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

Throws

Swift_IoException

Implementation of

Swift_OutputByteStream::read()
public integer
# write( string $bytes )

Writes $bytes to the end of the stream.

Writes $bytes to the end of the stream.

Parameters

$bytes
string
$bytes

Returns

integer

Throws

Swift_IoException

Implementation of

Swift_InputByteStream::write()
public
# commit( )

Not used.

Not used.

Throws

Swift_IoException

Implementation of

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

Attach $is to this stream.

Attach $is to this stream.

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

Parameters

$is
Swift_InputByteStream
$is

Implementation of

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

Remove an already bound stream.

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
Swift_InputByteStream
$is

Implementation of

Swift_InputByteStream::unbind()
public boolean
# setReadPointer( integer $byteOffset )

Move the internal read pointer to $byteOffset in the stream.

Move the internal read pointer to $byteOffset in the stream.

Parameters

$byteOffset
integer
$byteOffset

Returns

boolean

Throws

Swift_IoException

Implementation of

Swift_OutputByteStream::setReadPointer()
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()
Properties summary
private string[] $_array array()
#

The internal stack of bytes.

The internal stack of bytes.

private integer $_arraySize 0
#

The size of the stack

The size of the stack

private integer $_offset 0
#

The internal pointer offset.

The internal pointer offset.

private Swift_InputByteStream[] $_mirrors array()
#

Bound streams.

Bound streams.

My fork of Webasyst Framework API documentation generated by ApiGen 2.8.0