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

  • html
  • plain

Class html

Formats incident summary and trace as HTML. To further format the output, a stylesheet should be used.

Core\Object implements Core\Chainable
Extended by Core\Set implements Core\Accessor
Extended by Core\Fault\Formatter
Extended by Core\Fault\Formatter\Driver\html
Namespace: Core\Fault\Formatter\Driver
Package: Core\Fault\Formatter
Since: 3.2
Requires: PHP 5.3
Version: 1.0
Located at Fault/Formatter/Driver/html.inc.php

Methods summary

public string
# contentType( )

Returns the content type of the output generated by the formatter. This is used by some reporters that allows a flexible configuration of the formatter being used but need to know the type of output generated.

Returns the content type of the output generated by the formatter. This is used by some reporters that allows a flexible configuration of the formatter being used but need to know the type of output generated.

Returns

string
Content type of generated output.

Since

3.2
public string
# encodeCDATA( $string )

Encodes CDATA for output. Takes the current character set into account if available.

Encodes CDATA for output. Takes the current character set into account if available.

Parameters

$string
to encode.

Returns

string
Encoded string.

Since

3.2

Overrides

Core\Fault\Formatter::encodeCDATA
public mixed
# format( Core\Fault\Incident $incident )

Formats an incident.

Formats an incident.

Parameters

$incident
Incident to format.

Returns

mixed
Formatted incident.

Since

3.2
public mixed
# formatTrace( array $trace )

Formats the trace of an incident.

Formats the trace of an incident.

Parameters

$trace
Trace to format.

Returns

mixed
Formatted incident trace.

Since

3.2
public string
# stylesheet( )

Returns a stylesheet declaration with the definitions for all CSS classes used by the formatter.

Returns a stylesheet declaration with the definitions for all CSS classes used by the formatter.

Returns

string

Stylesheet declaration. Either a link tag to an external stylesheet or a full self-contained style tag. If no stylesheet is found, null is returned instead.

Since

3.2
public string
# stylesheetPath( string $type = null )

Retrieves the path of the stylesheet file that contains definitions for all CSS classes used by the formatter.

Retrieves the path of the stylesheet file that contains definitions for all CSS classes used by the formatter.

Parameters

$type

Type of stylesheet path to return or URL of stylesheet to use. See corresponding configuration constants for a list of supported types. Defaults to the module resource path.

Returns

string
Path name of stylesheet path. If the

Methods inherited from Core\Fault\Formatter

__construct(), autocreate(), charset(), formatFilename()

Methods inherited from Core\Set

__get(), __isset()

Methods inherited from Core\Object

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

Constants summary

string CDNStylesheetPath

Retrieves the stylesheet CDN path.

Retrieves the stylesheet CDN path.

Since

3.2
# 'cdn'
string ModuleStylesheetPath

Retrieves the local module resource stylesheet path.

Retrieves the local module resource stylesheet path.

Since

3.2
# 'module'

Constants inherited from Core\Object

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

Properties summary

Properties inherited from Core\Fault\Formatter

$_charset

Magic properties

public read-only string $stylesheet

Full stylesheet definition for HTML generated by the formatter.
public read-only string $stylesheetPath

Path of stylesheet resource for HTML generated by the formatter.

Magic properties inherited from Core\Fault\Formatter

$charset, $contentType

Magic properties inherited from Core\Object

$hash, $uuid

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