a-blog cms PHP API Reference

SnsAuthCallback

SNS認証URLを作成

Table of Contents

Properties

$targetBlogId  : int
ターゲートブログID
$type  : string
処理タイプ

Methods

canAccessAdminLoginFromCurrentIp()  : bool
管理ログイン用のIP制限で、現在のIPアドレスからのアクセス可否を判定する。
canAccessFromCurrentIp()  : bool
処理タイプに応じて、現在のIPアドレスからのアクセスが許可されているか判定する。
canAccessSigninFromCurrentIp()  : bool
一般サインイン用のIP制限で、現在のIPアドレスからのアクセス可否を判定する。
cleanupSession()  : void
セッションをクリーンアップ
error()  : never
失敗時
extractAccountData()  : array<string|int, mixed>
ユーザー作成用にgoogle認証からユーザー情報を抜き出し
findAccount()  : null|array<string|int, mixed>
指定されたユーザーでログインできるか認証
getEmail()  : string
APIレスポンスから、Emailアドレスを取得
getIcon()  : string
APIレスポンスから、アカウントアイコンを取得
getKeyName()  : string
データベースにSNSのsubを登録するカラム名
getServiceName()  : string
SNSサービス名
getSessionUserId()  : int
ログイン中ユーザー（連携登録の対象）のIDを取得する。
getSubId()  : string
APIレスポンスから、アカウント識別IDを取得
getTargetBlog()  : int
ターゲットブログをセッションから取得
getType()  : string
処理タイプをセッションから取得
getUserName()  : string
APIレスポンスから、アカウント名を取得
limitedAuthority()  : array<string|int, mixed>
権限を制限
oauth()  : array<string|int, mixed>
認証してユーザー情報を取得
oAuthCallbackProcess()  : never
Main
redirect()  : never
リダイレクト
regenerateLoginSession()  : void
ログインセッションを再生成する。
register()  : never
既存ユーザーに認証を登録
runProcess()  : never
各処理を開始
searchUserFromDB()  : array<string|int, mixed>
指定された（SNSアカウント含む）ユーザー情報を取得
signin()  : never
サインイン
signup()  : never
サインアップ
success()  : never
成功時

Properties

$targetBlogId

ターゲートブログID

protected int $targetBlogId

Methods

canAccessAdminLoginFromCurrentIp()

管理ログイン用のIP制限で、現在のIPアドレスからのアクセス可否を判定する。

protected canAccessAdminLoginFromCurrentIp() : bool

Login ファサードへの薄いラッパー（テストで差し替え可能にするための seam）。

Return values
bool

canAccessFromCurrentIp()

処理タイプに応じて、現在のIPアドレスからのアクセスが許可されているか判定する。

protected canAccessFromCurrentIp() : bool
  • admin-login: 管理ログイン用のIP制限 (login_white_hosts / login_black_hosts)
  • それ以外 (signin): 一般サインイン用のIP制限 (signin_white_hosts / signin_black_hosts)

findAccount() は signin / admin-login からのみ到達するため、この2分岐で過不足ない。

Return values
bool

canAccessSigninFromCurrentIp()

一般サインイン用のIP制限で、現在のIPアドレスからのアクセス可否を判定する。

protected canAccessSigninFromCurrentIp() : bool

Login ファサードへの薄いラッパー（テストで差し替え可能にするための seam）。

Return values
bool

cleanupSession()

セッションをクリーンアップ

protected cleanupSession() : void

extractAccountData()

ユーザー作成用にgoogle認証からユーザー情報を抜き出し

protected extractAccountData(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
Return values
array<string|int, mixed>

findAccount()

指定されたユーザーでログインできるか認証

protected findAccount(string $key, string $id) : null|array<string|int, mixed>
Parameters
$key : string

IDのタイプを指定 user_id | user_google_id | user_twitter_id

$id : string
Return values
null|array<string|int, mixed>

getEmail()

APIレスポンスから、Emailアドレスを取得

protected abstract getEmail(array<string|int, mixed> $data) : string
Parameters
$data : array<string|int, mixed>
Tags
throws
RuntimeException
Return values
string

getIcon()

APIレスポンスから、アカウントアイコンを取得

protected abstract getIcon(array<string|int, mixed> $data) : string
Parameters
$data : array<string|int, mixed>
Tags
throws
RuntimeException
Return values
string

getKeyName()

データベースにSNSのsubを登録するカラム名

protected abstract getKeyName() : string
Return values
string

getServiceName()

SNSサービス名

protected abstract getServiceName() : string
Return values
string

getSessionUserId()

ログイン中ユーザー（連携登録の対象）のIDを取得する。

protected getSessionUserId() : int

グローバル定数 SUID への参照を集約した seam（テストで差し替え可能にするため）。

Return values
int

getSubId()

APIレスポンスから、アカウント識別IDを取得

protected abstract getSubId(array<string|int, mixed> $data) : string
Parameters
$data : array<string|int, mixed>
Tags
throws
RuntimeException
Return values
string

getTargetBlog()

ターゲットブログをセッションから取得

protected getTargetBlog() : int
Return values
int

getType()

処理タイプをセッションから取得

protected getType() : string
Return values
string

getUserName()

APIレスポンスから、アカウント名を取得

protected abstract getUserName(array<string|int, mixed> $data) : string
Parameters
$data : array<string|int, mixed>
Tags
throws
RuntimeException
Return values
string

limitedAuthority()

権限を制限

protected limitedAuthority() : array<string|int, mixed>
Return values
array<string|int, mixed>

oauth()

認証してユーザー情報を取得

protected abstract oauth() : array<string|int, mixed>
Tags
throws
RuntimeException
Return values
array<string|int, mixed>

oAuthCallbackProcess()

Main

protected oAuthCallbackProcess() : never
Return values
never

redirect()

リダイレクト

protected redirect(int $bid, array<string|int, mixed> $params) : never
Parameters
$bid : int
$params : array<string|int, mixed>
Return values
never

regenerateLoginSession()

ログインセッションを再生成する。

protected regenerateLoginSession(int $uid) : void

グローバル関数 generateSession() への薄いラッパー（テストで差し替え可能にするための seam）。

Parameters
$uid : int

register()

既存ユーザーに認証を登録

protected register(array<string|int, mixed> $data) : never
Parameters
$data : array<string|int, mixed>
Return values
never

runProcess()

各処理を開始

protected runProcess(array<string|int, mixed> $data) : never
Parameters
$data : array<string|int, mixed>
Return values
never

searchUserFromDB()

指定された（SNSアカウント含む）ユーザー情報を取得

protected searchUserFromDB(string $key, string $id) : array<string|int, mixed>
Parameters
$key : string

IDのタイプを指定 user_id | user_google_id | user_twitter_id

$id : string
Return values
array<string|int, mixed>

signin()

サインイン

protected signin(array<string|int, mixed> $data) : never
Parameters
$data : array<string|int, mixed>
Return values
never

signup()

サインアップ

protected signup(array<string|int, mixed> $data) : never
Parameters
$data : array<string|int, mixed>
Return values
never

success()

成功時

protected success([int $uid = 0 ]) : never
Parameters
$uid : int = 0
Return values
never 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results