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 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
<?php
/* --------------------------------------------------------------
SliderReadServiceInterface.inc.php 2016-11-01
Gambio GmbH
http://www.gambio.de
Copyright (c) 2016 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
/**
* Interface SliderReadServiceInterface
*
* @category System
* @package Slider
* @subpackage Interfaces
*/
Interface SliderReadServiceInterface
{
/**
* Returns a SliderCollection with all existing Slider objects.
*
* @return SliderCollection
*/
public function getAllSlider();
/**
* Returns a Slider instance by the given slider ID.
*
* @param IdType $sliderId
*
* @return SliderInterface
*/
public function getSliderById(IdType $sliderId);
/**
* Returns a Slide instance by the given slide ID.
*
* @param IdType $slideId
*
* @return SlideInterface
*/
public function getSlideById(IdType $slideId);
/**
* Returns a SlideImage instance by the given slide image ID.
*
* @param IdType $slideImageId
*
* @return SlideImageInterface
*/
public function getSlideImageById(IdType $slideImageId);
/**
* Returns a SlideCollection with all existing Slide objects by the given slider ID.
*
* @param IdType $sliderId
*
* @return SlideCollection
*/
public function getSlidesBySliderId(IdType $sliderId);
/**
* Returns a SlideImageCollection with all existing SlideImage objects by the given slide ID.
*
* @param IdType $slideId
*
* @return SlideImageCollection
*/
public function getSlideImagesBySlideId(IdType $slideId);
/**
* Returns a SlideCollection with all existing Slide objects by the given slider ID and language ID.
*
* @param IdType $sliderId
* @param IdType $languageId
*
* @return SlideCollection
*/
public function getSlidesBySliderIdAndLanguageId(IdType $sliderId, IdType $languageId);
/**
* Returns a SlideImageCollection with all existing SlideImage objects by the given slide ID and language ID.
*
* @param IdType $slideId
* @param IdType $languageId
*
* @return SlideImageCollection
*/
public function getSlideImagesBySlideIdAndLanguageId(IdType $slideId, IdType $languageId);
/**
* Returns a SlideImageArea instance by the given slide image area ID.
*
* @param IdType $slideImageAreaId
*
* @return SlideImageAreaInterface
*/
public function getSlideImageAreaById(IdType $slideImageAreaId);
/**
* Returns a SlideImageAreaCollection with all existing SlideImageArea objects by the given slide image ID.
*
* @param IdType $slideImageId
*
* @return SlideImageAreaCollection
*/
public function getSlideImageAreasBySlideImageId(IdType $slideImageId);
/**
* Check if an image file is used by another slide image entry.
*
* @param FilenameStringType $filename Slide image filename.
* @param IdType $slideImageId
*
* @return bool
*/
public function isSlideImageFileUsed(FilenameStringType $filename, IdType $slideImageId);
/**
* Check if an image file is used by another slide entry.
*
* @param FilenameStringType $filename Slide thumbnail image filename.
* @param IdType $slideId
*
* @return bool
*/
public function isSlideThumbnailImageFileUsed(FilenameStringType $filename, IdType $slideId);
/**
* Get the Slider for the start page.
*
* @return SliderInterface|null Returns the start page slider instance or null if no record was found.
*/
public function getStartPageSlider();
/**
* Get the Slider ID for the provided category ID.
*
* @param IdType $categoryId
*
* @return int|null Returns the ID of the slider which is assigned for the given category id or null if no record
* was found.
*/
public function findAssignedSliderIdForCategoryId(IdType $categoryId);
/**
* Get the Slider ID for the provided content ID.
*
* @param IdType $contentId
*
* @return int|null Returns the ID of the slider which is assigned for the given content id or null if no record
* was found.
*/
public function findAssignedSliderIdForContentId(IdType $contentId);
/**
* Get the Slider ID for the provided product ID.
*
* @param IdType $productId
*
* @return int|null Returns the ID of the slider which is assigned for the given product id or null if no record
* was found.
*/
public function findAssignedSliderIdForProductId(IdType $productId);
}