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

  • coreui
  • html
  • htmlbuilder
  • plain
  • yui

Class html

Simple string-based HTML renderer.

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\Field\Mutable implements Core\Variator
Extended by Core\View
Extended by Core\View\Driver\html

Direct known subclasses

Core\View\Driver\coreui, Core\View\Driver\htmlbuilder

Namespace: Core\View\Driver
Package: Core\View
Link: Transparent Content Negotiation in HTTP
Link: HTTP Extensions for Distributed Authoring – WEBDAV
Link: An HTTP Extension Framework
Link: Delta encoding in HTTP
Link: HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)
Link: Binding Extensions to Web Distributed Authoring and Versioning (WebDAV)
Link: Additional HTTP Status Codes
Link: Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content
Link: Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests
Link: Hypertext Transfer Protocol (HTTP/1.1): Range Requests
Link: Hypertext Transfer Protocol (HTTP/1.1): Authentication
Link: The Hypertext Transfer Protocol Status Code 308 (Permanent Redirect)
Link: Hypertext Transfer Protocol Version 2 (HTTP/2)
Link: Hypertext Transfer Protocol (HTTP) Client-Initiated Content-Encoding
Since: 3.0
Requires: PHP 5.3
Version: 1.1
Located at View/Driver/html.inc.php

Methods summary

public
# __construct( Core\URI $uri )

Initialises a new View instance. Sets the HTML encoder as the default encoder if no encoder is specified in the URI.

Initialises a new View instance. Sets the HTML encoder as the default encoder if no encoder is specified in the URI.

Parameters

$uri
Driver configuration URI.

Since

3.0

Overrides

Core\View::__construct
public
# append( string $html )

Appends HTML code verbatim to the internal buffer.

Appends HTML code verbatim to the internal buffer.

Parameters

$html
HTML to append to buffer.

Returns


$this

Since

3.0
public
# clear( )

Resets the internal HTML buffer to null.

Resets the internal HTML buffer to null.

Returns


$this

Since

3.1

Overrides

Core\View::clear
public boolean
# render( )

Sets the context type to HTML text including the currently active character set and the response code according to the currently set response code, if no headers have yet been sent, and echoes the internal HTML buffer to the standard output.

Sets the context type to HTML text including the currently active character set and the response code according to the currently set response code, if no headers have yet been sent, and echoes the internal HTML buffer to the standard output.

Returns

boolean

See

Charset::active()

Since

3.0

Overrides

Core\View::render
public
# setDataForUndefinedKey( string $key, mixed $value )

Adds a KDC value to the view. Additionally, if the key is the empty string, the value is added to the internal HTML buffer. This allows the use of the array-append operator to append values to the internal HTML buffer verbatim.

Adds a KDC value to the view. Additionally, if the key is the empty string, the value is added to the internal HTML buffer. This allows the use of the array-append operator to append values to the internal HTML buffer verbatim.

Parameters

$key
Data field key.
$value
Value to store.

Throws

Exception\UndefinedKey
No data field identified by the given key exists.

Since

3.0

Overrides

Core\View::setDataForUndefinedKey
public boolean
# setResponseCode( integer $code )

Sets the HTTP status code of the response.

Sets the HTTP status code of the response.

Parameters

$code
HTTP status code to set.

Returns

boolean

true, if the new status code has been accepted and set, otherwise false. A status code is only accepted, if it is defined in the static array of known response codes.

Since

3.1

Methods inherited from Core\View

autocreate(), chain(), derive(), encode(), encoder(), uri(), url()

Methods inherited from Core\Field\Mutable

offsetSet(), offsetUnset(), setDataForKey(), setDataForKeys(), setKeyMasquerade(), updateMasqueradedKeys()

Methods inherited from Core\Field

getDataForKey(), getDataForKeys(), getDataForUndefinedKey(), issetDataForKey(), offsetExists(), offsetGet()

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

EncoderParameter

Constants inherited from Core\Object

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

Properties summary

protected static string[] $_v_responseCodes

List of known HTTP status response codes based on the status code defined by the Hypertext Transfer Protocol (HTTP) Status Code Registry.

List of known HTTP status response codes based on the status code defined by the Hypertext Transfer Protocol (HTTP) Status Code Registry.

Link

http://www.iana.org/assignments/http-status-codes/http-status-codes.xml

Since

3.1

Version

