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

  • Authentication
  • Authentication_Token
  • AutoLoader
  • Cache
  • Charset
  • ClassDescriptor
  • Closure
  • Configuration
  • 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_Node
  • Log
  • Module
  • Module_Iterator
  • Nothing
  • Object
  • OS
  • Plugin
  • Profiler
  • Query
  • Registry
  • Resource
  • Server
  • Session
  • Session_Token
  • Set
  • Storage
  • Storage_Result
  • Storage_Statement
  • Stream
  • 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
  • Version

Class Session_Token

Session token interface.

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\Session_Token implements IteratorAggregate
Namespace: Core
Package: Core\Session
Since: 3.0
Requires: PHP 5.3
Version: 1.0
Located at Session.inc.php

Methods summary

public
# __construct( Core\Session $driver, string $name )

Parameters

$driver
Driver instance that created the token.
$name
Name of session token.

Since

3.0
public
# clear( )

Unsets all token values.

Unsets all token values.

Since

3.0
public null
# getDataForUndefinedKey( string $key )

Returns null for an undefined key data request and triggers a notice.

Returns null for an undefined key data request and triggers a notice.

Parameters

$key
Name of data field to return value for.

Returns

null
Always returns null.

Throws

Core\Exception\UndefinedKey
Failed to resolve data field for the given key.

Since

3.0

Overrides

Core\Field::getDataForUndefinedKey
public mixed
# get( string $key )

Retrieves an item from the internal data field.

Retrieves an item from the internal data field.

This method is a convenience layer as earlier PHP does not support direct array access to return values of functions without the use of an intermediate variable. Also, instead of displaying a notice, null is silently returned if the requested key does not exist.

Parameters

$key
Key of data field to retrieve.

Returns

mixed
Value of data field or null, if no such key exists.

Since

3.1
public ArrayIterator
# getIterator( )

Retrieves iterator over session data (used by iterators).

Retrieves iterator over session data (used by iterators).

Returns

ArrayIterator

Since

3.0

Implementation of

IteratorAggregate::getIterator()
public
# register( string\string[] $var1 )

Registers new session data entry names and initialises new entry values with false. This is especially useful for registering data entry names when using automatic data reflection.

Registers new session data entry names and initialises new entry values with false. This is especially useful for registering data entry names when using automatic data reflection.

Parameters

$var1

Name of data entry to register. Arrays are traversed recursively and each value is considered a single key.

Since

3.0
public mixed
# setDataForUndefinedKey( string $key, mixed $value )

Registers a new session data entry.

Registers a new session data entry.

Parameters

$key
Name of data entry to register.
$value
Value of new data entry.

Returns

mixed
The return value depends on the reimplementation.

Throws

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

Since

3.0

Overrides

Core\Field\Mutable::setDataForUndefinedKey

Methods inherited from Core\Field\Mutable

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

Methods inherited from Core\Field

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

Constants summary

string CoreName

Name of core-internal session token.

Name of core-internal session token.

Since

3.0
# '__xc'
string StandardName

Name of standard session token.

Name of standard session token.

Since

3.0
# 'Standard'

Constants inherited from Core\Object

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

Properties summary

protected Core\Session $_v_driver

The reference to the session instance the token is derived from.

The reference to the session instance the token is derived from.

Since

3.0
#
protected string $_v_name

The session token name.

The session token name.

Since

3.0
#

Properties inherited from Core\Field\Mutable

$_v_masqueradedKeys

Properties inherited from Core\Field

$_v_data

Magic properties

public read-only Core\Session $driver

Session instance the token is part of.
public read-only string $name

Name of session token.

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