PeServer

ApiControllerBase extends DomainControllerBase
in package

AbstractYes

[API] API処理コントローラ基底。

Table of Contents

Properties

$logger  : ILogger
ロガー。
$loggerFactory  : ILoggerFactory
ロガー生成器。
$logic  : LogicBase|null
コントローラ内で今輝いてるロジック。よくないんよなぁ。
$logicFactory  : ILogicFactory
$programContext  : ProgramContext
$stores  : Stores
$templateFactory  : ITemplateFactory
$urlHelper  : IUrlHelper
$webSecurity  : WebSecurity
$appUrl  : AppUrl

Methods

__construct()  : mixed
生成。
createLogic()  : LogicBase
ロジック生成処理。
createViewActionResult()  : ViewActionResult
Viewを表示。
data()  : DataActionResult
データ応答。
getSkipBaseName()  : string
コントローラ完全名からコントローラベース名を取得する際にスキップする文言(文字列長が使用される)
redirectPath()  : RedirectActionResult
ドメイン内でリダイレクト。 基本的にこれを使っておけばいいが、ドメイン周りはそれっぽく取得しているだけなので正確に対応するなら継承先でいい感じにすること。
redirectUrl()  : RedirectActionResult
URLリダイレクト。
view()  : ViewActionResult
Viewを表示。
viewWithController()  : ViewActionResult
Viewを表示。
getResponseHeaders()  : array<non-empty-string, array<string|int, string>>
ロジック側で生成された応答ヘッダを取得。

Properties

$logic

コントローラ内で今輝いてるロジック。よくないんよなぁ。

protected LogicBase|null $logic = null

Methods

createLogic()

ロジック生成処理。

protected createLogic(LogicBase> $logicClass[, array<int|string, mixed> $arguments = [] ]) : LogicBase
Parameters
$logicClass : LogicBase>

ロジック完全名。

$arguments : array<int|string, mixed> = []
Return values
LogicBase

createViewActionResult()

Viewを表示。

protected createViewActionResult(string $templateBaseName, string $actionName, TemplateParameter $templateParameter, array<string|int, mixed> $headers, ProgramContext $programContext, ITemplateFactory $templateFactory, IUrlHelper $urlHelper, WebSecurity $webSecurity) : ViewActionResult
Parameters
$templateBaseName : string
$actionName : string
$templateParameter : TemplateParameter
$headers : array<string|int, mixed>
$programContext : ProgramContext
$templateFactory : ITemplateFactory
$urlHelper : IUrlHelper
$webSecurity : WebSecurity
Return values
ViewActionResult

getSkipBaseName()

コントローラ完全名からコントローラベース名を取得する際にスキップする文言(文字列長が使用される)

protected getSkipBaseName() : string
Return values
string

redirectPath()

ドメイン内でリダイレクト。 基本的にこれを使っておけばいいが、ドメイン周りはそれっぽく取得しているだけなので正確に対応するなら継承先でいい感じにすること。

protected redirectPath(UrlPath|string $path[, UrlQuery|null $query = null ]) : RedirectActionResult
Parameters
$path : UrlPath|string

行先。

$query : UrlQuery|null = null

付与するクエリ。

Return values
RedirectActionResult

getResponseHeaders()

ロジック側で生成された応答ヘッダを取得。

private getResponseHeaders() : array<non-empty-string, array<string|int, string>>
Return values
array<non-empty-string, array<string|int, string>> —

応答ヘッダ。ロジック未生成の場合は空の応答ヘッダを返す。


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results