クラス yii\db\mssql\ColumnSchema
| 継承 | yii\db\mssql\ColumnSchema » yii\db\ColumnSchema » yii\base\BaseObject |
|---|---|
| 実装 | yii\base\Configurable |
| 利用可能なバージョン | 2.0.23 |
| ソースコード | https://github.com/yiisoft/yii2/blob/master/framework/db/mssql/ColumnSchema.php |
MSSQLデータベース用のColumnSchemaクラス
パブリックプロパティ
| プロパティ | 型 | 説明 | 定義元 |
|---|---|---|---|
| $allowNull | boolean | このカラムがNULLを許容するかどうか。 | yii\db\ColumnSchema |
| $autoIncrement | boolean | このカラムが自動インクリメントかどうか | yii\db\ColumnSchema |
| $comment | string | このカラムのコメント。 | yii\db\ColumnSchema |
| $dbType | string | このカラムのDB型。 | yii\db\ColumnSchema |
| $defaultValue | mixed | このカラムのデフォルト値 | yii\db\ColumnSchema |
| $enumValues | array | 列挙可能な値。 | yii\db\ColumnSchema |
| $isComputed | boolean | このカラムが計算されたカラムかどうか | yii\db\mssql\ColumnSchema |
| $isPrimaryKey | boolean | このカラムが主キーかどうか | yii\db\ColumnSchema |
| $name | string | このカラムの名前(引用符なし)。 | yii\db\ColumnSchema |
| $phpType | string | このカラムのPHP型。 | yii\db\ColumnSchema |
| $precision | integer | 数値型の場合、カラムデータの精度。 | yii\db\ColumnSchema |
| $scale | integer | 数値型の場合、カラムデータのスケール。 | yii\db\ColumnSchema |
| $size | integer | カラムの表示サイズ。 | yii\db\ColumnSchema |
| $type | string | このカラムの抽象型。 | yii\db\ColumnSchema |
| $unsigned | boolean | このカラムが符号なしかどうか。 | yii\db\ColumnSchema |
パブリックメソッド
| メソッド | 説明 | 定義元 |
|---|---|---|
| __call() | クラスメソッドではない名前付きメソッドを呼び出します。 | yii\base\BaseObject |
| __construct() | コンストラクタ。 | yii\base\BaseObject |
| __get() | オブジェクトプロパティの値を返します。 | yii\base\BaseObject |
| __isset() | プロパティが設定されているか、つまり定義されていてNULLではないかを確認します。 | yii\base\BaseObject |
| __set() | オブジェクトプロパティの値を設定します。 | yii\base\BaseObject |
| __unset() | オブジェクトプロパティをNULLに設定します。 | yii\base\BaseObject |
| canGetProperty() | プロパティが読み取り可能かどうかを示す値を返します。 | yii\base\BaseObject |
| canSetProperty() | プロパティが設定可能かどうかを示す値を返します。 | yii\base\BaseObject |
| className() | このクラスの完全修飾名を返します。 | yii\base\BaseObject |
| dbTypecast() | $type と $dbType に従って、DBクエリで使用するために入力値を変換します。 | yii\db\ColumnSchema |
| defaultPhpTypecast() | デフォルト値を準備し、$phpType に従って変換します。 | yii\db\mssql\ColumnSchema |
| hasMethod() | メソッドが定義されているかどうかを示す値を返します。 | yii\base\BaseObject |
| hasProperty() | プロパティが定義されているかどうかを示す値を返します。 | yii\base\BaseObject |
| init() | オブジェクトを初期化します。 | yii\base\BaseObject |
| phpTypecast() | データベースから取得した後、$phpType に従って入力値を変換します。 | yii\db\ColumnSchema |
プロテクトメソッド
| メソッド | 説明 | 定義元 |
|---|---|---|
| typecast() | データベースから取得した後、$phpType に従って入力値を変換します。 | yii\db\ColumnSchema |
プロパティの詳細
メソッドの詳細
定義元: yii\base\BaseObject::__call()
クラスメソッドではない名前付きメソッドを呼び出します。
このメソッドは、不明なメソッドが呼び出されたときに暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。
| public mixed __call ( $name, $params ) | ||
| $name | string |
メソッド名 |
| $params | array |
メソッドのパラメータ |
| return | mixed |
メソッドの戻り値 |
|---|---|---|
| throws | yii\base\UnknownMethodException |
不明なメソッドを呼び出した場合 |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
定義元: yii\base\BaseObject::__construct()
コンストラクタ。
デフォルトの実装では、次の2つのことを行います。
- 与えられた設定
$configでオブジェクトを初期化します。 - init() を呼び出します。
このメソッドが子クラスでオーバーライドされる場合は、以下をお勧めします。
- コンストラクタの最後のパラメータは、ここにある
$configのような設定配列にすること。 - コンストラクタの最後に親の実装を呼び出すこと。
| public void __construct ( $config = [] ) | ||
| $config | array |
オブジェクトのプロパティを初期化するために使用される名前と値のペア |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
定義元: yii\base\BaseObject::__get()
オブジェクトプロパティの値を返します。
このメソッドは、`$value = $object->property;` を実行するときに暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。
__set() も参照してください。
| public mixed __get ( $name ) | ||
| $name | string |
プロパティ名 |
| return | mixed |
プロパティの値 |
|---|---|---|
| throws | yii\base\UnknownPropertyException |
プロパティが定義されていない場合 |
| throws | yii\base\InvalidCallException |
プロパティが書き込み専用の場合 |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter();
} elseif (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
定義元: yii\base\BaseObject::__isset()
プロパティが設定されているか、つまり定義されていてNULLではないかを確認します。
このメソッドは、`isset($object->property)` を実行するときに暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。
プロパティが定義されていない場合は、false が返されることに注意してください。
| public boolean __isset ( $name ) | ||
| $name | string |
プロパティ名またはイベント名 |
| return | boolean |
指定されたプロパティが設定されているか (null でないか)。 |
|---|---|---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
定義元: yii\base\BaseObject::__set()
オブジェクトプロパティの値を設定します。
このメソッドは、`$object->property = $value;` を実行するときに暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。
__get() も参照してください。
| public void __set ( $name, $value ) | ||
| $name | string |
プロパティ名またはイベント名 |
| $value | mixed |
プロパティの値 |
| throws | yii\base\UnknownPropertyException |
プロパティが定義されていない場合 |
|---|---|---|
| throws | yii\base\InvalidCallException |
プロパティが読み取り専用の場合 |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter($value);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
} else {
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
}
定義元: yii\base\BaseObject::__unset()
オブジェクトプロパティをNULLに設定します。
このメソッドは、`unset($object->property)` を実行するときに暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。
プロパティが定義されていない場合、このメソッドは何もしないことに注意してください。プロパティが読み取り専用の場合は、例外がスローされます。
| public void __unset ( $name ) | ||
| $name | string |
プロパティ名 |
| throws | yii\base\InvalidCallException |
プロパティが読み取り専用の場合。 |
|---|---|---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
}
}
定義元: yii\base\BaseObject::canGetProperty()
プロパティが読み取り可能かどうかを示す値を返します。
プロパティは、次の場合に読み取り可能です。
- クラスが指定された名前に関連付けられたゲッターメソッドを持っている場合 (この場合、プロパティ名は大小文字を区別しません)。
- クラスが指定された名前のメンバ変数を持っている場合 (
$checkVarsが true の場合)。
canSetProperty() も参照してください。
| public boolean canGetProperty ( $name, $checkVars = true ) | ||
| $name | string |
プロパティ名 |
| $checkVars | boolean |
メンバ変数をプロパティとして扱うかどうか |
| return | boolean |
プロパティが読み取れるかどうか |
|---|---|---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
定義元: yii\base\BaseObject::canSetProperty()
プロパティが設定可能かどうかを示す値を返します。
プロパティは、次の場合に書き込み可能です。
- クラスが指定された名前に関連付けられたセッターメソッドを持っている場合 (この場合、プロパティ名は大小文字を区別しません)。
- クラスが指定された名前のメンバ変数を持っている場合 (
$checkVarsが true の場合)。
canGetProperty() も参照してください。
| public boolean canSetProperty ( $name, $checkVars = true ) | ||
| $name | string |
プロパティ名 |
| $checkVars | boolean |
メンバ変数をプロパティとして扱うかどうか |
| return | boolean |
プロパティが書き込み可能かどうか |
|---|---|---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
::class を使用してください。
定義元: yii\base\BaseObject::className()
このクラスの完全修飾名を返します。
| public static string className ( ) | ||
| return | string |
このクラスの完全修飾名。 |
|---|---|---|
public static function className()
{
return get_called_class();
}
定義元: yii\db\ColumnSchema::dbTypecast()
$type と $dbType に従って、DBクエリで使用するために入力値を変換します。
値が null または yii\db\Expression の場合、変換されません。
| public mixed dbTypecast ( $value ) | ||
| $value | mixed |
入力値 |
| return | mixed |
変換された値。これは、最初の要素として値、2番目の要素として PDO タイプを含む配列になることもあります。 |
|---|---|---|
public function dbTypecast($value)
{
// the default implementation does the same as casting for PHP, but it should be possible
// to override this with annotation of explicit PDO type.
return $this->typecast($value);
}
デフォルト値を準備し、$phpType に従って変換します。
| public mixed defaultPhpTypecast ( $value ) | ||
| $value | mixed |
デフォルト値 |
| return | mixed |
変換後の値 |
|---|---|---|
public function defaultPhpTypecast($value)
{
if ($value !== null) {
// convert from MSSQL column_default format, e.g. ('1') -> 1, ('string') -> string
$value = substr(substr($value, 2), 0, -2);
}
return parent::phpTypecast($value);
}
定義元: yii\base\BaseObject::hasMethod()
メソッドが定義されているかどうかを示す値を返します。
デフォルトの実装は、PHP 関数 method_exists() を呼び出すことです。PHP のマジックメソッド __call() を実装した場合は、このメソッドをオーバーライドできます。
| public boolean hasMethod ( $name ) | ||
| $name | string |
メソッド名 |
| return | boolean |
メソッドが定義されているかどうか |
|---|---|---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
定義元: yii\base\BaseObject::hasProperty()
プロパティが定義されているかどうかを示す値を返します。
プロパティが定義されているのは、以下の場合です。
- クラスが、指定された名前に関連付けられたゲッターまたはセッターメソッドを持っている場合(この場合、プロパティ名は大小文字を区別しません)。
- クラスが指定された名前のメンバ変数を持っている場合 (
$checkVarsが true の場合)。
参考
| public boolean hasProperty ( $name, $checkVars = true ) | ||
| $name | string |
プロパティ名 |
| $checkVars | boolean |
メンバ変数をプロパティとして扱うかどうか |
| return | boolean |
プロパティが定義されているかどうか |
|---|---|---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
| public void init ( ) |
public function init()
{
}
定義元: yii\db\ColumnSchema::phpTypecast()
データベースから取得した後、$phpType に従って入力値を変換します。
値が null または yii\db\Expression の場合、変換されません。
| public mixed phpTypecast ( $value ) | ||
| $value | mixed |
入力値 |
| return | mixed |
変換後の値 |
|---|---|---|
public function phpTypecast($value)
{
return $this->typecast($value);
}
定義元: yii\db\ColumnSchema::typecast()
データベースから取得した後、$phpType に従って入力値を変換します。
値が null または yii\db\Expression の場合、変換されません。
| protected mixed typecast ( $value ) | ||
| $value | mixed |
入力値 |
| return | mixed |
変換後の値 |
|---|---|---|
protected function typecast($value)
{
if (
$value === ''
&& !in_array(
$this->type,
[
Schema::TYPE_TEXT,
Schema::TYPE_STRING,
Schema::TYPE_BINARY,
Schema::TYPE_CHAR
],
true
)
) {
return null;
}
if (
$value === null
|| gettype($value) === $this->phpType
|| $value instanceof ExpressionInterface
|| $value instanceof Query
) {
return $value;
}
if (
is_array($value)
&& count($value) === 2
&& isset($value[1])
&& in_array($value[1], $this->getPdoParamTypes(), true)
) {
return new PdoValue($value[0], $value[1]);
}
switch ($this->phpType) {
case 'resource':
case 'string':
if (is_resource($value)) {
return $value;
}
if (is_float($value)) {
// ensure type cast always has . as decimal separator in all locales
return StringHelper::floatToString($value);
}
if (
is_numeric($value)
&& ColumnSchemaBuilder::CATEGORY_NUMERIC === ColumnSchemaBuilder::$typeCategoryMap[$this->type]
) {
// https://github.com/yiisoft/yii2/issues/14663
return $value;
}
if (PHP_VERSION_ID >= 80100 && is_object($value) && $value instanceof \BackedEnum) {
return (string) $value->value;
}
return (string) $value;
case 'integer':
if (PHP_VERSION_ID >= 80100 && is_object($value) && $value instanceof \BackedEnum) {
return (int) $value->value;
}
return (int) $value;
case 'boolean':
// treating a 0 bit value as false too
// https://github.com/yiisoft/yii2/issues/9006
return (bool) $value && $value !== "\0" && strtolower($value) !== 'false';
case 'double':
return (float) $value;
}
return $value;
}
コメントするには、サインアップまたはログインしてください。