PHP mysqli_result Class

The PHP mysqli_result class represents the result set obtained after running a query.

• Properties
  • $current_field
  • $field_count
  • $lengths
  • $num_rows
  • $type
• Methods
  • __construct
  • data_seek
  • fetch_all
  • fetch_array
  • fetch_assoc
  • fetch_column
  • fetch_field_direct
  • fetch_field
  • fetch_fields
  • fetch_object
  • fetch_row
  • field_seek
  • free / close / free_result
  • getIterator

Puedes cerrar o abrir este menú cliqueando sobre el boton contenido

class mysqli_result implements IteratorAggregate {
/* Properties */
public readonly int $current_field;
public readonly int $field_count;
public readonly ?array $lengths;
public readonly int|string $num_rows;
public int $type;
/* Methods */
public __construct(mysqli $mysql, int $result_mode = MYSQLI_STORE_RESULT)
public data_seek(int $offset): bool
public fetch_all(int $mode = MYSQLI_NUM): array
public fetch_array(int $mode = MYSQLI_BOTH): array|null|false
public fetch_assoc(): array|null|false
public fetch_column(int $column = 0): null|int|float|string|false
public fetch_field_direct(int $index): object|false
public fetch_field(): object|false
public fetch_fields(): array
public fetch_object(string $class = "stdClass", array $constructor_args = []): object|null|false
public fetch_row(): array|null|false
public field_seek(int $index): bool
public free(): void
public close(): void
public free_result(): void
public getIterator(): Iterator
}

We can obtain mysqli_result objects in several ways, both from a mysqli object and from a mysqli_stmt object.

From mysqli, we have the following methods:

• mysqli reap_async_query
• mysqli store_result
• mysqli use_result

From mysqli_stmt, we have:

• mysqli_stmt get_result
• mysqli_stmt result_metadata

Lastly, we could use its constructor.

Before diving into the properties and methods, we should remember that a query or prepared statement will have already been executed before using these properties or methods.

Properties

In the following properties, you will see the variable $mysqli_result in the syntax, which will be holding a mysqli_result object.

$current_field

Gets the position of the current field in a result set pointer. You will need to use fetch_field to access this property.

$mysqli_result->current_field;

$field_count

Number of fields in a result set.

$mysqli_result->field_count;

$lengths

Returns the length of the columns of the current row in the result set as an array; it may return null or false in case of an error.

$mysqli_result->lengths;

$num_rows

Number of rows returned in the result.

$mysqli_result->num_rows;

$type

Indicates whether the result is buffered or unbuffered as an integer (int), with these values represented by the constants MYSQLI_STORE_RESULT and MYSQLI_USE_RESULT, respectively

$mysqli_result->type;

Methods

In the following syntax examples, we will use the variable $result to hold a mysqli_result object. Keep in mind that to obtain a mysqli_result, it should be created in one of the ways mentioned earlier or with the constructor.

__construct

The constructor of the mysqli_result class is responsible for building the object. The constructor can be used after using the real_query method of mysqli.

public mysqli_result::__construct(mysqli $mysqli, int $result_mode = MYSQLI_STORE_RESULT)

$result = new mysqli_result($mysqli,$reslt_mode)

data_seek

The data_seek method allows you to reposition the internal pointer of a MySQL result set to a specific row. This is useful when you want to access rows in a non-sequential order or when you need to revisit a previous row.

For example, take a look at the following table, our arrow is where we are pointing at, or better say where we want to point at. Let’s indicate in our $offset parameter where we want to point at.

In this context, if we want to point at the row where Mariana is $result->data_seek(1) this is cause the offset starts at 0 and finish in length-1 like an array.

If we look at the table, the indexes are 0, 1 and 2 and the length is 3.

public mysqli_result::data_seek(int $offset): bool

$result->data_seek($offset);

fetch_all

Returns all rows in the result as an associative, numeric, or both types of arrays, depending on the mode passed as a parameter.

public mysqli_result::fetch_all(int $mode = MYSQLI_NUM): array

$result->fetch_all($mode);

fetch_array

Returns the result of the next row as an associative, numeric, or both types of array.

public mysqli_result::fetch_array(int $mode = MYSQLI_BOTH): array|null|false

$result->fetch_array($mode);

fetch_assoc

Extracts or returns the next row from a result set as an associative array.

public mysqli_result::fetch_assoc(): array|null|false

$result->fetch_assoc();

fetch_column

Retrieves a column from the next row in the result set. See the following table, assuming our pointer is positioned as seen in the table.

If I call this method for column 2, $result->fetch_column(2) I will get “Tell me 1782.

public mysqli_result::fetch_column(int $column = 0): null|int|float|string|false

$result->fetch_column($column);

fetch_field_direct

Gets the metadata of a single field as an object.

public mysqli_result::fetch_field_direct(int $index): object|false

$camp_info = $result->fetch_field_direct($index);

As you can see in the syntax, $camp_info will hold our object. With this variable, we can retrieve the values of the different attributes shown in the table above. For example, $camp_info->name will get the column name, $camp_info->table will get the name of the table to which the field belongs, and so on.

fetch_field

Returns the information of the next field in the result set

public mysqli_result::fetch_field(): object|false

$camp_info = $result->fetch_field();

fetch_fields

Returns an array of objects with the metadata of the fields. The objects will have the following attributes or properties.

public mysqli_result::fetch_fields(): array

$result->fetch_fields();

fetch_object

Extracts the next row from the result set and returns it as an object.

public mysqli_result::fetch_object(string $class = "stdClass", array $constructor_args = []): object|null|false

$objRow = $result->fetch_object($class,$constructor_args);

fetch_row

Extracts the new row from the result set and returns an enumerated array.

public mysqli_result::fetch_row(): array|null|false

$e_row = $result->fetch_row();

field_seek

Set result pointer to a specified field offset($index)

public mysqli_result::field_seek(int $index): bool

$result->field_seek($index);

free / close / free_result

Frees the memory associated with the result.

public mysqli_result::free(): void

public mysqli_result::close(): void

public mysqli_result::free_result(): void

$result->close();

getIterator

Returns an external iterator

public mysqli_result::getIterator(): Iterator

$iterator = $result->getIterator();