Constants

PASSWORD_HASH_TYPE

PASSWORD_HASH_TYPE

パスワードのHashType

DISPLAY_PAGE_NUMBER

DISPLAY_PAGE_NUMBER

表示ページ数の定数

PUBLIC_TYPE_CONFIDENTIAL

PUBLIC_TYPE_CONFIDENTIAL

非公開の定数

PUBLIC_TYPE_DISCLOSE_TO_ALL

PUBLIC_TYPE_DISCLOSE_TO_ALL

公開の定数

AVATAR_THUMB

AVATAR_THUMB

アバターNoimageサムネイル画像

AVATAR_IMG

AVATAR_IMG

アバターNoimage画像

Properties

$actsAs

$actsAs : array

use behaviors

Type

array

$validate

$validate : array

Validation rules

Type

array

$useDbConfig

$useDbConfig : string

Use database config

Type

string

$blockId

$blockId : string

ブロックId Behaviorで関連データ削除する際に使用する

Type

string

$blockKey

$blockKey : string

ブロックKey Behaviorで関連データ削除する際に使用する

Type

string

$contentKey

$contentKey : string

コンテンツKey Behaviorで関連データ削除する際に使用する

Type

string

$publicTypes

$publicTypes : array

公開・非公開のリスト __constructでセットする

Type

array

$languages

$languages : array

language data.

Type

array

$userAttributeData

$userAttributeData : array

user attribute data.

Type

array

$belongsTo

$belongsTo : array

belongsTo associations

Type

array

$hasMany

$hasMany : array

hasMany associations

Type

array

$hasAndBelongsToMany

$hasAndBelongsToMany : array

hasAndBelongsToMany associations

Type

array

$__changeDbConfig

$__changeDbConfig : string

接続先DB master slave変更用

Type

string

$__oldSlaveDbConfig

$__oldSlaveDbConfig : string

接続先DB 古いslave保存用

Type

string

Methods

__construct()

__construct(boolean|integer|string|array  $id = false, string  $table = null, string  $ds = null) 

Constructor. Binds the model's database table to the object.

Parameters

boolean|integer|string|array $id

Set this ID for this model on startup, can also be an array of options, see above.

string $table

Name of database table to use.

string $ds

DataSource connection name.

setMasterDataSource()

setMasterDataSource() : void

Masterの接続先に変更する。

setSlaveDataSource()

setSlaveDataSource() : void

以前のSlaveの接続先に戻す。なければ、ランダムに選択

getDataSource()

getDataSource() : \DataSource

Gets the DataSource to which this model is bound.

Returns

\DataSource —

A DataSource object

create()

create(boolean|array  $data = array(), boolean  $filterKey = false) : array

NetCommonsで使用する共通の値がセットされた結果を返します。<br> CakePHPのSchemaは、not null指定されたカラムのdefaultがnullになっているため、<br> ''(長さ0の文字列)に書き換えています。<br> https://github.com/NetCommons3/NetCommons3/issues/7

セットされるデータ

'room_id' => Current::read('Room.id'),
'language_id' => Current::read('Language.id'),
'block_id' => Current::read('Block.id'),
'block_key' => Current::read('Block.key'),
'frame_id' => Current::read('Frame.id'),
'frame_key' => Current::read('Frame.key'),
'plugin_key' => Inflector::underscore($this->plugin),

Parameters

boolean|array $data

Optional data array to assign to the model after it is created. If null or false, schema data defaults are not merged.

boolean $filterKey

If true, overwrites any primary key input with an empty value

Returns

array —

The current Model::data; after merging $data and/or defaults from database

createAll()

createAll(boolean|array  $data = array(), boolean  $filterKey = false) : array

Initializes the model for writing a new record, loading the default values for those fields that are not defined in $data, and clearing previous validation errors.

Especially helpful for saving data in loops.

Parameters

boolean|array $data

Optional data array to assign to the model after it is created. If null or false, schema data defaults are not merged.

boolean $filterKey

If true, overwrites any primary key input with an empty value

Returns

array —

The current Model::data; after merging $data and/or defaults from database

begin()

begin() : void

transaction begin

commit()

commit() : void

transaction commit

rollback()

rollback(mixed  $ex = null) : void

transaction rollback

Parameters

mixed $ex

Exception

Throws

\Exception

loadModels()

loadModels(array  $models = array()) : void

Load models

Parameters

array $models

models to load

prepare()

prepare(boolean  $force = false) : void

UserModelの前準備

自動登録の場合、この処理を呼び出す前に$this->userAttributeDataをセットする。詳しくは、 Auth.AutoUserRegist::saveAutoUserRegist() を参照してください。

Parameters

boolean $force

強制的に取得するフラグ

beforeValidate()

beforeValidate(array  $options = array()) : boolean

バリデーションのセット

  • ログインIDとパスワードのバリデーションルールをセットする。
    その他のUserモデルのバリデーションルールのセットは、 Users.SaveUserBehavior::beforeValidate で行う。
    また、UsersLanguageのバリデーションも実施する。

  • 自動登録のバリデーションの初期値のセットは、 Auth.AutoUserRegist::validateRequest で行う。

Parameters

array $options

Model::save()のオプション

Returns

boolean

afterValidate()

afterValidate() : void

Called after data has been checked for errors

createUser()

createUser() : array

Userの生成

Returns

array

existsUser()

existsUser(integer|array  $userId) : boolean

Userの存在チェック

Parameters

integer|array $userId

ユーザID

Returns

boolean —

True:正常、False:不正

getUser()

getUser(integer  $userId, integer  $languageId = null) : array

Userの取得

Parameters

integer $userId

ユーザID

integer $languageId

言語ID

Returns

array

getMailAddressForAdmin()

getMailAddressForAdmin() : array

管理者ユーザのメールアドレス取得 ここでいう管理者権限とは、会員管理が使える権限のこと。

Returns

array

saveUser()

saveUser(array  $data, boolean  $self = false) : mixed

ユーザの登録処理

Parameters

array $data

data

boolean $self

自分自身かどうか(=UsersプラグインかUserManagerかどうか)

Throws

\InternalErrorException

Returns

mixed —

On success Model::$data, false on failure

_getDefaultValue()

_getDefaultValue() : array

全カラムのデフォルト値をセットした配列を返す。

Returns

array —

デフォルト値をセットした配列

_setUsernameValidate()

_setUsernameValidate() : void

バリデーションのセット(ログインID)

_setPasswordValidate()

_setPasswordValidate(array  $options = array()) : void

バリデーションのセット(パスワード)

Parameters

array $options

Model::save()のオプション

__getRandomlySlave()

__getRandomlySlave() : string

Find the slaves we have

Returns

string —

The name of the DataSource, as defined in app/Config/database.php

__changeDataSource()

__changeDataSource() : void

MasterDBに切り替える処理