perdedora/leftypol
1
0
Fork 0
forked from leftypol/leftypol
Code Pull requests Activity

MediaHandler.php: update doc

Browse source
This commit is contained in:
Zankaria 2025-03-28 15:53:27 +01:00
parent b28c2b13dd
commit 9d92517980
1 changed files with 13 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

15
inc/Service/Media/MediaHandler.php
View file

@ -40,7 +40,7 @@ interface MediaHandler {
* @param string $file_mime The mime type of the file. MUST be of a value for which {@link supportsMime} returns true. * @param string $file_mime The mime type of the file. MUST be of a value for which {@link supportsMime} returns true.
* @param int $file_kind One of the FILE_KIND_* constants. * @param int $file_kind One of the FILE_KIND_* constants.
* @return mixed An opaque handle. * @return mixed An opaque handle.
* @throws \RuntimeException On error. * @throws MediaException On error.
*/ */
public function openHandle(string $file_path, string $file_mime, int $file_kind): mixed; public function openHandle(string $file_path, string $file_mime, int $file_kind): mixed;
@ -51,6 +51,17 @@ interface MediaHandler {
*/ */
public function closeHandle(mixed $handle); public function closeHandle(mixed $handle);
/**
* Installs the given file and generates a thumbnail for it.
*
* @param mixed $handle
* @param string $media_preferred_out_file_basepath
* @param string $preferred_out_file_basepath
* @param int $thumb_max_width
* @param int $thumb_max_height
* @return MediaInstallResult
* @throws MediaException On error.
*/
public function installMediaAndGenerateThumb( public function installMediaAndGenerateThumb(
mixed $handle, mixed $handle,
string $media_preferred_out_file_basepath, string $media_preferred_out_file_basepath,
@ -67,7 +78,7 @@ interface MediaHandler {
* @param int $max_width * @param int $max_width
* @param int $max_height * @param int $max_height
* @return ThumbGenerationResult * @return ThumbGenerationResult
* @throws \RuntimeException On error. * @throws MediaException On error.
*/ */
public function generateThumb( public function generateThumb(
mixed $handle, mixed $handle,