0
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2025-05-06 06:50:39 +00:00
nextcloud_server/lib/public/Preview/BeforePreviewFetchedEvent.php
Daniel Kesselberg 8d3b99349d
docs: update docs for ocp events
Signed-off-by: Daniel Kesselberg <mail@danielkesselberg.de>
2024-07-23 21:42:01 +02:00

74 lines
1.5 KiB
PHP

<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Preview;
use OCP\Files\Node;
use OCP\IPreview;
/**
* Emitted before a file preview is being fetched.
*
* It can be used to block preview rendering by throwing a ``OCP\Files\NotFoundException``
*
* @since 25.0.1
* @since 28.0.0 the constructor arguments ``$width``, ``$height``, ``$crop`` and ``$mode`` are no longer nullable.
*/
class BeforePreviewFetchedEvent extends \OCP\EventDispatcher\Event {
/**
* @since 25.0.1
*/
public function __construct(
private Node $node,
/** @deprecated 28.0.0 null deprecated **/
private ?int $width = null,
/** @deprecated 28.0.0 null deprecated **/
private ?int $height = null,
/** @deprecated 28.0.0 null deprecated **/
private ?bool $crop = null,
/** @deprecated 28.0.0 null deprecated **/
private ?string $mode = null,
) {
parent::__construct();
}
/**
* @since 25.0.1
*/
public function getNode(): Node {
return $this->node;
}
/**
* @since 28.0.0
*/
public function getWidth(): ?int {
return $this->width;
}
/**
* @since 28.0.0
*/
public function getHeight(): ?int {
return $this->height;
}
/**
* @since 28.0.0
*/
public function isCrop(): ?bool {
return $this->crop;
}
/**
* @since 28.0.0
* @return null|IPreview::MODE_FILL|IPreview::MODE_COVER
*/
public function getMode(): ?string {
return $this->mode;
}
}