• Home
  • BcManagerComponent

PHP Class BcManagerComponent

Inheritance: extends Component
Datei anzeigen Open project: baserproject/basercms Class Usage Examples

Public Properties

Property Type Description
$Controller Controller Controller

Public Methods

Method Description
addDefaultUser ( array $user, $securitySalt = '' ) : boolean 初期ユーザーを登録する
checkDbConnection ( $config ) : boolean DB接続チェック
checkDefaultDataPattern ( string $pattern, string $theme = 'core' ) : boolean 初期データチェックする
checkEnv ( ) : array 環境チェック
connectDb ( array $config, $name = 'default' ) : DboSource データベースに接続する
constructionDb ( array $dbConfig, string $dbDataPattern = '' ) : boolean baserCMSコアのデータベースを構築する
constructionTable ( $plugin, string $dbConfigKeyName = 'default', string $dbConfig = null ) : boolean テーブルを構築する
createDatabaseConfig ( array $options = [] ) : boolean データベース設定ファイル[database.php]を保存する
createDefaultFiles ( ) アップロード用初期フォルダを作成する
createInstallFile ( $securitySalt, $secrityCipherSeed, $siteUrl = "" ) : boolean インストール設定ファイルを生成する
createPageTemplates ( ) テーマ用のページファイルを生成する
deleteTables ( string $dbConfigKeyName = 'default', array $dbConfig = null ) : boolean テーブルを削除する
deployAdminAssets ( ) : boolean テーマに管理システム用アセットを配置する
deployEditorTemplateImage ( ) : boolean エディタテンプレート用のアイコン画像をデプロイ
deployTheme ( string $theme = null ) : boolean テーマを配置する
executeDefaultUpdates ( $dbConfig ) データベースのデータに初期更新を行う
getAllDefaultDataPatterns ( ) : array 全ての初期データセットのリストを取得する
getDatasourceName ( $datasource = null ) : string datasource名を取得
getDefaultDataPatterns ( string $theme = 'core', array $options = [] ) : array 初期データのセットを取得する
getRealDbName ( string $type, string $name ) : string 実際の設定用のDB名を取得する
initPlugin ( $_path, $dbDataPattern = '' ) プラグインを初期化
initSystemData ( array $dbConfig = null, $options = [] ) システムデータを初期化する
install ( $siteUrl, type $dbConfig, type $adminUser = [], $baseUrl = '', $dbDataPattern = '' ) : boolean baserCMSのインストール
installCorePlugin ( $dbConfig, $dbDataPattern ) : boolean コアプラグインをインストールする
installPlugin ( string $name, $dbDataPattern = '' ) : boolean プラグインをインストールする
loadDefaultDataPattern ( string $dbConfigKeyName, array $dbConfig, string $pattern, string $theme = 'core', string $plugin = 'core', $excludes = [] ) : boolean 初期データを読み込む
reset ( array $dbConfig ) baserCMSをリセットする
resetAdminAssets ( ) : boolean 管理画面用のアセットフォルダ（img / js / css）を初期化する
resetAllTables ( array $dbConfig = null, $excludes = [] ) : boolean プラグインも含めて全てのテーブルをリセットする
resetEmptyFolder ( string $path ) : boolean empty ファイルを梱包したフォルダをリセットする
resetFiles ( ) : boolean files フォルダを初期化する
resetPages ( ) : boolean 固定ページテンプレートをリセットする
resetSetting ( ) : boolean 設定ファイルをリセットする
resetTables ( type $dbConfigKeyName = 'default', type $dbConfig = null, $plugin = 'core', $excludes = [] ) : boolean テーブルをリセットする
resetTheme ( ) : boolean テーマリセットする
setAdminEmail ( string $email ) : boolean サイト基本設定に管理用メールアドレスを登録する
setInstallSetting ( string $key, string $value ) : boolean インストール設定を書き換える
setSecurityCipherSeed ( integer $length = 29 ) : string セキュリティ用の数字キーを生成する
setSecuritySalt ( integer $length = 40 ) : string セキュリティ用のキーを生成する
startup ( Controller $controller )
uninstallPlugin ( string $name ) : boolean プラグインをアンインストールする

