13.14.4 createTmpDoc
Cette fonction permet de créer un nouveau document temporaire.
13.14.4.1 Description
[bool|Doc] createDoc ( string $dbaccess, string $fromid, bool $defaultvalues = true)
Cette fonction permet de créer un nouveau document temporaire. Les documents
temporaires stockés en base sont effacés par le script cleanContext .
13.14.4.1.1 Avertissements
Les documents temporaires n'ont pas de :
- cycle de vie,
- profil,
- contrôle de vue.
Le document retourné n'est pas inséré en base.
Si le paramètre fromid ne correspond pas à un nom logique de famille un objet
de type \Dcp\Family\Document est retourné, cet objet n'est pas utilisable et
doit être considéré comme un retour d'erreur.
13.14.4.2 Liste des paramètres
- (string)
dbaccess - Coordonnées de la base de données. Cet élément peut-être trouvé grâce à la
fonction
getDbAccess. - (string)
fromid - Nom logique de la famille du document à créer.
- (bool)
defaultvalues(défaut : true) - Indique si les valeurs par défaut doivent être initialisées dans le document retourné.
13.14.4.3 Valeur de retour
Un document de la classe correspondant à la famille demandée.
Le document retourné n'est pas inséré en base, c'est à la charge du développeur de procéder, si besoin, à cette insertion à l'aide de la méthode Doc::store().
13.14.4.4 Erreurs / Exceptions
Si le paramètre fromid ne correspond pas à un nom logique de famille un objet
de type \Dcp\Family\Document est retourné, cet objet n'est pas utilisable et
doit être considéré comme un retour d'erreur.
13.14.4.5 Historique
Aucun
13.14.4.6 Exemple
require_once "FDL/freedom_util.php"; $animal = createTmpDoc(getDbAccess(), "ZOO_ANIMAL"); var_export(get_class($animal)); print("\n"); printf("is alive ? %s", var_export($animal->isAlive(), true)."\n"); $animal->setValue("an_espece", "ZOO_ESP_ALLI"); $err = $animal->store(); if ($err) { print $err; } printf("is alive ? %s", var_export($animal->isAlive(), true)."\n");
Résultat :
'Dcp\\Family\\Zoo_animal' is alive ? false is alive ? true
13.14.4.7 Notes
Aucune