Docs For Class Mage_Core_Controller_Request

Description

Custom Zend_Controller_Request_Http class (formally)

Allows dispatching before and after events for each controller action

author: Magento Core Team <[email protected]>

Located in /Core/Controller/Request/Http.php (line 35)

Zend_Controller_Request_Http
   |
   --Mage_Core_Controller_Request_Http

Class Constant Summary

XML_NODE_DIRECT_FRONT_NAMES = 'global/request/direct_front_name'

Variable Summary

array $_beforeForwardInfo

mixed $_controllerModule

mixed $_directFrontNames

$_isStraight $_isStraight

string $_originalPathInfo

mixed $_requestedRouteName

mixed $_requestString

null $_rewritedPathInfo

mixed $_route

mixed $_routingInfo

mixed $_storeCode

Method Summary

string getActionName ()

string|null getAlias (string $name)

array getAliases ()

void getBasePath ()

void getBaseUrl ()

array|string|null getBeforeForwardInfo ([string $name = null])

string getControllerModule ()

string getControllerName ()

array getDirectFrontNames ()

string getHttpHost ([bool $trimPort = true])

string getModuleName ()

string getOriginalPathInfo ()

void getOriginalRequest ()

string getRequestedActionName ()

string getRequestedControllerName ()

string getRequestedRouteName ()

void getRequestString ()

void getRouteName ()

void getStoreCodeFromPath ()

Mage_Core_Controller_Varien_Action initForward ()

boolean isAjax ()

bool isDirectAccessFrontendName (string $code)

bool isStraight ([bool $flag = null])

Mage_Core_Controller_Request_Http rewritePathInfo (string $pathInfo)

Mage_Core_Controller_Request_Http setControllerModule (string $module)

Zend_Controller_Request_Http setPathInfo ([string|null $pathInfo = null])

Mage_Core_Controller_Request_Http setPost (striing|array $key, [mixed $value = null])

void setRouteName ( $route)

Mage_Core_Controller_Request_Http setRoutingInfo (array $data)

bool _canBeStoreCodeInUrl ()

Variables

array $_beforeForwardInfo = array() (line 74)

Request's original information before forward.

access: protected

mixed $_controllerModule = null (line 59)

access: protected

mixed $_directFrontNames = null (line 58)

access: protected

$_isStraight $_isStraight = false (line 67)

Streight request flag.

If flag is determined no additional logic is applicable

var: bool
access: protected

string $_originalPathInfo = '' (line 43)

ORIGINAL_PATH_INFO

access: protected

mixed $_requestedRouteName = null (line 53)

access: protected

mixed $_requestString = '' (line 45)

access: protected

null $_rewritedPathInfo = null (line 52)

Path info array used before applying rewrite from config

var: || array
access: protected

mixed $_route (line 56)

access: protected

mixed $_routingInfo = array() (line 54)

access: protected

mixed $_storeCode = null (line 44)

access: protected

Methods

getActionName (line 359)

Retrieve the action name

access: public

string getActionName ()

getAlias (line 372)

Retrieve an alias

Retrieve the actual key represented by the alias $name.

return: Returns null when no alias exists
access: public

string|null getAlias (string $name)

string $name

getAliases (line 386)

Retrieve the list of all aliases

access: public

array getAliases ()

getBasePath (line 242)

access: public

void getBasePath ()

getBaseUrl (line 253)

access: public

void getBaseUrl ()

getBeforeForwardInfo (line 491)

Retrieve property's value which was before _forward call.

If property was not changed during _forward call null will be returned. If passed name will be null whole state array will be returned.

access: public

array|string|null getBeforeForwardInfo ([string $name = null])

string $name

getControllerModule (line 331)

Get module name of currently used controller

access: public

string getControllerModule ()

getControllerName (line 350)

Retrieve the controller name

access: public

string getControllerName ()

getDirectFrontNames (line 217)

Get list of front names available with access without store code

access: public

array getDirectFrontNames ()

getHttpHost (line 283)

Retrieve HTTP HOST

access: public

string getHttpHost ([bool $trimPort = true])

bool $trimPort

getModuleName (line 341)

Retrieve the module name

access: public

string getModuleName ()

getOriginalPathInfo (line 83)

Returns ORIGINAL_PATH_INFO.

This value is calculated instead of reading PATH_INFO directly from $_SERVER due to cross-platform differences.

access: public

string getOriginalPathInfo ()

getOriginalRequest (line 230)

access: public

void getOriginalRequest ()

getRequestedActionName (line 438)

Get action name used in request (ignore rewrite)

access: public

string getRequestedActionName ()

getRequestedControllerName (line 422)

Get controller name used in request (ignore rewrite)

access: public

string getRequestedControllerName ()

getRequestedRouteName (line 399)

Get route name used in request (ignore rewrite)

access: public

string getRequestedRouteName ()

getRequestString (line 237)

access: public

void getRequestString ()

getRouteName (line 272)

access: public

void getRouteName ()

getStoreCodeFromPath (line 91)

access: public

void getStoreCodeFromPath ()

initForward (line 469)

Collect properties changed by _forward in protected storage before _forward was called first time.

access: public

Mage_Core_Controller_Varien_Action initForward ()

isAjax (line 521)

Check is Request from AJAX

access: public

boolean isAjax ()

isDirectAccessFrontendName (line 206)

Check if code declared as direct access frontend name this mean what this url can be used without store code

access: public

bool isDirectAccessFrontendName (string $code)

string $code

isStraight (line 508)

Specify/get _isStraight flag value

access: public

bool isStraight ([bool $flag = null])

bool $flag

rewritePathInfo (line 180)

Specify new path info It happen when occur rewrite based on configuration

access: public

Mage_Core_Controller_Request_Http rewritePathInfo (string $pathInfo)

string $pathInfo

setControllerModule (line 320)

Specify module name where was found currently used controller

access: public

Mage_Core_Controller_Request_Http setControllerModule (string $module)

string $module

setPathInfo (line 125)

Set the PATH_INFO string Set the ORIGINAL_PATH_INFO string

access: public

Zend_Controller_Request_Http setPathInfo ([string|null $pathInfo = null])

string|null $pathInfo

setPost (line 303)

Set a member of the $_POST superglobal

access: public

Mage_Core_Controller_Request_Http setPost (striing|array $key, [mixed $value = null])

striing|array $key
mixed $value

setRouteName (line 260)

access: public

void setRouteName ( $route)

$route

setRoutingInfo (line 455)

Set routing info data

access: public

Mage_Core_Controller_Request_Http setRoutingInfo (array $data)

array $data

_canBeStoreCodeInUrl (line 194)

Check if can be store code as part of url

access: protected

bool _canBeStoreCodeInUrl ()

Class Constants

XML_NODE_DIRECT_FRONT_NAMES = 'global/request/direct_front_name' (line 37)

Class Mage_Core_Controller_Request_Http