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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
<?php
/* --------------------------------------------------------------
SlideImageFileStorage.inc.php 2016-10-17
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]
--------------------------------------------------------------
*/
/**
* Class SlideImageFileStorage
*
* @category System
* @package Slider
* @subpackage Storages
*/
class SlideImageFileStorage extends ImageFileStorage
{
/**
* Settings
*
* @var EnvSlideImageFileStorageSettings
*/
protected $settings;
/**
* Slide image directory.
*
* @var WritableDirectory
*/
protected $imagesDirectory;
/**
* Slide thumbnail image directory.
*
* @var WritableDirectory
*/
protected $thumbnailImagesDirectory;
/**
* Valid file extensions.
* @var array
*/
protected $validExtensions = [];
/**
* SlideImageFileStorage constructor.
*
* @param SlideImagePathsSettingsInterface $settings Slide image path settings.
*/
public function __construct(SlideImagePathsSettingsInterface $settings)
{
$this->settings = $settings;
$this->imagesDirectory = MainFactory::create('WritableDirectory',
$this->settings->getSlideImagesDirPath());
$this->thumbnailImagesDirectory = MainFactory::create('WritableDirectory',
$this->settings->getSlideThumbnailImagesDirPath());
$this->validExtensions = ['jpg', 'jpeg', 'png', 'gif', 'bmp'];
parent::__construct($this->imagesDirectory);
}
/**
* Saves a slide image file to a writable directory.
*
* @param ExistingFile $sourceFile The source file to import.
* @param FilenameStringType $preferredFilename The preferred name of the file to be saved.
*
* @throws InvalidArgumentException If the provided source file of the preferred filename is not valid.
*
* @return string Preferred filename
*/
public function importImage(ExistingFile $sourceFile, FilenameStringType $preferredFilename)
{
$filename = parent::importFile($sourceFile, $preferredFilename);
$filename = new FilenameStringType($filename);
return $filename->asString();
}
/**
* Saves a slide thumbnail image file to a writable directory.
*
* @param ExistingFile $sourceFile The source file to import.
* @param FilenameStringType $preferredFilename The preferred name of the file to be saved.
*
* @throws InvalidArgumentException If the provided source file of the preferred filename is not valid.
*
* @return string Preferred filename
*/
public function importThumbnailImage(ExistingFile $sourceFile, FilenameStringType $preferredFilename)
{
$this->_validateFile($sourceFile);
$this->_validateFilename($preferredFilename);
$uniqueFilename = $preferredFilename;
if($this->fileExists($preferredFilename))
{
$uniqueFilename = new FilenameStringType($this->_createAndReturnNewFilename($preferredFilename));
}
copy($sourceFile->getFilePath(),
$this->thumbnailImagesDirectory->getDirPath() . DIRECTORY_SEPARATOR . $uniqueFilename->asString());
return $uniqueFilename->asString();
}
/**
* Renames an existing slide image file.
*
* @param FilenameStringType $oldName The old name of the file.
* @param FilenameStringType $newName The new name of the file.
*
* @throws InvalidArgumentException If the file that should be renamed does not exists.
* @throws InvalidArgumentException If a file with the preferred name already exists.
*
* @return AbstractFileStorage Same instance for chained method calls.
*/
public function renameImage(FilenameStringType $oldName, FilenameStringType $newName)
{
if(!$this->fileExists($oldName))
{
throw new InvalidArgumentException($oldName->asString() . ' does not exist in ' . $this->imagesDirectory->getDirPath());
}
if($this->fileExists($newName))
{
throw new InvalidArgumentException($newName->asString() . ' already exists in ' . $this->imagesDirectory->getDirPath());
}
$this->_validateFilename($newName);
rename($this->imagesDirectory->getDirPath() . DIRECTORY_SEPARATOR . $oldName->asString(),
$this->imagesDirectory->getDirPath() . DIRECTORY_SEPARATOR . $newName->asString());
return $this;
}
/**
* Renames an existing slide thumbnail image file.
*
* @param FilenameStringType $oldName The old name of the file.
* @param FilenameStringType $newName The new name of the file.
*
* @throws InvalidArgumentException If the file that should be renamed does not exists.
* @throws InvalidArgumentException If a file with the preferred name already exists.
*
* @return AbstractFileStorage Same instance for chained method calls.
*/
public function renameThumbnailImage(FilenameStringType $oldName, FilenameStringType $newName)
{
if(!$this->fileExists($oldName))
{
throw new InvalidArgumentException($oldName->asString() . ' does not exist in ' . $this->thumbnailImagesDirectory->getDirPath());
}
if($this->fileExists($newName))
{
throw new InvalidArgumentException($newName->asString() . ' already exists in ' . $this->thumbnailImagesDirectory->getDirPath());
}
$this->_validateFilename($newName);
rename($this->thumbnailImagesDirectory->getDirPath() . DIRECTORY_SEPARATOR . $oldName->asString(),
$this->thumbnailImagesDirectory->getDirPath() . DIRECTORY_SEPARATOR . $newName->asString());
return $this;
}
/**
* Checks if the provided slider image exists.
*
* @param FilenameStringType $filename The filename of the slider image file to be checked.
*
* @return bool Does it exist?
*/
public function imageExists(FilenameStringType $filename)
{
$filePath = $this->imagesDirectory->getDirPath() . DIRECTORY_SEPARATOR . $filename->asString();
return file_exists($filePath) && !is_dir($filePath);
}
/**
* Checks if the provided slider thumbnail image exists.
*
* @param FilenameStringType $filename The filename of the slider thumbnail image file to be checked.
*
* @return bool Does it exist?
*/
public function thumbnailImageExists(FilenameStringType $filename)
{
$filePath = $this->thumbnailImagesDirectory->getDirPath() . DIRECTORY_SEPARATOR . $filename->asString();
return file_exists($filePath) && !is_dir($filePath);
}
/**
* Deletes an existing slider image.
*
* @param FilenameStringType $filename The file to delete.
*
* @return AbstractFileStorage Same instance for chained method calls.
*/
public function deleteImage(FilenameStringType $filename)
{
if($this->imageExists($filename))
{
unlink($this->imagesDirectory->getDirPath() . DIRECTORY_SEPARATOR . $filename->asString());
}
return $this;
}
/**
* Deletes an existing slider thumbnail image.
*
* @param FilenameStringType $filename The file to delete.
*
* @return AbstractFileStorage Same instance for chained method calls.
*/
public function deleteThumbnailImage(FilenameStringType $filename)
{
if($this->thumbnailImageExists($filename))
{
unlink($this->thumbnailImagesDirectory->getDirPath() . DIRECTORY_SEPARATOR . $filename->asString());
}
return $this;
}
/**
* Returns an array of slide images.
*
* @return array Found files.
*/
public function getImages()
{
return $this->getFileList($this->imagesDirectory, $this->validExtensions);
}
/**
* Returns an array of slide thumbnail images.
*
* @return array Found files.
*/
public function getThumbnailImages()
{
return $this->getFileList($this->thumbnailImagesDirectory, $this->validExtensions);
}
}