mirrors
/
SDWebImage
mirror of https://github.com/SDWebImage/SDWebImage.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Formally deprecate `sd_cancelCurrentImageLoad`, which cause misunderstanding on UIImageView category 

Use `sd_cancelLatestImageLoad` instead
This commit is contained in:
DreamPiggy 2023-12-27 19:21:06 +08:00
parent 9953745d94
commit 2424848c92
3 changed files with 19 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
SDWebImage/Core/UIView+WebCache.h
View File

@ -91,12 +91,19 @@ typedef void(^SDSetImageBlock)(UIImage * _Nullable image, NSData * _Nullable ima
completed:(nullable SDInternalCompletionBlock)completedBlock; completed:(nullable SDInternalCompletionBlock)completedBlock;
/** /**
* Cancel the current image load * Cancel the latest image load, using the `sd_latestOperationKey` as operation key
* This simply translate to `[self sd_cancelImageLoadOperationWithKey:self.sd_latestOperationKey]` from v5.18.0 * This simply translate to `[self sd_cancelImageLoadOperationWithKey:self.sd_latestOperationKey]`
*
* @warning This method should be only used for single state view, like `UIImageView` without highlighted state. For stateful view like `UIBUtton` (one view can have multiple images loading), use `sd_cancelImageLoadOperationWithKey:` instead. See `UIView+WebCacheOperation.h` for more information.
*/ */
- (void)sd_cancelCurrentImageLoad; - (void)sd_cancelLatestImageLoad;
/**
* Cancel the current image load, for single state view.
* This actually does not cancel current loading, because stateful view can load multiple images at the same time (like UIButton, each state can load different images). Just behave the same as `sd_cancelLatestImageLoad`
*
* @warning This method should be only used for single state view, like `UIImageView` without highlighted state. For stateful view like `UIBUtton` (one view can have multiple images loading), use `sd_cancelImageLoadOperationWithKey:` instead. See `UIView+WebCacheOperation.h` for more information.
* @deprecated Use `sd_cancelLatestImageLoad` instead. Which don't cause overload method misunderstanding (`UIImageView+WebCache` provide the same API as this one, but does not do the same thing). This API will be totally removed in v6.0 due to this.
*/
- (void)sd_cancelCurrentImageLoad API_DEPRECATED_WITH_REPLACEMENT("sd_cancelLatestImageLoad", macos(10.10, 10.10), ios(8.0, 8.0), tvos(9.0, 9.0), watchos(2.0, 2.0));
#if SD_UIKIT || SD_MAC #if SD_UIKIT || SD_MAC

4
SDWebImage/Core/UIView+WebCache.m
View File

@ -255,6 +255,10 @@ const int64_t SDWebImageProgressUnitCountUnknown = 1LL;
return operation; return operation;
} }
- (void)sd_cancelLatestImageLoad {
[self sd_cancelImageLoadOperationWithKey:self.sd_latestOperationKey];
}
- (void)sd_cancelCurrentImageLoad { - (void)sd_cancelCurrentImageLoad {
[self sd_cancelImageLoadOperationWithKey:self.sd_latestOperationKey]; [self sd_cancelImageLoadOperationWithKey:self.sd_latestOperationKey];
} }

6
Tests/Tests/SDWebCacheCategoriesTests.m
View File

@ -334,7 +334,7 @@
[SDImageCache.sharedImageCache removeImageFromDiskForKey:kTestJPEGURL]; [SDImageCache.sharedImageCache removeImageFromDiskForKey:kTestJPEGURL];
[SDImageCache.sharedImageCache removeImageFromMemoryForKey:kTestJPEGURL]; [SDImageCache.sharedImageCache removeImageFromMemoryForKey:kTestJPEGURL];
SDWebImageCombinedOperation *op1 = [imageView sd_internalSetImageWithURL:originalImageURL placeholderImage:nil options:0 context:nil setImageBlock:nil progress:nil completed:nil]; SDWebImageCombinedOperation *op1 = [imageView sd_internalSetImageWithURL:originalImageURL placeholderImage:nil options:0 context:nil setImageBlock:nil progress:nil completed:nil];
[imageView sd_cancelCurrentImageLoad]; [imageView sd_cancelLatestImageLoad];
expect(op1.isCancelled).beTruthy(); expect(op1.isCancelled).beTruthy();
NSString *operationKey = NSStringFromClass(UIView.class); NSString *operationKey = NSStringFromClass(UIView.class);
expect([imageView sd_imageLoadOperationForKey:operationKey]).beNil(); expect([imageView sd_imageLoadOperationForKey:operationKey]).beNil();
@ -393,7 +393,7 @@
// At this point, our transition has started, and so we cancel the load operation, // At this point, our transition has started, and so we cancel the load operation,
// perhaps as a result of a call to `prepareForReuse` in a UICollectionViewCell // perhaps as a result of a call to `prepareForReuse` in a UICollectionViewCell
[imageView sd_cancelCurrentImageLoad]; [imageView sd_cancelLatestImageLoad];
// Now, we update our context's imageOperationKey and URL, perhaps // Now, we update our context's imageOperationKey and URL, perhaps
// because of a re-use of a UICollectionViewCell. In this case, // because of a re-use of a UICollectionViewCell. In this case,
@ -423,7 +423,7 @@
expect(error.code).equal(SDWebImageErrorCancelled); expect(error.code).equal(SDWebImageErrorCancelled);
[expectation fulfill]; [expectation fulfill];
}]; }];
[imageView sd_cancelCurrentImageLoad]; [imageView sd_cancelLatestImageLoad];
[self waitForExpectationsWithCommonTimeout]; [self waitForExpectationsWithCommonTimeout];
} }