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

surecart / app / src / Models / ProductCollection.php

surecart / app / src / Models Last commit date

ProductCollection.php

234 lines

1	<?php
2
3	namespace SureCart\Models;
4
5	use SureCart\Support\Contracts\PageModel;
6
7	/**
8	* Holds Product Collection data.
9	*/
10	class ProductCollection extends Model implements PageModel {
11	use Traits\HasImageSizes;
12
13	/**
14	* Rest API endpoint
15	*
16	* @var string
17	*/
18	protected $endpoint = 'product_collections';
19
20	/**
21	* Object name
22	*
23	* @var string
24	*/
25	protected $object_name = 'product_collection';
26
27	/**
28	* Is this cachable.
29	*
30	* @var boolean
31	*/
32	protected $cachable = true;
33
34	/**
35	* Clear cache when products are updated.
36	*
37	* @var string
38	*/
39	protected $cache_key = 'product_collections_updated_at';
40
41	/**
42	* Create a new model
43	*
44	* @param array $attributes Attributes to create.
45	*
46	* @return $this\|false
47	*/
48	protected function create( $attributes = [] ) {
49	if ( ! wp_is_block_theme() ) {
50	$attributes['metadata'] = [
51	...$attributes['metadata'] ?? [],
52	'wp_template_id' => apply_filters( 'surecart/templates/collections/default', 'pages/template-surecart-collection.php' ),
53	];
54	}
55
56	$created = parent::create( $attributes );
57
58	if ( is_wp_error( $created ) ) {
59	return $created;
60	}
61
62	// sync with the post.
63	$this->sync();
64
65	return $this;
66	}
67
68	/**
69	* Update a model
70	*
71	* @param array $attributes Attributes to update.
72	*
73	* @return $this\|false
74	*/
75	protected function update( $attributes = array() ) {
76	// update the model.
77	$updated = parent::update( $attributes );
78	if ( is_wp_error( $updated ) ) {
79	return $updated;
80	}
81
82	// sync with the post.
83	$this->sync();
84
85	// return.
86	return $this;
87	}
88
89	/**
90	* Sync the collection
91	*/
92	public function sync() {
93	\SureCart::sync()
94	->collection()
95	->sync( $this );
96
97	return $this;
98	}
99
100	/**
101	* Get the attached term.
102	*
103	* @return int\|false
104	*/
105	public function getTermAttribute() {
106	return \SureCart::sync()->collection()->findByModelId( $this->id );
107	}
108
109	/**
110	* Get the product template
111	*
112	* @return \WP_Template
113	*/
114	public function getTemplateAttribute() {
115	return get_block_template( $this->getTemplateIdAttribute() );
116	}
117
118	/**
119	* Get the product template part template.
120	*
121	* @return \WP_Template
122	*/
123	public function getTemplatePartAttribute() {
124	return get_block_template( $this->getTemplatePartIdAttribute(), 'wp_template_part' );
125	}
126
127	/**
128	* Get the product template id.
129	*
130	* @return string\|false
131	*/
132	public function getTemplatePartIdAttribute(): string {
133	if ( ! empty( $this->attributes['metadata']->wp_template_part_id ) ) {
134	return $this->attributes['metadata']->wp_template_part_id;
135	}
136	return 'surecart/surecart//product-collection-part';
137	}
138
139	/**
140	* Get the product template id.
141	*
142	* @return string
143	*/
144	public function getTemplateIdAttribute(): string {
145	if ( ! empty( $this->attributes['metadata']->wp_template_id ) ) {
146	// we have a php file, switch to default.
147	if ( wp_is_block_theme() && false !== strpos( $this->attributes['metadata']->wp_template_id, '.php' ) ) {
148	return 'surecart/surecart//product-collection';
149	}
150
151	// this is acceptable.
152	return $this->attributes['metadata']->wp_template_id;
153	}
154	return 'surecart/surecart//product-collection';
155	}
156
157	/**
158	* Get the product permalink.
159	*
160	* @return string
161	*/
162	public function getPermalinkAttribute(): string {
163	if ( empty( $this->attributes['id'] ) ) {
164	return false;
165	}
166
167	$term = $this->term;
168
169	if ( isset( $term->term_id ) ) {
170	return get_term_link( $term );
171	}
172
173	return '';
174	}
175
176	/**
177	* Get the page title for SEO.
178	*
179	* @return string
180	*/
181	public function getPageTitleAttribute(): string {
182	return $this->attributes['name'] ?? '';
183	}
184
185	/**
186	* Get the page description for SEO.
187	*
188	* @return string
189	*/
190	public function getMetaDescriptionAttribute(): string {
191	return $this->attributes['description'] ?? '';
192	}
193
194	/**
195	* Get the image url for a specific size.
196	*
197	* @param integer $size The size.
198	*
199	* @return string
200	*/
201	public function getImageUrl( $size = 0, $additional_options = '' ) {
202	if ( empty( $this->attributes['image']->url ) ) {
203	return '';
204	}
205
206	return $size ? $this->imageUrl( $this->attributes['image']->url, $size, false, $additional_options ) : $this->attributes['image']->url;
207	}
208
209	/**
210	* Get the srcset for the product media.
211	*
212	* @param array $sizes The sizes.
213	*
214	* @return string
215	*/
216	public function getSrcSet( $sizes = [] ) {
217	if ( empty( $this->attributes['image']->url ) ) {
218	return '';
219	}
220	return $this->imageSrcSet( $this->attributes['image']->url, $sizes );
221	}
222
223	/**
224	* Get Template Content.
225	*
226	* @return string
227	*/
228	public function getTemplateContent(): string {
229	return wp_is_block_theme() ?
230	$this->template->content ?? '' :
231	$this->template_part->content ?? '';
232	}
233	}
234