CodeIgniter4 生成查詢結果

結果數組

getResult()

這個方法返回 對象數組 類型的查詢結果，或在失敗時返回 一個空數組 。 典型的用法是使用 foreach 循環(huán)，像這樣:

$query = $db->query("YOUR QUERY");


foreach ($query->getResult() as $row)
{
    echo $row->title;
    echo $row->name;
    echo $row->body;
}

上面的方法是 getResultObject() 的別名。

如果你想返回一個二維數組，可以給第一個參數傳字符串 ‘array’

$query = $db->query("YOUR QUERY");


foreach ($query->getResult('array') as $row)
{
    echo $row['title'];
    echo $row['name'];
    echo $row['body'];
}

上面的方法是 getResultArray() 的別名。

你也可以傳字符串參數到 getResult() 方法，表示要為每個結果對象實例化的類

$query = $db->query("SELECT * FROM users;");


foreach ($query->getResult('User') as $user)
{
    echo $user->name; // 獲取屬性
    echo $user->reverseName(); // 或訪問 'User' 類定義的方法
}

上面的方法是 getCustomResultObject() 的別名。

getResultArray()

這個方法返回一個純數組的查詢結果，查無結果時為空數組。 典型的用法是使用 foreach 循環(huán)，像這樣:

$query = $db->query("YOUR QUERY");


foreach ($query->getResultArray() as $row)
{
    echo $row['title'];
    echo $row['name'];
    echo $row['body'];
}

單行結果

getRow()

這個方法返回一個單行結果，如果你的查詢有多行結果，它僅返回第一條。 返回結果是一個 對象 。使用示例:

$query = $db->query("YOUR QUERY");


$row = $query->getRow();


if (isset($row))
{
    echo $row->title;
    echo $row->name;
    echo $row->body;
}

如果你想返回指定行的結果，可以在第一個參數里提供這個數字:

$row = $query->getRow(5);

你也可以傳一個字符串到第二個參數，表示該結果實例化的對象類:

$query = $db->query("SELECT * FROM users LIMIT 1;");
$row = $query->getRow(0, 'User');


echo $row->name; // 獲取屬性
echo $row->reverse_name(); // 或訪問 'User' 類定義的方法

getRowArray()

這個與上面的 row() 方法基本相同，區(qū)別是它返回的是一個數組。 示例:

$query = $db->query("YOUR QUERY");


$row = $query->getRowArray();


if (isset($row))
{
    echo $row['title'];
    echo $row['name'];
    echo $row['body'];
}

如果你想返回指定行的結果，可以在第一個參數里提供這個數字:

$row = $query->getRowArray(5);

另外，你可以用這些方法在結果集里做 前進/后退/首行/尾行 的游標操作:

$row = $query-&getFirstRow()

$row = $query-&getLastRow()

$row = $query-&getNextRow()

$row = $query-&getPreviousRow()

默認他們返回一個對象，除非第一個參數是字符串 “array” 才會返回數組:

$row = $query-&getFirstRow(‘array’)

$row = $query-&getLastRow(‘array’)

$row = $query-&getNextRow(‘array’)

$row = $query-&getPreviousRow(‘array’)

注解

以上所有方法都會把整個查詢結果載入內存（預加載）。 請使用 getUnbufferedRow() 方法處理大型結果集。

getUnbufferedRow()

這個方法返回單個結果，不會像 row() 把整個結果預加載到內存里。 如果你的查詢結果多于一個，它返回當前行并將內部數據指針向前移動。

$query = $db->query("YOUR QUERY");


while ($row = $query->getUnbufferedRow())
{
    echo $row->title;
    echo $row->name;
    echo $row->body;
}

你可以選擇性的傳參 ‘object’ (默認) 或 ‘array’ 來指定返回數據的類型:

$query->getUnbufferedRow();         // 對象
$query->getUnbufferedRow('object'); // 對象
$query->getUnbufferedRow('array');  // 關聯(lián)數組

自定義結果對象

