0 フォロワー

クラス yii\grid\Column

全てのクラス | プロパティ | メソッド
継承yii\grid\Column » yii\base\BaseObject
実装yii\base\Configurable
サブクラスyii\grid\ActionColumn、yii\grid\CheckboxColumn、yii\grid\DataColumn、yii\grid\RadioButtonColumn、yii\grid\SerialColumn
利用可能バージョン2.0
ソースコード https://github.com/yiisoft/yii2/blob/master/framework/grid/Column.php

Columnは、全てのyii\grid\GridViewカラムクラスの基底クラスです。

Columnの詳細と使用方法については、データウィジェットに関するガイド記事を参照してください。

公開プロパティ

継承されたプロパティを非表示

プロパティ 型 説明 定義元
$content callable これは、各セルのコンテンツを生成するために使用されるcallableです。 yii\grid\Column
$contentOptions array|Closure データセルタグのHTML属性。 yii\grid\Column
$filterOptions array フィルタセルタグのHTML属性。 yii\grid\Column
$footer string フッターセルのコンテンツ。 yii\grid\Column
$footerOptions array フッターセルタグのHTML属性。 yii\grid\Column
$grid yii\grid\GridView このカラムを所有するグリッドビューオブジェクト。 yii\grid\Column
$header string|null ヘッダーセルのコンテンツ。 yii\grid\Column
$headerOptions array ヘッダーセルタグのHTML属性。 yii\grid\Column
$options array カラムグループタグのHTML属性。 yii\grid\Column
$visible boolean このカラムが表示されるかどうか。 yii\grid\Column

公開メソッド

継承されたメソッドを非表示

メソッド 説明 定義元
__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
hasMethod() メソッドが定義されているかどうかを示す値を返します。 yii\base\BaseObject
hasProperty() プロパティが定義されているかどうかを示す値を返します。 yii\base\BaseObject
init() オブジェクトを初期化します。 yii\base\BaseObject
renderDataCell() データセルをレンダリングします。 yii\grid\Column
renderFilterCell() フィルタセルをレンダリングします。 yii\grid\Column
renderFooterCell() フッターセルをレンダリングします。 yii\grid\Column
renderHeaderCell() ヘッダーセルをレンダリングします。 yii\grid\Column

保護されたメソッド

継承されたメソッドを非表示

メソッド 説明 定義元
getHeaderCellLabel() ヘッダーセルのラベルを返します。 yii\grid\Column
renderDataCellContent() データセルのコンテンツをレンダリングします。 yii\grid\Column
renderFilterCellContent() フィルタセルのコンテンツをレンダリングします。 yii\grid\Column
renderFooterCellContent() フッターセルのコンテンツをレンダリングします。 yii\grid\Column
renderHeaderCellContent() ヘッダーセルのコンテンツをレンダリングします。 yii\grid\Column

プロパティの詳細

継承されたプロパティを非表示

$content public property

これは、各セルのコンテンツを生成するために使用されるcallableです。関数のシグネチャは次のようになります。function ($model, $key, $index, $column)。ここで、$model、$key、$indexは、現在レンダリングされている行のモデル、キー、インデックスを表し、$columnはyii\grid\Columnオブジェクトへの参照です。

public callable $content = null
$contentOptions public property

データセルタグのHTML属性です。これは、属性の配列、またはそのような配列を返す無名関数（Closure）のいずれかになります。関数のシグネチャは以下のとおりです。function ($model, $key, $index, $column)。ここで、$model、$key、$indexは、現在レンダリングされている行のモデル、キー、インデックスを表し、$columnはyii\grid\Columnオブジェクトへの参照です。関数を使用すると、その行のデータに基づいて異なる行に異なる属性を割り当てることができます。

属性のレンダリング方法の詳細については、yii\helpers\Html::renderTagAttributes()も参照してください。

public array|Closure $contentOptions = []
$filterOptions パブリックプロパティ

フィルタセルタグのHTML属性。

属性のレンダリング方法の詳細については、yii\helpers\Html::renderTagAttributes()も参照してください。

public array $filterOptions = []
$footer パブリックプロパティ

フッターセルのコンテンツです。HTMLエンコードされません。

public string $footer = null
$footerOptions パブリックプロパティ

フッターセルタグのHTML属性。

属性のレンダリング方法の詳細については、yii\helpers\Html::renderTagAttributes()も参照してください。

public array $footerOptions = []
$grid パブリックプロパティ

このカラムを所有するグリッドビューオブジェクト。

public yii\grid\GridView $grid = null
$header パブリックプロパティ

ヘッダーセルのコンテンツです。HTMLエンコードされません。

public string|null $header = null
$headerOptions パブリックプロパティ

ヘッダーセルタグのHTML属性。

属性のレンダリング方法の詳細については、yii\helpers\Html::renderTagAttributes()も参照してください。

public array $headerOptions = []
$options パブリックプロパティ

