La classe Donateur_Charitable vous permet d'accéder aux informations relatives à un donateur particulier.
Obtenir une instance de Donateur_Charitable
Une instance de Donateur_Charitable peut être récupérée de différentes manières selon le contexte dans lequel vous devez l'utiliser.
Avec un ID de donateur
$donor_id = 123;
$donor = new Charitable_Donor( $donor_id );Avec un ID de donateur et un ID de don
$donor_id = 123;
$donation_id = 456;
$donor = new Charitable_Donor( $donor_id, $donation_id );Avec un objet ou un ID de don
// If you have a donation ID, first get the Charitable_Donation object.
$donation_id = 123;
$donation = charitable_get_donation( $donation_id );
// Get the Charitable_Donor object.
$donor = $donation->get_donor();Avec un objet Utilisateur_Charitable
// If you have a user ID, first get the Charitable_User object.
$user_id = 123;
$user = charitable_get_user( $user_id );
// Now get the donor ID.
$donor_id = $user->get_donor_id();
// Instantiate the Charitable_Donor object with the donor ID.
$donor = new Charitable_Donor( $donor_id );Propriétés
user_id
L'ID utilisateur du donateur. Pour les donateurs non enregistrés, cela renverra 0.
first_name
Le prénom du donateur.
last_name
Le nom de famille du donateur.
email
L'adresse e-mail du donateur.
date_joined
La date à laquelle le donateur est devenu donateur pour la première fois. Ceci sera renvoyé sous forme de chaîne de date et heure MySQL.
date_erased
La date au format date et heure MySQL à laquelle les informations du donateur ont été effacées. Ceci n'est renseigné que s'il y a eu une demande d'effacement de données pour l'adresse e-mail du donateur.
contact_consent
Si le donateur a consenti à être contacté.
Méthodes
get_user()
Ceci renvoie l'objet Utilisateur_Charitable associé à ce donateur.
get_donation()
Si vous avez instancié Donateur_Charitable avec un ID de don ou avec la méthode get_donor() de Donation_Charitable, get_donation() renverra l'instance de Donation_Charitable.
Sinon, ceci renverra false.
get_donations()
Ceci renverra un tableau de tous les dons effectués par le donateur.
get_donor_meta( $key = '' )
Renvoie les métadonnées du donateur stockées pour le don particulier.
Paramètres$key
Si défini, ceci renverra la valeur méta pour la clé donnée, ou false si aucune valeur méta de ce type n'existe. Si laissé vide, ceci renverra un tableau de toutes les métadonnées du donateur.
get_last_donation()
Renvoie le don le plus récent du donateur en tant qu'instance de Donation_Charitable, ou null s'il n'a pas fait de don.
get_name()
Renvoie le nom du donateur stocké pour le don particulier.
get_email()
Retourne l'adresse e-mail du donateur.
has_valid_email()
Retourne si l'adresse e-mail fournie par le donateur est valide.
get_address()
Retourne l'adresse imprimable du donateur.
Ceci est un wrapper pour Charitable_User::get_address().
get_avatar( $size = 100 )
Retourne le HTML pour afficher l'avatar du donateur. Par défaut, ceci retournera le Gravatar associé à l'adresse e-mail du donateur.
Ceci est un wrapper pour Charitable_User::get_avatar().
Paramètres$size
Optionnel. Définit la largeur et la hauteur de l'avatar à retourner. Par défaut, l'avatar est retourné avec une largeur et une hauteur de 100px.
get_location()
Retourne la localisation du donateur.
Si l'objet Charitable_Donor n'a pas été appelé avec un $donation_id défini, ceci retourne le résultat de Charitable_User::get_location(). Sinon, ceci retournera la localisation fournie pour le don, basée sur la ville, l'état et/ou le pays.
get_amount( $campaign_id = false )
Retourne le montant du don.
Si un ID de don a été passé lors de l'instanciation de Charitable_Donor, ceci retournera le total donné avec ce don particulier. Sinon, ceci retournera le montant total jamais donné par le donateur.
Paramètres$campaign_id
Optionnel. S'il est défini, ceci retournera uniquement le montant donné à la campagne spécifiée.
