xplo.re Medusa Core Framework 3.2
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Event
  • Todo
  • Download

Namespaces

  • Core
    • Authentication
      • Auto
        • Driver
      • Driver
    • Cache
      • Driver
    • Charset
      • Driver
    • Configuration
      • Driver
    • Controller
    • Converter
      • Driver
    • Decoder
      • Driver
    • Encoder
      • Driver
    • Env
      • Authentication
      • Locale
      • Proxy
      • Server
        • HTTP
        • Redirect
        • X
    • Exception
    • Exchange
      • Driver
    • Fault
      • Formatter
        • Driver
      • Incident
        • Exception
      • Reporter
        • Driver
    • Field
    • Filter
      • Driver
    • Formatter
      • Driver
        • coreuimarkup
          • Token
    • Hash
    • Loader
    • Locale
    • Log
      • Driver
    • Module
      • Dependency
        • Requirement
          • Core
          • PHP
      • Linkage
        • Driver
    • PDF
    • Plugin
    • Query
      • Driver
    • Server
      • Driver
    • Session
      • Driver
    • Set
    • Storage
      • Driver
      • Field
        • Element
    • Stream
      • Driver
    • String
    • Translation
      • Driver
      • Language
        • Driver
    • Type
    • URI
      • Driver
    • Version
    • View
      • Driver
        • coreui
          • Control
            • Button
            • Table
          • Element
        • htmlbuilder
          • Tags
        • yui
          • Modules
  • None
  • PHP

Classes

  • Buildin

Class Buildin

PHP build-in stream interface.

Core\Object implements Core\Chainable
Extended by Core\Set implements Core\Accessor
Extended by Core\Stream
Extended by Core\Stream\Buildin implements Core\SeekableStream

Direct known subclasses

Core\Stream\Driver\file, Core\Stream\Driver\input, Core\Stream\Driver\memory, Core\Stream\Driver\output, Core\Stream\Driver\stderr, Core\Stream\Driver\stdin, Core\Stream\Driver\stdout, Core\Stream\Driver\swap

Abstract
Namespace: Core\Stream
Package: Core\Stream
Since: 3.0
Requires: PHP 5.3
Version: 1.0
Located at Stream/Buildin.inc.php

Methods summary

public
# __construct( Core\URI $uri )

Initialises a new build-in stream interface.

Initialises a new build-in stream interface.

Parameters

$uri
URI instance describing the stream interface to initialise.

Since

3.0

Overrides

Core\Stream::__construct
public
# dismantle( )

Returns


$this

Since

3.0

Overrides

Core\Stream::dismantle
public
# establish( integer $access )

Establishes the stream interface.

Establishes the stream interface.

Parameters

$access

Returns


$this

Since

3.0

Overrides

Core\Stream::establish
public boolean
# flush( )

Flushes any stream-specific output buffers.

Flushes any stream-specific output buffers.

Returns

boolean
true on success, otherwise false.

Since

3.0

Overrides

Core\Stream::flush
public integer|null
# length( )

Returns the size of the Stream in units. The size unit of build-in streams is a byte.

Returns the size of the Stream in units. The size unit of build-in streams is a byte.

Returns

integer|null
Size of stream in units or null, if length is unknown.

Since

3.0
public mixed
# read( integer $units )

Reads from stream.

Reads from stream.

Parameters

$units
Length in units to read from stream.

Returns

mixed
Returns segments read from stream or null on error.

Since

3.0
public mixed|null
# readln( integer $limit = null )

Reads a line from the stream.

Reads a line from the stream.

Parameters

$limit
Optional. Maximum number of units to read from stream.

Returns

mixed|null
Returns segments read from stream or null on error.

Remark

Chained Decoder instances are applied equally to the standard Core\Stream\Buildin::read() method (with the ending newline character excluded).


See

Core\Stream\Buildin::read()

Since

3.0

Overrides

Core\Stream::readln
public
# seek( integer $units )

Moved position in stream relative to the current position.

Moved position in stream relative to the current position.

Parameters

$units
Number of units to seek forward or backward if value is negative.

Since

3.1

Implementation of

Core\SeekableStream::seek()
public
# seekTo( integer $units_ )

Moved position in stream to an absolute position.

Moved position in stream to an absolute position.

Parameters

$units_

$position Position in units to set stream to. If negative, the absolute position is relative from the end of the stream.

Since

3.1

Implementation of

Core\SeekableStream::seekTo()
public integer
# write( mixed $segments, integer $units = null )

Writes to stream.

Writes to stream.

Parameters

$segments
Segments to write to stream.
$units
Maximum number of units to write to stream.

Returns

integer
Returns the number of units written to the stream.

Since

3.0

Methods inherited from Core\Stream

__destruct(), _verifyAccess(), autocreate(), canCreate(), canRead(), canStat(), canTruncate(), canWrite(), chain(), readRemainingSegments(), stderr(), stdin(), stdout(), writeln()

Methods inherited from Core\Set

__get(), __isset()

Methods inherited from Core\Object

__autocreateFactory(), __call(), __processParameters(), __toString(), attachMethod(), getValueForKey(), getValueForKeyPath(), getValueForUndefinedKey(), hash(), issetValueForKey(), setValueForKey(), setValueForKeyPath(), setValueForUndefinedKey(), uuid()

Constants summary

Constants inherited from Core\Stream

CharsetParameter, Create, Read, Stat, Truncate, Write

Constants inherited from Core\Object

AnyParameterType, AutochainParameterType, AutocreateParameterType, BooleanParameterType, CharParameterType, EnumParameterType, IntegerParameterType, RealParameterType, StringParameterType, UserParameterType

Properties summary

protected resource $_v_handle

File handle.

File handle.

Since

3.0
#
protected string $_v_wrapperTarget

Wrapper target URL string.

Wrapper target URL string.

Since

3.0
#

Properties inherited from Core\Stream

$_v_access, $_v_decoder, $_v_encoder, $_v_established, $_v_onDismantle, $_v_parameters, $_v_uri

Magic properties

public read-only resource $handle

Internal PHP file handle.
public read-only string $wrapperTarget

Target URL string.

Magic properties inherited from Core\Stream

$access, $canCreate, $canRead, $canStat, $canTruncate, $canWrite, $decoder, $encoder, $established, $length, $onDismantle, $parameters, $uri

Magic properties inherited from Core\Object

$hash, $uuid

xplo.re Medusa Core Framework 3.2 API documentation generated by ApiGen