Protected Methods

Method Description
_getDataSource ( $dbConfigKeyName = 'default', array $dbConfig = null ) : DataSource データソースを取得する
_updateContents ( ) : boolean コンテンツを更新する
_updatePluginStatus ( $dbConfig ) : boolean プラグインのステータスを更新する

Method Details

_getDataSource() protected method

データソースを取得する
protected _getDataSource ( $dbConfigKeyName = 'default', array $dbConfig = null ) : DataSource
$dbConfig array
return DataSource

_updateContents() protected method

コンテンツを更新する
protected _updateContents ( ) : boolean
return boolean

_updatePluginStatus() protected method

プラグインのステータスを更新する
protected _updatePluginStatus ( $dbConfig ) : boolean
return boolean

addDefaultUser() public method

初期ユーザーを登録する
public addDefaultUser ( array $user, $securitySalt = '' ) : boolean
$user array
return boolean

checkDbConnection() public method

DB接続チェック
public checkDbConnection ( $config ) : boolean
return boolean

checkDefaultDataPattern() public method

初期データチェックする
public checkDefaultDataPattern ( string $pattern, string $theme = 'core' ) : boolean
$pattern string
$theme string
return boolean

checkEnv() public method

環境チェック
public checkEnv ( ) : array
return array

connectDb() public method

データベースに接続する
public connectDb ( array $config, $name = 'default' ) : DboSource
$config array
return DboSource $db

constructionDb() public method

baserCMSコアのデータベースを構築する
public constructionDb ( array $dbConfig, string $dbDataPattern = '' ) : boolean
$dbConfig array データベース設定名
$dbDataPattern string データパターン
return boolean

constructionTable() public method

テーブルを構築する
public constructionTable ( $plugin, string $dbConfigKeyName = 'default', string $dbConfig = null ) : boolean
$dbConfigKeyName string
$dbConfig string
return boolean

createDatabaseConfig() public method

データベース設定ファイル[database.php]を保存する
public createDatabaseConfig ( array $options = [] ) : boolean
$options array
return boolean

createDefaultFiles() public method

アップロード用初期フォルダを作成する
public createDefaultFiles ( )

createInstallFile() public method

インストール設定ファイルを生成する
public createInstallFile ( $securitySalt, $secrityCipherSeed, $siteUrl = "" ) : boolean
return boolean

createPageTemplates() public method

テーマ用のページファイルを生成する
public createPageTemplates ( )

deleteTables() public method

テーブルを削除する
public deleteTables ( string $dbConfigKeyName = 'default', array $dbConfig = null ) : boolean
$dbConfigKeyName string
$dbConfig array
return boolean TODO 処理を DboSource に移動する TODO コアのテーブルを削除する際、プレフィックスだけでは、プラグインを識別できないので、プラグインのテーブルも削除されてしまう。 その為、プラグインのテーブルを削除しようとすると存在しない為、Excerptionが発生してしまい。処理が停止してしまうので、 try で実行し、catch はスルーしている。

deployAdminAssets() public method

テーマに管理システム用アセットを配置する
public deployAdminAssets ( ) : boolean
return boolean

deployEditorTemplateImage() public method

エディタテンプレート用のアイコン画像をデプロイ
public deployEditorTemplateImage ( ) : boolean
return boolean

deployTheme() public method

テーマを配置する
public deployTheme ( string $theme = null ) : boolean
$theme string
return boolean

executeDefaultUpdates() public method

データベースのデータに初期更新を行う
public executeDefaultUpdates ( $dbConfig )

getAllDefaultDataPatterns() public method

全ての初期データセットのリストを取得する
public getAllDefaultDataPatterns ( ) : array
return array

