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

  • Authentication
  • Authentication_Token
  • AutoLoader
  • Cache
  • Charset
  • ClassDescriptor
  • Closure
  • Configuration
  • Controller
  • Converter
  • Date
  • Decoder
  • Delegate
  • Dispatcher
  • Encoder
  • Env
  • Env_Field
  • Env_File
  • Env_FileList
  • Env_Request
  • Env_SERVER
  • Exchange
  • Fault
  • Field
  • Filter
  • Filter_Value
  • Formatter
  • Hash
  • IP
  • Loader
  • Locale
  • Locale_Node
  • Log
  • Module
  • Module_Iterator
  • Nothing
  • Object
  • OS
  • Plugin
  • Profiler
  • Query
  • Registry
  • Resource
  • Server
  • Session
  • Session_Token
  • Set
  • Storage
  • Storage_Result
  • Storage_Statement
  • Stream
  • Translation
  • URI
  • URI_Parameters
  • UUID
  • Value
  • Version
  • View

Interfaces

  • Accessor
  • Chainable
  • Comparable
  • Configurable
  • Equality
  • Identity
  • Inquiry
  • Masquerade
  • Mutator
  • SeekableStream
  • Storable
  • Variator

Exceptions

  • Exception

Constants

  • Copyright
  • ProductName
  • Version

Class Decoder

Data decoder interface to decode arbitrary data previously encoded with a corresponding encoder and optional support for data sources to provide transparent data decoding.

Core\Object implements Core\Chainable
Extended by Core\Set implements Core\Accessor
Extended by Core\Set\Mutable implements Core\Mutator
Extended by Core\Field implements Core\Inquiry
Extended by Core\Decoder

Direct known subclasses

Core\Decoder\Driver\base16, Core\Decoder\Driver\base64, Core\Decoder\Driver\rawurl, Core\Decoder\Driver\serialize, Core\Decoder\Driver\url, Core\Decoder\Driver\uu, Core\Decoder\Driver\base64s, Core\Decoder\Driver\boolean, Core\Decoder\Driver\charset, Core\Decoder\Driver\decimal, Core\Decoder\Driver\delegate, Core\Decoder\Driver\html, Core\Decoder\Driver\integer, Core\Decoder\Driver\passthrough

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

Methods summary

public mixed
# __invoke( string $data )

Object invocation variant of Core\Decoder::decode().

Object invocation variant of Core\Decoder::decode().

Parameters

$data
Data to decode.

Returns

mixed
Decoded data.

Since

3.0
public static Core\Decoder
# autocreate( Core\URI $uri )

Parameters

$uri
Decoder configuration.

Returns

Core\Decoder

Since

3.0
public boolean
# chain( Core\Chainable $object, array $flags = null )

Chains another object to this decoder instance.

Chains another object to this decoder instance.

Parameters

$object

Object to chain to this instance. Supports the following classes:

  • Core\Decoder

    Sets or adds a new successor. If a successor is already set and the boolean replace flag is not set to true, the chain call is delegated to the chain method of the successor. Otherwise a new successor for this instance is set.

  • Core\Inquiry

    Attaches a new data source to this instance.

$flags
Hash of flags. See object parameter description for details.

Returns

boolean
true on success, otherwise false.

Throws

Core\Exception\InvalidArgument
Class of provided object is not supported.

Since

3.0

Overrides

Core\Object::chain
public mixed
# decode( string $data )

Passes data through the full decoder chain and returns the result.

Passes data through the full decoder chain and returns the result.

Parameters

$data
Data to decode.

Returns

mixed
Decoded data.

Since

3.0
public mixed
# getDataForUndefinedKey( string $key )

Parameters

$key
Key of data source entry.

Returns

mixed
Decoded value from associated data source with the given key.

Throws

Core\Exception\Loader
Core\Exception\UndefinedKey
No data source assigned to decoder.

Since

3.0

Overrides

Core\Field::getDataForUndefinedKey

Methods inherited from Core\Field

getDataForKey(), getDataForKeys(), issetDataForKey(), offsetExists(), offsetGet(), offsetSet(), offsetUnset()

Methods inherited from Core\Set\Mutable

__set(), __unset()

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\Object

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

Properties summary

protected Core\Inquiry $_v_dataSource

Assigned data source or null if none is set.

Assigned data source or null if none is set.

Since

3.0
#
protected Core\Decoder $_v_successor

Subsequent (chained) decoder layer or null if none is set.

Subsequent (chained) decoder layer or null if none is set.

Since

3.0
#

Properties inherited from Core\Field

$_v_data

Magic properties

public read-only Core\Inquiry $dataSource

Assigned data source or null if none is set.
public read-only Core\Decoder $successor

Subsequent (chained) decoder layer or null if none is set.

Magic properties inherited from Core\Field

$data

Magic properties inherited from Core\Object

$hash, $uuid

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