PHP Class Zend\Mvc\Controller\Plugin\AcceptableViewModelSelector

Inheritance: extends Zend\Mvc\Controller\Plugin\AbstractPlugin
Show file Open project: zendframework/zend-mvc

Protected Properties

Property Type Description
$defaultMatchAgainst Array Default array to match against.
$defaultViewModelName Default ViewModel
$event Zend\Mvc\MvcEvent
$request Zend\Http\Request

Public Methods

Method Description
__invoke ( array $matchAgainst = null, boolean $returnDefault = true, Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart | null &$resultReference = null ) : Zend\View\Model\ModelInterface | null Detects an appropriate viewmodel for request.
getDefaultMatchAgainst ( ) : array | null Get the default Accept Types and View Model combinations to match against if none are specified.
getDefaultViewModelName ( ) : string Set the default View Model (name) to return if no match could be made
getViewModel ( array $matchAgainst = null, boolean $returnDefault = true, Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart | null &$resultReference = null ) : Zend\View\Model\ModelInterface | null Detects an appropriate viewmodel for request.
getViewModelName ( array $matchAgainst = null, boolean $returnDefault = true, Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart | null &$resultReference = null ) : Zend\View\Model\ModelInterface | null Detects an appropriate viewmodel name for request.
match ( array $matchAgainst = null ) : Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart | null Detects an appropriate viewmodel name for request.
setDefaultMatchAgainst ( array $matchAgainst = null ) : AcceptableViewModelSelector Set the default Accept Types and View Model combinations to match against if none are specified.
setDefaultViewModelName ( string $defaultViewModelName ) : AcceptableViewModelSelector Set the default View Model (name) to return if no match could be made

Protected Methods

Method Description
extractViewModelName ( Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart $res ) : string Extract the viewmodel name from a match
getEvent ( ) : MvcEvent Get the event
getRequest ( ) : Zend\Http\Request Get the request
injectViewModelName ( string $modelAcceptString, string $modelName ) : string Inject the viewmodel name into the accept header string

Method Details

__invoke() public method

Detects an appropriate viewmodel for request.
public __invoke ( array $matchAgainst = null, boolean $returnDefault = true, Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart | null &$resultReference = null ) : Zend\View\Model\ModelInterface | null
$matchAgainst array (optional) The Array to match against
$returnDefault boolean (optional) If no match is available. Return default instead
$resultReference Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart | null (optional) The object that was matched
return Zend\View\Model\ModelInterface | null

extractViewModelName() protected method

Extract the viewmodel name from a match
protected extractViewModelName ( Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart $res ) : string
$res Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart
return string

getDefaultMatchAgainst() public method

Get the default Accept Types and View Model combinations to match against if none are specified.
public getDefaultMatchAgainst ( ) : array | null
return array | null

getDefaultViewModelName() public method

Set the default View Model (name) to return if no match could be made
public getDefaultViewModelName ( ) : string
return string

getEvent() protected method

Get the event
protected getEvent ( ) : MvcEvent
return Zend\Mvc\MvcEvent

getRequest() protected method

Get the request
protected getRequest ( ) : Zend\Http\Request
return Zend\Http\Request

getViewModel() public method

Detects an appropriate viewmodel for request.
public getViewModel ( array $matchAgainst = null, boolean $returnDefault = true, Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart | null &$resultReference = null ) : Zend\View\Model\ModelInterface | null
$matchAgainst array (optional) The Array to match against
$returnDefault boolean (optional) If no match is available. Return default instead
$resultReference Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart | null (optional) The object that was matched
return Zend\View\Model\ModelInterface | null

getViewModelName() public method

Detects an appropriate viewmodel name for request.
public getViewModelName ( array $matchAgainst = null, boolean $returnDefault = true, Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart | null &$resultReference = null ) : Zend\View\Model\ModelInterface | null
$matchAgainst array (optional) The Array to match against
$returnDefault boolean (optional) If no match is available. Return default instead
$resultReference Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart | null (optional) The object that was matched.
return Zend\View\Model\ModelInterface | null Returns null if $returnDefault = false and no match could be made

injectViewModelName() protected method

Inject the viewmodel name into the accept header string
protected injectViewModelName ( string $modelAcceptString, string $modelName ) : string
$modelAcceptString string
$modelName string
return string

match() public method

Detects an appropriate viewmodel name for request.
public match ( array $matchAgainst = null ) : Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart | null
$matchAgainst array (optional) The Array to match against
return Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart | null The object that was matched

setDefaultMatchAgainst() public method

Set the default Accept Types and View Model combinations to match against if none are specified.
public setDefaultMatchAgainst ( array $matchAgainst = null ) : AcceptableViewModelSelector
$matchAgainst array (optional) The Array to match against
return AcceptableViewModelSelector provides fluent interface

setDefaultViewModelName() public method

Set the default View Model (name) to return if no match could be made
public setDefaultViewModelName ( string $defaultViewModelName ) : AcceptableViewModelSelector
$defaultViewModelName string The default View Model name
return AcceptableViewModelSelector provides fluent interface

Property Details

$defaultMatchAgainst protected property

Default array to match against.
protected Array $defaultMatchAgainst
return Array

$defaultViewModelName protected property

Default ViewModel
protected $defaultViewModelName

$event protected property

protected MvcEvent,Zend\Mvc $event
return Zend\Mvc\MvcEvent

$request protected property

protected Request,Zend\Http $request
return Zend\Http\Request