a-blog cms PHP API Reference

Engine
in package
implements Base

Table of Contents

Interfaces

Base

Constants

PREVIEW_SHARE_ADMIN  = 'preview_share'
プレビュー共有ページのADMIN
PREVIEW_SHARE_TPL  = 'admin/preview/share.html'
プレビュー共有ページのテンプレート

Properties

$get  : Field
$lifetime  : int
プレビュー共有URLの有効時間
$previewFakeUaKeyName  : string
偽装UAをセッションに保存する時のキー名
$previewFakeUaTokenKeyName  : string
偽装UAをセッションを確認するためのトークンのキー名
$previewModeQueryParameter  : string
プレビューモードか判定するために使うURLクエリパラメーター名
$previewShareUrlTokenKeyName  : string
プレビュー共有するための認証トークンのキー名
$session  : Session
PHPセッションラッパー
$shareUrl  : string
共有URL

Methods

__construct()  : mixed
Engine constructor.
endPreviewMode()  : void
プレビューモードを終了
expiredShareUrl()  : mixed
期限切れの共有URLを削除
getFakeUserAgent()  : string|false
偽装ユーザーエージェントの取得
getPreviewShareTpl()  : string
getSharePreviewUrl()  : string
共有URLで実際に表示するiFrameのURL
getShareUrl()  : string
プレビュー共有URLの取得
isPreviewMode()  : bool
プレビューモード中か判定
isPreviewShareAdmin()  : bool
isValidPreviewSharingUrl()  : bool
プレビュー共有モードになれるか判定
startPreviewMode()  : void
プレビューモードを開始
shareUrlFormat()  : string
共有URLから余分な文字列を削除
getSession()  : bool|mixed

Constants

PREVIEW_SHARE_ADMIN

プレビュー共有ページのADMIN

protected mixed PREVIEW_SHARE_ADMIN = 'preview_share'

PREVIEW_SHARE_TPL

プレビュー共有ページのテンプレート

protected mixed PREVIEW_SHARE_TPL = 'admin/preview/share.html'

Properties

$lifetime

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

protected int $lifetime

$previewFakeUaKeyName

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

protected string $previewFakeUaKeyName = 'preview_fake_ua'

$previewFakeUaTokenKeyName

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

protected string $previewFakeUaTokenKeyName = 'preview_fake_ua_token'

$previewModeQueryParameter

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

protected string $previewModeQueryParameter = 'acms-preview-mode'

$previewShareUrlTokenKeyName

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

protected string $previewShareUrlTokenKeyName = 'preview-token'

$session

PHPセッションラッパー

protected Session $session

$shareUrl

共有URL

protected string $shareUrl

Methods

__construct()

Engine constructor.

public __construct(int $lifetime, string $shareUrl) : mixed
Parameters
$lifetime : int
$shareUrl : string

endPreviewMode()

プレビューモードを終了

public endPreviewMode() : void

expiredShareUrl()

期限切れの共有URLを削除

public expiredShareUrl() : mixed

getFakeUserAgent()

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

public getFakeUserAgent() : string|false
Return values
string|false

getPreviewShareTpl()

public getPreviewShareTpl() : string
Return values
string

getSharePreviewUrl()

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

public getSharePreviewUrl() : string
Return values
string

getShareUrl()

プレビュー共有URLの取得

public getShareUrl(string $url[, mixed $lifetime = false ]) : string
Parameters
$url : string
$lifetime : mixed = false
Return values
string

isPreviewMode()

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

public isPreviewMode() : bool
Return values
bool

isPreviewShareAdmin()

public isPreviewShareAdmin(string $admin) : bool
Parameters
$admin : string
Return values
bool

isValidPreviewSharingUrl()

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

public isValidPreviewSharingUrl() : bool
Return values
bool

startPreviewMode()

プレビューモードを開始

public startPreviewMode(string $fakeUserAgent, string $token) : void
Parameters
$fakeUserAgent : string
$token : string

shareUrlFormat()

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

protected shareUrlFormat(string $url) : string
Parameters
$url : string
Return values
string

getSession()

private getSession() : bool|mixed
Return values
bool|mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results