\Acms\Services\PreviewEngine

Summary

Methods

Properties

Constants

__construct()
isPreviewMode()
getFakeUserAgent()
isValidPreviewSharingUrl()
getShareUrl()
getSharePreviewUrl()
expiredShareUrl()
startPreviewMode()
endPreviewMode()

No public properties found

No constants found

shareUrlFormat()

$session
$get
$lifetime
$shareUrl
$previewFakeUaKeyName
$previewFakeUaTokenKeyName
$previewShareUrlTokenKeyName
$previewModeQueryParameter

N/A

No private methods found

No private properties found

N/A

File: Services/Preview/Engine.php
Package: Default
Class hierarchy: \Acms\Services\Preview\Engine
Implements: \Acms\Services\Preview\Contracts\Base

Properties

$session

$session : \ACMS_Session

PHPセッションラッパー

Type

\ACMS_Session

$get

$get :

Type

$lifetime

$lifetime : integer

プレビュー共有URLの有効時間

Type

integer

$shareUrl

$shareUrl : string

共有URL

Type

string

$previewFakeUaKeyName

$previewFakeUaKeyName : string

偽装UAをセッションに保存する時のキー名

Type

string

$previewFakeUaTokenKeyName

$previewFakeUaTokenKeyName : string

偽装UAをセッションを確認するためのトークンのキー名

Type

string

$previewShareUrlTokenKeyName

$previewShareUrlTokenKeyName : string

プレビュー共有するための認証トークンのキー名

Type

string

$previewModeQueryParameter

$previewModeQueryParameter : string

プレビューモードか判定するために使うURLクエリパラメーター名

Type

string

Methods

__construct()

__construct(\ACMS_Session  $session, integer  $lifetime, string  $shareUrl)

Engine constructor.

Parameters

\ACMS_Session	$session
integer	$lifetime
string	$shareUrl

isPreviewMode()

isPreviewMode() : boolean

プレビューモード中か判定

Returns

boolean

getFakeUserAgent()

getFakeUserAgent() : string

偽装ユーザーエージェントの取得

Returns

string —

| bool

isValidPreviewSharingUrl()

isValidPreviewSharingUrl() : boolean

プレビュー共有モードになれるか判定

Returns

boolean

getShareUrl()

getShareUrl(string  $url) : string

プレビュー共有URLの取得

Parameters

string

$url

Returns

string

getSharePreviewUrl()

getSharePreviewUrl() : string

共有URLで実際に表示するiFrameのURL

Returns

string

expiredShareUrl()

expiredShareUrl()

期限切れの共有URLを削除

startPreviewMode()

startPreviewMode(string  $fakeUserAgent, string  $token) : boolean

プレビューモードを開始

Parameters

string	$fakeUserAgent
string	$token

Returns

boolean

endPreviewMode()

endPreviewMode() : boolean

プレビューモードを終了

Returns

boolean

shareUrlFormat()

shareUrlFormat(string  $url) : string

共有URLから余分な文字列を削除

Parameters

string

$url

Returns

string