カラムグループタグのHTML属性。

属性のレンダリング方法の詳細については、yii\helpers\Html::renderTagAttributes()も参照してください。

public array $options = []
$visible パブリックプロパティ

この列が表示されるかどうかを示します。デフォルトはtrueです。

public boolean $visible = true

メソッドの詳細

継承されたメソッドを非表示

__call() パブリックメソッド

定義されている場所: yii\base\BaseObject::__call()

クラスメソッドではない名前付きメソッドを呼び出します。

これはPHPのマジックメソッドなので、直接呼び出さないでください。未知のメソッドが呼び出されると暗黙的に呼び出されます。

public mixed __call ( $name, $params )
$name string

メソッド名
$params array

メソッドパラメータ
戻り値 mixed

メソッドの戻り値
例外 yii\base\UnknownMethodException

未知のメソッドを呼び出した場合

 

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() パブリックメソッド

定義されている場所: 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();
}
__get() パブリックメソッド

定義されている場所: yii\base\BaseObject::__get()

オブジェクトプロパティの値を返します。

これはPHPのマジックメソッドなので、直接呼び出さないでください。$value = $object->property;を実行すると暗黙的に呼び出されます。

__set()も参照してください。

public mixed __get ( $name )
$name string

プロパティ名
戻り値 mixed

プロパティ値
例外 yii\base\UnknownPropertyException

プロパティが定義されていない場合
例外 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);
}
__isset() パブリックメソッド

定義されている場所: yii\base\BaseObject::__isset()

プロパティが設定されているかどうか（定義されていてnullではない）を確認します。

これはPHPのマジックメソッドなので、直接呼び出さないでください。isset($object->property)を実行すると暗黙的に呼び出されます。

プロパティが定義されていない場合、falseが返されることに注意してください。

https://www.php.net/manual/en/function.isset.phpも参照してください。

public boolean __isset ( $name )
$name string

プロパティ名またはイベント名
戻り値 boolean

指定されたプロパティが設定されているかどうか（nullでないかどうか）。

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() publicメソッド

定義先: yii\base\BaseObject::__set()

オブジェクトプロパティの値を設定します。

これはPHPのマジックメソッドであり、`$object->property = $value;`を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。

こちらも参照してください __get().

public void __set ( $name, $value )
$name string

プロパティ名またはイベント名
$value mixed

プロパティ値
例外 yii\base\UnknownPropertyException

プロパティが定義されていない場合
例外 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);
    }
}
__unset() publicメソッド

定義先: yii\base\BaseObject::__unset()

オブジェクトプロパティをnullに設定します。

これはPHPのマジックメソッドであり、`unset($object->property)`を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。

プロパティが定義されていない場合、このメソッドは何もしません。プロパティが読み取り専用の場合、例外をスローします。

こちらも参照してください https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

プロパティ名
例外 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);
    }
}
canGetProperty() publicメソッド

定義先: yii\base\BaseObject::canGetProperty()

プロパティを読み取ることができるかどうかを示す値を返します。

プロパティは、以下の場合に読み取り可能です。

  • クラスが、指定された名前と関連付けられたゲッターメソッドを持つ場合（この場合、プロパティ名はケースインセンシティブです）。
  • クラスが、指定された名前のメンバ変数を持つ場合（`$checkVars`がtrueの場合）。

こちらも参照してください canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true )
$name string

プロパティ名
$checkVars boolean

メンバ変数をプロパティとして扱うかどうか
戻り値 boolean

プロパティを読み取ることができるかどうか

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() publicメソッド

定義先: yii\base\BaseObject::canSetProperty()

プロパティを設定できるかどうかを示す値を返します。

プロパティは、以下の場合に書き込み可能です。

  • クラスが、指定された名前と関連付けられたセッターメソッドを持つ場合（この場合、プロパティ名はケースインセンシティブです）。
  • クラスが、指定された名前のメンバ変数を持つ場合（`$checkVars`がtrueの場合）。

こちらも参照してください canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true )
$name string

プロパティ名
$checkVars boolean

メンバ変数をプロパティとして扱うかどうか
戻り値 boolean

プロパティを書き込むことができるかどうか

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public staticメソッド
2.0.14以降非推奨。PHP >= 5.5では、代わりに`::class`を使用してください。

定義先: yii\base\BaseObject::className()

このクラスの完全修飾名を返します。

public static string className ( )
戻り値 string

このクラスの完全修飾名。

 

                public static function className()
{
    return get_called_class();
}
getHeaderCellLabel() protectedメソッド (バージョン2.0.8から使用可能)

ヘッダーセルのラベルを返します。

このメソッドは、ヘッダーセルのラベルをカスタマイズするためにオーバーライドできます。

protected string getHeaderCellLabel ( )
戻り値 string

ラベル

 

                protected function getHeaderCellLabel()
{
    return $this->grid->emptyCell;
}
hasMethod() publicメソッド

