#SingleRecordResource

Une ressource orientée vers un enregistrement unique : les données correspondent à un objet unique, prenant en charge la récupération par clé primaire, la création/mise à jour (save) et la suppression. Elle est adaptée aux scénarios d'"enregistrement unique" tels que les détails et les formulaires. Contrairement à MultiRecordResource, la méthode getData() de SingleRecordResource retourne un objet unique. Vous spécifiez la clé primaire via setFilterByTk(id), et save() appellera automatiquement create ou update en fonction de l'état de isNewRecord.

Hiérarchie d'héritage : FlowResource → APIResource → BaseRecordResource → SingleRecordResource.

Méthode de création : ctx.makeResource('SingleRecordResource') ou ctx.initResource('SingleRecordResource'). Vous devez appeler setResourceName('nom_de_la_collection') avant l'utilisation. Pour les opérations par clé primaire, utilisez setFilterByTk(id). Dans RunJS, ctx.api est injecté par l'environnement d'exécution.

#Scénarios d'utilisation

#Format des données

• getData() retourne un objet d'enregistrement unique, correspondant au champ data de la réponse de l'API get.
• getMeta() retourne les métadonnées (si disponibles).

#Nom de la ressource et clé primaire

#État

#Paramètres de requête (Filtre / Champs)

#CRUD

#Configuration et événements

#Exemples

#Récupération et mise à jour de base

ctx.initResource('SingleRecordResource');
ctx.resource.setResourceName('users');
ctx.resource.setFilterByTk(1);
await ctx.resource.refresh();
const user = ctx.resource.getData();

// Mise à jour
await ctx.resource.save({ name: 'Jean Dupont' });

#Créer un nouvel enregistrement

const newRes = ctx.makeResource('SingleRecordResource');
newRes.setResourceName('users');
await newRes.save({ name: 'Marie Durand', email: 'mariedurand@example.com' });

#Supprimer un enregistrement

ctx.resource.setResourceName('users');
ctx.resource.setFilterByTk(1);
await ctx.resource.destroy();
// Après destroy, getData() retourne null

#Chargement d'associations et de champs

ctx.resource.setResourceName('users');
ctx.resource.setFilterByTk(1);
ctx.resource.setFields(['id', 'nickname', 'email']);
ctx.resource.setAppends(['profile', 'roles']);
await ctx.resource.refresh();
const user = ctx.resource.getData();

#Ressources associées (par ex. users.profile)

const res = ctx.makeResource('SingleRecordResource');
res.setResourceName('users.profile');
res.setSourceId(ctx.record?.id); // Clé primaire de l'enregistrement parent
res.setFilterByTk(profileId);    // filterByTk peut être omis si profile est une relation hasOne
await res.refresh();
const profile = res.getData();

#Sauvegarde sans rafraîchissement automatique

await ctx.resource.save({ status: 'active' }, { refresh: false });
// getData() conserve l'ancienne valeur car le rafraîchissement n'est pas déclenché après la sauvegarde

#Écoute des événements refresh / saved

ctx.resource?.on?.('refresh', () => {
  const data = ctx.resource.getData();
  ctx.render(<div>Utilisateur : {data?.nickname}</div>);
});
ctx.resource?.on?.('saved', (savedData) => {
  ctx.message.success('Enregistré avec succès');
});
await ctx.resource?.refresh?.();

#Remarques

• setResourceName est obligatoire : Vous devez appeler setResourceName('nom_de_la_collection') avant l'utilisation, sinon l'URL de la requête ne pourra pas être construite.
• filterByTk et isNewRecord : Si setFilterByTk n'est pas appelé, isNewRecord est true, et refresh() n'initiera pas de requête ; save() exécutera une action create.
• Ressources associées : Lorsque le nom de la ressource est au format parent.child (par ex. users.profile), vous devez d'abord appeler setSourceId(clé_primaire_parent).
• getData retourne un objet : Les données retournées par les API d'enregistrement unique sont un objet d'enregistrement ; getData() retourne cet objet directement. Il devient null après destroy().

#Liens connexes

• ctx.resource - L'instance de ressource dans le contexte actuel
• ctx.initResource() - Initialiser et lier à ctx.resource
• ctx.makeResource() - Créer une nouvelle instance de ressource sans liaison
• APIResource - Ressource API générale requise par URL
• MultiRecordResource - Orientée vers les collections/listes, prenant en charge le CRUD et la pagination