/
ProductAttributeMediaGalleryEntryInterface.php
162 lines (142 loc) · 3.41 KB
/
ProductAttributeMediaGalleryEntryInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
<?php
/**
* Product Media Attribute
*
* Copyright © 2016 Magento. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Catalog\Api\Data;
use Magento\Framework\Api\ExtensibleDataInterface;
/**
* @api
*/
interface ProductAttributeMediaGalleryEntryInterface extends ExtensibleDataInterface
{
const ID = 'id';
const LABEL = 'label';
const POSITION = 'position';
const DISABLED = 'disabled';
const TYPES = 'types';
const MEDIA_TYPE = 'media_type';
const FILE = 'file';
const CONTENT = 'content';
/**
* Retrieve gallery entry ID
*
* @return int|null
*/
public function getId();
/**
* Set gallery entry ID
*
* @param int $id
* @return $this
*/
public function setId($id);
/**
* Get media type
*
* @return string
*/
public function getMediaType();
/**
* Set media type
*
* @param string $mediaType
* @return $this
*/
public function setMediaType($mediaType);
/**
* Retrieve gallery entry alternative text
*
* @return string
*/
public function getLabel();
/**
* Set gallery entry alternative text
*
* @param string $label
* @return $this
*/
public function setLabel($label);
/**
* Retrieve gallery entry position (sort order)
*
* @return int
*/
public function getPosition();
/**
* Set gallery entry position (sort order)
*
* @param int $position
* @return $this
*/
public function setPosition($position);
/**
* Check if gallery entry is hidden from product page
*
* @return bool
*/
public function isDisabled();
/**
* Set whether gallery entry is hidden from product page
*
* @param bool $disabled
* @return $this
*/
public function setDisabled($disabled);
/**
* Retrieve gallery entry image types (thumbnail, image, small_image etc)
*
* @return string[]
*/
public function getTypes();
/**
* Set gallery entry image types (thumbnail, image, small_image etc)
*
* @param string[] $types
* @return $this
*/
public function setTypes(array $types = null);
/**
* Get file path
*
* @return string|null
*/
public function getFile();
/**
* Set file path
*
* @param string $file
* @return $this
*/
public function setFile($file);
/**
* Get media gallery content
*
* @return \Magento\Framework\Api\Data\ImageContentInterface|null
*/
public function getContent();
/**
* Set media gallery content
*
* @param $content \Magento\Framework\Api\Data\ImageContentInterface
* @return $this
*/
public function setContent($content);
/**
* Retrieve existing extension attributes object or create a new one.
*
* @return \Magento\Catalog\Api\Data\ProductAttributeMediaGalleryEntryExtensionInterface|null
*/
public function getExtensionAttributes();
/**
* Set an extension attributes object.
*
* @param \Magento\Catalog\Api\Data\ProductAttributeMediaGalleryEntryExtensionInterface $extensionAttributes
* @return $this
*/
public function setExtensionAttributes(
\Magento\Catalog\Api\Data\ProductAttributeMediaGalleryEntryExtensionInterface $extensionAttributes
);
}