13.6.3.15 Doc::getDate()

13.6.3.15.1 Description

string getDate ( int $daydelta  = 0,
                 int $dayhour   = "",
                 int $daymin    = "",
                bool $getlocale = false )

La méthode getDate permet d'obtenir une date du jour compensée par un certain nombre de jours, d'heures ou de minutes.

La date retournée est au format texte international ou au format de la locale de l'utilisateur courant.

La valeur ainsi obtenue est utilisable pour affecter la valeur d'un attribut de type date ou timestamp avec la méthode Doc::setAttributeValue.

13.6.3.15.1.1 Avertissements

Aucun.

13.6.3.15.2 Liste des paramètres

(int) daydelta

daydelta permet d'appliquer une compensation de la date en nombre de jours.

Si daydelta est < 0, alors la date retournée est la date courante moins le nombre de jours demandés.

Si daydelta est > 0, alors la date retournée est la date courante plus le nombre de jours demandés.

Par défaut, daydelta est égal à 0 et retourne donc la date courante.

(int) dayhour

dayhour permet d'appliquer une compensation en nombre d'heures.

Si dayhour est différent de la chaîne vide, alors une compensation exprimée en nombre d'heures est appliquée.

Par défaut dayhour est égal à la chaîne vide.

(int) daymin

daymin permet d'appliquer une compensation en nombre de minutes.

Si daymin est différent de la chaîne vide, alors une compensation exprimée en nombre de minutes est appliquée.

Par défaut daymin est égal à la chaîne vide.

(boo) getlocale

getlocale permet de spécifier si la doit être retournée localisée en fonction de la locale de l'utilisateur courant.

Par défaut getlocale est égal à false et la date retournée est au format international.

13.6.3.15.3 Valeur de retour

La date est retournée en texte au format international ou localisé.

Si getlocale est égal à false, alors la date est retournée au format international Y-m-d ou Y-m-d H:i s'il y a eu ajout d'heures ou de minutes.

Si getlocale est égal à true, alors la date est retournée au format défini par la locale de l'utilisateur courant.

13.6.3.15.4 Erreurs / Exceptions

Aucune.

13.6.3.15.5 Historique

Aucun.

13.6.3.15.6 Exemples

• Exemple #1

Obtenir la date d'hier, d'aujourd'hui et de demain :

/*
 * Date d'hier : -1 jour
 */
var_dump($doc->getDate(-1));
 
/*
 * Date du jour
 */
var_dump($doc->getDate());    
 
/*
 * Date de demain : +1 jour
 */
var_dump($doc->getDate(1));

Résultat :

string(10) "2013-12-24"
string(10) "2013-12-25"
string(10) "2013-12-26"

• Exemple #2

Obtenir la date d'après demain (+2 jours) localisée (un utilisateur utilisant la locale fr_FR) :

var_dump($doc->getDate(2, "", "", true));

Résultat :

string(10) "25/12/2013"

• Exemple #3

Compensation en heures et minutes :

/*
 * Aujourd'hui (25/12/2013 14:15) + 10 h 40 min
 */
var_dump($doc->getDate("", 10, 40, true));

Résultat :

string(16) "26/12/2013 00:55"

• Exemple #4

Affecter la date du jour à un attribut date_facturation de type date :

$doc->setAttributeValue(
    \Dcp\AttributeIdentifiers\Facture::date_facturation,
    $doc->getDate()
);
$doc->store();

13.6.3.15.7 Notes

Les compensations daydelta, dayhour et dayminsont cumulatives.

13.6.3.15.8 Voir aussi

• Doc::setAttributeValue
• PHP date