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 Query

HTTP query parser and builder.

Core\Object implements Core\Chainable
Extended by Core\Set implements Core\Accessor
Extended by Core\Query

Direct known subclasses

Core\Query\Driver\fullpath, Core\Query\Driver\minipath, Core\Query\Driver\standard

Indirect known subclasses

Core\Query\Driver\localizedfullpath

Abstract
Namespace: Core
Package: Core\Query
Since: 3.0
Requires: PHP 5.3
Version: 1.1
Located at Query.inc.php

Methods summary

public
# __construct( Core\URI $uri )

Parameters

$uri
Driver configuration URI.

Since

3.0
public static Core\Query
# autocreate( Core\URI $uri )

Query factory.

Query factory.

Parameters

$uri
Driver configuration URI.

Returns

Core\Query

Since

3.0
abstract public string
# base( )

Returns

string

Since

3.1
abstract public string
# build( string|boolean $controller, string|boolean $action = false, array $parameters = null )

Builds a query string from controller, action and additional parameters.

Builds a query string from controller, action and additional parameters.

Parameters

$controller
Name of target controller.
$action
Name of target action.
$parameters
Associative array of additional parameters to embed in the query.

Returns

string
Query string.

Since

3.0
public string
# convertKey( string $key )

Encodes a GET argument key name the same way PHP handles such conversions.

Encodes a GET argument key name the same way PHP handles such conversions.

Parameters

$key
Argument key name to encode.

Returns

string
Encoded argument key name.

Since

3.0
public array
# parse( string $query = null )

Parses a query string.

Parses a query string.

Although the parse part is very specific to a query implementation, many queries use mod_rewrite or similar techniques to redirect calls to an index script, where path components have been replaced with query parameters.

Parameters

$query
Query string to parse.

Returns

array

Array with three components:

  • string controller:

    The requested controller name (if any).

  • string action:

    The requested action name (if any).

  • array parameters

    An array of all remaining query parameters.

Since

3.0

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 ActionKeyParameter

Key name configuration parameter for action field in query.

Key name configuration parameter for action field in query.

Since

3.0
# 'action-key'
string ControllerKeyParameter

Key name configuration parameter for controller field in query.

Key name configuration parameter for controller field in query.

Since

3.0
# 'controller-key'

Constants inherited from Core\Object

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

Properties summary

protected array $_v_parameters

Associative array of parsed configuration parameters.

Associative array of parsed configuration parameters.

Since

3.0
#

Magic properties

public read-only array $parameters

Associative array of parsed configuration parameters.

Magic properties inherited from Core\Object

$hash, $uuid

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