Docs For Class Mage_Core_Controller_Varien

Class Mage_Core_Controller_Varien_Action

Description

Custom Zend_Controller_Action class (formally)

Allows dispatching before and after events for each controller action

author: Magento Core Team <[email protected]>
abstract:

Located in /Core/Controller/Varien/Action.php (line 37)

Direct descendents

Class	Description
Mage_Adminhtml_Controller_Action	Base adminhtml controller
Mage_Core_Controller_Front_Action	Base front controller
Mage_Install_Controller_Action	Magento

Class Constant Summary

FLAG_NO_CHECK_INSTALLATION = 'no-install-check'

FLAG_NO_COOKIES_REDIRECT = 'no-cookies-redirect'

FLAG_NO_DISPATCH = 'no-dispatch'

FLAG_NO_DISPATCH_BLOCK_EVENT = 'no-beforeGenerateLayoutBlocksDispatch'

FLAG_NO_POST_DISPATCH = 'no-postDispatch'

FLAG_NO_PRE_DISPATCH = 'no-preDispatch'

FLAG_NO_START_SESSION = 'no-startSession'

PARAM_NAME_BASE64_URL = 'r64'

PARAM_NAME_ERROR_URL = 'error_url'

PARAM_NAME_REFERER_URL = 'referer_url'

PARAM_NAME_SUCCESS_URL = 'success_url'

PARAM_NAME_URL_ENCODED = 'uenc'

PROFILER_KEY = 'mage::dispatch::controller::action'

Variable Summary

array $_cookieCheckActions

string $_currentArea

array $_flags

bool $_isLayoutLoaded

string $_realModuleName

bool $_removeDefaultTitle

Zend_Controller_Request_Abstract $_request

Zend_Controller_Response_Abstract $_response

string $_sessionNamespace

array $_titles

Method Summary

Mage_Core_Controller_Varien_Action __construct ( $request, $response, [ $invokeArgs = array()])

void addActionLayoutHandles ()

void dispatch ( $action)

void generateLayoutBlocks ()

void generateLayoutXml ()

void getActionMethodName ( $action)

bool getFlag (string $action, [string $flag = ''])

string getFullActionName ([string $delimiter = '_'])

Mage_Core_Model_Layout getLayout ()

Mage_Core_Controller_Request_Http getRequest ()

Mage_Core_Controller_Response_Http getResponse ()

void hasAction ( $action)

Mage_Core_Controller_Varien_Action initLayoutMessages (string|array $messagesStorage)

Mage_Core_Controller_Varien_Action loadLayout ([string $handles = null], [boolean $generateBlocks = true], [ $generateXml = true], string $cacheId)

void loadLayoutUpdates ()

void noCookiesAction ()

void norouteAction ([ $coreRoute = null])

void postDispatch ()

void preDispatch ()

Mage_Core_Controller_Varien_Action renderLayout ([string $output = ''])

Mage_Core_Controller_Varien_Action setFlag (string $action, string $flag, string $value)

void _construct ()

array _filterDates (array $array, array $dateFields)

array _filterDateTime (array $array, array $dateFields)

void _forward (string $action, [string|null $controller = null], [string|null $module = null], [ $params = null])

string _getRealModuleName ()

string _getRefererUrl ()

Mage_Core_Controller_Varien_Action _initLayoutMessages (string|array $messagesStorage)

bool _isUrlInternal (string $url)

Mage_Core_Controller_Varien_Action _prepareDownloadResponse (string $fileName, string|array $content, [string $contentType = 'application/octet-stream'], [int $contentLength = null])

void _redirect (string $path, [array $arguments = array()])

void _redirectError (string $defaultUrl)

Mage_Core_Controller_Varien_Action _redirectReferer ([string $defaultUrl = null])

void _redirectSuccess (string $defaultUrl)

Mage_Core_Controller_Varien_Action _redirectUrl (string $url)

void _renderTitles ()

boolean _rewrite ()

Mage_Core_Controller_Varien_Action _title ([string|false|-1|null $text = null], [ $resetIfExists = true])

bool _validateFormKey ()

Variables

array $_cookieCheckActions = array() (line 90)

Action list where need check enabled cookie

access: protected

Redefined in descendants as:

Mage_Catalog_Product_CompareController::$_cookieCheckActions : Action list where need check enabled cookie
Mage_Customer_AccountController::$_cookieCheckActions : Action list where need check enabled cookie
Mage_Wishlist_IndexController::$_cookieCheckActions : Action list where need check enabled cookie
Mage_Checkout_CartController::$_cookieCheckActions : Action list where need check enabled cookie
Mage_Poll_VoteController::$_cookieCheckActions : Action list where need check enabled cookie
Mage_Review_ProductController::$_cookieCheckActions : Action list where need check enabled cookie