定義先: yii\base\BaseObject::hasMethod()

メソッドが定義されているかどうかを示す値を返します。

デフォルトの実装は、PHP関数`method_exists()`の呼び出しです。PHPのマジックメソッド`__call()`を実装した場合は、このメソッドをオーバーライドできます。

public boolean hasMethod ( $name )
$name string

メソッド名
戻り値 boolean

メソッドが定義されているかどうか

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() publicメソッド

定義先: yii\base\BaseObject::hasProperty()

プロパティが定義されているかどうかを示す値を返します。

プロパティは、以下の場合に定義されています。

  • クラスが、指定された名前と関連付けられたゲッターまたはセッターメソッドを持つ場合（この場合、プロパティ名はケースインセンシティブです）。
  • クラスが、指定された名前のメンバ変数を持つ場合（`$checkVars`がtrueの場合）。

こちらも参照してください

public boolean hasProperty ( $name, $checkVars = true )
$name string

プロパティ名
$checkVars boolean

メンバ変数をプロパティとして扱うかどうか
戻り値 boolean

プロパティが定義されているかどうか

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() publicメソッド

定義先: yii\base\BaseObject::init()

オブジェクトを初期化します。

このメソッドは、オブジェクトが指定された設定で初期化された後、コンストラクタの最後に呼び出されます。

public void init ( )

                public function init()
{
}
renderDataCell() publicメソッド

データセルをレンダリングします。

public string renderDataCell ( $model, $key, $index )
$model mixed

レンダリングされるデータモデル
$key mixed

データモデルに関連付けられたキー
$index 整数

yii\grid\GridView::$dataProviderによって返されるアイテム配列における、データアイテムのゼロベースインデックス。
戻り値 string

レンダリング結果

 

                public function renderDataCell($model, $key, $index)
{
    if ($this->contentOptions instanceof Closure) {
        $options = call_user_func($this->contentOptions, $model, $key, $index, $this);
    } else {
        $options = $this->contentOptions;
    }
    return Html::tag('td', $this->renderDataCellContent($model, $key, $index), $options);
}
renderDataCellContent() protectedメソッド

データセルのコンテンツをレンダリングします。

protected string renderDataCellContent ( $model, $key, $index )
$model mixed

データモデル
$key mixed

データモデルに関連付けられたキー
$index 整数

yii\grid\GridView::$dataProviderによって返されるモデル配列における、データモデルのゼロベースインデックス。
戻り値 string

レンダリング結果

 

                protected function renderDataCellContent($model, $key, $index)
{
    if ($this->content !== null) {
        return call_user_func($this->content, $model, $key, $index, $this);
    }
    return $this->grid->emptyCell;
}
renderFilterCell() publicメソッド

フィルタセルをレンダリングします。

public void renderFilterCell ( )

                public function renderFilterCell()
{
    return Html::tag('td', $this->renderFilterCellContent(), $this->filterOptions);
}
renderFilterCellContent() protectedメソッド

フィルタセルのコンテンツをレンダリングします。

デフォルトの実装では、単にスペースをレンダリングします。このメソッドは、フィルターセル（存在する場合）のレンダリングをカスタマイズするためにオーバーライドできます。

protected string renderFilterCellContent ( )
戻り値 string

レンダリング結果

 

                protected function renderFilterCellContent()
{
    return $this->grid->emptyCell;
}
renderFooterCell() publicメソッド

フッターセルをレンダリングします。

public void renderFooterCell ( )

                public function renderFooterCell()
{
    return Html::tag('td', $this->renderFooterCellContent(), $this->footerOptions);
}
renderFooterCellContent() protectedメソッド

フッターセルのコンテンツをレンダリングします。

デフォルトの実装では、単に$footerをレンダリングします。このメソッドは、フッターセルのレンダリングをカスタマイズするためにオーバーライドできます。

protected string renderFooterCellContent ( )
戻り値 string

レンダリング結果

 

                protected function renderFooterCellContent()
{
    return $this->footer !== null && trim($this->footer) !== '' ? $this->footer : $this->grid->emptyCell;
}
renderHeaderCell() publicメソッド

ヘッダーセルをレンダリングします。

public void renderHeaderCell ( )

                public function renderHeaderCell()
{
    return Html::tag('th', $this->renderHeaderCellContent(), $this->headerOptions);
}
renderHeaderCellContent() protectedメソッド

ヘッダーセルのコンテンツをレンダリングします。

デフォルトの実装では、単に$headerをレンダリングします。このメソッドは、ヘッダーセルのレンダリングをカスタマイズするためにオーバーライドできます。

protected string renderHeaderCellContent ( )
戻り値 string

レンダリング結果

 

                protected function renderHeaderCellContent()
{
    return $this->header !== null && trim($this->header) !== '' ? $this->header : $this->getHeaderCellLabel();
}