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

Namespaces

  • Core
    • Authentication
      • Auto
        • Driver
      • Driver
    • Cache
      • Driver
    • Charset
      • Driver
    • Configuration
    • Controller
    • Converter
      • Driver
    • Decoder
      • Driver
    • Encoder
      • Driver
    • Env
      • Authentication
      • Locale
      • Proxy
      • Server
        • HTTP
        • Redirect
        • X
    • Exception
    • Exchange
      • 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
    • URI
      • Driver
    • Version
    • View
      • Driver
        • coreui
          • Control
            • Button
            • Table
          • Element
        • htmlbuilder
          • Tags
        • yui
          • Modules
  • None
  • PHP

Classes

  • base64
  • base64s
  • boolean
  • charset
  • clear
  • crc32
  • decimal
  • delegate
  • escape
  • hash
  • html
  • integer
  • md5
  • md5sum
  • passthrough
  • qp
  • rawurl
  • serialize
  • sha
  • sha1
  • sha1sum
  • smd5
  • split
  • ssha
  • taggedhash
  • url
  • uu
  • xml

Class taggedhash

Implements multiple hash encodings with hash method tagging, cf. RFC 2307. The encoded hash is prefixed by the hash method used in curly brackets; all encoding drivers are supported. The hash itself is stored in binary format, encoded in Base-64.

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\Encoder
Extended by Core\Encoder\Driver\taggedhash
Namespace: Core\Encoder\Driver
Package: Core\Encoder
Link: RFC 2307: An Approach for Using LDAP as a Network Information Service
Since: 3.1
Requires: PHP 5.3
Version: 1.0
Located at Encoder/Driver/taggedhash.inc.php

Methods summary

public
# __construct( Core\URI $uri )

Initialises new encoder instance and automatically initialises and chains a successor encoder if specified by URI. Additionally initialises default encoder from URI path.

Initialises new encoder instance and automatically initialises and chains a successor encoder if specified by URI. Additionally initialises default encoder from URI path.

Parameters

$uri
Reference to describing URI instance from factory.

Since

3.1

Overrides

Core\Encoder::__construct
public Core\URI
# decoderURI( )

Generally, as this encoding depends on other encoders, encoded values cannot be decoded.

Generally, as this encoding depends on other encoders, encoded values cannot be decoded.

Returns

Core\URI
Yields null.

Since

3.1

Overrides

Core\Encoder::decoderURI
public boolean
# reversible( )

Generally, as this encoding depends on other encoders, it is not reversible.

Generally, as this encoding depends on other encoders, it is not reversible.

Returns

boolean
Yields false.

Since

3.1

Overrides

Core\Encoder::reversible
public boolean
# verify( string $input, string $output )

Verifies that this encoder applied to given input data yields the given output data. Verification silently fails, if no matching driver for the embedded encoding scheme is found.

Verifies that this encoder applied to given input data yields the given output data. Verification silently fails, if no matching driver for the embedded encoding scheme is found.

Parameters

$input
Raw data to verify.
$output
Expected output data to verify against.

Returns

boolean
true, if the input matches the output, otherwise false.

Since

3.1

Overrides

Core\Encoder::verify
protected string
# _encode( string $data )

Encoder stub used by drivers to implement specific encodings.

Encoder stub used by drivers to implement specific encodings.

Parameters

$data
Data to encode.

Returns

string
Encoded data.

Since

3.1

Methods inherited from Core\Encoder

__invoke(), autocreate(), chain(), decoderChainURI(), encode(), encoderChainURI(), getDataForUndefinedKey(), resolveDecoder(), resolveDecoderChain()

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

SuccessorParameter

Constants inherited from Core\Object

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

Properties summary

protected Core\Encoder $_v_defaultEncoder

KVC property.

KVC property.

Since

3.1
#
protected string $_v_defaultScheme

KVC property

KVC property

Since

3.1
#

Properties inherited from Core\Encoder

$_v_parameters, $_v_successor, $_v_uri

Properties inherited from Core\Field

$_v_data

Magic properties

public read-only Core\Encoder $defaultEncoder

Reference to encoder instance used by default to encode data.
public read-only string $defaultScheme

Scheme of default encoder used to encode data.

Magic properties inherited from Core\Encoder

$dataSource, $parameters, $successor, $uri

Magic properties inherited from Core\Field

$data

Magic properties inherited from Core\Object

$hash, $uuid

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