Traits
2 years ago
AbandonedCheckout.php
3 years ago
AbandonedCheckoutProtocol.php
3 years ago
Account.php
3 years ago
AccountPortalSession.php
4 years ago
Activation.php
3 years ago
ApiToken.php
3 years ago
BalanceTransaction.php
3 years ago
Brand.php
4 years ago
Bump.php
3 years ago
BuyLink.php
3 years ago
CancellationAct.php
3 years ago
CancellationReason.php
3 years ago
Charge.php
4 years ago
Checkout.php
2 years ago
Collection.php
4 years ago
Component.php
4 years ago
Coupon.php
4 years ago
Customer.php
3 years ago
CustomerLink.php
4 years ago
CustomerNotificationProtocol.php
4 years ago
DatabaseModel.php
2 years ago
Download.php
4 years ago
Event.php
4 years ago
Form.php
3 years ago
Fulfillment.php
3 years ago
FulfillmentItem.php
3 years ago
IncomingWebhook.php
2 years ago
Integration.php
4 years ago
Invoice.php
4 years ago
License.php
3 years ago
LineItem.php
2 years ago
ManualPaymentMethod.php
3 years ago
Media.php
3 years ago
Model.php
2 years ago
ModelInterface.php
4 years ago
Order.php
3 years ago
OrderProtocol.php
3 years ago
PaymentIntent.php
4 years ago
PaymentMethod.php
4 years ago
Period.php
3 years ago
PortalProtocol.php
4 years ago
PortalSession.php
4 years ago
Price.php
3 years ago
Processor.php
3 years ago
Product.php
2 years ago
ProductCollection.php
2 years ago
ProductGroup.php
4 years ago
ProductMedia.php
3 years ago
Promotion.php
4 years ago
ProvisionalAccount.php
3 years ago
Purchase.php
3 years ago
Refund.php
4 years ago
RegisteredWebhook.php
2 years 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 years ago
SubscriptionProtocol.php
4 years ago
TaxProtocol.php
4 years ago
TaxRegistration.php
4 years ago
TaxZone.php
4 years ago
Upload.php
4 years ago
User.php
2 years ago
Variant.php
2 years ago
VariantOption.php
2 years ago
VariantValue.php
2 years ago
VerificationCode.php
3 years ago
Webhook.php
2 years ago
WebhookRegistration.php
2 years ago
Product.php
359 lines
| 1 | <?php |
| 2 | |
| 3 | namespace SureCart\Models; |
| 4 | |
| 5 | use SureCart\Support\Contracts\PageModel; |
| 6 | use SureCart\Support\Currency; |
| 7 | |
| 8 | /** |
| 9 | * Price model |
| 10 | */ |
| 11 | class Product extends Model implements PageModel { |
| 12 | use Traits\HasImageSizes; |
| 13 | |
| 14 | /** |
| 15 | * Rest API endpoint |
| 16 | * |
| 17 | * @var string |
| 18 | */ |
| 19 | protected $endpoint = 'products'; |
| 20 | |
| 21 | /** |
| 22 | * Object name |
| 23 | * |
| 24 | * @var string |
| 25 | */ |
| 26 | protected $object_name = 'product'; |
| 27 | |
| 28 | /** |
| 29 | * Is this cachable? |
| 30 | * |
| 31 | * @var boolean |
| 32 | */ |
| 33 | protected $cachable = true; |
| 34 | |
| 35 | /** |
| 36 | * Clear cache when products are updated. |
| 37 | * |
| 38 | * @var string |
| 39 | */ |
| 40 | protected $cache_key = 'products_updated_at'; |
| 41 | |
| 42 | /** |
| 43 | * Create a new model |
| 44 | * |
| 45 | * @param array $attributes Attributes to create. |
| 46 | * |
| 47 | * @return $this|false |
| 48 | */ |
| 49 | protected function create( $attributes = [] ) { |
| 50 | if ( ! wp_is_block_theme() ) { |
| 51 | $attributes['metadata'] = [ |
| 52 | ...$attributes['metadata'] ?? [], |
| 53 | 'wp_template_id' => apply_filters( 'surecart/templates/products/default', 'pages/template-surecart-product.php' ), |
| 54 | ]; |
| 55 | } |
| 56 | |
| 57 | return parent::create( $attributes ); |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * Image srcset. |
| 62 | * |
| 63 | * @return string |
| 64 | */ |
| 65 | public function getImageSrcsetAttribute() { |
| 66 | if ( empty( $this->attributes['image_url'] ) ) { |
| 67 | return ''; |
| 68 | } |
| 69 | return $this->imageSrcSet( $this->attributes['image_url'] ); |
| 70 | } |
| 71 | |
| 72 | /** |
| 73 | * Get the image url for a specific size. |
| 74 | * |
| 75 | * @param integer $size The size. |
| 76 | * |
| 77 | * @return string |
| 78 | */ |
| 79 | public function getImageUrl( $size = 0 ) { |
| 80 | if ( empty( $this->attributes['image_url'] ) ) { |
| 81 | return ''; |
| 82 | } |
| 83 | return $size ? $this->imageUrl( $this->attributes['image_url'], $size ) : $this->attributes['image_url']; |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Set the prices attribute. |
| 88 | * |
| 89 | * @param object $value Array of price objects. |
| 90 | * @return void |
| 91 | */ |
| 92 | public function setPricesAttribute( $value ) { |
| 93 | $this->setCollection( 'prices', $value, Price::class ); |
| 94 | } |
| 95 | |
| 96 | /** |
| 97 | * Set the product collections attribute |
| 98 | * |
| 99 | * @param object $value Product collections. |
| 100 | * @return void |
| 101 | */ |
| 102 | public function setProductCollectionsAttribute( $value ) { |
| 103 | $this->setCollection( 'product_collections', $value, ProductCollection::class ); |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * Set the variants attribute. |
| 108 | * |
| 109 | * @param object $value Array of price objects. |
| 110 | * @return void |
| 111 | */ |
| 112 | public function setVariantsAttribute( $value ) { |
| 113 | $this->setCollection( 'variants', $value, Variant::class ); |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * Set the product attribute |
| 118 | * |
| 119 | * @param string $value Product properties. |
| 120 | * @return void |
| 121 | */ |
| 122 | public function setPurchaseAttribute( $value ) { |
| 123 | $this->setRelation( 'purchase', $value, Purchase::class ); |
| 124 | } |
| 125 | |
| 126 | /** |
| 127 | * Set the product media attribute |
| 128 | * |
| 129 | * @param string $value ProductMedia properties. |
| 130 | * @return void |
| 131 | */ |
| 132 | public function setProductMediasAttribute( $value ) { |
| 133 | $this->setCollection( 'product_medias', $value, ProductMedia::class ); |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Buy link model |
| 138 | * |
| 139 | * @return \SureCart\Models\BuyLink |
| 140 | */ |
| 141 | public function buyLink() { |
| 142 | return new BuyLink( $this ); |
| 143 | } |
| 144 | |
| 145 | /** |
| 146 | * Checkout Permalink. |
| 147 | * |
| 148 | * @return string |
| 149 | */ |
| 150 | public function getCheckoutPermalinkAttribute() { |
| 151 | return $this->buyLink()->url(); |
| 152 | } |
| 153 | |
| 154 | /** |
| 155 | * Get the product permalink. |
| 156 | * |
| 157 | * @return string |
| 158 | */ |
| 159 | public function getPermalinkAttribute(): string { |
| 160 | if ( empty( $this->attributes['id'] ) ) { |
| 161 | return ''; |
| 162 | } |
| 163 | // permalinks off. |
| 164 | if ( ! get_option( 'permalink_structure' ) ) { |
| 165 | return add_query_arg( 'sc_product_page_id', $this->slug, get_home_url() ); |
| 166 | } |
| 167 | // permalinks on. |
| 168 | return trailingslashit( get_home_url() ) . trailingslashit( \SureCart::settings()->permalinks()->getBase( 'product_page' ) ) . $this->slug; |
| 169 | } |
| 170 | |
| 171 | /** |
| 172 | * Get the page title. |
| 173 | * |
| 174 | * @return string |
| 175 | */ |
| 176 | public function getPageTitleAttribute(): string { |
| 177 | return $this->metadata->page_title ?? $this->name ?? ''; |
| 178 | } |
| 179 | |
| 180 | /** |
| 181 | * Get the meta description. |
| 182 | * |
| 183 | * @return string |
| 184 | */ |
| 185 | public function getMetaDescriptionAttribute(): string { |
| 186 | return $this->metadata->meta_description ?? $this->description ?? ''; |
| 187 | } |
| 188 | |
| 189 | /** |
| 190 | * Return attached active prices. |
| 191 | * |
| 192 | * @return array |
| 193 | */ |
| 194 | public function activePrices() { |
| 195 | $active_prices = array_values( |
| 196 | array_filter( |
| 197 | $this->prices->data ?? [], |
| 198 | function( $price ) { |
| 199 | return ! $price->archived; |
| 200 | } |
| 201 | ) |
| 202 | ); |
| 203 | |
| 204 | usort( |
| 205 | $active_prices, |
| 206 | function( $a, $b ) { |
| 207 | if ( $a->position == $b->position ) { |
| 208 | return 0; |
| 209 | } |
| 210 | return ( $a->position < $b->position ) ? -1 : 1; |
| 211 | } |
| 212 | ); |
| 213 | |
| 214 | return $active_prices; |
| 215 | } |
| 216 | |
| 217 | /** |
| 218 | * Get the JSON Schema Array |
| 219 | * |
| 220 | * @return array |
| 221 | */ |
| 222 | public function getJsonSchemaArray(): array { |
| 223 | $active_prices = (array) $this->activePrices(); |
| 224 | |
| 225 | $offers = array_map( |
| 226 | function( $price ) { |
| 227 | return [ |
| 228 | '@type' => 'Offer', |
| 229 | 'price' => Currency::maybeConvertAmount( $price->amount, $price->currency ), |
| 230 | 'priceCurrency' => $price->currency, |
| 231 | 'availability' => 'https://schema.org/InStock', |
| 232 | ]; |
| 233 | }, |
| 234 | $active_prices ?? [] |
| 235 | ); |
| 236 | |
| 237 | return apply_filters( |
| 238 | 'surecart/product/json_schema', |
| 239 | [ |
| 240 | '@context' => 'http://schema.org', |
| 241 | '@type' => 'Product', |
| 242 | 'name' => $this->name, |
| 243 | 'image' => $this->image_url ?? '', |
| 244 | 'description' => sanitize_text_field( $this->description ), |
| 245 | 'offers' => $offers, |
| 246 | ], |
| 247 | $this |
| 248 | ); |
| 249 | } |
| 250 | |
| 251 | /** |
| 252 | * Get the product template id. |
| 253 | * |
| 254 | * @return string |
| 255 | */ |
| 256 | public function getTemplateIdAttribute(): string { |
| 257 | if ( ! empty( $this->attributes['metadata']->wp_template_id ) ) { |
| 258 | // we have a php file, switch to default. |
| 259 | if ( wp_is_block_theme() && false !== strpos( $this->attributes['metadata']->wp_template_id, '.php' ) ) { |
| 260 | return 'surecart/surecart//single-product'; |
| 261 | } |
| 262 | |
| 263 | // this is acceptable. |
| 264 | return $this->attributes['metadata']->wp_template_id; |
| 265 | } |
| 266 | return 'surecart/surecart//single-product'; |
| 267 | } |
| 268 | |
| 269 | /** |
| 270 | * Get product with acgive and sorted prices. |
| 271 | * |
| 272 | * @return this |
| 273 | */ |
| 274 | public function withActiveAndSortedPrices() { |
| 275 | $filtered = clone $this; |
| 276 | |
| 277 | // Filter out archived prices. |
| 278 | $filtered->prices->data = array_values( |
| 279 | array_filter( |
| 280 | $filtered->prices->data, |
| 281 | function( $price ) { |
| 282 | return ! $price->archived; |
| 283 | } |
| 284 | ) |
| 285 | ); |
| 286 | |
| 287 | // Sort prices by position. |
| 288 | usort( |
| 289 | $filtered->prices->data, |
| 290 | function( $a, $b ) { |
| 291 | return $a->position - $b->position; |
| 292 | } |
| 293 | ); |
| 294 | |
| 295 | return $filtered; |
| 296 | } |
| 297 | |
| 298 | /** |
| 299 | * Get the first variant with stock. |
| 300 | * |
| 301 | * @return \SureCart\Models\Variant; |
| 302 | */ |
| 303 | public function getFirstVariantWithStock() { |
| 304 | $first_variant_with_stock = $this->variants->data[0] ?? null; |
| 305 | |
| 306 | // stock is enabled. |
| 307 | if ( $this->stock_enabled ) { |
| 308 | foreach ( $this->variants->data as $variant ) { |
| 309 | if ( $variant->available_stock > 0 ) { |
| 310 | $first_variant_with_stock = $variant; |
| 311 | break; |
| 312 | } |
| 313 | } |
| 314 | } |
| 315 | return $first_variant_with_stock; |
| 316 | } |
| 317 | |
| 318 | /** |
| 319 | * Get the product template |
| 320 | * |
| 321 | * @return \WP_Template |
| 322 | */ |
| 323 | public function getTemplateAttribute() { |
| 324 | return get_block_template( $this->getTemplateIdAttribute() ); |
| 325 | } |
| 326 | |
| 327 | /** |
| 328 | * Get the product template id. |
| 329 | * |
| 330 | * @return string |
| 331 | */ |
| 332 | public function getTemplatePartIdAttribute(): string { |
| 333 | if ( ! empty( $this->attributes['metadata']->wp_template_part_id ) ) { |
| 334 | return $this->attributes['metadata']->wp_template_part_id; |
| 335 | } |
| 336 | return 'surecart/surecart//product-info'; |
| 337 | } |
| 338 | |
| 339 | /** |
| 340 | * Get the product template part template. |
| 341 | * |
| 342 | * @return \WP_Template |
| 343 | */ |
| 344 | public function getTemplatePartAttribute() { |
| 345 | return get_block_template( $this->getTemplatePartIdAttribute(), 'wp_template_part' ); |
| 346 | } |
| 347 | |
| 348 | /** |
| 349 | * Get Template Content. |
| 350 | * |
| 351 | * @return string |
| 352 | */ |
| 353 | public function getTemplateContent() : string { |
| 354 | return wp_is_block_theme() ? |
| 355 | $this->template->content ?? '' : |
| 356 | $this->template_part->content ?? ''; |
| 357 | } |
| 358 | } |
| 359 |