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

surecart / app / src / Models / Media.php

surecart / app / src / Models Last commit date

Media.php

163 lines

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