Base
in
Table of Contents
Methods
- endPreviewMode() : void
- プレビューモードを終了
- expiredShareUrl() : mixed
- 期限切れの共有URLを削除
- getFakeUserAgent() : string|false
- 偽装ユーザーエージェントの取得
- getSharePreviewUrl() : string
- 共有URLで実際に表示するiFrameのURL
- getShareUrl() : string
- プレビュー共有URLの取得
- isPreviewMode() : bool
- プレビューモード中か判定
- isShareableUrl() : bool
- 共有してよい URL か
- isSharedUrlItself() : bool
- なりすまし権限（SUID）を与えてよいリクエストか
- isValidPreviewSharingUrl() : bool
- プレビュー共有モードになれるか判定
- shareabilityError() : string|null
- 共有できない理由（利用者向けメッセージ）を返す。共有してよい URL なら null
- startPreviewMode() : void
- プレビューモードを開始
Methods
endPreviewMode()
プレビューモードを終了
public
endPreviewMode() : void
expiredShareUrl()
期限切れの共有URLを削除
public
expiredShareUrl() : mixed
getFakeUserAgent()
偽装ユーザーエージェントの取得
public
getFakeUserAgent() : string|false
Return values
string|falsegetSharePreviewUrl()
共有URLで実際に表示するiFrameのURL
public
getSharePreviewUrl() : string
Return values
stringgetShareUrl()
プレビュー共有URLの取得
public
getShareUrl(string $url[, mixed $lifetime = false ]) : string
Parameters
- $url : string
- $lifetime : mixed = false
Return values
stringisPreviewMode()
プレビューモード中か判定
public
isPreviewMode() : bool
Return values
boolisShareableUrl()
共有してよい URL か
public
isShareableUrl(string $url) : bool
Parameters
- $url : string
Return values
boolisSharedUrlItself()
なりすまし権限（SUID）を与えてよいリクエストか
public
isSharedUrlItself() : bool
Return values
boolisValidPreviewSharingUrl()
プレビュー共有モードになれるか判定
public
isValidPreviewSharingUrl() : bool
Return values
boolshareabilityError()
共有できない理由（利用者向けメッセージ）を返す。共有してよい URL なら null
public
shareabilityError(string $url) : string|null
Parameters
- $url : string
Return values
string|nullstartPreviewMode()
プレビューモードを開始
public
startPreviewMode(string $fakeUserAgent, string $token) : void
Parameters
- $fakeUserAgent : string
- $token : string