give / src / Campaigns / Models / Campaign.php

Campaign.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.9, at src/Campaigns/Models/Campaign.php

221 lines 5.6 KB

Raw Download Zip

1	<?php
2
3	namespace Give\Campaigns\Models;
4
5	use DateTime;
6	use Exception;
7	use Give\Campaigns\Actions\ConvertQueryDataToCampaign;
8	use Give\Campaigns\DataTransferObjects\CampaignGoalData;
9	use Give\Campaigns\Factories\CampaignFactory;
10	use Give\Campaigns\Repositories\CampaignPageRepository;
11	use Give\Campaigns\Repositories\CampaignRepository;
12	use Give\Campaigns\ValueObjects\CampaignGoalType;
13	use Give\Campaigns\ValueObjects\CampaignPageStatus;
14	use Give\Campaigns\ValueObjects\CampaignStatus;
15	use Give\Campaigns\ValueObjects\CampaignType;
16	use Give\DonationForms\V2\Models\DonationForm;
17	use Give\DonationForms\V2\Repositories\DonationFormsRepository;
18	use Give\Framework\Exceptions\Primitives\InvalidArgumentException;
19	use Give\Framework\Models\Contracts\ModelCrud;
20	use Give\Framework\Models\Contracts\ModelHasFactory;
21	use Give\Framework\Models\Model;
22	use Give\Framework\Models\ModelQueryBuilder;
23	use Give\Framework\QueryBuilder\JoinQueryBuilder;
24
25	/**
26	* @since 4.0.0
27	*
28	* @property int $id
29	* @property int $pageId
30	* @property int $defaultFormId
31	* @property CampaignType $type
32	* @property string $title
33	* @property string $url
34	* @property string $shortDescription
35	* @property string $longDescription
36	* @property string $logo
37	* @property string $image
38	* @property string $primaryColor
39	* @property string $secondaryColor
40	* @property int $goal
41	* @property CampaignGoalType $goalType
42	* @property CampaignStatus $status
43	* @property DateTime $startDate
44	* @property DateTime $endDate
45	* @property DateTime $createdAt
46	*/
47	class Campaign extends Model implements ModelCrud, ModelHasFactory
48	{
49	/**
50	* @inheritdoc
51	*/
52	protected $properties = [
53	'id' => 'int',
54	'pageId' => 'int',
55	'defaultFormId' => 'int',
56	'type' => CampaignType::class,
57	'title' => 'string',
58	'shortDescription' => 'string',
59	'longDescription' => 'string',
60	'logo' => 'string',
61	'image' => 'string',
62	'primaryColor' => 'string',
63	'secondaryColor' => 'string',
64	'goal' => 'int',
65	'goalType' => CampaignGoalType::class,
66	'status' => CampaignStatus::class,
67	'startDate' => DateTime::class,
68	'endDate' => DateTime::class,
69	'createdAt' => DateTime::class,
70	];
71
72	/**
73	* @since 4.0.0
74	*/
75	public function defaultForm(): ?DonationForm
76	{
77	return give(DonationFormsRepository::class)->getById($this->defaultFormId);
78	}
79
80	/**
81	* @since 4.0.0
82	*/
83	public function forms(): ModelQueryBuilder
84	{
85	return DonationForm::query()
86	->join(function (JoinQueryBuilder $builder) {
87	$builder
88	->leftJoin('give_campaign_forms', 'campaign_forms')
89	->on('campaign_forms.form_id', 'id');
90	})
91	->where('campaign_forms.campaign_id', $this->id);
92	}
93
94	/**
95	* @since 4.0.0
96	*/
97	public function page(): ?CampaignPage
98	{
99	return give(CampaignPageRepository::class)->findByCampaignId($this->id);
100	}
101
102	/**
103	* @since 4.0.0
104	*/
105	public static function factory(): CampaignFactory
106	{
107	return new CampaignFactory(static::class);
108	}
109
110	/**
111	* Find campaign by ID
112	*
113	* @since 4.0.0
114	*/
115	public static function find($id): ?Campaign
116	{
117	return give(CampaignRepository::class)->getById($id);
118	}
119
120	/**
121	* Find campaign by Form ID
122	*
123	* @since 4.0.0
124	*/
125	public static function findByFormId(int $formId): ?Campaign
126	{
127	return give(CampaignRepository::class)->getByFormId($formId);
128	}
129
130	/**
131	* @since 4.0.0
132	*
133	* @throws Exception
134	*/
135	public static function create(array $attributes): Campaign
136	{
137	$campaign = new static($attributes);
138
139	give(CampaignRepository::class)->insert($campaign);
140
141	return $campaign;
142	}
143
144	/**
145	* @since 4.0.0
146	*
147	* @throws Exception\|InvalidArgumentException
148	*/
149	public function save(): void
150	{
151	if ( ! $this->id) {
152	give(CampaignRepository::class)->insert($this);
153	} else {
154	give(CampaignRepository::class)->update($this);
155	}
156	}
157
158	/**
159	* @since 4.0.0
160	*
161	* @throws Exception
162	*/
163	public function delete(): bool
164	{
165	return give(CampaignRepository::class)->delete($this);
166	}
167
168	/**
169	* @since 4.0.0
170	*
171	* @throws Exception
172	*/
173	public function merge(Campaign ...$campaignsToMerge): bool
174	{
175	return give(CampaignRepository::class)->mergeCampaigns($this, ...$campaignsToMerge);
176	}
177
178	/**
179	* @since 4.13.1
180	*/
181	public function createPage(?array $attributes = []): ?CampaignPage
182	{
183	$page = CampaignPage::create(array_merge([
184	'campaignId' => $this->id,
185	'status' => CampaignPageStatus::DRAFT(),
186	], $attributes));
187
188	$this->pageId = $page->id;
189
190	return $page;
191	}
192
193	/**
194	* @since 4.0.0
195	*/
196	public function getGoalStats(): array
197	{
198	return (new CampaignGoalData($this))->toArray();
199	}
200
201	/**
202	* @since 4.0.0
203	*
204	* @return ModelQueryBuilder<Campaign>
205	*/
206	public static function query(): ModelQueryBuilder
207	{
208	return give(CampaignRepository::class)->prepareQuery();
209	}
210
211	/**
212	* @since 4.0.0
213	*
214	* @param object $object
215	*/
216	public static function fromQueryBuilderObject($object): Campaign
217	{
218	return (new ConvertQueryDataToCampaign())($object);
219	}
220	}
221