Class Params

Summary

Fully Qualified Name: Laminas\Mvc\Controller\Plugin\Params
Extends: AbstractPlugin

Description

Methods

Name Description Defined By
__invoke() Grabs a param from route match by default. Params
fromFiles() Return all files or a single file. Params
fromHeader() Return all header parameters or a single header parameter. Params
fromPost() Return all post parameters or a single post parameter. Params
fromQuery() Return all query parameters or a single query parameter. Params
fromRoute() Return all route parameters or a single route parameter. Params
getController() Get the current controller instance AbstractPlugin
setController() Set the current controller instance AbstractPlugin

Method Details

__invoke()

Grabs a param from route match by default.

Parameter Name Type Description
$param string
$default mixed

Returns: mixed

fromFiles()

Return all files or a single file.

Parameter Name Type Description
$name string File
$default mixed Default

Returns: array|\ArrayAccess|null

fromHeader()

Return all header parameters or a single header parameter.

Parameter Name Type Description
$header string Header
$default mixed Default

Returns: null|\Laminas\Http\Header\HeaderInterface

fromPost()

Return all post parameters or a single post parameter.

Parameter Name Type Description
$param string Parameter
$default mixed Default

Returns: mixed

fromQuery()

Return all query parameters or a single query parameter.

Parameter Name Type Description
$param string Parameter
$default mixed Default

Returns: mixed

fromRoute()

Return all route parameters or a single route parameter.

Parameter Name Type Description
$param string Parameter
$default mixed Default

Returns: mixed

getController()

Get the current controller instance

Returns: null|\Dispatchable

setController()

Set the current controller instance

Parameter Name Type Description
$controller \Dispatchable

Returns: void

Top