13.6.3.32 Doc::refresh()

13.6.3.32.1 Description

string refresh ()

Cette méthode est appelée depuis l'interface lors de la consultation du document unitaire mais pas depuis les interfaces présentant les listes de documents.

Cette méthode est appelée depuis la méthode Doc::store().

13.6.3.32.1.1 Avertissements

Les attributs calculés en visibilité "I" ne sont pas mis à jour. La visibilité appliquée est celle donnée par le contrôle de vue (vue par défaut).

13.6.3.32.2 Liste des paramètres

Aucun paramètre.

13.6.3.32.3 Valeur de retour

Cette méthode retourne les message fournis par les hameçons preRefresh() et postRefresh(). Ce message est présenté sur l'interface web de consultation de document lors de l'affichage du document.

13.6.3.32.4 Erreurs / Exceptions

Aucune.

13.6.3.32.5 Historique

Aucun.

13.6.3.32.6 Exemples

Actualisation d'un ensemble de documents.

$s=new SearchDoc("", "MYFAMILY");
$s->setObjectReturn();
$dl=$s->search()->getDocumentList();
 
$messages=array();
/** @var Doc $doc */
foreach ($dl as $doc) {
    $messages[$doc->id]=$doc->refresh();
}

13.6.3.32.7 Notes

Lors de l'actualisation du document les hameçons suivants sont lancés :

1. Doc::preRefresh()
2. Calcul des attributs calculés
3. Doc::postRefresh()
4. Enregistrement en base si modification détectée

Les affectations des attributs calculés sont réalisées par la méthode specRefreshGen() qui est générée lors de l'importation de la famille. Cette méthode est appelée entre les hameçons Doc::preRefresh() et Doc::postRefresh().

Les méthodes Doc::preRefresh() et Doc::specRefreshGen() sont exécutés en inhibant le contrôle des droits (utilisation Doc::disableEditControl()).

13.6.3.32.8 Voir aussi

• Doc::preRefresh(),
• Doc::postRefresh().