a-blog cms PHP API Reference

Helper
in package

Table of Contents

Methods

canBulkChangeStatus()  : bool
現在ログインしているユーザーが指定ブログ配下のステータス一括変更を行えるか
canChangeMaintenanceMode()  : bool
現在ログインしているユーザーが指定ブログのメンテナンスモードを切り替えできるか
canCreate()  : bool
現在ログインしているユーザーが指定ブログ配下に新規ブログを作成できるか
canDelete()  : bool
現在ログインしているユーザーが指定ブログを削除できるか
canManageStructure()  : bool
現在ログインしているユーザーが指定ブログ配下のツリー / コンフィグセット等の一括操作を行えるか
canTransitionStatus()  : bool
指定ブログから $toStatus へのステータス遷移が業務ルール上許可されるか
canUpdate()  : bool
現在ログインしているユーザーが指定ブログを編集できるか
hasDescendantBlogs()  : bool
指定したブログが子孫ブログを持っているか
isCodeExists()  : array<string|int, mixed>|bool
ブログコードの存在をチェック
isDomain()  : bool
ライセンスされているドメインかチェック
isValidStatus()  : string|bool
指定したブログのステータスが設定できるか
resolveSessionUserBlogId()  : int|null
セッションユーザーが所属するブログ ID を取得する

Methods

canBulkChangeStatus()

現在ログインしているユーザーが指定ブログ配下のステータス一括変更を行えるか

public canBulkChangeStatus(int $blogId, string $toStatus) : bool

セッション権限と業務ルール（canTransitionStatus()）の両方を満たす場合に true。

Parameters
$blogId : int
$toStatus : string
Return values
bool

canChangeMaintenanceMode()

現在ログインしているユーザーが指定ブログのメンテナンスモードを切り替えできるか

public canChangeMaintenanceMode(int $blogId) : bool
Parameters
$blogId : int
Return values
bool

canCreate()

現在ログインしているユーザーが指定ブログ配下に新規ブログを作成できるか

public canCreate(int $blogId) : bool

$blogId には新規ブログの親となるブログ ID（通常は現在の BID）を渡す。 ライセンスチェック・スーパーブログ要件など a-blog cms 全体のドメインルールも含む。 ショートカット権限による許可はモジュール側で別途検証する。

Parameters
$blogId : int
Return values
bool

canDelete()

現在ログインしているユーザーが指定ブログを削除できるか

public canDelete(int $blogId) : bool

スーパーブログ自身は削除できない。現在のスーパーブログがグローバルブログ （ドメイン直下）でない場合も削除を許可しない。

Parameters
$blogId : int
Return values
bool

canManageStructure()

現在ログインしているユーザーが指定ブログ配下のツリー / コンフィグセット等の一括操作を行えるか

public canManageStructure(int $blogId) : bool

並び替え (Sort)、親変更 (Parent)、コンフィグセット一括設定 (ConfigSet) で利用する。

Parameters
$blogId : int
Return values
bool

canTransitionStatus()

指定ブログから $toStatus へのステータス遷移が業務ルール上許可されるか

public canTransitionStatus(int $blogId, string $toStatus) : bool

現在のステータスより公開度を上げる方向への変更は禁止する:

  • 現在 open → 何にでも変更可
  • 現在 secret → secret / close へ変更可 (open は不可)
  • 現在 close → 変更不可
Parameters
$blogId : int
$toStatus : string
Return values
bool

canUpdate()

現在ログインしているユーザーが指定ブログを編集できるか

public canUpdate(int $blogId) : bool

ショートカット権限による許可はモジュール側で別途検証する。

Parameters
$blogId : int
Return values
bool

hasDescendantBlogs()

指定したブログが子孫ブログを持っているか

public hasDescendantBlogs(int $blogId) : bool
Parameters
$blogId : int
Return values
bool

isCodeExists()

ブログコードの存在をチェック

public isCodeExists(string $domain, string $code[, int $bid = null ][, int $aid = null ]) : array<string|int, mixed>|bool
Parameters
$domain : string
$code : string
$bid : int = null
$aid : int = null
Return values
array<string|int, mixed>|bool

isDomain()

ライセンスされているドメインかチェック

public isDomain(string $domain, int $aid[, bool $isAlias = false ][, bool $update = false ]) : bool
Parameters
$domain : string
$aid : int
$isAlias : bool = false
$update : bool = false
Return values
bool

isValidStatus()

指定したブログのステータスが設定できるか

public isValidStatus(string $val[, bool $update = false ]) : string|bool
Parameters
$val : string
$update : bool = false
Return values
string|bool

resolveSessionUserBlogId()

セッションユーザーが所属するブログ ID を取得する

private resolveSessionUserBlogId() : int|null

SBID は main.php で実行時に決まる動的グローバル定数で、未確定の場合は null になり得る。 値が正の整数として確定している場合のみ返す。

Return values
int|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results