13.6.3.23 Doc::getState()

13.6.3.23.1 Description

string getState ( void )

La méthode getState retourne le nom de l'état du document si celui-ci est associé à un cycle de vie.

13.6.3.23.1.1 Avertissements

Aucun.

13.6.3.23.2 Liste des paramètres

Aucun.

13.6.3.23.3 Valeur de retour

La méthode retourne le nom de l'état du document si celui-ci est associé à un cycle de vie. Si le document ne possède pas de cycle, alors une chaîne vide est retournée.

13.6.3.23.4 Erreurs / Exceptions

Aucune.

13.6.3.23.5 Historique

Aucun.

13.6.3.23.6 Exemples

• Exemple #1

Contrôler que la facture est dans l'état Payée (PAID) :

$state = $facture->getState();
if ($state !== 'PAID') {
    throw new Exception(sprintf(
        "La facture '%s' n'est pas dans l'état payée.",
        $facture->getTitle()
    ));
}

13.6.3.23.7 Notes

Cette fonction est un raccourci vers la propriété state du document. Pour avoir la version affichée dans l'interface de l'état, il suffit de traduire celui-ci avec la fonction _.

13.6.3.23.8 Voir aussi

• getPropertyValue
• Cycle de vie