Documentation

Mage_Cms_PageController extends Mage_Core_Controller_Front_Action

in package

• Mage
• Cms

Maho

Tags

copyright

Copyright (c) 2006-2020 Magento, Inc. (https://magento.com)

copyright

Copyright (c) 2022-2024 The OpenMage Contributors (https://openmage.org)

copyright

Copyright (c) 2024 Maho (https://mahocommerce.com)

license

https://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)

Table of Contents

Constants

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'

SESSION_LEGACY_NAMESPACES  = ['om_frontend', 'frontend']

SESSION_MAX_LIFETIME  = 60 * 60 * 24 * 400

SESSION_MIN_LIFETIME  = 60 * 60

SESSION_NAMESPACE  = 'maho_session'

Session constants to refer in other places

Properties

$_cookieCheckActions  : array<string|int, mixed>

Action list where need check enabled cookie

$_currentArea  : string

Currently used area

$_flags  : array<string|int, mixed>

Action flags

$_isLayoutLoaded  : bool

Whether layout is loaded

$_realModuleName  : string

Real module name (like 'Mage_Module')

$_removeDefaultTitle  : bool

Whether the default title should be removed

$_request  : Mage_Core_Controller_Request_Http

Request object

$_response  : Mage_Core_Controller_Response_Http

Response object

$_sessionNamespace  : string

Namespace for session.

$_titles  : array<string|int, mixed>

Title parts to be rendered in the page head title

Methods

__()  : string

Translate a phrase

__construct()  : mixed

addActionLayoutHandles()  : $this

dispatch()  : mixed

generateLayoutBlocks()  : $this

generateLayoutXml()  : $this

getActionMethodName()  : string

Retrieve action method name

getFlag()  : array<string|int, mixed>|bool

Retrieve flag value

getFullActionName()  : string

Retrieve full bane of current action current controller and current module

getLayout()  : Mage_Core_Model_Layout

Retrieve current layout object

getRequest()  : Mage_Core_Controller_Request_Http

Retrieve request object

getResponse()  : Mage_Core_Controller_Response_Http

Retrieve response object

hasAction()  : bool

initLayoutMessages()  : $this

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

loadLayout()  : $this

Load layout by handles(s)

loadLayoutUpdates()  : $this

noCookiesAction()  : mixed

norouteAction()  : mixed

postDispatch()  : $this

Postdispatch: should set last visited url

preDispatch()  : $this

Predispatch: should set layout area

renderLayout()  : $this|void

Rendering layout

setFlag()  : $this

Setting flag value

setRedirectWithCookieCheck()  : $this

Set redirect into response with session id in URL if it is enabled.

viewAction()  : mixed

_construct()  : void

_filterDates()  : array<string|int, mixed>

Convert dates in array from localized to internal format

_filterDateTime()  : array<string|int, mixed>

Convert dates with time in array from localized to internal format

_forward()  : mixed

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

_getRealModuleName()  : string

Get real module name (like 'Mage_Module')

_getRefererUrl()  : string

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

_initLayoutMessages()  : $this

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

_isFormKeyEnabled()  : bool

Check if form key validation is enabled.

_isUrlInternal()  : bool

Check url to be used as internal

_prepareDownloadResponse()  : $this

Declare headers and content file in response for file download

_redirect()  : $this

Set redirect into response

_redirectError()  : $this

Redirect to error page

_redirectReferer()  : $this

Set referer url for redirect in response

_redirectSuccess()  : $this

Redirect to success page

_redirectUrl()  : $this

Set redirect url into response

_renderTitles()  : mixed

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

_rewrite()  : bool

Support for controllers rewrites

_title()  : $this

Add an extra title to the end or one from the end, or remove all

_validateFormKey()  : bool

Validate Form Key

isFormkeyValidationOnCheckoutEnabled()  : bool

Check if form_key validation enabled on checkout process