PHP Class UpdatersController

Inheritance: extends AppController
Show file Open project: baserproject/basercms

Public Properties

Property Type Description
$components array コンポーネント
$helpers array ヘルパー
$name string クラス名
$uses array モデル

Protected Properties

Property Type Description
$_updateMessage array アップデートメッセージ

Public Methods

Method Description
_execScript ( string $__plugin, string $__version ) : void アップデートスクリプトを実行する
admin_exec_script ( ) : void [ADMIN] アップデートスクリプトを実行する
admin_plugin ( string $name ) : void プラグインのアップデート実行
beforeFilter ( ) : void beforeFilter
beforeRender ( )
index ( ) : void コアのアップデート実行
loadCsv ( string $version, string $plugin = '', string $filterTable = '' ) : boolean CSVファイルで作成されたデータをインポートする
loadSchema ( string $version, tring $plugin = '', string $filterTable = '', string $filterType = '' ) : boolean スキーマファイルを読み込みデータベースのテーブル構造を変更する
setUpdateLog ( string $message ) : void アップデートメッセージをセットする

Protected Methods

Method Description
_getScriptMessages ( string $plugin = '' ) : array アップデータのパスを取得する
_getUpdateFolder ( string $plugin = '' ) : mixed アップデートフォルダのパスを取得する
_getUpdatePath ( string $version, string $plugin = '' ) : string アップデートスクリプトのパスを取得する
_getUpdaters ( string $plugin = '' ) : array アップデータのパスを取得する
_update ( string $plugin = '' ) : boolean アップデートを実行する
_writeUpdateLog ( ) : void アップデートメッセージを保存する

Method Details

_execScript() public method

アップデートスクリプトを実行する
public _execScript ( string $__plugin, string $__version ) : void
$__plugin string
$__version string
return void

_getScriptMessages() protected method

アップデータのパスを取得する
protected _getScriptMessages ( string $plugin = '' ) : array
$plugin string
return array $updates

_getUpdateFolder() protected method

アップデートフォルダのパスを取得する
protected _getUpdateFolder ( string $plugin = '' ) : mixed
$plugin string
return mixed $path or false

_getUpdatePath() protected method

アップデートスクリプトのパスを取得する
protected _getUpdatePath ( string $version, string $plugin = '' ) : string
$version string
$plugin string
return string $path or ''

_getUpdaters() protected method

アップデータのパスを取得する
protected _getUpdaters ( string $plugin = '' ) : array
$plugin string
return array $updates

_update() protected method

アップデートスクリプトを読み込む為、 よく使われるような変数名はダブらないように アンダースコアを二つつける
protected _update ( string $plugin = '' ) : boolean
$plugin string
return boolean

_writeUpdateLog() protected method

アップデートメッセージを保存する
protected _writeUpdateLog ( ) : void
return void

admin_exec_script() public method

[ADMIN] アップデートスクリプトを実行する
public admin_exec_script ( ) : void
return void

admin_plugin() public method

プラグインのアップデート実行
public admin_plugin ( string $name ) : void
$name string
return void

beforeFilter() public method

beforeFilter
public beforeFilter ( ) : void
return void

beforeRender() public method

public beforeRender ( )

index() public method

コアのアップデート実行
public index ( ) : void
return void

loadCsv() public method

CSVファイルで作成されたデータをインポートする
public loadCsv ( string $version, string $plugin = '', string $filterTable = '' ) : boolean
$version string アップデート対象のバージョン番号を指定します。(例)'4.0.0'
$plugin string プラグイン内のCSVを読み込むにはプラグイン名を指定します。(例)'Mail'
$filterTable string 指定したテーブルのみCSVファイルを読み込む場合は、プレフィックス部分を除外したテーブル名を指定します。(例)'permissions' 指定しない場合は全てのテーブルが対象になります。
return boolean

loadSchema() public method

スキーマファイルを読み込みデータベースのテーブル構造を変更する
public loadSchema ( string $version, tring $plugin = '', string $filterTable = '', string $filterType = '' ) : boolean
$version string アップデート対象のバージョン番号を指定します。(例)'4.0.0'
$plugin tring プラグイン内のスキーマを読み込むにはプラグイン名を指定します。(例)'Mail'
$filterTable string 指定したテーブルのみを追加・更新する場合は、プレフィックス部分を除外したテーブル名を指定します。(例)'permissions' 指定しない場合は全てのスキーマファイルが対象となります。
$filterType string 指定した更新タイプ(create / alter / drop)のみを対象とする場合は更新タイプを指定します。(例)'create' 指定しない場合は全てのスキーマファイルが対象となります。
return boolean

setUpdateLog() public method

アップデートメッセージをセットする
public setUpdateLog ( string $message ) : void
$message string
return void

Property Details

$_updateMessage protected property

アップデートメッセージ
protected array $_updateMessage
return array

$components public property

コンポーネント
public array $components
return array

$helpers public property

ヘルパー
public array $helpers
return array

$name public property

クラス名
public string $name
return string

$uses public property

モデル
public array $uses
return array