アップデーターコントローラー

Add your application-wide methods in the class below, your controllers will inherit them.
package Baser.Controller

 Methods

コンストラクタ

__construct(\CakeRequest $request = null, \CakeResponse $response = null
access private

Parameters

$request

\CakeRequest

リクエストオブジェクト

$response

\CakeResponse

レスポンスオブジェクト

Securityコンポーネントのブラックホールからのコールバック

_blackHoleCallback(string $err) : void
フォーム改ざん対策・CSRF対策・SSL制限・HTTPメソッド制限などへの違反が原因で Securityコンポーネントに"ブラックホールされた"場合の動作を指定する

Parameters

$err

string

エラーの種類

Exceptions

\BadRequestException

アップデートスクリプトを実行する

_execScript(string $__plugin, string $__version) : void
access protected

Parameters

$__plugin

string

$__version

string

一括処理

admin_ajax_batch() : void
一括処理としてコントローラーの次のメソッドを呼び出す バッチ処理名は、バッチ処理指定用のコンボボックスで定義する _batch{バッチ処理名} 処理結果として成功の場合は、バッチ処理名を出力する
access public

Token の key を取得

admin_ajax_get_token() : string

Returns

string

よく使う項目の表示状態を保存する

admin_ajax_save_favorite_box(mixed $open = '') : void

Parameters

$open

mixed

1 Or ''

[ADMIN] アップデートスクリプトを実行する

admin_exec_script() : void
access public

プラグインのアップデート実行

admin_plugin(string $name) : void
access public

Parameters

$name

string

Ajax用のエラーを出力する

ajaxError(int $errorNo = 500, mixed $message = '') : void
access public

Parameters

$errorNo

int

エラーのステータスコード

$message

mixed

エラーメッセージ

beforeFilter

beforeFilter() : void
access public

beforeFilter

beforeFilter() : void
access public

beforeRender

beforeRender() : void
access public

現在のユーザーのドキュメントルートの書き込み権限確認

checkRootEditable() : bool
access public

Returns

bool

BETWEEN 条件を生成

convertBetweenCondition(string $fieldName, mixed $value) : array
access public

Parameters

$fieldName

string

フィールド名

$value

mixed

Returns

array

Select Text 用の条件を生成する

convertSelectTextCondition(string $fieldName, mixed $values, array $options = array()) : string
access public

Parameters

$fieldName

string

フィールド名

$values

mixed

$options

array

オプション

Returns

string

イベントを発火

dispatchEvent(string $name, array $params = array(), array $options = array()) : mixed

Parameters

$name

string

イベント名

$params

array

パラメータ

$options

array

オプション

Returns

mixed

ランダムなパスワード文字列を生成する

generatePassword(int $len = 8) : string
access public

Parameters

$len

int

文字列の長さ

Returns

stringパスワード

baserCMSのバージョンを取得する

getBaserVersion(string $plugin = '') : string
access public

Parameters

$plugin

string

プラグイン名

Returns

stringBaserバージョン

CakePHPのバージョンを取得する

getCakeVersion() : string

Returns

stringBaserバージョン

DBのバージョンを取得する

getSiteVersion(string $plugin = '') : string
access public

Parameters

$plugin

string

プラグイン名

Returns

string

テーマのバージョン番号を取得する

getThemeVersion(string $theme) : string
access public

Parameters

$theme

string

テーマ名

Returns

string

リクエストされた画面に対しての認証用ユーザーモデルを取得する

getUserModel() : mixed

Returns

mixedstring Or false

コアのアップデート実行

index() : void
access public

認証完了後処理

isAuthorized(array $user) : bool

Parameters

$user

array

認証されたユーザー情報

Returns

bool

CSVファイルで作成されたデータをインポートする

loadCsv(string $version, string $plugin = '', string $filterTable = '') : boolean
access public

Parameters

$version

string

アップデート対象のバージョン番号を指定します。(例)'3.1.0'

$plugin

string

プラグイン内のCSVを読み込むにはプラグイン名を指定します。(例)'Mail'

$filterTable

string

指定したテーブルのみCSVファイルを読み込む場合は、プレフィックス部分を除外したテーブル名を指定します。(例)'permissions'

指定しない場合は全てのテーブルが対象になります。

Returns

boolean

スキーマファイルを読み込みデータベースのテーブル構造を変更する

loadSchema(string $version, \tring $plugin = '', string $filterTable = '', string $filterType = '') : boolean
access public

Parameters

$version

string

アップデート対象のバージョン番号を指定します。(例)'3.1.0'

$plugin

\tring

プラグイン内のスキーマを読み込むにはプラグイン名を指定します。(例)'Mail'

$filterTable

string

指定したテーブルのみを追加・更新する場合は、プレフィックス部分を除外したテーブル名を指定します。(例)'permissions'

指定しない場合は全てのスキーマファイルが対象となります。

$filterType

string

指定した更新タイプ(create / alter / drop)のみを対象とする場合は更新タイプを指定します。(例)'create'

指定しない場合は全てのスキーマファイルが対象となります。

Returns

boolean

NOT FOUNDページを出力する

notFound() : void
access public

Exceptions

\NotFoundException

Redirects to given $url, after turning off $this->autoRender.

redirect(mixed $url, int $status = null, bool $exit = true) : mixed
Script execution is halted after the redirect.
access public

Parameters

$url

mixed

A string or array-based URL pointing to another location within the app, or an absolute URL

$status

int

Optional HTTP status code (eg: 404)

$exit

bool

If true, exit() will be called after the redirect

Returns

mixedvoid if $exit = false. Terminates script if $exit = true

Returns the referring URL for this request.

referer(string $default = null, bool $local = false) : string
access public
link http://book.cakephp.org/view/430/referer

Parameters

$default

string

Default URL to use if HTTP_REFERER cannot be read from headers

$local

bool

If true, restrict referring URLs to local server

Returns

stringReferring URL

Calls a controller's method from any location.

requestAction(mixed $url, array $extra = array()) : mixed
access public

Parameters

$url

mixed

String or array-based url.

$extra

array

if array includes the key "return" it sets the AutoRender to true.

Returns

mixedBoolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.

メールを送信する

sendMail(string $to, string $title = '', mixed $body = '', array $options = array()) : bool

Parameters

$to

string

送信先アドレス

$title

string

タイトル

$body

mixed

本文

$options

array

オプション

Returns

bool送信結果

Internally redirects one action to another. Examples:

setAction(string $action) : mixed
setAction('another_action'); setAction('action_with_parameters', $parameter1);
access public

Parameters

$action

string

The new action to be redirected to

Returns

mixedReturns the return value of the called action

メッセージをビューにセットする

setMessage(string $message, bool $alert = false, bool $saveDblog = false) : void

Parameters

$message

string

メッセージ

$alert

bool

警告かどうか

$saveDblog

bool

Dblogに保存するか

テーマをセットする

setTheme() : void
access public

テーマ用のヘルパーをセットする 管理画面では読み込まない

setThemeHelpers() : void
access public

アップデートメッセージをセットする

setUpdateLog(string $message) : void
access public

Parameters

$message

string

画面の情報をセットする

setViewConditions(array $filterModels = array(), array $options = array()) : void
access public

Parameters

$filterModels

array

$options

array

オプション

SSLエラー処理

sslFail(string $err) : void
SSL通信が必要なURLの際にSSLでない場合、 SSLのURLにリダイレクトさせる
access protected

Parameters

$err

string

エラーの種類

管理画面用のメソッドを取得(コールバックメソッド)

_adminSslMethods(string $var) : bool
access public

Parameters

$var

string

Returns

bool

配列の文字コードを変換する

_autoConvertEncodingByArray(array $data, string $outenc) : array
access protected

Parameters

$data

array

変換前データ

$outenc

string

変換後の文字コード

Returns

array変換後データ

リファラチェックを行う

_checkReferer() : bool

Returns

bool

リクエストメソッドとトークンをチェックする

_checkSubmitToken() 
- GETでのアクセスの場合 not found - トークンが送信されていない場合 not found

アップデータのパスを取得する

_getScriptMessages(string $plugin = '') : array
access protected

Parameters

$plugin

string

Returns

array$updates

アップデートフォルダのパスを取得する

_getUpdateFolder(string $plugin = '') : mixed
access protected

Parameters

$plugin

string

Returns

mixed$path or false

アップデートスクリプトのパスを取得する

_getUpdatePath(string $version, string $plugin = '') : string

Parameters

$version

string

$plugin

string

Returns

string$path or ''

アップデータのパスを取得する

_getUpdaters(string $plugin = '') : array
access protected

Parameters

$plugin

string

Returns

array$updates

_isRequireCheckSubmitToken()

_isRequireCheckSubmitToken() 

画面の情報をセッションから読み込む

_loadViewConditions(array $filterModels = array(), array|string $options = array()) : void
access protected

Parameters

$filterModels

array

$options

arraystring

オプション

画面の情報をセッションに保存する

_saveViewConditions(array $filterModels = array(), array $options = array()) : void
access protected

Parameters

$filterModels

array

$options

array

オプション

アップデートを実行する

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

Parameters

$plugin

string

Returns

boolean

アップデートメッセージを保存する

_writeUpdateLog() : void
access protected

http経由で送信されたデータを変換する とりあえず、UTF-8で固定

__convertEncodingHttpInput() : void
access private

View用のデータを読み込む。 beforeRenderで呼び出される

__loadDataToView() : void
access private

初回アクセスメッセージ用のフラグを更新する

__updateFirstAccess() : void
access private

 Properties

 

$BcManager

$BcManager : \BcManagerComponent

Default

magic
property
 

管理画面テーマ

$adminTheme : string

Default

null
 

コンポーネント

$components : array

Default

array('BcAuth', 'Cookie', 'BcAuthConfigure', 'BcManager')
access public
 

コンポーネント

$components : array

Default

array('RequestHandler', 'Security', 'Session', 'BcManager', 'Email')
access public
 

コンテンツタイトル

$contentsTitle : string

Default

''
access public
 

パンくずナビ

$crumbs : array

Default

array()
access public
 

ヘルプ

$help : string

Default

''
access public
 

ヘルパー

$helpers : array

Default

array('BcForm')
access public
 

$helpers

$helpers 

Default

array('Session', 'BcHtml', 'Form', 'BcForm', 'BcWidgetArea', 'Js' => array('Jquery'), 'BcBaser', 'BcXml', 'BcArray', 'BcAdmin')
 

レイアウト

$layout : string

Default

'default'
access public
 

クラス名

$name : string

Default

'Updaters'
access public
 

ページタイトル

$pageTitle : string

Default

''
access public
 

プレビューフラグ

$preview : bool

Default

false
access public
   

サイトコンフィグデータ

$siteConfigs : array

Default

array()
access public
 

ページ説明文

$siteDescription : string

Default

''
access public
 

サブディレクトリ

$subDir : string

Default

null
access public
 

サブメニューエレメント

$subMenuElements : string

Default

''
access public
 

モデル

$uses : array

Default

array('Menu', 'Favorite')
access public
 

モデル

$uses : mixed

Default

array('User', 'Menu', 'Favorite')
access protected TODO メニュー管理を除外後、Menuを除外する
 

view

$viewClass : string

Default

'App'
 

アップデートメッセージ

$_updateMessage : array

Default

array()
access protected