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

  • Authentication
  • Authentication_Token
  • Autoloader
  • Cache
  • Charset
  • ClassDescriptor
  • Closure
  • 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_Iterator
  • 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
  • String
  • 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
  • UseVersion
  • Version

Functions

  • ns_expand
  • ns_file_exists
  • ns_get_version
  • ns_resolve

Namespace Core

Namespaces summary

Core\Authentication
Core\Cache
Core\Charset
Core\Configuration
Core\Controller
Core\Converter
Core\Decoder
Core\Encoder
Core\Env
Core\Exception
Core\Exchange
Core\Field
Core\Filter
Core\Formatter
Core\Hash
Core\Loader
Core\Locale
Core\Log
Core\Module
Core\PDF
Core\Plugin
Core\Query
Core\Server
Core\Session
Core\Set
Core\Storage
Core\Stream
Core\String
Core\Translation
Core\URI
Core\Version
Core\View

Classes summary

Authentication Generic authentication interface.
Authentication_Token Authentication token of a successful authentication attempt.
Autoloader

Extensible auto-loader for Core classes with support for user-defined callbacks to support arbitrary file architectures.

Cache

Provides a cache for arbitrary data and driver-based storage. Cache entries are identified by a class and key that together form a unique hash. Additionally, a timestamp is stored with each entry and optionally a maximum age, after which entries are deleted.

Charset

Provides support for handling different kinds of characters sets: A basic set of string functions, conversion methods and character constants.

ClassDescriptor Manages class extensions properties.
Closure

Interface to PHP native Closure instances. Embeds a Closure instance (aka lambda function) and provides an extended user interface including code and parameter retrieval and serialisation.

Controller

A controller implements application logic based on models and feeds data to views for rendering a corresponding output.

Converter

A Converter takes a constant data source and returns a transformed value. The interface is very similar to an Encoder or Decoder, but a Converter is not designed to work on streaming data sources. Additionally, the performed transformation is in general not reversible.

Date Helper class for standard HTTP date formats.
Decoder Data decoder interface with optional data source for transparent data decoding.
Delegate

A delegate is a collection of callbacks that are invoked sequentially when the delegate itself is invoked.

Dispatcher

A Dispatcher is responsible for delegating control to the controller action as specified by the request.

Encoder

Provides encoding of arbitrary data. Encoders are commonly used to enable transparent data processing, such as escaping of HTML CDATA, password hashing, conversion of data streams. Additionally, encoder instances can be chained together to provide complex data conversion schemes.

Env Provides access to environmental values.
Env_Field Environmental value group interface. Base class for simple global arrays.
Env_File Extended value that represents an uploaded file.
Env_FileList Extended value that represents a list of uploaded files.
Env_Request Combined POST and GET globals access.
Env_SERVER Provides access to the server environment.
Exchange Data exchange facility to im- and export arbitrary data formats.
Fault

Global error handling (triggered errors and uncaught exceptions) and backtrace formatting.

Field

A Field is a proxy object to an immutable (dynamic) data storage. Data storage access is available via array access or the Core\Field::getDataForKey() method. Field properties are separated from the data core, accessible through properties and KVC access inherited by Core\Set, and contain object specific values.

Filter Value filtering with chain and data source overlay support.
Filter_Value Represents a filtered value.
Formatter

A Formatter transforms arbitrary data sources into a generally readable format according to a chained data output interface (e.g. a view).

Hash Array object implementation with full Core support.
IP Provides parsing and transformation support for IPv4 and IPv6 addresses.
Loader

Module resolver and loader. Also used by the auto-loader. Keeps track of loaded modules and automatically records time and memory states for modules if enabled in Core configuration.

Locale Independent LDML-based access to locale information with cache integration.
Locale_Iterator

Iterator for locales. Use Locale::iterator() to retrieve a locale iterator instance.

Locale_Node

Data node for parsed LDML locale data. Attributes are accessible via KDC field access, value and children via the corresponding KVC properties.

Log Driver-based logging interface with support for chaining.
Module Represents Core-compatible modules and provides an advanced query interface.
Module_Iterator Module iterator.
Nothing Singleton class that represents the null value.
Object

Object is the root class for most core class hierarchies. Object provides key-value coding support methods and generic helpers for all derived classes. Also, all Core\Object derived classes inherit a default implementation to the Core\Chainable interface.

OS Collection of OS-related helper methods.
Plugin

A plugin provides means to extend an application with new functionality without requiring changes to the application itself.

Profiler Profiler take snapshots of runtime and overall memory footprint.
Query HTTP query parser and builder.
Registry Central database for shared objects.
Resource Helper class to determine types of resources.
Server

A server offers services via a single connection method. If multiple connection methods (such as multiple ports) are offered, each is represented by an own server instance.

Session Session interface.
Session_Token Session token interface.
Set An immutable complex object that provides KVC-based property access.
Storage Base class for storage driver implementations and driver factory interface.
Storage_Result Base class for storage query execution results.
Storage_Statement Base class for prepared storage query statements.
Stream Streaming interface base class.
String

A String object stores a native PHP string and implements an advanced interface. Strings are per default immutable. For a mutable String object, see String\Mutable.

Translation

Provides translation of arbitrary data identified by keys with support for fallback locales.

URI Represents an immutable uniform resource identifier (URI).
URI_Parameters Holds parsed parameters from an URI instance.
UUID Universally unique identifier.
Value A value represents any type of data and offers data conversion.
Version Version parsing and comparison helper.
View

Base class for views with integrated support for data encoders, a shared proxy view, automated renderer delegation and chained translator instance.

Interfaces summary

Accessor

Interface to provide read access on (dynamic) properties. A class that implements this interface enables PHP-syntax property access to properties, which may not necessarily have been defined as class members. Additionally, checking the existence of properties via the library function isset() is possible.

Chainable Chainable classes accept connections to foreign classes via a unified interface.
Comparable

Comparable conform classes implement a comparator method to compare two objects to determine an ordering for a set of objects. Implementations may decide to allow comparison to any type of value.

Configurable Configurable classes offer a generic interface to set options.
Equality

Equality conform classes implement an equality test between two objects. Implementations may decide to allow equality tests with any type of value.

Identity

Identity conform classes implement an identity test between two objects. This extends standard equality comparison to include more strict rules, e.g. the type of the compared objects must match.

Inquiry

Interface to provide read access to data fields. A class that implements this interface also implements standard PHP array access on its data fields, including support for isset() calls.

Masquerade Masquerades enable value masquerade using a unified interface.
Mutator

Interface to provide write access on (dynamic) properties. A class that implements this interface enables PHP-syntax property assignments for attributes that are not restricted to class members. Additionally, un-setting properties via the library function unset() is possible.

SeekableStream Interface implemented by streams that support seeking.
Storable

Interface for improved storage support. Storable instances implement data encoder and decoder methods to enable compact data storage, primarily used with Core Storage.

Variator Interface to provide write access to (dynamic) data fields.

Exceptions summary

Exception

Base exception for all Core exceptions. Equals the default SPL exception but enables enhanced Core\Fault report functionality.

Constants summary

Copyright Core copyright string for display purposes.
ProductName Core product name string for display purposes.
UseVersion

Core version configured for use. Set in configuration to force a specific Core version. Otherwise the value is automatically set by the Version Manager. In flat version mode, the value is set to false.

Version

Core version string for display purposes. Includes major, minor and release version plus revision.

Functions summary

ns_expand

Updates namespace identifier with version subdirectory, if any. The provided namespace name is first processed by Core\ns_get_version(); if the returned value yields VM usage, the namespace identifier is suffixed by "/vX", where "X" denotes the determined version number to use (w.r.t. version limits defined for the namespace in question).

ns_file_exists

Equals file_exists() but resolves relative paths using the PHP include path.

ns_get_version Retrieves the library version number to use for a given namespace.
ns_resolve Resolves a filename against the include path.
xplo.re Medusa Core Framework 3.1 API documentation generated by ApiGen