| Server IP : 104.21.30.238 / Your IP : 216.73.216.153 Web Server : LiteSpeed System : Linux premium151.web-hosting.com 4.18.0-553.44.1.lve.el8.x86_64 #1 SMP Thu Mar 13 14:29:12 UTC 2025 x86_64 User : tempvsty ( 647) PHP Version : 8.0.30 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /././home/./tempvsty/./pontiacques.org/wp-content/plugins/give/src/Donations/Models/ |
Upload File : |
<?php
namespace Give\Donations\Models;
use DateTime;
use Give\Campaigns\Models\Campaign;
use Give\Donations\DataTransferObjects\DonationQueryData;
use Give\Donations\Factories\DonationFactory;
use Give\Donations\Properties\BillingAddress;
use Give\Donations\ValueObjects\DonationMode;
use Give\Donations\ValueObjects\DonationStatus;
use Give\Donations\ValueObjects\DonationType;
use Give\Donors\Models\Donor;
use Give\Framework\Exceptions\Primitives\Exception;
use Give\Framework\Exceptions\Primitives\InvalidArgumentException;
use Give\Framework\Models\Contracts\ModelCrud;
use Give\Framework\Models\Contracts\ModelHasFactory;
use Give\Framework\Models\Model;
use Give\Framework\Models\ModelQueryBuilder;
use Give\Framework\Models\ValueObjects\Relationship;
use Give\Framework\PaymentGateways\PaymentGateway;
use Give\Framework\Support\ValueObjects\Money;
use Give\Subscriptions\Models\Subscription;
/**
* Class Donation
*
* @since 3.9.0 Add phone property
* @since 2.23.0 add type property; remove parentId property
* @since 2.20.0 update amount type, fee recovered, and exchange rate
* @since 2.19.6
*
* @property int $id
* @property int $campaignId
* @property int $formId
* @property string $formTitle
* @property DateTime $createdAt
* @property DateTime $updatedAt
* @property DonationStatus $status
* @property DonationMode $mode
* @property DonationType $type
* @property Money $amount amount charged to the gateway
* @property Money $feeAmountRecovered
* @property string $exchangeRate
* @property string $gatewayId
* @property int $donorId
* @property string $honorific
* @property string $firstName
* @property string $lastName
* @property string $email
* @property string $phone
* @property int $subscriptionId
* @property BillingAddress $billingAddress
* @property string $purchaseKey
* @property string $donorIp
* @property bool $anonymous
* @property string $levelId
* @property string $gatewayTransactionId
* @property Donor $donor
* @property Campaign $campaign
* @property Subscription $subscription
* @property DonationNote[] $notes
* @property string $company
* @property string $comment
*/
class Donation extends Model implements ModelCrud, ModelHasFactory
{
/**
* @inheritdoc
*/
protected $properties = [
'id' => 'int',
'campaignId' => 'int',
'formId' => 'int',
'formTitle' => 'string',
'purchaseKey' => 'string',
'donorIp' => 'string',
'createdAt' => DateTime::class,
'updatedAt' => DateTime::class,
'status' => DonationStatus::class,
'type' => DonationType::class,
'mode' => DonationMode::class,
'amount' => Money::class,
'feeAmountRecovered' => Money::class,
'exchangeRate' => ['string', '1'],
'gatewayId' => 'string',
'donorId' => 'int',
'honorific' => 'string',
'firstName' => 'string',
'lastName' => 'string',
'email' => 'string',
'phone' => 'string',
'subscriptionId' => ['int', 0],
'billingAddress' => BillingAddress::class,
'anonymous' => ['bool', false],
'levelId' => ['string', ''],
'gatewayTransactionId' => 'string',
'company' => 'string',
'comment' => 'string',
];
/**
* @inheritdoc
*/
protected $relationships = [
'campaign' => Relationship::BELONGS_TO,
'donor' => Relationship::BELONGS_TO,
'subscription' => Relationship::BELONGS_TO,
'notes' => Relationship::HAS_MANY,
];
/**
* Find donation by ID
*
* @since 2.19.6
*
* @param int $id
*
* @return Donation|null
*/
public static function find($id)
{
return give()->donations->getById($id);
}
/**
* @since 2.20.0 return mutated model instance
* @since 2.19.6
*
* @throws Exception|InvalidArgumentException
*/
public static function create(array $attributes): Donation
{
$donation = new static($attributes);
give()->donations->insert($donation);
return $donation;
}
/**
* @since 2.20.0 mutate model in repository and return void
* @since 2.19.6
*
* @return void
*
* @throws Exception|InvalidArgumentException
*/
public function save()
{
if (!$this->id) {
give()->donations->insert($this);
} else {
give()->donations->update($this);
}
}
/**
* @since 2.19.6
*
* @throws Exception|InvalidArgumentException
*/
public function delete(): bool
{
return give()->donations->delete($this);
}
/**
* @since 2.19.6
*
* @return ModelQueryBuilder<Donor>
*/
public function donor(): ModelQueryBuilder
{
return give()->donors->queryById($this->donorId);
}
/**
* @since 2.19.6
*
* @return ModelQueryBuilder<Subscription>
*/
public function subscription(): ModelQueryBuilder
{
if ($this->subscriptionId) {
return give()->subscriptions->queryById($this->subscriptionId);
}
return give()->subscriptions->queryByDonationId($this->id);
}
/**
* @since 4.0.0
*
* @return ModelQueryBuilder<Campaign>
*/
public function campaign(): ModelQueryBuilder
{
return give()->campaigns->queryById($this->campaignId);
}
/**
* @since 2.19.6
*
* @return int|null
*/
public function getSequentialId()
{
return give()->donations->getSequentialId($this->id);
}
/**
* @since 2.19.6
*
* @return ModelQueryBuilder<DonationNote>
*/
public function notes(): ModelQueryBuilder
{
return give()->donations->notes->queryByDonationId($this->id);
}
/**
* Returns the amount charged in the currency the GiveWP site is set to
*
* @since 2.20.0
*/
public function amountInBaseCurrency(): Money
{
return $this->amount->inBaseCurrency($this->exchangeRate);
}
/**
* Returns the donation amount the donor "intended", which means it is the amount without recovered fees. So if the
* donor paid $100, but the donation was charged $105 with a $5 fee, this method will return $100.
*
* @since 2.20.0
*/
public function intendedAmount(): Money
{
return $this->feeAmountRecovered === null
? $this->amount
: $this->amount->subtract($this->feeAmountRecovered);
}
/**
* Returns the amount intended in the currency the GiveWP site is set to
*
* @since 2.20.0
*/
public function intendedAmountInBaseCurrency(): Money
{
return $this->intendedAmount()->inBaseCurrency($this->exchangeRate);
}
/**
* Returns the gateway instance for this donation
*
* @since 2.20.0
*/
public function gateway(): PaymentGateway
{
return give()->gateways->getPaymentGateway($this->gatewayId);
}
/**
* @since 2.20.0
*
* @inheritDoc
*/
protected function getPropertyDefaults(): array
{
return array_merge(parent::getPropertyDefaults(), [
'mode' => give_is_test_mode() ? DonationMode::TEST() : DonationMode::LIVE(),
'donorIp' => give_get_ip(),
'billingAddress' => new BillingAddress(),
]);
}
/**
* @since 2.19.6
*
* @return ModelQueryBuilder<Donation>
*/
public static function query(): ModelQueryBuilder
{
return give()->donations->prepareQuery();
}
/**
* @since 2.19.6
*
* @param object $object
*/
public static function fromQueryBuilderObject($object): Donation
{
return DonationQueryData::fromObject($object)->toDonation();
}
/**
* @since 2.19.6
*/
public static function factory(): DonationFactory
{
return new DonationFactory(static::class);
}
}