Class Mage_Core_Controller_Varien_Action

Custom Zend_Controller_Action class (formally)

Allows dispatching before and after events for each controller action

Direct known subclasses

Mage_Adminhtml_Controller_Action, Mage_Core_Controller_Front_Action, Mage_Install_Controller_Action

Indirect known subclasses

Abstract
Package: Mage\Core
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Core/Controller/Varien/Action.php

Methods summary
`public`	# `__construct( Zend_Controller_Request_Abstract $request, Zend_Controller_Response_Abstract $response, array $invokeArgs = array() )` Constructor Constructor Parameters `$request` `Zend_Controller_Request_Abstract` $request `$response` `Zend_Controller_Response_Abstract` $response `$invokeArgs` `array` $invokeArgs
`protected`	# `_construct( )`
`public`	# `hasAction( mixed $action )`
`public Mage_Core_Controller_Request_Http`	# `getRequest( )` Retrieve request object Retrieve request object Returns `Mage_Core_Controller_Request_Http`
`public Mage_Core_Controller_Response_Http`	# `getResponse( )` Retrieve response object Retrieve response object Returns `Mage_Core_Controller_Response_Http`
`public boolean`	# `getFlag( string $action, string $flag = '' )` Retrieve flag value Retrieve flag value Parameters `$action` `string` $action `$flag` `string` $flag Returns `boolean`
`public Mage_Core_Controller_Varien_Action`	# `setFlag( string $action, string $flag, string $value )` Setting flag value Setting flag value Parameters `$action` `string` $action `$flag` `string` $flag `$value` `string` $value Returns `Mage_Core_Controller_Varien_Action`
`public string`	# `getFullActionName( string $delimiter = '_' )` Retrieve full bane of current action current controller and current module Retrieve full bane of current action current controller and current module Parameters `$delimiter` `string` $delimiter Returns `string`
`public Mage_Core_Model_Layout`	# `getLayout( )` Retrieve current layout object Retrieve current layout object Returns `Mage_Core_Model_Layout`
`public Mage_Core_Controller_Varien_Action`	# `loadLayout( string\|null\|boolean $handles = null, boolean $generateBlocks = true, boolean $generateXml = true )` Load layout by handles(s) Load layout by handles(s) Parameters `$handles` `string\|null\|boolean` $handles `$generateBlocks` `boolean` $generateBlocks `$generateXml` `boolean` $generateXml Returns `Mage_Core_Controller_Varien_Action`
`public`	# `addActionLayoutHandles( )`
`public`	# `loadLayoutUpdates( )`
`public`	# `generateLayoutXml( )`
`public`	# `generateLayoutBlocks( )`
`public Mage_Core_Controller_Varien_Action`	# `renderLayout( string $output = '' )` Rendering layout Rendering layout Parameters `$output` `string` $output Returns `Mage_Core_Controller_Varien_Action`
`public`	# `dispatch( mixed $action )`
`public string`	# `getActionMethodName( string $action )` Retrieve action method name Retrieve action method name Parameters `$action` `string` $action Returns `string`
`public`	# `preDispatch( )` Dispatch event before action Dispatch event before action
`public`	# `postDispatch( )` Dispatches event after action Dispatches event after action
`public`	# `norouteAction( mixed $coreRoute = null )`
`public`	# `noCookiesAction( )`
`protected`	# `_forward( string $action, string\|null $controller = null, string\|null $module = null, array $params = null )` Throw control to different action (control and module if was specified). Throw control to different action (control and module if was specified). Parameters `$action` `string` $action `$controller` `string\|null` $controller `$module` `string\|null` $module `$params` `array\|null` $params
`protected Mage_Core_Controller_Varien_Action`	# `_initLayoutMessages( string\|array $messagesStorage )` Initializing layout messages by message storage(s), loading and adding messages to layout messages block Initializing layout messages by message storage(s), loading and adding messages to layout messages block Parameters `$messagesStorage` `string\|array` $messagesStorage Returns `Mage_Core_Controller_Varien_Action`
`public Mage_Core_Controller_Varien_Action`	# `initLayoutMessages( string\|array $messagesStorage )` Initializing layout messages by message storage(s), loading and adding messages to layout messages block Initializing layout messages by message storage(s), loading and adding messages to layout messages block Parameters `$messagesStorage` `string\|array` $messagesStorage Returns `Mage_Core_Controller_Varien_Action`
`protected Mage_Core_Controller_Varien_Action`	# `_redirectUrl( string $url )` Set redirect url into response Set redirect url into response Parameters `$url` `string` $url Returns `Mage_Core_Controller_Varien_Action`
`protected Mage_Core_Controller_Varien_Action`	# `_redirect( string $path, array $arguments = array() )` Set redirect into response Set redirect into response Parameters `$path` `string` $path `$arguments` `array` $arguments Returns `Mage_Core_Controller_Varien_Action`
`public Mage_Core_Controller_Varien_Action`	# `setRedirectWithCookieCheck( string $path, array $arguments = array() )` Set redirect into response with session id in URL if it is enabled. It allows to distinguish primordial request from browser with cookies disabled. Set redirect into response with session id in URL if it is enabled. It allows to distinguish primordial request from browser with cookies disabled. Parameters `$path` `string` $path `$arguments` `array` $arguments Returns `Mage_Core_Controller_Varien_Action`
`protected Mage_Core_Controller_Varien_Action`	# `_redirectSuccess( string $defaultUrl )` Redirect to success page Redirect to success page Parameters `$defaultUrl` `string` $defaultUrl Returns `Mage_Core_Controller_Varien_Action`
`protected Mage_Core_Controller_Varien_Action`	# `_redirectError( string $defaultUrl )` Redirect to error page Redirect to error page Parameters `$defaultUrl` `string` $defaultUrl Returns `Mage_Core_Controller_Varien_Action`
`protected Mage_Core_Controller_Varien_Action`	# `_redirectReferer( string $defaultUrl = null )` Set referer url for redirect in response Set referer url for redirect in response Parameters `$defaultUrl` `string` $defaultUrl Returns `Mage_Core_Controller_Varien_Action`
`protected string`	# `_getRefererUrl( )` Identify referer url via all accepted methods (HTTP_REFERER, regular or base64-encoded request param) Identify referer url via all accepted methods (HTTP_REFERER, regular or base64-encoded request param) Returns `string`
`protected boolean`	# `_isUrlInternal( string $url )` Check url to be used as internal Check url to be used as internal Parameters `$url` `string` $url Returns `boolean`
`protected string`	# `_getRealModuleName( )` Get real module name (like 'Mage_Module') Get real module name (like 'Mage_Module') Returns `string`
`protected boolean`	# `_rewrite( )` Support for controllers rewrites Support for controllers rewrites Example of configuration: <global> <routers> <core_module> <rewrite> <core_controller> <to>new_route/new_controller</to> <override_actions>true</override_actions> <actions> <core_action><to>new_module/new_controller/new_action</core_action> </actions> <core_controller> </rewrite> </core_module> </routers> </global> This will override: core_module/core_controller/core_action to new_module/new_controller/new_action all other actions of core_module/core_controller to new_module/new_controller Returns `boolean` true if rewrite happened
`protected boolean`	# `_validateFormKey( )` Validate Form Key Validate Form Key Returns `boolean`
`protected Mage_Core_Controller_Varien_Action`	# `_title( string\|false\|-1\|null $text = null, boolean $resetIfExists = true )` Add an extra title to the end or one from the end, or remove all Add an extra title to the end or one from the end, or remove all Usage examples: $this->_title('foo')->_title('bar'); => bar / foo / <default title> $this->_title()->_title('foo')->_title('bar'); => bar / foo $this->_title('foo')->_title(false)->_title('bar'); bar / <default title> Parameters `$text` `string\|false\|-1\|null` $text `$resetIfExists` `boolean` $resetIfExists Returns `Mage_Core_Controller_Varien_Action` See `Mage_Core_Controller_Varien_Action::_renderTitles()`
`protected`	# `_renderTitles( )` Prepare titles in the 'head' layout block Supposed to work only in actions where layout is rendered Falls back to the default logic if there are no titles eventually Prepare titles in the 'head' layout block Supposed to work only in actions where layout is rendered Falls back to the default logic if there are no titles eventually See `Mage_Core_Controller_Varien_Action::loadLayout()` `Mage_Core_Controller_Varien_Action::renderLayout()`
`protected array`	# `_filterDates( array $array, array $dateFields )` Convert dates in array from localized to internal format Convert dates in array from localized to internal format Parameters `$array` `array` $array `$dateFields` `array` $dateFields Returns `array`
`protected array`	# `_filterDateTime( array $array, array $dateFields )` Convert dates with time in array from localized to internal format Convert dates with time in array from localized to internal format Parameters `$array` `array` $array `$dateFields` `array` $dateFields Returns `array`
`protected Mage_Core_Controller_Varien_Action`	# `_prepareDownloadResponse( string $fileName, string\|array $content, string $contentType = 'application/octet-stream', integer $contentLength = null )` Declare headers and content file in response for file download Declare headers and content file in response for file download Parameters `$fileName` `string` $fileName `$content` `string\|array` $content set to null to avoid starting output, $contentLength should be set explicitly in that case `$contentType` `string` $contentType `$contentLength` `integer` $contentLength explicit content length, if strlen($content) isn't applicable Returns `Mage_Core_Controller_Varien_Action`