你可以用一個自定義的類實例作為返回結果，代替原來的 stdClass 對象或數組，

getResult() 和 getResultArray() 允許如此操作。

如果該類（文件）尚未加載到內存，自動加載器會嘗試載入它。 對象的屬性值會設置為數據庫的返回數據，如果是非公開屬性， 你需要提供一個 __set() 方法以允許他們被賦予值。

示例:

class User
{
        public $id;
        public $email;
        public $username;


        protected $last_login;


        public function lastLogin($format)
        {
                return $this->lastLogin->format($format);
        }


        public function __set($name, $value)
        {
                if ($name === 'lastLogin')
                {
                        $this->lastLogin = DateTime::createFromFormat('U', $value);
                }
        }


        public function __get($name)
        {
                if (isset($this->$name))
                {
                        return $this->$name;
                }
        }
}

除了下面列出的兩個方法之外，這些方法也可以指定類名 返回類實例的結果集: getFirstRow(), getLastRow(), getNextRow() 和 getPreviousRow() 。

getCustomResultObject()

以要求的類實例數組的形式返回整個結果集。 唯一的參數是要實例化的類的名稱。

示例:

$query = $db->query("YOUR QUERY");


$rows = $query->getCustomResultObject('User');


foreach ($rows as $row)
{
        echo $row->id;
        echo $row->email;
        echo $row->last_login('Y-m-d');
}

getCustomRowObject()

以要求的類實例形式返回單個結果，第一個參數是它在結果集里的序號， 第二個參數是要實例化的類的名稱。

示例:

$query = $db->query("YOUR QUERY");


$row = $query->getCustomRowObject(0, 'User');


if (isset($row))
{
        echo $row->email;                 // 獲取屬性
        echo $row->last_login('Y-m-d');   // 或訪問 'User' 類定義的方法
}

你也可以用 getRow() 方法達到相同效果。

示例:

$row = $query->getCustomRowObject(0, 'User');

結果處理輔助方法

getFieldCount()

返回查詢結果的字段個數（列數），確保你是使用查詢結果對象調用此方法:

$query = $db->query('SELECT * FROM my_table');


echo $query->getFieldCount();

getFieldNames()

返回查詢結果的字段名（列名）的數組，確保你是使用查詢結果對象調用此方法:

$query = $db->query('SELECT * FROM my_table');


    echo $query->getFieldNames();

freeResult()

它會釋放查詢結果占用的內存并刪除資源ID。通常 PHP 會在腳本結束時自動釋放內存， 然而，如果你在某個腳本里執(zhí)行了很多查詢，你也許想處理完每個查詢后即刻釋放內存， 以此減少內存消耗。

舉例:

$query = $thisdb->query('SELECT title FROM my_table');


foreach ($query->getResult() as $row)
{
        echo $row->title;
}


$query->freeResult();  // $query 的結果對象不再可用


$query2 = $db->query('SELECT name FROM some_table');


$row = $query2->getRow();
echo $row->name;
$query2->freeResult(); // $query2 的結果對象不再可用

dataSeek()

該方法設置一個內部指針，用來獲取下一個結果行，它僅和 getUnbufferedRow() 一起使用才有作用。

它接受一個正整數值，默認是0，返回 TRUE 表示成功，F(xiàn)ALSE 表示失敗。

$query = $db->query('SELECT `field_name` FROM `table_name`');
$query->dataSeek(5); // Skip the first 5 rows
$row = $query->getUnbufferedRow();

注解

不是所有數據庫驅動支持這個特性，（不支持的）會返回 FALSE。 最值得注意的是 - 你無法在 PDO 中使用它。

類庫參考

CodeIgniter\Database\BaseResult

getResult([$type = 'object'])

參數:	$type (string) – 要求的結果類型 - array, object, 或 類名
返回:	包含查詢到的行的數組
返回類型:	array

它是這幾種方法的包裝： getResultArray(), getResultObject() 和 getCustomResultObject() 。

用法: 詳見 結果數組.

