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