2015-12-21
# array ( // Informational: Request received, continuing process. 100 => 'Continue', // RFC 7231, Section 6.2.1 101 => 'Switching Protocols', // RFC 7231, Section 6.2.2 102 => 'Processing', // RFC 2518 // Success: The action was successfully received, understood, and // accepted. 200 => 'OK', // RFC 7231, Section 6.3.1 201 => 'Created', // RFC 7231, Section 6.3.2 202 => 'Accepted', // RFC 7231, Section 6.3.3 203 => 'Non-Authoritative Information', // RFC 7231, Section 6.3.4 204 => 'No Content', // RFC 7231, Section 6.3.5 205 => 'Reset Content', // RFC 7231, Section 6.3.6 206 => 'Partial Content', // RFC 7233, Section 4.1 207 => 'Multi-Status', // RFC 4918 208 => 'Already Reported', // RFC 5842 226 => 'IM Used', // RFC 3229 // Redirection: Further action must be taken in order to complete // the request. 300 => 'Multiple Choices', // RFC 7231, Section 6.4.1 301 => 'Moved Permanently', // RFC 7231, Section 6.4.2 302 => 'Found', // RFC 7231, Section 6.4.3 303 => 'See Other', // RFC 7231, Section 6.4.4 304 => 'Not Modified', // RFC 7232, Section 4.1 305 => 'Use Proxy', // RFC 7231, Section 6.4.5 306 => 'Reserved', // RFC 7231, Section 6.4.6 307 => 'Temporary Redirect', // RFC 7231, Section 6.4.7 308 => 'Permanent Redirect', // RFC 7538 // Client Error: The request contains bad syntax or cannot be // fulfilled. 400 => 'Bad Request', // RFC 7231, Section 6.5.1 401 => 'Unauthorized', // RFC 7235, Section 3.1 402 => 'Payment Required', // RFC 7231, Section 6.5.2 403 => 'Forbidden', // RFC 7231, Section 6.5.3 404 => 'Not Found', // RFC 7231, Section 6.5.4 405 => 'Method Not Allowed', // RFC 7231, Section 6.5.5 406 => 'Not Acceptable', // RFC 7231, Section 6.5.6 407 => 'Proxy Authentication Required', // RFC 7235, Section 3.2 408 => 'Request Timeout', // RFC 7231, Section 6.5.7 409 => 'Conflict', // RFC 7231, Section 6.5.8 410 => 'Gone', // RFC 7231, Section 6.5.9 411 => 'Length Required', // RFC 7231, Section 6.5.10 412 => 'Precondition Failed', // RFC 7232, Section 4.2 413 => 'Payload Too Large', // RFC 7231, Section 6.5.11 414 => 'URI Too Long', // RFC 7231, Section 6.5.12 415 => 'Unsupported Media Type', // RFC 7231, Section 6.5.13; RFC 7694, Section 3 416 => 'Range Not Satisfiable', // RFC 7233, Section 4.4 417 => 'Expectation Failed', // RFC 7231, Section 6.5.14 421 => 'Misdirected Request', // RFC 7540, Section 9.1.2 422 => 'Unprocessable Entity', // RFC 4918 423 => 'Locked', // RFC 4918 424 => 'Failed Dependency', // RFC 4918 426 => 'Upgrade Required', // RFC 7231, Section 6.5.15 428 => 'Precondition Required', // RFC 6585 429 => 'Too Many Requests', // RFC 6585 431 => 'Request Header Fields Too Large', // RFC 6585 // Server Error: The server failed to fulfill an apparently valid // request. 500 => 'Internal Server Error', // RFC 7231, Section 6.6.1 501 => 'Not Implemented', // RFC 7231, Section 6.6.2 502 => 'Bad Gateway', // RFC 7231, Section 6.6.3 503 => 'Service Unavailable', // RFC 7231, Section 6.6.4 504 => 'Gateway Timeout', // RFC 7231, Section 6.6.5 505 => 'HTTP Version Not Supported', // RFC 7231, Section 6.6.6 506 => 'Variant Also Negotiates', // RFC 2295 507 => 'Insufficient Storage', // RFC 4918 508 => 'Loop Detected', // RFC 5842 510 => 'Not Extended', // RFC 2774 511 => 'Network Authentication Required', // RFC 6585 )
protected string $_v_buffer

Internal rendering buffer.

Internal rendering buffer.

Since

3.0
#
protected integer $_v_responseCode

Currently set response code.

Currently set response code.

Since

3.1
# 200

Properties inherited from Core\View

$_encoder, $_v_parameters, $_v_proxy, $_v_renderers, $_v_translator, $_v_uri

Properties inherited from Core\Field\Mutable

$_v_masqueradedKeys

Properties inherited from Core\Field

$_v_data

Magic properties

public read-only string $buffer

Internal rendering buffer. null, if no contents have been added to the buffer or the buffer has been cleared.
public read-only integer $responseCode

Currently set numeric HTTP response code. Defaults to 200 ("OK").

Magic properties inherited from Core\View

$encoder, $parameters, $proxy, $renderers, $translator, $uri

Magic properties inherited from Core\Field\Mutable

$masqueradedKeys

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