DevelopmentApiController
extends ApiControllerBase
in package
FinalYes
[API] 開発用コントローラ。
こいつ自体は何もしないけどミドルウェアが localhost
以外を弾く。
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
- 生成。
- administrator() : IActionResult
- initialize() : IActionResult
- 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
$logger read-only
ロガー。
protected
ILogger
$logger
$loggerFactory read-only
ロガー生成器。
protected
ILoggerFactory
$loggerFactory
$logic
コントローラ内で今輝いてるロジック。よくないんよなぁ。
protected
LogicBase|null
$logic
= null
$logicFactory read-only
protected
ILogicFactory
$logicFactory
$programContext read-only
protected
ProgramContext
$programContext
$stores read-only
protected
Stores
$stores
$templateFactory read-only
protected
ITemplateFactory
$templateFactory
$urlHelper read-only
protected
IUrlHelper
$urlHelper
$webSecurity read-only
protected
WebSecurity
$webSecurity
$appUrl
private
AppUrl
$appUrl
Attributes
- #[Inject]
Methods
__construct()
生成。
public
__construct(ControllerArgument $argument) : mixed
Parameters
- $argument : ControllerArgument
-
コントローラ入力値(継承先でも必須となる)。
administrator()
public
administrator() : IActionResult
Return values
IActionResultinitialize()
public
initialize() : IActionResult
Return values
IActionResultcreateLogic()
ロジック生成処理。
protected
createLogic(LogicBase> $logicClass[, array<int|string, mixed> $arguments = [] ]) : LogicBase
Parameters
- $logicClass : LogicBase>
-
ロジック完全名。
- $arguments : array<int|string, mixed> = []
Return values
LogicBasecreateViewActionResult()
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
ViewActionResultdata()
データ応答。
protected
data(DataContent $content) : DataActionResult
Parameters
- $content : DataContent
Return values
DataActionResultgetSkipBaseName()
コントローラ完全名からコントローラベース名を取得する際にスキップする文言(文字列長が使用される)
protected
getSkipBaseName() : string
Return values
stringredirectPath()
ドメイン内でリダイレクト。 基本的にこれを使っておけばいいが、ドメイン周りはそれっぽく取得しているだけなので正確に対応するなら継承先でいい感じにすること。
protected
redirectPath(UrlPath|string $path[, UrlQuery|null $query = null ]) : RedirectActionResult
Parameters
Return values
RedirectActionResultredirectUrl()
URLリダイレクト。
protected
redirectUrl(Url $url) : RedirectActionResult
Parameters
- $url : Url
Return values
RedirectActionResultview()
Viewを表示。
protected
view(non-empty-string $action, TemplateParameter $parameter) : ViewActionResult
viewWithController
を調整すれば基本的にこれだけ使っておけばよい。
Parameters
- $action : non-empty-string
-
アクション名。
- $parameter : TemplateParameter
-
View連携データ。
Return values
ViewActionResultviewWithController()
Viewを表示。
protected
viewWithController(non-empty-string $controllerName, non-empty-string $action, TemplateParameter $parameter) : ViewActionResult
Parameters
- $controllerName : non-empty-string
-
コントローラ完全名。
- $action : non-empty-string
-
アクション名。
- $parameter : TemplateParameter
-
View連携データ。
Return values
ViewActionResultgetResponseHeaders()
ロジック側で生成された応答ヘッダを取得。
private
getResponseHeaders() : array<non-empty-string, array<string|int, string>>
Return values
array<non-empty-string, array<string|int, string>> —応答ヘッダ。ロジック未生成の場合は空の応答ヘッダを返す。