Die Klasse Charitable_Donor ermöglicht Ihnen den Zugriff auf Informationen über einen bestimmten Spender.
Abrufen einer Instanz von Charitable_Donor
Eine Instanz von Charitable_Donor kann je nach Kontext, in dem Sie sie verwenden müssen, auf verschiedene Arten abgerufen werden.
Mit einer Spender-ID
$donor_id = 123;
$donor = new Charitable_Donor( $donor_id );Mit einer Spender-ID und einer Spenden-ID
$donor_id = 123;
$donation_id = 456;
$donor = new Charitable_Donor( $donor_id, $donation_id );Mit einem Spendenobjekt oder einer Spenden-ID
// 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();Mit einem Charitable_User-Objekt
// 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 );Eigenschaften
user_id
Die Benutzer-ID für den Spender. Für nicht registrierte Spender wird hier 0 zurückgegeben.
first_name
Der Vorname des Spenders.
last_name
Der Nachname des Spenders.
email
Die E-Mail-Adresse des Spenders.
date_joined
Das Datum, an dem der Spender zum ersten Mal Spender wurde. Dies wird als MySQL-Datum-Zeit-String zurückgegeben.
date_erased
Das Datum im MySQL-Datum-Zeit-Format, an dem die Informationen des Spenders gelöscht wurden. Dies wird nur ausgefüllt, wenn eine Datenlöschungsanforderung für die E-Mail-Adresse des Spenders vorlag.
contact_consent
Ob der Spender zugestimmt hat, kontaktiert zu werden.
Methoden
get_user()
Dies gibt das Charitable_User-Objekt zurück, das diesem Spender zugeordnet ist.
get_donation()
Wenn Sie Charitable_Donor mit einer Spenden-ID oder mit der Methode get_donor() von Charitable_Donation instanziiert haben, gibt get_donation() die Instanz von Charitable_Donation zurück.
Andernfalls gibt dies false zurück.
get_donations()
Dies gibt ein Array aller Spenden des Spenders zurück.
get_donor_meta( $key = '' )
Gibt die Spender-Metadaten zurück, die für die jeweilige Spende gespeichert sind.
Parameter$key
Wenn gesetzt, wird der Metawert für den angegebenen Schlüssel zurückgegeben, oder false, wenn kein solcher Metawert existiert. Wenn leer gelassen, wird ein Array aller Spender-Metadaten zurückgegeben.
get_last_donation()
Gibt die letzte Spende des Spenders als Instanz von Charitable_Donation zurück, oder null, wenn keine Spende getätigt wurde.
get_name()
Gibt den Spendernamen zurück, der für die jeweilige Spende gespeichert ist.
get_email()
Gibt die E-Mail-Adresse des Spenders zurück.
hat_gueltige_email()
Gibt zurück, ob die vom Spender angegebene E-Mail-Adresse gültig ist.
get_address()
Gibt die druckbare Adresse des Spenders zurück.
Dies ist ein Wrapper für Charitable_User::get_address().
get_avatar( $size = 100 )
Gibt das HTML zur Anzeige des Avatars des Spenders zurück. Standardmäßig wird der mit der E-Mail-Adresse des Spenders verknüpfte Gravatar zurückgegeben.
Dies ist ein Wrapper für Charitable_User::get_avatar().
Parameter$size
Optional. Legt die Breite und Höhe des zurückzugebenden Avatars fest. Standardmäßig wird der Avatar mit einer Breite und Höhe von 100 Pixel zurückgegeben.
get_location()
Gibt den Standort des Spenders zurück.
Wenn das Charitable_Donor-Objekt nicht mit einer gesetzten $donation_id aufgerufen wurde, wird das Ergebnis von Charitable_User::get_location() zurückgegeben. Andernfalls wird der für die Spende angegebene Standort basierend auf Stadt, Bundesland und/oder Land zurückgegeben.
get_amount( $campaign_id = false )
Spendenbetrag zurückgeben.
Wenn beim Instanziieren von Charitable_Donor eine Spenden-ID übergeben wurde, wird der Gesamtbetrag zurückgegeben, der mit dieser speziellen Spende gespendet wurde. Andernfalls wird der Gesamtbetrag zurückgegeben, der jemals vom Spender gespendet wurde.
Parameter$campaign_id
Optional. Wenn gesetzt, wird nur der Betrag zurückgegeben, der für die angegebene Kampagne gespendet wurde.
