InstallationsAdminService
extends InstallationsService
in package
implements
InstallationsAdminServiceInterface
uses
BcContainerTrait
InstallationsAdminService
Table of Contents
Interfaces
- InstallationsAdminServiceInterface
- InstallationsAdminServiceInterface
Properties
- $BcDatabase : BcDatabaseServiceInterface|BcDatabaseService
- BcDatabase Service
- $BcDatabase : BcDatabaseService
Methods
- __construct() : mixed
- Constructor
- addDefaultUser() : EntityInterface
- 初期ユーザーを登録する
- buildPermissions() : mixed
- アクセスルールを構築する
- checkEnv() : array<string|int, mixed>
- 環境情報をチェックする
- connectDb() : ConnectionInterface
- データベースに接続する
- constructionDb() : bool
- baserCMSコアのデータベースを構築する
- createDefaultFiles() : bool
- アップロード用初期フォルダを作成する
- createInstallFile() : bool
- インストール設定ファイルを生成する
- createJwt() : bool
- JWTキーを作成する
- deleteAllTables() : bool
- 全てのテーブルを削除する
- deployEditorTemplateImage() : bool
- エディタテンプレート用のアイコン画像をデプロイ
- executeDefaultUpdates() : bool
- データベースのデータに初期更新を行う
- getAllDefaultDataPatterns() : array<string|int, mixed>
- 全てのテーマの初期データのリストを取得する
- getDefaultValuesStep3() : array<string|int, mixed>
- ステップ3用のフォーム初期値を取得する
- getDefaultValuesStep4() : array<string|int, mixed>
- ステップ4用のフォーム初期値を取得する
- getRealDbName() : string
- 実際の設定用のDB名を取得する
- getService() : array<string|int, mixed>|mixed|object
- Get Service
- getViewVarsForStep2() : array<string|int, mixed>
- ステップ2用の view 変数を取得する
- getViewVarsForStep3() : array<string|int, mixed>
- ステップ3用の view 変数を取得する
- hasService() : bool
- Has Service
- initAdmin() : void
- 管理情報を初期化する
- initDb() : void
- データベースを初期化する
- initFiles() : void
- インストールに関するファイルやフォルダを初期化する
- installCorePlugin() : bool
- コアプラグインをインストールする
- installPlugin() : bool
- プラグインをインストールする
- login() : void
- 管理画面にログインする
- readDbSetting() : array<string|int, mixed>
- DB設定をセッションから取得
- sendCompleteMail() : mixed
- インストール完了メールを送信
- setAdminEmailAndVersion() : SiteConfig|false
- サイト基本設定に管理用メールアドレスを登録する
- setSecuritySalt() : string
- セキュリティ用のキーを生成する
- setSiteName() : EntityInterface|null
- サイト名を登録する
- testConnectDb() : mixed
- DBへの接続テストを行う
- writeDbSettingToSession() : void
- DB設定をセッションに保存
- _getDbSource() : array<string|int, mixed>
- 利用可能なデータソースを取得する
- _getMemoryLimit() : int
- memory_limit を取得する
Properties
$BcDatabase
BcDatabase Service
public
BcDatabaseServiceInterface|BcDatabaseService
$BcDatabase
$BcDatabase
public
BcDatabaseService
$BcDatabase
Methods
__construct()
Constructor
public
__construct() : mixed
Tags
addDefaultUser()
初期ユーザーを登録する
public
addDefaultUser(array<string|int, mixed> $user[, mixed $securitySalt = '' ]) : EntityInterface
Parameters
- $user : array<string|int, mixed>
- $securitySalt : mixed = ''
Tags
Return values
EntityInterfacebuildPermissions()
アクセスルールを構築する
public
buildPermissions() : mixed
Tags
checkEnv()
環境情報をチェックする
public
checkEnv() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>connectDb()
データベースに接続する
public
connectDb(ServerRequest $request) : ConnectionInterface
Parameters
- $request : ServerRequest
Tags
Return values
ConnectionInterfaceconstructionDb()
baserCMSコアのデータベースを構築する
public
constructionDb(array<string|int, mixed> $dbConfig[, string $dbDataPattern = '' ][, string $adminTheme = '' ]) : bool
Parameters
- $dbConfig : array<string|int, mixed>
-
データベース設定名
- $dbDataPattern : string = ''
-
データパターン
- $adminTheme : string = ''
Tags
Return values
boolcreateDefaultFiles()
アップロード用初期フォルダを作成する
public
createDefaultFiles() : bool
Tags
Return values
boolcreateInstallFile()
インストール設定ファイルを生成する
public
createInstallFile(array<string|int, mixed> $dbConfig, string $securitySalt) : bool
Parameters
- $dbConfig : array<string|int, mixed>
- $securitySalt : string
Tags
Return values
boolcreateJwt()
JWTキーを作成する
public
createJwt() : bool
Tags
Return values
booldeleteAllTables()
全てのテーブルを削除する
public
deleteAllTables(ServerRequest $request) : bool
Parameters
- $request : ServerRequest
Tags
Return values
booldeployEditorTemplateImage()
エディタテンプレート用のアイコン画像をデプロイ
public
deployEditorTemplateImage() : bool
Tags
Return values
boolexecuteDefaultUpdates()
データベースのデータに初期更新を行う
public
executeDefaultUpdates() : bool
Tags
Return values
boolgetAllDefaultDataPatterns()
全てのテーマの初期データのリストを取得する
public
getAllDefaultDataPatterns() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getDefaultValuesStep3()
ステップ3用のフォーム初期値を取得する
public
getDefaultValuesStep3(ServerRequest $request) : array<string|int, mixed>
Parameters
- $request : ServerRequest
Tags
Return values
array<string|int, mixed>getDefaultValuesStep4()
ステップ4用のフォーム初期値を取得する
public
getDefaultValuesStep4(ServerRequest $request) : array<string|int, mixed>
Parameters
- $request : ServerRequest
Tags
Return values
array<string|int, mixed>getRealDbName()
実際の設定用のDB名を取得する
public
getRealDbName(string $type, string $name) : string
Parameters
- $type : string
- $name : string
Tags
Return values
stringgetService()
Get Service
public
getService(mixed $service) : array<string|int, mixed>|mixed|object
Parameters
- $service : mixed
Tags
Return values
array<string|int, mixed>|mixed|objectgetViewVarsForStep2()
ステップ2用の view 変数を取得する
public
getViewVarsForStep2() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getViewVarsForStep3()
ステップ3用の view 変数を取得する
public
getViewVarsForStep3(bool $blDBSettingsOK) : array<string|int, mixed>
Parameters
- $blDBSettingsOK : bool
Tags
Return values
array<string|int, mixed>hasService()
Has Service
public
hasService(mixed $service) : bool
Parameters
- $service : mixed
Tags
Return values
boolinitAdmin()
管理情報を初期化する
public
initAdmin(ServerRequest $request) : void
- 初期ユーザー情報
- サイト名
Parameters
- $request : ServerRequest
Tags
initDb()
データベースを初期化する
public
initDb(ServerRequest $request) : void
Parameters
- $request : ServerRequest
Tags
initFiles()
インストールに関するファイルやフォルダを初期化する
public
initFiles(ServerRequest $request) : void
Parameters
- $request : ServerRequest
Tags
installCorePlugin()
コアプラグインをインストールする
public
installCorePlugin() : bool
Tags
Return values
boolinstallPlugin()
プラグインをインストールする
public
installPlugin(string $name) : bool
Parameters
- $name : string
Tags
Return values
boollogin()
管理画面にログインする
public
login(ServerRequest $request, Response $response) : void
Parameters
- $request : ServerRequest
- $response : Response
Tags
readDbSetting()
DB設定をセッションから取得
public
readDbSetting(ServerRequest $request[, array<string|int, mixed> $installationData = [] ]) : array<string|int, mixed>
Parameters
- $request : ServerRequest
- $installationData : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed>sendCompleteMail()
インストール完了メールを送信
public
sendCompleteMail(array<string|int, mixed> $postData) : mixed
Parameters
- $postData : array<string|int, mixed>
Tags
setAdminEmailAndVersion()
サイト基本設定に管理用メールアドレスを登録する
public
setAdminEmailAndVersion(string $email) : SiteConfig|false
Parameters
- $email : string
Tags
Return values
SiteConfig|falsesetSecuritySalt()
セキュリティ用のキーを生成する
public
setSecuritySalt([int $length = 40 ]) : string
Parameters
- $length : int = 40
Tags
Return values
string —キー
setSiteName()
サイト名を登録する
public
setSiteName(string $name) : EntityInterface|null
Parameters
- $name : string
Tags
Return values
EntityInterface|nulltestConnectDb()
DBへの接続テストを行う
public
testConnectDb(array<string|int, mixed> $config) : mixed
Parameters
- $config : array<string|int, mixed>
Tags
writeDbSettingToSession()
DB設定をセッションに保存
public
writeDbSettingToSession(ServerRequest $request, array<string|int, mixed> $data) : void
Parameters
- $request : ServerRequest
- $data : array<string|int, mixed>
Tags
_getDbSource()
利用可能なデータソースを取得する
protected
_getDbSource() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>_getMemoryLimit()
memory_limit を取得する
protected
_getMemoryLimit() : int