13.6.3.27 Doc::isAlive()

13.6.3.27.1 Description

bool isAlive ( void )

La méthode isAlive permet de savoir si un document est vivant.

Un document est vivant si :

• le document est stocké en base de données ;
• la propriété doctype est différente de Z.

13.6.3.27.1.1 Avertissements

Aucun.

13.6.3.27.2 Liste des paramètres

Aucune.

13.6.3.27.3 Valeur de retour

La méthode retourne true si le document est vivant ou false dans le cas contraire.

13.6.3.27.4 Erreurs / Exceptions

Aucune.

13.6.3.27.5 Historique

Aucun.

13.6.3.27.6 Exemples

• Exemple #1

$facture = new_Doc('', $id);
if (!$facture->isAlive()) {
    throw new Exception(
        sprintf("Le document avec l'identifiant '%d' n'existe pas ou a été supprimé.", $id)
    );
}

• Exemple #2

/*
 * $facture est un objet qui n'existe qu'en mémoire,
 * par conséquent, isAlive() retourne `false`
 */
$facture = createDoc('', 'FACTURE');
var_dump($facture->isAlive());
 
/*
 * Une fois l'objet sauvegardé en base de données
 * isAlive() retourne alors `true`
 */
$facture->store();
var_dump($facture->isAlive());

Résultat :

bool(false)
bool(true)

13.6.3.27.7 Notes

Aucune.

13.6.3.27.8 Voir aussi

• Propriété doctype
• Méthode DbObj::isAffected