Referral.php — SureCart – Ecommerce Made Easy For Selling Physical Products, Digital Downloads, Subscriptions, Donations, & Payments 3.0.0-beta1

surecart / app / src / Models / Referral.php

surecart / app / src / Models Last commit date

Referral.php

199 lines

1	<?php
2
3	namespace SureCart\Models;
4
5	use SureCart\Models\Traits\HasAffiliation;
6	use SureCart\Models\Traits\HasCheckout;
7	use SureCart\Models\Traits\HasPayout;
8	use SureCart\Models\Traits\HasReferralItems;
9
10	/**
11	* Referral model
12	*/
13	class Referral extends Model {
14	use HasAffiliation, HasCheckout, HasPayout, HasReferralItems;
15
16	/**
17	* Rest API endpoint
18	*
19	* @var string
20	*/
21	protected $endpoint = 'referrals';
22
23	/**
24	* Object name
25	*
26	* @var string
27	*/
28	protected $object_name = 'referral';
29
30	/**
31	* Approve a referral
32	*
33	* @param string $id Referral ID.
34	*
35	* @return $this\|\WP_Error
36	*/
37	protected function approve( $id = null ) {
38	if ( $id ) {
39	$this->setAttribute( 'id', $id );
40	}
41
42	if ( $this->fireModelEvent( 'approving' ) === false ) {
43	return $this;
44	}
45
46	if ( empty( $this->attributes['id'] ) ) {
47	return new \WP_Error( 'not_saved', 'Please create the referral.' );
48	}
49
50	$approved = \SureCart::request(
51	$this->endpoint . '/' . $this->attributes['id'] . '/approve',
52	[
53	'method' => 'PATCH',
54	'query' => $this->query,
55	]
56	);
57
58	if ( is_wp_error( $approved ) ) {
59	return $approved;
60	}
61
62	$this->resetAttributes();
63	$this->fill( $approved );
64	$this->fireModelEvent( 'approved' );
65
66	return $this;
67	}
68
69	/**
70	* Deny a referral
71	*
72	* @param string $id Referral ID.
73	*
74	* @return $this\|\WP_Error
75	*/
76	protected function deny( $id = null ) {
77	if ( $id ) {
78	$this->setAttribute( 'id', $id );
79	}
80
81	if ( $this->fireModelEvent( 'denying' ) === false ) {
82	return $this;
83	}
84
85	if ( empty( $this->attributes['id'] ) ) {
86	return new \WP_Error( 'not_saved', 'Please create the referral.' );
87	}
88
89	$denied = \SureCart::request(
90	$this->endpoint . '/' . $this->attributes['id'] . '/deny',
91	[
92	'method' => 'PATCH',
93	'query' => $this->query,
94	]
95	);
96
97	if ( is_wp_error( $denied ) ) {
98	return $denied;
99	}
100
101	$this->resetAttributes();
102	$this->fill( $denied );
103	$this->fireModelEvent( 'denied' );
104
105	return $this;
106	}
107
108	/**
109	* Make a referral as in review
110	*
111	* @param string $id Referral ID.
112	*
113	* @return $this\|\WP_Error
114	*/
115	protected function make_reviewing( $id = null ) {
116	if ( $id ) {
117	$this->setAttribute( 'id', $id );
118	}
119
120	if ( $this->fireModelEvent( 'making_reviewing' ) === false ) {
121	return $this;
122	}
123
124	if ( empty( $this->attributes['id'] ) ) {
125	return new \WP_Error( 'not_saved', 'Please create the referral.' );
126	}
127
128	$reviewing = \SureCart::request(
129	$this->endpoint . '/' . $this->attributes['id'] . '/make_reviewing',
130	[
131	'method' => 'PATCH',
132	'query' => $this->query,
133	]
134	);
135
136	if ( is_wp_error( $reviewing ) ) {
137	return $reviewing;
138	}
139
140	$this->resetAttributes();
141	$this->fill( $reviewing );
142	$this->fireModelEvent( 'made_reviewing' );
143
144	return $this;
145	}
146
147	/**
148	* Set the affiliation attribute
149	*
150	* @param object $value Array of payout objects.
151	*
152	* @return void
153	*/
154	public function setAttributedClickAttribute( $value ) {
155	$this->setRelation( 'attributed_click', $value, Click::class );
156	}
157
158	/**
159	* Get the display status attribute.
160	*
161	* @return string
162	*/
163	public function getStatusDisplayTextAttribute() {
164	$statuses = [
165	'reviewing' => __( 'Reviewing', 'surecart' ),
166	'paid' => __( 'In Payout', 'surecart' ),
167	'denied' => __( 'Denied', 'surecart' ),
168	'cancelled' => __( 'Cancelled', 'surecart' ),
169	'approved' => __( 'Approved', 'surecart' ),
170	];
171	return $statuses[ $this->status ] ?? '';
172	}
173
174	/**
175	* Get the display status attribute.
176	*
177	* @return string
178	*/
179	public function getStatusTypeAttribute() {
180	$types = [
181	'reviewing' => 'warning',
182	'paid' => 'success',
183	'denied' => 'danger',
184	'cancelled' => 'default',
185	'approved' => 'info',
186	];
187	return $types[ $this->status ] ?? 'default';
188	}
189
190	/**
191	* Get the editable attribute.
192	*
193	* @return bool
194	*/
195	public function getEditableAttribute() {
196	return 'paid' !== $this->status;
197	}
198	}
199