Overview
Prev	Solar_Uri_Action	Next

Overview

Manipulates and generates action URI strings.

This class is functionally identical to Solar_Uri, except that it automatically adds a prefix to the "path" portion of all URIs. This makes it easy to work with front-controller and page-controller URIs.

Use the Solar_Uri_Action::$_config key for 'path' to specify the path prefix leading to the front controller, if any.

Package

This class is part of the Solar_Uri package.

Inheritance:

Solar_Base
- Solar_Uri
  - Solar_Uri_Action

Configuration Keys

host: A host to use as default. Generally needed only for specific URI subclasses, for example Solar_Uri_Public.
path: A path prefix specifically for actions. If Apache has used SetEnv SOLAR_URI_ACTION_PATH /, then that is the default value for this item; otherwise, the default value is "/index.php".
uri: Calls set() with this URI string at construct-time, instead of loading from the current URI.

Constants

None.

Public Properties

These are all the public properties in the Solar_Uri_Action class.

You can also view the list of all public, protected, and private properties.

$format: The dot-format extension of the last path element (for example, the "rss" in "feed.rss").
$fragment: The fragment portion (for example, the "foo" in "#foo").
$host: The host specification (for example, 'example.com').
$pass: The password, if any.
$path: The path portion (for example, 'path/to/index.php').
$port: The port number (for example, '80').
$scheme: The scheme (for example 'http' or 'https').
$user: The username, if any.

Public Methods

These are all the public methods in the Solar_Uri_Action class.

You can also view the list of all public, protected, and private methods.

__construct(): Constructor.
__destruct(): Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().
__get(): Implements access to $_query by reference so that it appears to be a public $query property.
__set(): Implements the virtual $query property.
__toString(): Converts the URI object to a string and returns it.
dump(): Convenience method for getting a dump the whole object, or one of its properties, or an external variable.
get(): Returns a URI based on the object properties.
getFrontPath(): Returns a path suitable for the front controller to parse (i.e., without the prefix for subdirectory-based installations).
getPath(): Returns the path array as a string, including the format.
getQuery(): Returns the query portion as a string.
locale(): Looks up class-specific locale strings based on a key.
quick(): Returns a URI based on the specified string.
set(): Sets properties from a specified URI.
setPath(): Sets the Solar_Uri::$path array from a string.
setQuery(): Sets the query string in the URI, for Solar_Uri::getQuery() and Solar_Uri::$query.

Prev	Up	Next
Solar_Uri_Action	Home	Configuration