Media.php
| 1 | <?php |
| 2 | |
| 3 | namespace SureCart\Models; |
| 4 | |
| 5 | use SureCart\Models\Traits\HasDates; |
| 6 | use SureCart\Models\Traits\HasImageSizes; |
| 7 | |
| 8 | /** |
| 9 | * Price model |
| 10 | */ |
| 11 | class Media extends Model { |
| 12 | use HasImageSizes; |
| 13 | use HasDates; |
| 14 | |
| 15 | /** |
| 16 | * Rest API endpoint |
| 17 | * |
| 18 | * @var string |
| 19 | */ |
| 20 | protected $endpoint = 'medias'; |
| 21 | |
| 22 | /** |
| 23 | * Object name |
| 24 | * |
| 25 | * @var string |
| 26 | */ |
| 27 | protected $object_name = 'media'; |
| 28 | |
| 29 | /** |
| 30 | * Image srcset. |
| 31 | * |
| 32 | * @return string |
| 33 | */ |
| 34 | public function getSrcsetAttribute() { |
| 35 | if ( empty( $this->attributes['url'] ) ) { |
| 36 | return ''; |
| 37 | } |
| 38 | return $this->imageSrcSet( $this->attributes['url'] ); |
| 39 | } |
| 40 | |
| 41 | /** |
| 42 | * Get the image url for a specific size. |
| 43 | * |
| 44 | * @param integer $size The size. |
| 45 | * |
| 46 | * @return string |
| 47 | */ |
| 48 | public function getUrl( $size = 0 ) { |
| 49 | if ( empty( $this->attributes['url'] ) ) { |
| 50 | return ''; |
| 51 | } |
| 52 | return $size ? $this->imageUrl( $this->attributes['url'], $size ) : $this->attributes['url']; |
| 53 | } |
| 54 | |
| 55 | /** |
| 56 | * Get the image markup. |
| 57 | * We are assuming all media here is an image. |
| 58 | * |
| 59 | * @param string $size The size of the image. |
| 60 | * @param array $attr The attributes for the tag. |
| 61 | * |
| 62 | * @return string |
| 63 | */ |
| 64 | protected function html( $size = 'full', $attr = [] ) { |
| 65 | // prepare attributes. |
| 66 | $attr = $this->attributes( $size, $attr ); |
| 67 | $html = '<img '; |
| 68 | |
| 69 | foreach ( $attr as $name => $value ) { |
| 70 | $html .= " $name=" . '"' . $value . '"'; |
| 71 | } |
| 72 | |
| 73 | // close tag. |
| 74 | $html .= ' />'; |
| 75 | |
| 76 | return $html; |
| 77 | } |
| 78 | |
| 79 | /** |
| 80 | * Get the image attributes. |
| 81 | * |
| 82 | * @param string $size The size of the image. |
| 83 | * @param array $attr The attributes for the tag. |
| 84 | * |
| 85 | * @return array |
| 86 | */ |
| 87 | protected function attributes( $size = 'full', $attr = [] ) { |
| 88 | // get sizes. |
| 89 | $sizes = wp_get_registered_image_subsizes(); |
| 90 | $image_size = $sizes[ $size ] ?? null; |
| 91 | |
| 92 | // get width and constrain the dimensions based on the width/height. |
| 93 | $width = $image_size['width'] ?? $this->width ?? 1080; |
| 94 | if ( $this->width && $this->height ) { |
| 95 | [$width, $height] = wp_constrain_dimensions( $this->width, $this->height, $width ); |
| 96 | } else { |
| 97 | $height = $image_size['height'] ?? $this->height ?? 1080; |
| 98 | } |
| 99 | |
| 100 | $srcset_sizes = array_map( |
| 101 | function ( $size ) { |
| 102 | return $size['width']; |
| 103 | }, |
| 104 | $sizes |
| 105 | ); |
| 106 | |
| 107 | $attachment_class = 'attachment-' . $size . ' size-' . $size; |
| 108 | |
| 109 | // set attributes. |
| 110 | $attr['src'] = $this->getUrl( $width ); |
| 111 | $attr['alt'] = $this->alt ?? ''; |
| 112 | $attr['class'] = $attachment_class . ' ' . ( ! empty( $attr['class'] ) ? $attr['class'] : '' ); |
| 113 | $attr['sizes'] = sprintf( '(max-width: %1$dpx) 100vw, %1$dpx', $width ); |
| 114 | $attr['width'] = (int) $width; |
| 115 | $attr['height'] = (int) $height; |
| 116 | |
| 117 | // loading attributes. |
| 118 | $loading_attr = $attr; |
| 119 | $loading_attr['width'] = $width; |
| 120 | $loading_attr['height'] = $height; |
| 121 | $loading_optimization_attr = wp_get_loading_optimization_attributes( |
| 122 | 'img', |
| 123 | $loading_attr, |
| 124 | 'surecart-product-page' |
| 125 | ); |
| 126 | |
| 127 | // Add loading optimization attributes if not available. |
| 128 | $attr = array_merge( $attr, $loading_optimization_attr ); |
| 129 | |
| 130 | // Omit the `decoding` attribute if the value is invalid according to the spec. |
| 131 | if ( empty( $attr['decoding'] ) || ! in_array( $attr['decoding'], array( 'async', 'sync', 'auto' ), true ) ) { |
| 132 | unset( $attr['decoding'] ); |
| 133 | } |
| 134 | |
| 135 | /* |
| 136 | * If the default value of `lazy` for the `loading` attribute is overridden |
| 137 | * to omit the attribute for this image, ensure it is not included. |
| 138 | */ |
| 139 | if ( isset( $attr['loading'] ) && ! $attr['loading'] ) { |
| 140 | unset( $attr['loading'] ); |
| 141 | } |
| 142 | |
| 143 | // If the `fetchpriority` attribute is overridden and set to false or an empty string. |
| 144 | if ( isset( $attr['fetchpriority'] ) && ! $attr['fetchpriority'] ) { |
| 145 | unset( $attr['fetchpriority'] ); |
| 146 | } |
| 147 | |
| 148 | if ( empty( $attr['srcset'] ) ) { |
| 149 | $attr['srcset'] = $this->imageSrcSet( $this->url, $srcset_sizes ); |
| 150 | } |
| 151 | |
| 152 | /** |
| 153 | * Filters the list of attachment image attributes. |
| 154 | * |
| 155 | * @param string[] $attr Array of attribute values for the image markup, keyed by attribute name. |
| 156 | * See wp_get_attachment_image(). |
| 157 | * @param \SureCart\Models\ProductMedia $this The current instance of the ProductMedia class. |
| 158 | * @param string|int[] $size Requested image size. Can be any registered image size name, or |
| 159 | * an array of width and height values in pixels (in that order). |
| 160 | */ |
| 161 | $attr = apply_filters( 'wp_get_sc_product_attachment_image_attributes', $attr, $this, $size ); |
| 162 | |
| 163 | // prepare attributes. |
| 164 | return (object) $attr; |
| 165 | } |
| 166 | } |