Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions | Data Fields
ActionInterface Interface Reference
Inheritance diagram for ActionInterface:
AccountInterface AbstractAction HttpConnectActionInterface HttpDeleteActionInterface HttpGetActionInterface HttpHeadActionInterface HttpOptionsActionInterface HttpPatchActionInterface HttpPostActionInterface HttpPropfindActionInterface HttpPutActionInterface HttpTraceActionInterface CsrfAwareActionInterface OrderInterface Noroute CookieTester IndexInterface

Public Member Functions

 execute ()
 

Data Fields

const FLAG_NO_DISPATCH = 'no-dispatch'
 
const FLAG_NO_POST_DISPATCH = 'no-postDispatch'
 
const FLAG_NO_DISPATCH_BLOCK_EVENT = 'no-beforeGenerateLayoutBlocksDispatch'
 
const PARAM_NAME_BASE64_URL = 'r64'
 
const PARAM_NAME_URL_ENCODED = 'uenc'
 

Detailed Description

Magento application action controller type. Every action controller in Application should implement this interface.

@api

Since
100.0.2

Definition at line 14 of file ActionInterface.php.

Member Function Documentation

◆ execute()

execute ( )

Execute action based on request and return result

Note: Request will be added as operation argument in future

Returns
\Magento\Framework\Controller\ResultInterface|ResponseInterface
Exceptions

