PHP Класс Zend\Mvc\Controller\Plugin\AcceptableViewModelSelector

Наследование: extends Zend\Mvc\Controller\Plugin\AbstractPlugin
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$defaultMatchAgainst Array Default array to match against.
$defaultViewModelName Default ViewModel
$event Zend\Mvc\MvcEvent
$request Zend\Http\Request

Открытые методы

Метод Описание
__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

Защищенные методы

Метод Описание
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

Описание методов

__invoke() публичный Метод

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
Результат Zend\View\Model\ModelInterface | null

extractViewModelName() защищенный Метод

Extract the viewmodel name from a match
protected extractViewModelName ( Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart $res ) : string
$res Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart
Результат string

getDefaultMatchAgainst() публичный Метод

Get the default Accept Types and View Model combinations to match against if none are specified.
public getDefaultMatchAgainst ( ) : array | null
Результат array | null

getDefaultViewModelName() публичный Метод

Set the default View Model (name) to return if no match could be made
public getDefaultViewModelName ( ) : string
Результат string

getEvent() защищенный Метод

Get the event
protected getEvent ( ) : MvcEvent
Результат Zend\Mvc\MvcEvent

getRequest() защищенный Метод

Get the request
protected getRequest ( ) : Zend\Http\Request
Результат Zend\Http\Request

getViewModel() публичный Метод

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
Результат Zend\View\Model\ModelInterface | null

getViewModelName() публичный Метод

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.
Результат Zend\View\Model\ModelInterface | null Returns null if $returnDefault = false and no match could be made

injectViewModelName() защищенный Метод

Inject the viewmodel name into the accept header string
protected injectViewModelName ( string $modelAcceptString, string $modelName ) : string
$modelAcceptString string
$modelName string
Результат string

match() публичный Метод

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
Результат Zend\Http\Header\Accept\FieldValuePart\AbstractFieldValuePart | null The object that was matched

setDefaultMatchAgainst() публичный Метод

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
Результат AcceptableViewModelSelector provides fluent interface

setDefaultViewModelName() публичный Метод

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
Результат AcceptableViewModelSelector provides fluent interface

Описание свойств

$defaultMatchAgainst защищенное свойство

Default array to match against.
protected Array $defaultMatchAgainst
Результат Array

$defaultViewModelName защищенное свойство

Default ViewModel
protected $defaultViewModelName

$event защищенное свойство

protected MvcEvent,Zend\Mvc $event
Результат Zend\Mvc\MvcEvent

$request защищенное свойство

protected Request,Zend\Http $request
Результат Zend\Http\Request