string $_currentArea (line 97)

Currently used area

access: protected

Redefined in descendants as:

Mage_Adminhtml_Controller_Action::$_currentArea : Currently used area
Mage_Core_Controller_Front_Action::$_currentArea : Currently used area

array $_flags = array() (line 83)

Action flags

for example used to disable rendering default layout

access: protected

bool $_isLayoutLoaded = false (line 113)

Whether layout is loaded

see: self::loadLayout()
access: protected

string $_realModuleName (line 74)

Real module name (like 'Mage_Module')

access: protected

bool $_removeDefaultTitle = false (line 129)

Whether the default title should be removed

see: self::_title()
access: protected

Zend_Controller_Request_Abstract $_request (line 60)

Request object

access: protected

Zend_Controller_Response_Abstract $_response (line 67)

Response object

access: protected

string $_sessionNamespace (line 105)

Namespace for session.

Should be defined for proper working session.

access: protected

Redefined in descendants as:

Mage_Adminhtml_Controller_Action::$_sessionNamespace : Namespace for session.
Mage_Core_Controller_Front_Action::$_sessionNamespace : Namespace for session.

array $_titles = array() (line 121)

Title parts to be rendered in the page head title

see: self::_title()
access: protected

Methods

Constructor __construct (line 138)

Constructor

access: public

Mage_Core_Controller_Varien_Action __construct ( $request, $response, [ $invokeArgs = array()])

Zend_Controller_Request_Abstract $request
Zend_Controller_Response_Abstract $response
array $invokeArgs

addActionLayoutHandles (line 276)

access: public

void addActionLayoutHandles ()

dispatch (line 397)

access: public

void dispatch ( $action)

$action

generateLayoutBlocks (line 330)

access: public

void generateLayoutBlocks ()

generateLayoutXml (line 311)

access: public

void generateLayoutXml ()

getActionMethodName (line 453)

access: public

void getActionMethodName ( $action)

$action

getFlag (line 185)

Retrieve flag value

access: public

bool getFlag (string $action, [string $flag = ''])

string $action
string $flag

getFullActionName (line 225)

Retrieve full bane of current action current controller and current module

access: public

string getFullActionName ([string $delimiter = '_'])

string $delimiter

getLayout (line 237)

Retrieve current layout object

access: public

Mage_Core_Model_Layout getLayout ()

getRequest (line 163)

Retrieve request object

access: public

Mage_Core_Controller_Request_Http getRequest ()

getResponse (line 173)

Retrieve response object

access: public

Mage_Core_Controller_Response_Http getResponse ()

hasAction (line 153)

access: public

void hasAction ( $action)

$action

initLayoutMessages (line 643)

Inits layout messages by message storage(s), loading and adding messages to layout messages block

access: public

Mage_Core_Controller_Varien_Action initLayoutMessages (string|array $messagesStorage)

string|array $messagesStorage

loadLayout (line 250)

Load layout by handles(s)

access: public

Mage_Core_Controller_Varien_Action loadLayout ([string $handles = null], [boolean $generateBlocks = true], [ $generateXml = true], string $cacheId)

string $handles
string $cacheId
boolean $generateBlocks
$generateXml

Redefined in descendants as:

Mage_Adminhtml_Controller_Action::loadLayout()

loadLayoutUpdates (line 293)

access: public

void loadLayoutUpdates ()

noCookiesAction (line 557)

access: public

void noCookiesAction ()

Redefined in descendants as:

Mage_Cms_IndexController::noCookiesAction() : Render Disable cookies page

norouteAction (line 534)

access: public

void norouteAction ([ $coreRoute = null])

$coreRoute

Redefined in descendants as:

Mage_Adminhtml_Controller_Action::norouteAction()

postDispatch (line 517)

Dispatches event after action

access: public

void postDispatch ()

Redefined in descendants as:

Mage_GoogleBase_Adminhtml_Googlebase_TypesController::postDispatch() : Dispatches controller_action_postdispatch_adminhtml Event (as not Adminhtml router)
Mage_Core_Controller_Front_Action::postDispatch() : Postdispatch: should set last visited url
Mage_Customer_AccountController::postDispatch() : Action postdispatch
Mage_XmlConnect_Controller_Action::postDispatch() : Validate response body

preDispatch (line 462)

Dispatches event before action

access: public

void preDispatch ()

Redefined in descendants as:

Mage_Adminhtml_Controller_Action::preDispatch() : Controller predispatch method
Mage_Compiler_Adminhtml_Compiler_ProcessController::preDispatch()
Mage_Downloadable_Product_EditController::preDispatch() : Controller predispatch method
Mage_Adminhtml_Catalog_Product_AttributeController::preDispatch()
Mage_Adminhtml_System_ConfigController::preDispatch() : Controller predispatch method Check if current section is found and is allowed
Mage_Adminhtml_Rss_OrderController::preDispatch()
Mage_Adminhtml_Rss_CatalogController::preDispatch()
Mage_Downloadable_FileController::preDispatch() : Controller predispatch method
Mage_Core_Controller_Front_Action::preDispatch() : Predispatch: shoud set layout area
Mage_ProductAlert_AddController::preDispatch()
Mage_ProductAlert_UnsubscribeController::preDispatch()
Mage_CatalogSearch_TermController::preDispatch()
Mage_Catalog_Seo_SitemapController::preDispatch() : Check if SEO sitemap is enabled in configuration
Mage_Api_Controller_Action::preDispatch()
Mage_Customer_AccountController::preDispatch() : Action predispatch
Mage_Customer_AddressController::preDispatch()
Mage_Newsletter_ManageController::preDispatch() : Action predispatch
Mage_Sales_OrderController::preDispatch() : Action predispatch
Mage_Sales_Billing_AgreementController::preDispatch() : Action predispatch
Mage_Sales_Recurring_ProfileController::preDispatch() : Make sure customer is logged in and put it into registry
Mage_Wishlist_IndexController::preDispatch()
Mage_Contacts_IndexController::preDispatch()
Mage_Checkout_MultishippingController::preDispatch() : Action predispatch
Mage_Checkout_OnepageController::preDispatch()
Mage_Sendfriend_ProductController::preDispatch() : Predispatch: check is enable module If allow only for customer - redirect to login page
Mage_Downloadable_CustomerController::preDispatch() : Check customer authentication
Mage_Review_ProductController::preDispatch()
Mage_Review_CustomerController::preDispatch() : Action predispatch
Mage_XmlConnect_ConfigurationController::preDispatch() : Declare content type header
Mage_XmlConnect_Controller_Action::preDispatch() : Declare content type header Validate current application
Mage_XmlConnect_Paypal_MepController::preDispatch() : Make sure customer is logged in
Mage_XmlConnect_CheckoutController::preDispatch() : Make sure customer is logged in
Mage_XmlConnect_CmsController::preDispatch() : Declare content type header
Mage_XmlConnect_WishlistController::preDispatch() : Check if customer is logged in
Mage_Rss_OrderController::preDispatch() : Controller predispatch method to change area for some specific action.
Mage_Rss_CatalogController::preDispatch() : Controller predispatch method to change area for some specific action.
Mage_Install_WizardController::preDispatch()
Mage_Install_IndexController::preDispatch()

renderLayout (line 362)

Rendering layout

access: public

Mage_Core_Controller_Varien_Action renderLayout ([string $output = ''])

string $output

setFlag (line 209)

Setting flag value

access: public

Mage_Core_Controller_Varien_Action setFlag (string $action, string $flag, string $value)

string $action
string $flag
string $value

_construct (line 148)

access: protected

void _construct ()

Redefined in descendants as:

Mage_Bundle_Adminhtml_Bundle_SelectionController::_construct()
Mage_Adminhtml_Catalog_ProductController::_construct()
Mage_Bundle_Adminhtml_Bundle_Product_EditController::_construct()
Mage_Downloadable_Adminhtml_Downloadable_Product_EditController::_construct() : Varien class constructor
Mage_Adminhtml_Catalog_Product_Action_AttributeController::_construct()
Mage_Adminhtml_Sales_OrderController::_construct() : Additional initialization
Mage_Adminhtml_Sales_Order_CreateController::_construct() : Additional initialization
Mage_Adminhtml_Sales_Order_EditController::_construct() : Additional initialization
Mage_Adminhtml_Sales_Order_View_GiftmessageController::_construct() : Additional initialization
Mage_Adminhtml_Sales_Order_StatusController::_construct() : Additional initialization
Mage_Adminhtml_SalesController::_construct() : Additional initialization
Mage_Adminhtml_Controller_Sales_Creditmemo::_construct() : Additional initialization
Mage_Adminhtml_Controller_Sales_Invoice::_construct() : Additional initialization
Mage_Adminhtml_Controller_Sales_Shipment::_construct() : Additional initialization
Mage_ImportExport_Adminhtml_ExportController::_construct() : Custom constructor.
Mage_ImportExport_Adminhtml_ImportController::_construct() : Custom constructor.
Mage_Paypal_Controller_Express_Abstract::_construct() : Instantiate config
Mage_Install_Controller_Action::_construct()