getResultArray()

返回:	包含查詢到的行的數組
返回類型:	array

返回查詢結果行的數組，每行都是關聯(lián)數組。

用法: 詳見 結果數組.

getResultObject()

返回:	包含查詢到的行的數組
返回類型:	array

返回查詢結果行的數組，每行都是 stdClass 類的實例。

用法: 詳見 結果數組.

getCustomResultObject($class_name)

參數:	$class_name (string) – 結果行的類實例名
返回:	包含查詢到的行的數組
返回類型:	array

返回查詢結果行的數組，每行都是指定類的實例。

getRow([$n = 0[, $type = 'object']])

參數:	$n (int) – 想要返回的結果行的序號
	$type (string) – 要求的結果類型 - array, object, 或 類名
返回:	要求的行數據，不存在時返回 NULL
返回類型:	mixed

它是這幾種方法的包裝： getRowArray(), getRowObject() 和 getCustomRowObject() 。

用法: 詳見 單行結果.

getUnbufferedRow([$type = 'object'])

參數:	$type (string) – 要求的結果類型 - array, object, 或 類名
返回:	結果集的下一行，不存在時返回 NULL
返回類型:	mixed

按要求的格式返回結果集的下一行。

用法: 詳見 單行結果.

getRowArray([$n = 0])

參數:	$n (int) – 想要返回的結果行的序號
返回:	要求的行數據，不存在時返回 NULL
返回類型:	array

返回結果行，格式為關聯(lián)數組。

用法: 詳見 單行結果.

getRowObject([$n = 0])

參數:	$n (int) – 想要返回的結果行的序號
返回:	要求的行數據，不存在時返回 NULL
返回類型:	stdClass

返回結果行，格式為 stdClass 的類實例。

用法: 詳見 單行結果.

getCustomRowObject($n, $type)

參數:	$n (int) – 想要返回的結果行的序號
	$class_name (string) – 結果行的類實例名
返回:	要求的行數據，不存在時返回 NULL
返回類型:	$type

返回結果行，格式為要求的的類實例。

dataSeek([$n = 0])

參數:	$n (int) – 即將返回的結果行的序號
返回:	TRUE 表示成功，F(xiàn)ALSE 表示失敗
返回類型:	bool

移動結果集的內部指針到指定位置。

用法: 詳見 結果處理輔助方法.

setRow($key[, $value = NULL])

參數:	$key (mixed) – 列名或鍵值數組
	$value (mixed) – 分配給列的值，$key 是單個字段名
返回類型:	void

為特定列分配值。

getNextRow([$type = 'object'])

參數:	$type (string) – 要求的結果類型 - array, object, 或 類名
返回:	結果集的下一行，不存在時返回 NULL
返回類型:	mixed

返回結果集的下一行。

getPreviousRow([$type = 'object'])

參數:	$type (string) – 要求的結果類型 - array, object, 或 類名
返回:	結果集的上一行，不存在時返回 NULL
返回類型:	mixed

返回結果集的上一行。

getFirstRow([$type = 'object'])

參數:	$type (string) – 要求的結果類型 - array, object, 或 類名
返回:	結果集的第一行，不存在時返回 NULL
返回類型:	mixed

返回結果集的第一行。

getLastRow([$type = 'object'])

參數:	$type (string) – 要求的結果類型 - array, object, 或 類名
返回:	結果集的最后一行，不存在時返回 NULL
返回類型:	mixed

返回結果集的最后一行。

getFieldCount()

返回:	結果集中字段的個數
返回類型:	int

返回結果集中字段的個數。

用法: 詳見 結果處理輔助函數.

getFieldNames()

returns:	列名稱的數組
rtype:	array

返回一個包含結果集中字段名的數組。

getFieldData()

返回:	包含字段元數據的數組
返回類型:	array

生成一個包含字段元數據的 stdClass 對象的數組。

freeResult()

返回類型:	void

釋放一個結果集。

用法: 詳見 結果處理輔助函數.