Implemented in FormPost, View, BulkTransferPost, BulkAssignPost, BulkUnassignPost, NewAction, InvalidateToken, Response, PlaceOrder, Validate, Save, Handler, Save, UpdatePost, Redirect, Authorization, Validate, DeleteAction, Place, GetToken, SwitchAction, Add, Access, CheckItems, OverviewPost, View, Index, Upload, PlaceOrder, Index, AddComment, UpdateItemQty, CategoriesJson, Save, CouponPost, Post, Save, GridToCsv, GridToXml, UpdateQty, Save, Synchronize, Save, Request, Edit, Details, RemoveItem, SuggestConfigurableAttributes, MarkUserNotified, AddComment, PrintLabel, GetClientToken, ShippingSaved, View, GetNonce, PrintAction, NewAction, View, Index, GetAttributes, View, Configure, MassDelete, ShippingOptionsCallback, UpdateItemQty, Index, PrintCreditmemo, Popup, Result, Index, Save, EstimatePost, Save, Index, NewAction, SignUp, Upload, CreateOptions, Products, PrintAction, Delete, Success, PrintAction, CreateLabel, Index, Addgroup, VoidAction, Handle, CustomOptions, SuggestAttributes, SuggestAttributeSets, Delete, ExportVarnishConfig, Email, Save, Edit, Validate, Gallery, Index, DefaultTemplate, BulkTransfer, BulkAssign, BulkUnassign, Email, PrintInvoice, PrintShipment, Edit, Disabled, Index, Generate, Render, Validate, AddTrack, GetShippingItemsGrid, Index, InvalidateToken, Blocks, Login, Redirect, Refresh, AlertsStockGrid, Edit, Save, AddAttribute, Validate, Delete, MassUnsubscribe, Cancel, Index, NewAction, ListAction, ShowUpdateResult, View, MassDelete, Grid, Index, BuildWidget, NewAction, TokensDialog, TokensExchange, Grid, View, Response, Index, LogoutSuccess, CancelPayment, LogoutAll, Generate, MassDisable, MassEnable, Form, Index, Cancel, Redirect, Categories, Crosssell, CrosssellGrid, Grid, Options, Delete, Upsell, UpsellGrid, Conditions, Edit, Edit, ReturnQuote, Related, Edit, Index, Forward, Index, SetGrid, Review, Billing, Form, CustomerGrid, DefaultNoRoute, LoadOptions, ExportLowstockCsv, ExportLowstockExcel, Email, ExportLowstockCsv, ExportLowstockExcel, ExportViewedCsv, ExportViewedExcel, Viewed, ReviewPayment, Index, Index, Index, Downloads, ExportDownloadsCsv, ExportDownloadsExcel, Lowstock, Sold, Cancel, Start, ResetPassword, Start, View, Index, Cancel, Delete, Grid, View, Details, Address, Index, Noroute, MassMarkAsRead, MassRemove, Remove, Redirect, Edit, Creditmemos, Email, Hold, Unhold, Index, Edit, MarkAsRead, Index, Save, Index, Index, UpdateItemOptions, SaveOrder, Edit, Overview, Save, Start, Save, Index, Index, Grid, Grid, Index, Save, Form, Grid, NewAction, CmsPageGrid, RoleGrid, DeleteCookie, SetPublicCookie, SetSensitiveCookie, Add, NewConditionHtml, Index, SaveRates, PermissionsDialog, Addresses, Shipping, ExportCsv, ExportXml, ExportCustomerCsv, ExportCustomerExcel, ExportProductCsv, ExportProductDetailCsv, ExportProductDetailExcel, ExportProductExcel, Bestsellers, Coupons, ExportBestsellersCsv, ExportBestsellersExcel, ExportCouponsCsv, ExportCouponsExcel, ExportInvoicedCsv, ExportInvoicedExcel, ExportRefundedCsv, ExportRefundedExcel, ExportSalesCsv, ExportSalesExcel, ExportShippingCsv, ExportShippingExcel, ExportTaxCsv, ExportTaxExcel, Invoiced, Refunded, Sales, Tax, ExportAbandonedCsv, ExportAbandonedExcel, ExportProductCsv, ExportProductExcel, Index, Grid, Index, Grid, EditRole, Grid, Index, Delete, Success, Index, Index, Edit, Configure, Update, Edit, Index, NewAction, Save, ListAction, Index, NewAction, AddressesPost, BackToBilling, Index, Index, Drop, Index, NewAction, Accounts, Orders, Totals, Customer, Product, Shipping, Abandoned, ExportCustomerCsv, ExportCustomerExcel, Product, Index, Index, Delete, ExportCouponsCsv, ExportCouponsXml, Index, NewAction, Add, Index, ExportPost, Delete, Index, ResetPassword, Editrolegrid, Index, RoleGrid, Index, Save, NewAction, Index, NewAction, Cancel, Index, Transactions, DeleteFiles, ActionFake, Index, Index, ReturnQuote, CustomersMost, CustomersNewest, ProductsViewed, ChangeLocale, MassDelete, Grid, Search, AlertsPriceGrid, Delete, Index, OptionsImportGrid, Index, NewAction, NewActionHtml, Chooser, Index, NoCookies, Delete, Configure, Update, CountryRegion, Form, Delete, Grid, Preview, LoginSuccessCallback, Synchronize, NewShipping, BackToAddresses, BackToShipping, Login, Register, RemoveItem, ShippingPost, Grid, Cancel, Drop, Pause, Resume, Sending, Start, Grid, Delete, Grid, Index, Esi, OrdersGrid, Grid, CancelWizard, Index, StartWizard, View, Start, Edit, SaveShippingMethod, UpdateShippingMethods, Redirect, ReturnAction, Start, ProductDetail, RefreshLifetime, RefreshRecent, RefreshStatistics, Customer, RefreshLifetime, ApplyRules, Chooser, CouponsGrid, CouponsMassDelete, NewActionHtml, NewConditionHtml, Index, Activity, NewAction, Index, Contents, DeleteFolder, Index, NewFolder, TreeJson, Upload, CategoriesJson, ProductGrid, Index, Delete, Edit, NewAction, Products, Template, Validate, Index, Carts, LastOrders, Orders, ProductReviews, ViewCart, ViewWishlist, Wishlist, Unsubscribe, ProcessData, Grid, Invoices, Shipments, VoidPayment, ActionStub, Index, Grid, SetStore, ActionStub, Chooser, EstimateUpdatePost, Failure, OnepageStub, IndexStub, EditAddress, EditBilling, EditShipping, EditShippingPost, NewBilling, SaveBilling, SelectBilling, SetBilling, Save, NewAction, ProductControllerStub, and OrderCreateStub.

Field Documentation

◆ FLAG_NO_DISPATCH

const FLAG_NO_DISPATCH = 'no-dispatch'

Definition at line 16 of file ActionInterface.php.

◆ FLAG_NO_DISPATCH_BLOCK_EVENT

const FLAG_NO_DISPATCH_BLOCK_EVENT = 'no-beforeGenerateLayoutBlocksDispatch'

Definition at line 20 of file ActionInterface.php.

◆ FLAG_NO_POST_DISPATCH

const FLAG_NO_POST_DISPATCH = 'no-postDispatch'

Definition at line 18 of file ActionInterface.php.

◆ PARAM_NAME_BASE64_URL

const PARAM_NAME_BASE64_URL = 'r64'

Definition at line 22 of file ActionInterface.php.

◆ PARAM_NAME_URL_ENCODED

const PARAM_NAME_URL_ENCODED = 'uenc'

Definition at line 24 of file ActionInterface.php.


The documentation for this interface was generated from the following file: