|
|
@@ -144,34 +144,18 @@ public class ImageCache {
|
|
|
// MARK: - Store & Remove
|
|
|
extension ImageCache {
|
|
|
/**
|
|
|
- Store an image to cache. It will be saved to both memory and disk.
|
|
|
- It is an async operation, if you need to do something about the stored image, use `-storeImage:forKey:toDisk:completionHandler:`
|
|
|
- instead.
|
|
|
-
|
|
|
- - parameter image: The image will be stored.
|
|
|
- - parameter originalData: The original data of the image.
|
|
|
- Kingfisher will use it to check the format of the image and optimize cache size on disk.
|
|
|
- If `nil` is supplied, the image data will be saved as a normalized PNG file.
|
|
|
- It is strongly suggested to supply it whenever possible, to get a better performance and disk usage.
|
|
|
- - parameter key: Key for the image.
|
|
|
- */
|
|
|
- public func storeImage(image: Image, originalData: NSData? = nil, forKey key: String) {
|
|
|
- storeImage(image, originalData: originalData, forKey: key, toDisk: true, completionHandler: nil)
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- Store an image to cache. It is an async operation.
|
|
|
+ Store an image to cache. It will be saved to both memory and disk. It is an async operation.
|
|
|
|
|
|
- - parameter image: The image will be stored.
|
|
|
+ - parameter image: The image to be stored.
|
|
|
- parameter originalData: The original data of the image.
|
|
|
Kingfisher will use it to check the format of the image and optimize cache size on disk.
|
|
|
If `nil` is supplied, the image data will be saved as a normalized PNG file.
|
|
|
It is strongly suggested to supply it whenever possible, to get a better performance and disk usage.
|
|
|
- parameter key: Key for the image.
|
|
|
- parameter toDisk: Whether this image should be cached to disk or not. If false, the image will be only cached in memory.
|
|
|
- - parameter completionHandler: Called when stroe operation completes.
|
|
|
+ - parameter completionHandler: Called when store operation completes.
|
|
|
*/
|
|
|
- public func storeImage(image: Image, originalData: NSData? = nil, forKey key: String, toDisk: Bool, completionHandler: (() -> ())?) {
|
|
|
+ public func storeImage(image: Image, originalData: NSData? = nil, forKey key: String, toDisk: Bool = true, completionHandler: (() -> Void)? = nil) {
|
|
|
memoryCache.setObject(image, forKey: key, cost: image.kf_imageCost)
|
|
|
|
|
|
func callHandlerInMainQueue() {
|
|
|
@@ -183,7 +167,7 @@ extension ImageCache {
|
|
|
}
|
|
|
|
|
|
if toDisk {
|
|
|
- dispatch_async(ioQueue, { () -> Void in
|
|
|
+ dispatch_async(ioQueue, {
|
|
|
let imageFormat: ImageFormat
|
|
|
if let originalData = originalData {
|
|
|
imageFormat = originalData.kf_imageFormat
|
|
|
@@ -216,24 +200,14 @@ extension ImageCache {
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- Remove the image for key for the cache. It will be opted out from both memory and disk.
|
|
|
- It is an async operation, if you need to do something about the stored image, use `-removeImageForKey:fromDisk:completionHandler:`
|
|
|
- instead.
|
|
|
-
|
|
|
- - parameter key: Key for the image.
|
|
|
- */
|
|
|
- public func removeImageForKey(key: String) {
|
|
|
- removeImageForKey(key, fromDisk: true, completionHandler: nil)
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- Remove the image for key for the cache. It is an async operation.
|
|
|
+ Remove the image for key for the cache. It will be opted out from both memory and disk.
|
|
|
+ It is an async operation.
|
|
|
|
|
|
- parameter key: Key for the image.
|
|
|
- parameter fromDisk: Whether this image should be removed from disk or not. If false, the image will be only removed from memory.
|
|
|
- parameter completionHandler: Called when removal operation completes.
|
|
|
*/
|
|
|
- public func removeImageForKey(key: String, fromDisk: Bool, completionHandler: (() -> ())?) {
|
|
|
+ public func removeImageForKey(key: String, fromDisk: Bool = true, completionHandler: (() -> Void)? = nil) {
|
|
|
memoryCache.removeObjectForKey(key)
|
|
|
|
|
|
func callHandlerInMainQueue() {
|
|
|
@@ -286,7 +260,7 @@ extension ImageCache {
|
|
|
var sSelf: ImageCache! = self
|
|
|
block = dispatch_block_create(DISPATCH_BLOCK_INHERIT_QOS_CLASS) {
|
|
|
// Begin to load image from disk
|
|
|
- if let image = sSelf.retrieveImageInDiskCacheForKey(key, scale: options.scaleFactor) {
|
|
|
+ if let image = sSelf.retrieveImageInDiskCacheForKey(key, scale: options.scaleFactor, preloadAllGIFData: options.preloadAllGIFData) {
|
|
|
if options.backgroundDecode {
|
|
|
dispatch_async(sSelf.processQueue, { () -> Void in
|
|
|
let result = image.kf_decodedImage(scale: options.scaleFactor)
|
|
|
@@ -334,12 +308,14 @@ extension ImageCache {
|
|
|
Get an image for a key from disk.
|
|
|
|
|
|
- parameter key: Key for the image.
|
|
|
- - param scale: The scale factor to assume when interpreting the image data.
|
|
|
+ - parameter scale: The scale factor to assume when interpreting the image data.
|
|
|
+ - parameter preloadAllGIFData: Whether all GIF data should be loaded. If true, you can set the loaded image to a regular UIImageView to play
|
|
|
+ the GIF animation. Otherwise, you should use `AnimatedImageView` to play it. Default is `false`
|
|
|
|
|
|
- returns: The image object if it is cached, or `nil` if there is no such key in the cache.
|
|
|
*/
|
|
|
- public func retrieveImageInDiskCacheForKey(key: String, scale: CGFloat = 1.0) -> Image? {
|
|
|
- return diskImageForKey(key, scale: scale)
|
|
|
+ public func retrieveImageInDiskCacheForKey(key: String, scale: CGFloat = 1.0, preloadAllGIFData: Bool = false) -> Image? {
|
|
|
+ return diskImageForKey(key, scale: scale, preloadAllGIFData: preloadAllGIFData)
|
|
|
}
|
|
|
}
|
|
|
|
|
|
@@ -631,9 +607,9 @@ extension ImageCache {
|
|
|
// MARK: - Internal Helper
|
|
|
extension ImageCache {
|
|
|
|
|
|
- func diskImageForKey(key: String, scale: CGFloat) -> Image? {
|
|
|
+ func diskImageForKey(key: String, scale: CGFloat, preloadAllGIFData: Bool) -> Image? {
|
|
|
if let data = diskImageDataForKey(key) {
|
|
|
- return Image.kf_imageWithData(data, scale: scale)
|
|
|
+ return Image.kf_imageWithData(data, scale: scale, preloadAllGIFData: preloadAllGIFData)
|
|
|
} else {
|
|
|
return nil
|
|
|
}
|
xspyhack