Magento 2 Documentation  2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
Public Member Functions
RequestInterface Interface Reference
Inheritance diagram for RequestInterface:
Request RequestContentInterface Request Http Request Request Request Request

Public Member Functions

 getModuleName ()
 
 setModuleName ($name)
 
 getActionName ()
 
 setActionName ($name)
 
 getParam ($key, $defaultValue=null)
 
 setParams (array $params)
 
 getParams ()
 
 getCookie ($name, $default)
 
 isSecure ()
 

Detailed Description

@api

Since
100.0.2

Definition at line 14 of file RequestInterface.php.

Member Function Documentation

◆ getActionName()

getActionName ( )

Retrieve action name

Returns
string

Implemented in Request.

◆ getCookie()

getCookie (   $name,
  $default 
)

Retrieve cookie value

Parameters
string | null$name
string | null$default
Returns
string|null

Implemented in Request.

◆ getModuleName()

getModuleName ( )

Retrieve module name

Returns
string

Implemented in Request.

◆ getParam()

getParam (   $key,
  $defaultValue = null 
)

Retrieve param by key

Parameters
string$key
mixed$defaultValue
Returns
mixed

Implemented in Request.

◆ getParams()

getParams ( )

Retrieve all params as array

Returns
array

Implemented in Request.

◆ isSecure()

isSecure ( )

Returns whether request was delivered over HTTPS

Returns
bool

Implemented in Request.

◆ setActionName()

setActionName (   $name)

Set action name

Parameters
string$name
Returns
$this

Implemented in Request.

◆ setModuleName()

setModuleName (   $name)

Set Module name

Parameters
string$name
Returns
$this

Implemented in Request.

◆ setParams()

setParams ( array  $params)

Set params from key value array

Parameters
array$params
Returns
$this

Implemented in Request.


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