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

  • Language
  • Language_Node

Class Language_Node

Language nodes represent an entry of the hierarchical language repository data. They may represent a node and hence allow further queries relative to the key path they represent.

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\Translation\Language_Node

Direct known subclasses

Core\Translation\Language\Driver\xml_Node

Abstract
Namespace: Core\Translation
Package: Core\Translation\Language
Since: 3.1
Requires: PHP 5.3
Version: 1.0
Located at Translation/Language.inc.php

Methods summary

public
# __construct( Core\Translation\Language_Node $parentNode = null, string $path = null )

Parameters

$parentNode
Instance of parent language node.
$path
Language repository key path relative to the parent node.

Since

3.1
public Core\Translation\Language_Node
# __invoke( string $path )

Invocation shortcut for Core\Translation\Language_Node::query().

Invocation shortcut for Core\Translation\Language_Node::query().

Parameters

$path
See Core\Translation\Language_Node::query().

Returns

Core\Translation\Language_Node
Language repository entry identified by the provided key path.

Since

3.1
public string
# __toString( )

Returns Core\Translation\Language_Node::value().

Returns Core\Translation\Language_Node::value().

Returns

string

Since

3.1

Overrides

Core\Object::__toString
abstract public boolean
# exists( )

Indicates whether the language node represents an existing value.

Indicates whether the language node represents an existing value.

Returns

boolean

true, if the language entry represented by this node exists and was successfully retrieved, otherwise false.

Since

3.1
public string
# format( )

Returns a string formatted by the formatting instructions of its value.

Returns a string formatted by the formatting instructions of its value.

Returns

string
Formatted string.

See

\sprintf()

Since

3.1
abstract public Core\Translation\Language_Node
# query( string $path )

Returns a language repository entry relative to the node.

Returns a language repository entry relative to the node.

Parameters

$path

Hierarchical key path to retrieve the language repository entry for, relative to the current node. Each segment is delimited by a dot character. A key path must not necessarily end in a leaf but might as well be used to get a language entry node that is used for subsequent queries with relative paths.

Returns

Core\Translation\Language_Node

Language repository entry identified by the provided key path relative to the current node.

Remark

Drivers must implement this method to return a corresponding language node.


Since

3.1
public
# value( )

Node value text or placeholder, if key path of node is not covered by the language repository.

Node value text or placeholder, if key path of node is not covered by the language repository.

Remark

The default implementation always returns a placeholder string. Drivers should always return the value of the parent implementation, if the node does not have a value.


Since

3.1
public string
# vformat( array $arguments = null )

Returns a string formatted by the formatting instructions of its value.

Returns a string formatted by the formatting instructions of its value.

Parameters

$arguments
Formatting values.

Returns

string
Formatted string.

See

\vsprintf()

Since

3.1

Methods inherited from Core\Field

getDataForKey(), getDataForKeys(), getDataForUndefinedKey(), 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(), attachMethod(), chain(), getValueForKey(), getValueForKeyPath(), getValueForUndefinedKey(), hash(), issetValueForKey(), setValueForKey(), setValueForKeyPath(), setValueForUndefinedKey(), uuid()

Constants summary

Constants inherited from Core\Object

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

Properties summary

protected string $_v_path

Key path the language node represents.

Key path the language node represents.

Since

3.1
#

Properties inherited from Core\Field

$_v_data

Magic properties

public read-only boolean $exists

Indicates whether the language node represents an existing value.

public read-only string $path

Key path that this language node represents.

public read-only string $value

Node value text or placeholder, if key path of node is not covered by the language repository.

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