Constants summary
`string`	`FLAG_NO_CHECK_INSTALLATION`	`'no-install-check'`	#
`string`	`FLAG_NO_DISPATCH`	`'no-dispatch'`	#
`string`	`FLAG_NO_PRE_DISPATCH`	`'no-preDispatch'`	#
`string`	`FLAG_NO_POST_DISPATCH`	`'no-postDispatch'`	#
`string`	`FLAG_NO_START_SESSION`	`'no-startSession'`	#
`string`	`FLAG_NO_DISPATCH_BLOCK_EVENT`	`'no-beforeGenerateLayoutBlocksDispatch'`	#
`string`	`FLAG_NO_COOKIES_REDIRECT`	`'no-cookies-redirect'`	#
`string`	`PARAM_NAME_SUCCESS_URL`	`'success_url'`	#
`string`	`PARAM_NAME_ERROR_URL`	`'error_url'`	#
`string`	`PARAM_NAME_REFERER_URL`	`'referer_url'`	#
`string`	`PARAM_NAME_BASE64_URL`	`'r64'`	#
`string`	`PARAM_NAME_URL_ENCODED`	`'uenc'`	#
`string`	`PROFILER_KEY`	`'mage::dispatch::controller::action'`	#

Properties summary
`protected Zend_Controller_Request_Abstract`	`$_request`		# Request object Request object
`protected Zend_Controller_Response_Abstract`	`$_response`		# Response object Response object
`protected string`	`$_realModuleName`		# Real module name (like 'Mage_Module') Real module name (like 'Mage_Module')
`protected array`	`$_flags`	`array()`	# Action flags Action flags for example used to disable rendering default layout
`protected array`	`$_cookieCheckActions`	`array()`	# Action list where need check enabled cookie Action list where need check enabled cookie
`protected string`	`$_currentArea`		# Currently used area Currently used area
`protected string`	`$_sessionNamespace`		# Namespace for session. Should be defined for proper working session. Namespace for session. Should be defined for proper working session.
`protected boolean`	`$_isLayoutLoaded`	`false`	# Whether layout is loaded Whether layout is loaded See `Mage_Core_Controller_Varien_Action::loadLayout()`
`protected array`	`$_titles`	`array()`	# Title parts to be rendered in the page head title Title parts to be rendered in the page head title See `Mage_Core_Controller_Varien_Action::_title()`
`protected boolean`	`$_removeDefaultTitle`	`false`	# Whether the default title should be removed Whether the default title should be removed See `Mage_Core_Controller_Varien_Action::_title()`

Packages

Classes

Exceptions

Functions

Class Mage_Core_Controller_Varien_Action

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

See

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

See

See

See