getDatasourceName() public method

datasource名を取得
public getDatasourceName ( $datasource = null ) : string
return string

getDefaultDataPatterns() public method

初期データのセットを取得する
public getDefaultDataPatterns ( string $theme = 'core', array $options = [] ) : array
$theme string
$options array
return array

getRealDbName() public method

実際の設定用のDB名を取得する
public getRealDbName ( string $type, string $name ) : string
$type string
$name string
return string

initPlugin() public method

プラグインを初期化
public initPlugin ( $_path, $dbDataPattern = '' )
$_path

initSystemData() public method

システムデータを初期化する
public initSystemData ( array $dbConfig = null, $options = [] )
$dbConfig array

install() public method

baserCMSのインストール
public install ( $siteUrl, type $dbConfig, type $adminUser = [], $baseUrl = '', $dbDataPattern = '' ) : boolean
$dbConfig type
$adminUser type
return boolean

installCorePlugin() public method

TODO 引数となる $dbDataPattern は、BcManager::installPlugin() で利用できる仕様となっていない
public installCorePlugin ( $dbConfig, $dbDataPattern ) : boolean
return boolean

installPlugin() public method

プラグインをインストールする
public installPlugin ( string $name, $dbDataPattern = '' ) : boolean
$name string
return boolean

loadDefaultDataPattern() public method

初期データを読み込む
public loadDefaultDataPattern ( string $dbConfigKeyName, array $dbConfig, string $pattern, string $theme = 'core', string $plugin = 'core', $excludes = [] ) : boolean
$dbConfigKeyName string
$dbConfig array
$pattern string
$theme string
$plugin string
return boolean

reset() public method

baserCMSをリセットする
public reset ( array $dbConfig )
$dbConfig array

resetAdminAssets() public method

管理画面用のアセットフォルダ（img / js / css）を初期化する
public resetAdminAssets ( ) : boolean
return boolean

resetAllTables() public method

プラグインは有効となっているもののみ 現在のテーマでないテーマの梱包プラグインを検出できない為
public resetAllTables ( array $dbConfig = null, $excludes = [] ) : boolean
$dbConfig array
return boolean

resetEmptyFolder() public method

empty ファイルを残して内包するファイルとフォルダを全て削除する
public resetEmptyFolder ( string $path ) : boolean
$path string
return boolean

resetFiles() public method

files フォルダを初期化する
public resetFiles ( ) : boolean
return boolean

resetPages() public method

固定ページテンプレートをリセットする
public resetPages ( ) : boolean
return boolean

resetSetting() public method

設定ファイルをリセットする
public resetSetting ( ) : boolean
return boolean

resetTables() public method

テーブルをリセットする
public resetTables ( type $dbConfigKeyName = 'default', type $dbConfig = null, $plugin = 'core', $excludes = [] ) : boolean
$dbConfigKeyName type
$dbConfig type
return boolean

resetTheme() public method

テーマリセットする
public resetTheme ( ) : boolean
return boolean

setAdminEmail() public method

サイト基本設定に管理用メールアドレスを登録する
public setAdminEmail ( string $email ) : boolean
$email string
return boolean

setInstallSetting() public method

インストール設定を書き換える
public setInstallSetting ( string $key, string $value ) : boolean
$key string
$value string
return boolean

setSecurityCipherSeed() public method

セキュリティ用の数字キーを生成する
public setSecurityCipherSeed ( integer $length = 29 ) : string
$length integer
return string 数字キー

setSecuritySalt() public method

セキュリティ用のキーを生成する
public setSecuritySalt ( integer $length = 40 ) : string
$length integer
return string キー

startup() public method

public startup ( Controller $controller )
$controller Controller

uninstallPlugin() public method

プラグインをアンインストールする
public uninstallPlugin ( string $name ) : boolean
$name string
return boolean

Property Details

$Controller public_oe property

Controller
public Controller $Controller
return Controller