_filterDates (line 931)

Convert dates in array from localized to internal format

access: protected

array _filterDates (array $array, array $dateFields)

array $array
array $dateFields

_filterDateTime (line 959)

Convert dates with time in array from localized to internal format

access: protected

array _filterDateTime (array $array, array $dateFields)

array $array
array $dateFields

_forward (line 587)

Throw control to different action (control and module if was specified).

access: protected

void _forward (string $action, [string|null $controller = null], [string|null $module = null], [ $params = null])

string $action
string|null $controller
string|null $module
string|null $params

Redefined in descendants as:

Mage_Adminhtml_Controller_Action::_forward()

_getRealModuleName (line 775)

Get real module name (like 'Mage_Module')

access: protected

string _getRealModuleName ()

_getRefererUrl (line 731)

Identify referer url via all accepted methods (HTTP_REFERER, regular or base64-encoded request param)

access: protected

string _getRefererUrl ()

_initLayoutMessages (line 616)

Inits layout messages by message storage(s), loading and adding messages to layout messages block

access: protected

Mage_Core_Controller_Varien_Action _initLayoutMessages (string|array $messagesStorage)

string|array $messagesStorage

_isUrlInternal (line 756)

Check url to be used as internal

access: protected

bool _isUrlInternal (string $url)

string $url

_prepareDownloadResponse (line 990)

Declare headers and content file in responce for file download

access: protected

Mage_Core_Controller_Varien_Action _prepareDownloadResponse (string $fileName, string|array $content, [string $contentType = 'application/octet-stream'], [int $contentLength = null])

string $fileName
string|array $content: set to null to avoid starting output, $contentLength should be set explicitly in that case
string $contentType
int $contentLength: explicit content length, if strlen($content) isn't applicable

_redirect (line 666)

Set redirect into response

access: protected

void _redirect (string $path, [array $arguments = array()])

string $path
array $arguments

Redefined in descendants as:

Mage_Adminhtml_Controller_Action::_redirect() : Set redirect into responce

_redirectError (line 695)

Redirect to error page

access: protected

void _redirectError (string $defaultUrl)

string $defaultUrl

_redirectReferer (line 714)

Set referer url for redirect in responce

access: protected

Mage_Core_Controller_Varien_Action _redirectReferer ([string $defaultUrl = null])

string $defaultUrl

Redefined in descendants as:

Mage_Adminhtml_Controller_Action::_redirectReferer() : Set referer url for redirect in responce

_redirectSuccess (line 677)

Redirect to success page

access: protected

void _redirectSuccess (string $defaultUrl)

string $defaultUrl

_redirectUrl (line 654)

Set redirect url into response

access: protected

Mage_Core_Controller_Varien_Action _redirectUrl (string $url)

string $url

_renderTitles (line 908)

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: self::loadLayout()
see: self::renderLayout()
access: protected

void _renderTitles ()

_rewrite (line 814)

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

return: true if rewrite happened
access: protected

boolean _rewrite ()

_title (line 878)

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>

see: self::_renderTitles()
access: protected

Mage_Core_Controller_Varien_Action _title ([string|false|-1|null $text = null], [ $resetIfExists = true])

string|false|-1|null $text
$resetIfExists

_validateFormKey (line 852)

Validate Form Key

access: protected

bool _validateFormKey ()

Class Constants

FLAG_NO_CHECK_INSTALLATION = 'no-install-check' (line 39)

FLAG_NO_COOKIES_REDIRECT = 'no-cookies-redirect' (line 45)

FLAG_NO_DISPATCH = 'no-dispatch' (line 40)

FLAG_NO_DISPATCH_BLOCK_EVENT = 'no-beforeGenerateLayoutBlocksDispatch' (line 44)

FLAG_NO_POST_DISPATCH = 'no-postDispatch' (line 42)

FLAG_NO_PRE_DISPATCH = 'no-preDispatch' (line 41)

FLAG_NO_START_SESSION = 'no-startSession' (line 43)

PARAM_NAME_BASE64_URL = 'r64' (line 50)

PARAM_NAME_ERROR_URL = 'error_url' (line 48)

PARAM_NAME_REFERER_URL = 'referer_url' (line 49)

PARAM_NAME_SUCCESS_URL = 'success_url' (line 47)

PARAM_NAME_URL_ENCODED = 'uenc' (line 51)

PROFILER_KEY = 'mage::dispatch::controller::action' (line 53)

Documentation generated on Fri, 11 Feb 2011 16:55:55 +0200 by phpDocumentor 1.4.3