aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/preview/provider.php
blob: f544c2c4b133a36c2ab2ebbc4b9edeb52b555e79 (plain)
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
<?php
namespace OC\Preview;

abstract class Provider {
	private $options;

	public function __construct($options) {
		$this->options=$options;
	}

	abstract public function getMimeType();

	/**
	 * Check if a preview can be generated for $path
	 *
	 * @param string $path
	 * @return bool
	 */
	public function isAvailable($path) {
		return true;
	}

	/**
	 * get thumbnail for file at path $path
	 * @param string $path Path of file
	 * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image
	 * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image
	 * @param bool $scalingup Disable/Enable upscaling of previews
	 * @param object $fileview fileview object of user folder
	 * @return mixed
	 * 		false if no preview was generated
	 *		OC_Image object of the preview
	 */
	abstract public function getThumbnail($path, $maxX, $maxY, $scalingup, $fileview);

}