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

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

Class escape

Escapes an input string with respect to a given source character set.

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

Direct known subclasses

Core\Encoder\Driver\escapestring

Namespace: Core\Encoder\Driver
Package: Core\Encoder
Since: 3.0
Requires: PHP 5.3, MBString (optional, for character set support)
Version: 1.1
Located at Encoder/Driver/escape.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.

Initialises new encoder instance and automatically initialises and chains a successor encoder if specified by URI.

Parameters

$uri
Reference to describing URI instance from factory.

Since

3.0

Overrides

Core\Encoder::__construct
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.0

Methods inherited from Core\Encoder

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

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 string $_v_charset

Configured name of character set to apply to strings for encoding. If not set, the character set will be guessed on each encoder call. If the supplied string and the character set do not match, the string is encoded on a per-byte basis. To treat all strings as binary (i.e. basically ASCII), set the character set to false.

Configured name of character set to apply to strings for encoding. If not set, the character set will be guessed on each encoder call. If the supplied string and the character set do not match, the string is encoded on a per-byte basis. To treat all strings as binary (i.e. basically ASCII), set the character set to false.

Since

3.0
#

Properties inherited from Core\Encoder

$_v_parameters, $_v_successor, $_v_uri

Properties inherited from Core\Field

$_v_data

Magic properties

public read-only string $charset

Name of character set expected for string arguments.

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.2 API documentation generated by ApiGen