Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/mets.corals.io/wp-content/plugins/give/src/Donors/Repositories/ |
<?php
namespace Give\Donors\Repositories;
use Exception;
use Give\Donations\ValueObjects\DonationMetaKeys;
use Give\Donors\Exceptions\FailedDonorUpdateException;
use Give\Donors\Models\Donor;
use Give\Donors\ValueObjects\DonorMetaKeys;
use Give\Framework\Database\DB;
use Give\Framework\Exceptions\Primitives\InvalidArgumentException;
use Give\Framework\Models\ModelQueryBuilder;
use Give\Framework\Support\Facades\DateTime\Temporal;
use Give\Helpers\Hooks;
use Give\Log\Log;
/**
* @since 2.19.6
*/
class DonorRepository
{
/**
* @var string[]
*/
private $requiredDonorProperties = [
'name',
'firstName',
'lastName',
'email',
];
/**
* Query Donor By ID
*
* @since 2.19.6
*
* @return ModelQueryBuilder<Donor>
*/
public function queryById(int $donorId): ModelQueryBuilder
{
return $this->prepareQuery()
->where('id', $donorId);
}
/**
* Get Donor By ID
*
* @since 2.19.6
*
* @return Donor|null
*/
public function getById(int $donorId)
{
return $this->queryById($donorId)->get();
}
/**
* Get Donor By WP User ID
*
* @since 2.19.6
*
* @return Donor|null
*/
public function getByWpUserId(int $userId)
{
// user_id can technically be 0 so make sure to return null
if (!$userId) {
return null;
}
return $this->prepareQuery()
->where('user_id', $userId)
->get();
}
/**
* @since 2.19.6
*
* @return array|bool
*/
public function getAdditionalEmails(int $donorId)
{
$additionalEmails = DB::table('give_donormeta')
->select(['meta_value', 'email'])
->where('meta_key', 'additional_email')
->where('donor_id', $donorId)
->getAll();
if (!$additionalEmails) {
return null;
}
return array_column($additionalEmails, 'email');
}
/**
* @since 2.21.0 add actions givewp_donor_creating and givewp_donor_created
* @since 2.20.0 mutate model and return void
* @since 2.19.6
*
* @return void
* @throws Exception
*/
public function insert(Donor $donor)
{
$this->validateDonor($donor);
Hooks::doAction('givewp_donor_creating', $donor);
$dateCreated = Temporal::withoutMicroseconds($donor->createdAt ?: Temporal::getCurrentDateTime());
DB::query('START TRANSACTION');
try {
DB::table('give_donors')
->insert([
'date_created' => Temporal::getFormattedDateTime($dateCreated),
'user_id' => $donor->userId ?? 0,
'email' => $donor->email,
'name' => $donor->name
]);
$donorId = DB::last_insert_id();
foreach ($this->getCoreDonorMeta($donor) as $metaKey => $metaValue) {
DB::table('give_donormeta')
->insert([
'donor_id' => $donorId,
'meta_key' => $metaKey,
'meta_value' => $metaValue,
]);
}
if (isset($donor->additionalEmails)) {
foreach ($donor->additionalEmails as $additionalEmail) {
DB::table('give_donormeta')
->insert([
'donor_id' => $donorId,
'meta_key' => DonorMetaKeys::ADDITIONAL_EMAILS,
'meta_value' => $additionalEmail,
]);
}
}
} catch (Exception $exception) {
DB::query('ROLLBACK');
Log::error('Failed creating a donor', compact('donor'));
throw new $exception('Failed creating a donor');
}
DB::query('COMMIT');
$donor->id = $donorId;
$donor->createdAt = $dateCreated;
Hooks::doAction('givewp_donor_created', $donor);
}
/**
* @since 2.23.1 use give()->donor_meta to update meta so data is upserted
* @since 2.21.0 add actions givewp_donor_updating and givewp_donor_updated
* @since 2.20.0 return void
* @since 2.19.6
*
* @return void
* @throws Exception
*/
public function update(Donor $donor)
{
$this->validateDonor($donor);
Hooks::doAction('givewp_donor_updating', $donor);
DB::query('START TRANSACTION');
try {
DB::table('give_donors')
->where('id', $donor->id)
->update([
'user_id' => $donor->userId,
'email' => $donor->email,
'name' => $donor->name
]);
foreach ($this->getCoreDonorMeta($donor) as $metaKey => $metaValue) {
give()->donor_meta->update_meta($donor->id, $metaKey, $metaValue);
}
if (isset($donor->additionalEmails) && $donor->isDirty('additionalEmails')) {
$this->updateAdditionalEmails($donor);
}
} catch (Exception $exception) {
DB::query('ROLLBACK');
Log::error('Failed updating a donor', compact('donor'));
throw new FailedDonorUpdateException($donor, 0, $exception);
}
DB::query('COMMIT');
Hooks::doAction('givewp_donor_updated', $donor);
}
/**
* @since 2.19.6
*
* @throws Exception
*/
public function updateLegacyColumns(int $donorId, array $columns): bool
{
DB::query('START TRANSACTION');
foreach (Donor::propertyKeys() as $key) {
if (array_key_exists($key, $columns)) {
throw new InvalidArgumentException("'$key' is not a legacy column.");
}
}
try {
DB::table('give_donors')
->where('id', $donorId)
->update($columns);
} catch (Exception $exception) {
DB::query('ROLLBACK');
Log::error('Failed updating a donor', compact('donorId', 'columns'));
throw new $exception('Failed updating a donor');
}
DB::query('COMMIT');
return true;
}
/**
*
* @since 2.21.0 add actions givewp_donor_deleting and givewp_donor_deleted
* @since 2.20.0 consolidate meta deletion into a single query
* @since 2.19.6
*
* @throws Exception
*/
public function delete(Donor $donor): bool
{
DB::query('START TRANSACTION');
Hooks::doAction('givewp_donor_deleting', $donor);
try {
DB::table('give_donors')
->where('id', $donor->id)
->delete();
DB::table('give_donormeta')
->where('donor_id', $donor->id)
->delete();
} catch (Exception $exception) {
DB::query('ROLLBACK');
Log::error('Failed deleting a donor', compact('donor'));
throw new $exception('Failed deleting a donor');
}
DB::query('COMMIT');
Hooks::doAction('givewp_donor_deleted', $donor);
return true;
}
/**
* @since 2.19.6
*/
private function getCoreDonorMeta(Donor $donor): array
{
return [
DonorMetaKeys::FIRST_NAME => $donor->firstName,
DonorMetaKeys::LAST_NAME => $donor->lastName,
DonorMetaKeys::PREFIX => $donor->prefix ?? null,
];
}
/**
* @since 2.19.6
*
* @return void
*/
private function validateDonor(Donor $donor)
{
foreach ($this->requiredDonorProperties as $key) {
if (!isset($donor->$key)) {
throw new InvalidArgumentException("'$key' is required.");
}
}
}
/**
* @since 2.21.1 optimize query by skipping prepareQuery until found
* @since 2.19.6
*
* @return Donor|null
*/
public function getByEmail(string $email)
{
$queryByPrimaryEmail = DB::table('give_donors')
->select(
'id',
'email'
)
->where('email', $email)
->get();
if ($queryByPrimaryEmail) {
return $this->queryById($queryByPrimaryEmail->id)->get();
}
return $this->getByAdditionalEmail($email);
}
/**
* @since 2.19.6
*
* @return Donor|null
*/
public function getByAdditionalEmail(string $email)
{
$donorMetaObject = DB::table('give_donormeta')
->select(['donor_id', 'id'])
->where('meta_key', 'additional_email')
->where('meta_value', $email)
->get();
if (!$donorMetaObject) {
return null;
}
return $this->getById($donorMetaObject->id);
}
/**
* @since 2.19.6
*
* @return ModelQueryBuilder<Donor>
*/
public function prepareQuery(): ModelQueryBuilder
{
$builder = new ModelQueryBuilder(Donor::class);
return $builder->from('give_donors')
->select(
'id',
['user_id', 'userId'],
'email',
'name',
['purchase_value', 'totalAmountDonated'],
['purchase_count', 'totalDonations'],
['payment_ids', 'paymentIds'],
['date_created', 'createdAt'],
'token',
['verify_key', 'verifyKey'],
['verify_throttle', 'verifyThrottle']
)
->attachMeta(
'give_donormeta',
'ID',
'donor_id',
...DonorMetaKeys::getColumnsForAttachMetaQueryWithAdditionalEmails()
);
}
/**
* Additional emails are assigned to the same additional_email meta key.
* In order to update them we need to delete and re-insert.
*
* @since 2.19.6
*
* @return void
*/
private function updateAdditionalEmails(Donor $donor)
{
foreach ($donor->additionalEmails as $additionalEmail) {
DB::table('give_donormeta')
->where('donor_id', $donor->id)
->where('meta_key', DonorMetaKeys::ADDITIONAL_EMAILS)
->where('meta_value', $additionalEmail)
->delete();
}
foreach ($donor->additionalEmails as $additionalEmail) {
DB::table('give_donormeta')
->where('donor_id', $donor->id)
->insert([
'donor_id' => $donor->id,
'meta_key' => DonorMetaKeys::ADDITIONAL_EMAILS,
'meta_value' => $additionalEmail,
]);
}
}
/**
* @since 2.20.0
*
* @return string|null
*/
public function getDonorLatestDonationDate(int $donorId)
{
$donation = DB::table('posts')
->select('post_date')
->leftJoin('give_donationmeta', 'ID', 'donation_id')
->where('post_type', 'give_payment')
->where('meta_key', DonationMetaKeys::DONOR_ID)
->where('meta_value', $donorId)
->orderBy('ID', 'DESC')
->limit(1)
->get();
if ($donation) {
return $donation->post_date;
}
return null;
}
/**
* @since 2.20.0
*
* @return string|null
*/
public function getDonorType(int $donorId)
{
$donor = DB::table('give_donors')
->select(
'id',
['purchase_count', 'donationCount'],
['payment_ids', 'paymentIds']
)
->where('id', $donorId)
->get();
if (!$donor) {
return null;
}
if (!$donor->donationCount) {
return 'new';
}
// Donation IDs
$ids = strpos($donor->paymentIds, ',')
? explode(',', $donor->paymentIds)
: [$donor->paymentIds];
// Recurring
$recurringDonations = DB::table('posts')
->leftJoin('give_donationmeta', 'id', 'donation_id')
->whereIn('donation_id', $ids)
->where('meta_key', DonationMetaKeys::IS_RECURRING)
->where('meta_value', '1')
->count();
if ($recurringDonations) {
return 'subscriber';
}
if ((int)$donor->donationCount > 1) {
return 'repeat';
}
return 'single';
}
/**
* @since 2.20.0
*/
public function getDonorsCount(): int
{
return DB::table('give_donors')->count();
}
}