1 <?php
2
3 /* --------------------------------------------------------------
4 ProductImageInterface.inc.php 2015-12-07
5 Gambio GmbH
6 http://www.gambio.de
7 Copyright (c) 2015 Gambio GmbH
8 Released under the GNU General Public License (Version 2)
9 [http://www.gnu.org/licenses/gpl-2.0.html]
10 --------------------------------------------------------------
11 */
12
13 /**
14 * Interface ProductImageInterface
15 *
16 * @category System
17 * @package Product
18 * @subpackage Interfaces
19 */
20 Interface ProductImageInterface
21 {
22 /**
23 * Get Filename
24 *
25 * Returns the filename of the product.
26 *
27 * @return string The filename of the product.
28 */
29 public function getFilename();
30
31
32 /**
33 * Get Alt Text
34 *
35 * Returns the alternative text of a product image.
36 *
37 * @param LanguageCode $language The language code of the alt text to return.
38 *
39 * @return string The alternative text of the product image.
40 */
41 public function getAltText(LanguageCode $language);
42
43
44 /**
45 * Is Visible
46 *
47 * Checks if the product is set to visible or not.
48 *
49 * @return bool Is the product visible?
50 */
51 public function isVisible();
52
53
54 /**
55 * Set Alt Text
56 *
57 * Sets the alternative text of the product image.
58 *
59 * @param StringType $text The alternative text for the product image.
60 * @param LanguageCode $language The language code of the alternative text.
61 *
62 * @return string The alternative text of the product image.
63 */
64 public function setAltText(StringType $text, LanguageCode $language);
65
66
67 /**
68 * Set Visible
69 *
70 * Activates or deactivates the products visibility.
71 *
72 * @param BoolType $visible Should the product be visible?
73 *
74 * @return ProductImageInterface Same instance for chained method calls.
75 */
76 public function setVisible(BoolType $visible);
77 }