a-blog cms PHP API Reference

Helper
in package

Table of Contents

Methods

addExtraLoggedInCookie()  : void
ログインしている場合、権限のCookieを追加
addUserFromOauth()  : int
新しいユーザーをOAuth認証から作成
canAccessAdminLoginFromCurrentIp()  : bool
管理者ログイン用: 現在のIPアドレスからアクセス可能か判断
canAccessSigninFromCurrentIp()  : bool
一般サインイン用: 現在のIPアドレスからアクセス可能か判断
canMemberSignin()  : bool
会員サインインが可能かどうかを判定
checkAllowedDevice()  : bool
ログイン許可端末のチェック
createTimedLinkParams()  : string
createUser()  : int
findUser()  : int
登録ユーザーを検索
getAdminLoginAuth()  : array<string|int, string>
管理ログインできる権限を取得
getAuthSystemTemplate()  : string|false
認証系URL時のテンプレートを取得
getLogoutRedirectUrl()  : string
ログアウト時のリダイレクト先URLを取得
getSinginAuth()  : array<string|int, string>
一般サインインできる権限を取得
isAuthRequiredPage()  : bool
現在のページが認証が必要なページかどうか判定
isLoggedIn()  : bool
ログイン中かどうか判定
loginRedirect()  : mixed
ログインリダイレクト処理
postLoginProcessing()  : void
ログイン判定後の処理
removeExtraLoggedInCookie()  : void
ログインしていない時、追加されるCookieを削除
resizeUserIcon()  : string
ユーザーアイコンのサイズを変更
setConstantsAuthSystemPage()  : void
認証系ページの定数をセット
subscriberActivation()  : bool
ユーザーを有効化
updateSessionClientInfo()  : void
ログインセッションに付随するクライアント情報を更新
updateUser()  : mixed
userIconFromUri()  : string
画像URIから画像を生成
validateTimedLinkParams()  : array<string|int, mixed>
canAccessFromCurrentIp()  : bool
IPアドレスチェックの共通ロジック
requiresAuthenticationForSecretContent()  : bool
シークレットコンテンツへのアクセスに認証が必要か判定

Methods

addExtraLoggedInCookie()

ログインしている場合、権限のCookieを追加

public addExtraLoggedInCookie(int $uid) : void
Parameters
$uid : int

addUserFromOauth()

新しいユーザーをOAuth認証から作成

public addUserFromOauth(array<string|int, mixed> $data) : int
Parameters
$data : array<string|int, mixed>

OAuth認証データ

Return values
int

canAccessAdminLoginFromCurrentIp()

管理者ログイン用: 現在のIPアドレスからアクセス可能か判断

public canAccessAdminLoginFromCurrentIp() : bool
Return values
bool —

true: アクセス可能, false: アクセス不可能

canAccessSigninFromCurrentIp()

一般サインイン用: 現在のIPアドレスからアクセス可能か判断

public canAccessSigninFromCurrentIp() : bool
Return values
bool —

true: アクセス可能, false: アクセス不可能

canMemberSignin()

会員サインインが可能かどうかを判定

public canMemberSignin() : bool
Return values
bool

checkAllowedDevice()

ログイン許可端末のチェック

public checkAllowedDevice(array<string|int, mixed> $user) : bool
Parameters
$user : array<string|int, mixed>
Return values
bool

createTimedLinkParams()

public createTimedLinkParams(array<string|int, mixed> $context, int $lifetime) : string
Parameters
$context : array<string|int, mixed>
$lifetime : int
Return values
string

findUser()

登録ユーザーを検索

public findUser(string $email, mixed $bid) : int
Parameters
$email : string
$bid : mixed
Return values
int

getAdminLoginAuth()

管理ログインできる権限を取得

public getAdminLoginAuth() : array<string|int, string>
Return values
array<string|int, string>

getAuthSystemTemplate()

認証系URL時のテンプレートを取得

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

getLogoutRedirectUrl()

ログアウト時のリダイレクト先URLを取得

public getLogoutRedirectUrl(int $userId) : string
Parameters
$userId : int
Return values
string

getSinginAuth()

一般サインインできる権限を取得

public getSinginAuth() : array<string|int, string>
Return values
array<string|int, string>

isAuthRequiredPage()

現在のページが認証が必要なページかどうか判定

public isAuthRequiredPage() : bool
Return values
bool

isLoggedIn()

ログイン中かどうか判定

public isLoggedIn() : bool
Return values
bool

loginRedirect()

ログインリダイレクト処理

public loginRedirect(array<string|int, mixed> $user[, string|null $fieldRedirectUrl = null ]) : mixed
Parameters
$user : array<string|int, mixed>
$fieldRedirectUrl : string|null = null

postLoginProcessing()

ログイン判定後の処理

public postLoginProcessing() : void

removeExtraLoggedInCookie()

ログインしていない時、追加されるCookieを削除

public removeExtraLoggedInCookie() : void

resizeUserIcon()

ユーザーアイコンのサイズを変更

public resizeUserIcon(string $squarePath) : string
Parameters
$squarePath : string
Return values
string

setConstantsAuthSystemPage()

認証系ページの定数をセット

public setConstantsAuthSystemPage(Field $queryParameter) : void
Parameters
$queryParameter : Field

subscriberActivation()

ユーザーを有効化

public subscriberActivation(int $uid) : bool
Parameters
$uid : int
Return values
bool

updateSessionClientInfo()

ログインセッションに付随するクライアント情報を更新

public updateSessionClientInfo(int $uid) : void
Parameters
$uid : int

updateUser()

public updateUser(int $uid, Field_Validation $user[, bool $subscribeLoginAnywhere = false ]) : mixed
Parameters
$uid : int
$user : Field_Validation
$subscribeLoginAnywhere : bool = false

userIconFromUri()

画像URIから画像を生成

public userIconFromUri(string $imageUri) : string
Parameters
$imageUri : string

画像URL

Return values
string —

画像パス

validateTimedLinkParams()

public validateTimedLinkParams(string $key, string $salt, string $context) : array<string|int, mixed>
Parameters
$key : string
$salt : string
$context : string
Tags
throws
BadRequestException
throws
ExpiredException
Return values
array<string|int, mixed>

canAccessFromCurrentIp()

IPアドレスチェックの共通ロジック

private canAccessFromCurrentIp(string $whiteListName, string $blackListName) : bool
Parameters
$whiteListName : string
$blackListName : string
Return values
bool

requiresAuthenticationForSecretContent()

シークレットコンテンツへのアクセスに認証が必要か判定

private requiresAuthenticationForSecretContent(string $admin) : bool

シークレットブログ/カテゴリーにアクセスする際、 以下のいずれかに該当する場合は認証（ログイン/サインイン）が必要:

  • プレビュー共有URLではない
  • ログインしていない
  • 認証系ページの場合
  • 拡張機能による特殊な認証をおこなるためのページの場合
Parameters
$admin : string

管理画面パス

Return values
bool —

true: 認証が必要, false: アクセス可能（認証不要）


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results