PHP Class Plugin

Inheritance: extends CI_Controller
ファイルを表示 Open project: baserproject/basercms Class Usage Examples

Public Properties

Property Type Description
$actsAs array ビヘイビア
$validate array バリデーション

Public Methods

Method Description
addFavoriteAdminLink ( string $pluginName, array $user ) : void プラグイン管理のリンクを指定したユーザーのお気に入りに追加
alterDb ( string $plugin, string $dbConfigName = 'baser', string $filterTable = '' ) : boolean データベースの構造を変更する
changePriority ( string | integer $id, string | integer $offset, array $conditions = [] ) : boolean 優先順位を変更する
getDirectoryPath ( string $pluginName ) : string | null プラグインのディレクトリパスを取得
getPluginInfo ( array $datas, string $file ) : array プラグイン情報を取得する
hasDuplicateValue ( string $fieldName ) : boolean 指定したフィールドに重複値があるかチェック
initDb ( string $pluginName = '', $options = [] ) : boolean データベースを初期化する 既存のテーブルは上書きしない
rearrangePriorities ( ) : boolean 優先順位を連番で振り直す
resetDb ( string $plugin ) : boolean データベースをプラグインインストール前の状態に戻す

Method Details

alterDb() public method

データベースの構造を変更する
public alterDb ( string $plugin, string $dbConfigName = 'baser', string $filterTable = '' ) : boolean
$plugin string プラグイン名
$dbConfigName string データベース設定名
$filterTable string テーブル指定
return boolean

changePriority() public method

優先順位を変更する
public changePriority ( string | integer $id, string | integer $offset, array $conditions = [] ) : boolean
$id string | integer 起点となるプラグインのID
$offset string | integer 変更する範囲の相対位置
$conditions array find条件
return boolean

getDirectoryPath() public method

プラグインのディレクトリパスを取得
public getDirectoryPath ( string $pluginName ) : string | null
$pluginName string プラグイン名
return string | null

getPluginInfo() public method

プラグイン情報を取得する
public getPluginInfo ( array $datas, string $file ) : array
$datas array プラグインのデータ配列
$file string プラグインファイルのパス
return array

hasDuplicateValue() public method

指定したフィールドに重複値があるかチェック
public hasDuplicateValue ( string $fieldName ) : boolean
$fieldName string チェックするフィールド名
return boolean

initDb() public method

データベースを初期化する 既存のテーブルは上書きしない
public initDb ( string $pluginName = '', $options = [] ) : boolean
$pluginName string プラグイン名
return boolean

rearrangePriorities() public method

優先順位を連番で振り直す
public rearrangePriorities ( ) : boolean
return boolean

resetDb() public method

データベースをプラグインインストール前の状態に戻す
public resetDb ( string $plugin ) : boolean
$plugin string プラグイン名
return boolean

Property Details

$actsAs public_oe property

ビヘイビア
public array $actsAs
return array

$validate public_oe property

バリデーション
public array $validate
return array