mysqli_stmt::result_metadata

mysqli_stmt_result_metadata

(PHP 5, PHP 7, PHP 8)

mysqli_stmt::result_metadata -- mysqli_stmt_result_metadata — Retourne les métadonnées de préparation de requête MySQL

Description

Style orienté objet

public mysqli_stmt::result_metadata(): mysqli_result|false

Style procédural

mysqli_stmt_result_metadata(mysqli_stmt $statement): mysqli_result|false

Si une commande a été préparée par mysqli_prepare(), et qu'elle produira un résultat, mysqli_stmt_result_metadata() retourne l'objet de résultat qui sera utilisé pour lire les métadonnées, comme le nombre de champs et les informations de colonnes.

Ceci retourne un objet mysqli_result vide qui peut être utilisé pour accéder aux informations de métadonnées depuis la déclaration préparée sans avoir à récupérer les lignes de données réelles. Il n'est pas nécessaire d'utiliser cette fonction lors de l'utilisation de mysqli_stmt_get_result() pour récupérer l'ensemble complet des résultats d'une déclaration préparée en tant qu'objet de résultat.

Note:
Ce résultat peut être passé comme argument à toutes les fonctions qui demandent un champ, pour y lire les métadonnées :

mysqli_num_fields()

mysqli_fetch_field()

mysqli_fetch_field_direct()

mysqli_fetch_fields()

mysqli_field_count()

mysqli_field_seek()

mysqli_field_tell()

mysqli_free_result()

Note: Ce jeu de résultats retourné par mysqli_stmt_result_metadata() contient uniquement les métadonnées. Il ne contient pas de lignes de résultats. Les lignes sont obtenues en appelant mysqli_stmt_get_result() sur le gestionnaire de déclaration ou avec mysqli_stmt_fetch().

Liste de paramètres

statement: Style procédural uniquement : Un objet mysqli_stmt retourné par la fonction mysqli_stmt_init().

Valeurs de retour

Si la déclaration ne produit pas de résultat, false est retourné.

Erreurs / Exceptions

Si le rapport d'erreurs mysqli est activé (MYSQLI_REPORT_ERROR) et que l'opération demandée échoue, un avertissement est généré. Si, en plus, le mode est défini sur MYSQLI_REPORT_STRICT, une mysqli_sql_exception est lancée à la place.

Exemples

Exemple #1 Style orienté objet

<?php
$mysqli = new mysqli("localhost", "my_user", "my_password", "test");

$mysqli->query("DROP TABLE IF EXISTS friends");
$mysqli->query("CREATE TABLE friends (id int, name varchar(20))");

$mysqli->query("INSERT INTO friends VALUES (1,'Hartmut'), (2, 'Ulf')");

$stmt = $mysqli->prepare("SELECT id, name FROM friends");
$stmt->execute();

/* Lit les méta-données de résultat */
$result = $stmt->result_metadata();

/* Lit les informations d'un champ, depuis les méta-données */
$field = $result->fetch_field();

printf("Nom du champ : %s\n", $field->name);
?>

Exemple #2 Style procédural

<?php
$link = mysqli_connect("localhost", "my_user", "my_password", "test");

mysqli_query($link, "DROP TABLE IF EXISTS friends");
mysqli_query($link, "CREATE TABLE friends (id int, name varchar(20))");

mysqli_query($link, "INSERT INTO friends VALUES (1,'Hartmut'), (2, 'Ulf')");

$stmt = mysqli_prepare($link, "SELECT id, name FROM friends");
mysqli_stmt_execute($stmt);

/* Lit les méta-données de résultat */
$result = mysqli_stmt_result_metadata($stmt);

/* Lit les informations d'un champ, depuis les méta-données */
$field = mysqli_fetch_field($result);

printf("Nom du champ : %s\n", $field->name);
?>

Voir aussi

mysqli_prepare() - Prépare une requête SQL pour l'exécution
mysqli_free_result() - Libère la mémoire associée à un résultat
mysqli_stmt_get_result() - Récupère un jeu de résultats depuis une requête préparée en tant qu'objet mysqli_result