Documentation

Mage_Adminhtml_Report_SalesController extends Mage_Adminhtml_Controller_Report_Abstract

in package

• Mage
• Adminhtml

Allows dispatching before and after events for each controller action

Table of Contents

Constants

ADMIN_RESOURCE  : mixed = 'admin'

ACL resource

FLAG_IS_URLS_CHECKED  : mixed = 'check_url_settings'

Name of "is URLs checked" flag

FLAG_NO_CHECK_INSTALLATION  : mixed = 'no-install-check'

FLAG_NO_DISPATCH  : mixed = 'no-dispatch'

FLAG_NO_DISPATCH_BLOCK_EVENT  : mixed = 'no-beforeGenerateLayoutBlocksDispatch'

FLAG_NO_POST_DISPATCH  : mixed = 'no-postDispatch'

FLAG_NO_PRE_DISPATCH  : mixed = 'no-preDispatch'

FLAG_NO_START_SESSION  : mixed = 'no-startSession'

PARAM_NAME_BASE64_URL  : mixed = 'r64'

PARAM_NAME_ERROR_URL  : mixed = 'error_url'

PARAM_NAME_REFERER_URL  : mixed = 'referer_url'

PARAM_NAME_SUCCESS_URL  : mixed = 'success_url'

PARAM_NAME_URL_ENCODED  : mixed = 'uenc'

PROFILER_KEY  : mixed = 'dispatch.controller.action'

SESSION_MAX_LIFETIME  : mixed = 60 * 60 * 24 * 400

SESSION_MIN_LIFETIME  : mixed = 60

SESSION_NAMESPACE  : mixed = 'maho_admin_session'

Session constants to refer in other places

Properties

$_adminSession  : null|Mage_Admin_Model_Session

Admin session model

$_currentArea  : string

Currently used area

$_flags  : array<string|int, mixed>

Action flags

$_isLayoutLoaded  : bool

Whether layout is loaded

$_publicActions  : array<string|int, mixed>

Array of actions which can be processed without secret key validation

$_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

$_usedModuleName  : mixed

Used module name in current adminhtml controller

Methods

__()  : string

Translate a phrase

__construct()  : mixed

_initAction()  : $this

Add report/sales breadcrumbs

_initReportAction()  : Mage_Adminhtml_Controller_Report_Abstract

Report action init operations

addActionLayoutHandles()  : $this

bestsellersAction()  : void

couponsAction()  : void

deniedAction()  : void

dispatch()  : mixed

exportBestsellersCsvAction()  : void

Export bestsellers report grid to CSV format

exportBestsellersExcelAction()  : void

Export bestsellers report grid to Excel XML format

exportCouponsCsvAction()  : void

Export coupons report grid to CSV format

exportCouponsExcelAction()  : void

Export coupons report grid to Excel XML format

exportInvoicedCsvAction()  : void

Export invoiced report grid to CSV format

exportInvoicedExcelAction()  : void

Export invoiced report grid to Excel XML format

exportRefundedCsvAction()  : void

Export refunded report grid to CSV format

exportRefundedExcelAction()  : void

Export refunded report grid to Excel XML format

exportSalesCsvAction()  : void

Export sales report grid to CSV format

exportSalesExcelAction()  : void

Export sales report grid to Excel XML format

exportShippingCsvAction()  : void

Export shipping report grid to CSV format

exportShippingExcelAction()  : void

Export shipping report grid to Excel XML format

exportTaxCsvAction()  : void

Export tax report grid to CSV format

exportTaxExcelAction()  : void

Export tax report grid to Excel XML format

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

getUrl()  : string

Generate url by route and parameters

getUsedModuleName()  : string

Retrieve currently used module name

hasAction()  : bool

initLayoutMessages()  : $this

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

invoicedAction()  : void

loadLayout()  : $this

Load layout by handles(s)

loadLayoutUpdates()  : $this

norouteAction()  : void

postDispatch()  : mixed

Dispatches event after action

preDispatch()  : $this

Controller pre-dispatch method

refundedAction()  : void

renderLayout()  : $this|void

Rendering layout

salesAction()  : void

setFlag()  : $this

Setting flag value

setRedirectWithCookieCheck()  : $this

setUsedModuleName()  : $this

Set currently used module name

shippingAction()  : void

taxAction()  : void

_addBreadcrumb()  : $this

_addContent()  : $this

_addJs()  : mixed

_addLeft()  : 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).

_getHelper()  : Mage_Adminhtml_Helper_Data

Retrieve base admihtml helper

_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)

_getSession()  : Mage_Admin_Model_Session

Retrieve admin session model

_initLayoutMessages()  : $this

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

_isAllowed()  : bool

Check current user permission on resource and privilege

_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()  : Mage_Adminhtml_Controller_Action

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

_setActiveMenu()  : $this

Define active menu item in menu block

_showLastExecutionTime()  : Mage_Adminhtml_Controller_Report_Abstract

Add refresh statistics links

_title()  : $this

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

_validateCurrentPassword()  : mixed

Validate password for current admin user

_validateFormKey()  : bool

Validate Form Key

_validateRequestParam()  : bool

Validate request parameter

_validateRequestParams()  : bool

Validate request parameters

_validateSecretKey()  : bool

Validate Secret Key