2 フォロワー

クラス yii\helpers\VarDumper

継承yii\helpers\VarDumper » yii\helpers\BaseVarDumper
利用可能なバージョン2.0
ソースコード https://github.com/yiisoft/yii2/blob/master/framework/helpers/VarDumper.php

VarDumperは、バグのあるPHP関数`var_dump`と`print_r`に代わるものです。

複雑なオブジェクト構造において、再帰的に参照されるオブジェクトを正しく識別できます。また、特殊な変数の無限再帰的な表示を避けるための再帰深度制御も備えています。

VarDumperは次のように使用できます。

VarDumper::dump($var);

公開メソッド

継承されたメソッドを隠す

メソッド 説明 定義元
dump() 変数を表示します。 yii\helpers\BaseVarDumper
dumpAsString() 変数を文字列としてダンプします。 yii\helpers\BaseVarDumper
export() 変数を文字列表現としてエクスポートします。 yii\helpers\BaseVarDumper

メソッドの詳細

継承されたメソッドを隠す

dump() public static method

定義元: yii\helpers\BaseVarDumper::dump()

変数を表示します。

このメソッドは、`var_dump`と`print_r`と同様の機能を実現しますが、Yiiコントローラーなどの複雑なオブジェクトを処理する場合により堅牢です。

public static void dump ( $var, $depth 10, $highlight false )
$var mixed

ダンプする変数

$depth integer

ダンプが変数に深く入る最大深度。デフォルトは10。

$highlight boolean

結果を構文強調表示するかどうか

                public static function dump($var, $depth = 10, $highlight = false)
{
    echo static::dumpAsString($var, $depth, $highlight);
}

            
dumpAsString() public static method

定義元: yii\helpers\BaseVarDumper::dumpAsString()

変数を文字列としてダンプします。

このメソッドは、`var_dump`と`print_r`と同様の機能を実現しますが、Yiiコントローラーなどの複雑なオブジェクトを処理する場合により堅牢です。

public static string dumpAsString ( $var, $depth 10, $highlight false )
$var mixed

ダンプする変数

$depth integer

ダンプが変数に深く入る最大深度。デフォルトは10。

$highlight boolean

結果を構文強調表示するかどうか

戻り値 string

変数の文字列表現

                public static function dumpAsString($var, $depth = 10, $highlight = false)
{
    self::$_output = '';
    self::$_objects = [];
    self::$_depth = $depth;
    self::dumpInternal($var, 0);
    if ($highlight) {
        $result = highlight_string("<?php\n" . self::$_output, true);
        self::$_output = preg_replace('/&lt;\\?php<br \\/>/', '', $result, 1);
    }
    return self::$_output;
}

            
export() public static method

定義元: yii\helpers\BaseVarDumper::export()

変数を文字列表現としてエクスポートします。

この文字列は、PHPパーサーによって評価できる有効なPHP式であり、評価結果によって変数値が返されます。

このメソッドは`var_export()`に似ています。主な違いは、短い配列構文を使用してよりコンパクトな文字列表現を生成することです。

また、PHP関数`serialize()`と`unserialize()`を使用してオブジェクトを処理します。

エクスポートされた値を解析するには、PHP 5.4以降が必要です。

public static string export ( $var )
$var mixed

エクスポートする変数。

戻り値 string

変数の文字列表現

                public static function export($var)
{
    self::$_output = '';
    self::exportInternal($var, 0);
    return self::$_output;
}