Blocks
2 months ago
Concerns
6 months ago
Traits
2 weeks ago
Wordpress
1 year ago
AbandonedCheckout.php
1 year ago
AbandonedCheckoutProtocol.php
3 years ago
Account.php
10 months ago
AccountPortalSession.php
3 years ago
Activation.php
1 year ago
Affiliation.php
1 year ago
AffiliationProduct.php
1 year ago
AffiliationProtocol.php
2 years ago
AffiliationRequest.php
1 year ago
ApiToken.php
6 months ago
AutoFee.php
5 months ago
AutoFeeProtocol.php
5 months ago
BalanceTransaction.php
1 year ago
Batch.php
2 days ago
Brand.php
4 months ago
BulkAction.php
2 years ago
Bump.php
1 year ago
BuyLink.php
2 years ago
CancellationAct.php
1 year ago
CancellationReason.php
3 years ago
Charge.php
9 months ago
Checkout.php
2 months ago
Click.php
1 year ago
Collection.php
3 months ago
CommissionStructure.php
2 years ago
Component.php
4 months ago
Coupon.php
2 months ago
Customer.php
2 weeks ago
CustomerLink.php
3 years ago
CustomerNotificationProtocol.php
3 years ago
CustomerPortalProtocol.php
1 year ago
DatabaseModel.php
2 months ago
Discount.php
1 year ago
DisplayCurrency.php
1 year ago
Dispute.php
9 months ago
Download.php
3 years ago
Event.php
3 years ago
Export.php
2 years ago
ExternalApiModel.php
3 months ago
Fee.php
1 year ago
Form.php
3 years ago
Fulfillment.php
1 year ago
FulfillmentItem.php
1 year ago
GalleryItem.php
9 months ago
GalleryItemAttachment.php
5 months ago
GalleryItemImageAttachment.php
3 months ago
GalleryItemMedia.php
1 year ago
GalleryItemProductMedia.php
1 month ago
GalleryItemVideoAttachment.php
3 months ago
Import.php
6 months ago
ImportRow.php
2 months ago
IncomingWebhook.php
1 year ago
Integration.php
2 years ago
IntegrationCatalog.php
2 days ago
Invoice.php
1 year ago
License.php
1 year ago
LineItem.php
9 months ago
ManualPaymentMethod.php
1 year ago
Media.php
1 month ago
Model.php
2 days ago
ModelInterface.php
3 years ago
Order.php
2 weeks ago
OrderProtocol.php
3 years ago
ParcelTemplate.php
3 months ago
PaymentFailure.php
1 year ago
PaymentInstrument.php
2 months ago
PaymentIntent.php
1 year ago
PaymentMethod.php
1 year ago
Payout.php
1 year ago
PayoutGroup.php
2 years ago
Period.php
1 year ago
PlatformFee.php
1 year ago
PortalSession.php
3 years ago
Price.php
6 months ago
Processor.php
1 year ago
Product.php
2 days ago
ProductCollection.php
1 year ago
ProductCollectionImport.php
6 months ago
ProductGroup.php
1 year ago
ProductImport.php
6 months ago
ProductMedia.php
4 months ago
Promotion.php
1 year ago
ProvisionalAccount.php
2 months ago
Purchase.php
2 years ago
Referral.php
1 year ago
ReferralItem.php
2 years ago
Refund.php
1 year ago
RefundItem.php
1 year ago
RegisteredWebhook.php
2 months ago
ReturnItem.php
2 years ago
ReturnReason.php
2 years ago
ReturnRequest.php
1 year ago
Review.php
4 months ago
ReviewProtocol.php
4 months ago
RuleSchema.php
5 months ago
ServiceFee.php
1 year ago
ShippingChoice.php
1 year ago
ShippingMethod.php
3 years ago
ShippingProfile.php
3 years ago
ShippingProtocol.php
3 years ago
ShippingRate.php
3 years ago
ShippingZone.php
3 years ago
Statistic.php
3 years ago
Subscription.php
2 weeks ago
SubscriptionProtocol.php
3 years ago
Swap.php
1 year ago
TaxOverride.php
2 years ago
TaxProtocol.php
3 years ago
TaxRegistration.php
1 year ago
TaxZone.php
3 years ago
Upload.php
3 years ago
Upsell.php
1 year ago
UpsellFunnel.php
1 year ago
User.php
1 month ago
Variant.php
2 days ago
VariantOption.php
2 years ago
VariantOptionValue.php
1 year ago
VariantValue.php
2 years ago
VerificationCode.php
3 years ago
Webhook.php
1 year ago
WebhookRegistration.php
2 years ago
Payout.php
149 lines
| 1 | <?php |
| 2 | |
| 3 | namespace SureCart\Models; |
| 4 | |
| 5 | use SureCart\Models\Traits\HasAffiliation; |
| 6 | use SureCart\Models\Traits\HasDates; |
| 7 | use SureCart\Models\Traits\HasReferrals; |
| 8 | use SureCart\Support\Currency; |
| 9 | use SureCart\Support\TimeDate; |
| 10 | |
| 11 | /** |
| 12 | * Payout model |
| 13 | */ |
| 14 | class Payout extends Model { |
| 15 | use HasReferrals; |
| 16 | use HasAffiliation; |
| 17 | use HasDates; |
| 18 | |
| 19 | /** |
| 20 | * Rest API endpoint |
| 21 | * |
| 22 | * @var string |
| 23 | */ |
| 24 | protected $endpoint = 'payouts'; |
| 25 | |
| 26 | /** |
| 27 | * Object name |
| 28 | * |
| 29 | * @var string |
| 30 | */ |
| 31 | protected $object_name = 'payout'; |
| 32 | |
| 33 | /** |
| 34 | * Set the payout group attribute. |
| 35 | * |
| 36 | * @param object $value Array of payout objects. |
| 37 | * |
| 38 | * @return void |
| 39 | */ |
| 40 | public function setPayoutGroupAttribute( $value ) { |
| 41 | $this->setRelation( 'payout_group', $value, PayoutGroup::class ); |
| 42 | } |
| 43 | |
| 44 | /** |
| 45 | * Complete a payout |
| 46 | * |
| 47 | * @param string $id Payout ID. |
| 48 | * |
| 49 | * @return $this|\WP_Error |
| 50 | */ |
| 51 | protected function complete( $id = null ) { |
| 52 | if ( $id ) { |
| 53 | $this->setAttribute( 'id', $id ); |
| 54 | } |
| 55 | |
| 56 | if ( $this->fireModelEvent( 'completing' ) === false ) { |
| 57 | return $this; |
| 58 | } |
| 59 | |
| 60 | if ( empty( $this->attributes['id'] ) ) { |
| 61 | return new \WP_Error( 'not_saved', 'Please create the payout.' ); |
| 62 | } |
| 63 | |
| 64 | $completed = \SureCart::request( |
| 65 | $this->endpoint . '/' . $this->attributes['id'] . '/complete', |
| 66 | [ |
| 67 | 'method' => 'PATCH', |
| 68 | 'query' => $this->query, |
| 69 | ] |
| 70 | ); |
| 71 | |
| 72 | if ( is_wp_error( $completed ) ) { |
| 73 | return $completed; |
| 74 | } |
| 75 | |
| 76 | $this->resetAttributes(); |
| 77 | $this->fill( $completed ); |
| 78 | $this->fireModelEvent( 'completed' ); |
| 79 | |
| 80 | return $this; |
| 81 | } |
| 82 | |
| 83 | /** |
| 84 | * Make a payout as processing |
| 85 | * |
| 86 | * @param string $id Payout ID. |
| 87 | * |
| 88 | * @return $this|\WP_Error |
| 89 | */ |
| 90 | protected function make_processing( $id = null ) { |
| 91 | if ( $id ) { |
| 92 | $this->setAttribute( 'id', $id ); |
| 93 | } |
| 94 | |
| 95 | if ( $this->fireModelEvent( 'processing' ) === false ) { |
| 96 | return $this; |
| 97 | } |
| 98 | |
| 99 | if ( empty( $this->attributes['id'] ) ) { |
| 100 | return new \WP_Error( 'not_saved', 'Please create the payout.' ); |
| 101 | } |
| 102 | |
| 103 | $processing = \SureCart::request( |
| 104 | $this->endpoint . '/' . $this->attributes['id'] . '/make_processing', |
| 105 | [ |
| 106 | 'method' => 'PATCH', |
| 107 | 'query' => $this->query, |
| 108 | ] |
| 109 | ); |
| 110 | |
| 111 | if ( is_wp_error( $processing ) ) { |
| 112 | return $processing; |
| 113 | } |
| 114 | |
| 115 | $this->resetAttributes(); |
| 116 | $this->fill( $processing ); |
| 117 | $this->fireModelEvent( 'processed' ); |
| 118 | |
| 119 | return $this; |
| 120 | } |
| 121 | |
| 122 | /** |
| 123 | * Get status display |
| 124 | * |
| 125 | * @return string |
| 126 | */ |
| 127 | protected function getStatusDisplayTextAttribute() { |
| 128 | return 'completed' === $this->status ? esc_html__( 'Completed', 'surecart' ) : esc_html__( 'Processing', 'surecart' ); |
| 129 | } |
| 130 | |
| 131 | /** |
| 132 | * Get the end at date. |
| 133 | * |
| 134 | * @return string |
| 135 | */ |
| 136 | public function getEndAtDateAttribute() { |
| 137 | return ! empty( $this->end_date ) ? TimeDate::formatDate( $this->end_date ) : ''; |
| 138 | } |
| 139 | |
| 140 | /** |
| 141 | * Get the total commission amount display. |
| 142 | * |
| 143 | * @return string |
| 144 | */ |
| 145 | public function getTotalCommissionDisplayAmountAttribute() { |
| 146 | return Currency::format( $this->total_commission_amount, $this->currency ); |
| 147 | } |
| 148 | } |
| 149 |