0
0
mirror of https://github.com/nextcloud/server.git synced 2024-11-14 20:36:50 +00:00
nextcloud_server/lib/public/Files/Template/Template.php
provokateurin 77114fb327
fix(OpenAPI): Adjust array syntax to avoid ambiguities
Signed-off-by: provokateurin <kate@provokateurin.de>
2024-11-05 09:58:11 +01:00

105 lines
2.3 KiB
PHP

<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Files\Template;
use OCP\Files\File;
/**
* @since 21.0.0
*/
final class Template implements \JsonSerializable {
/** @var string */
private $templateType;
/** @var string */
private $templateId;
/** @var File */
private $file;
/** @var bool */
private $hasPreview = false;
/** @var string|null */
private $previewUrl = null;
/** @var list<Field> */
private $fields = [];
/**
* @since 21.0.0
*/
public function __construct(string $templateType, string $templateId, File $file) {
$this->templateType = $templateType;
$this->templateId = $templateId;
$this->file = $file;
}
/**
* @since 21.0.0
*/
public function setCustomPreviewUrl(string $previewUrl): void {
$this->previewUrl = $previewUrl;
}
/**
* @since 21.0.0
*/
public function setHasPreview(bool $hasPreview): void {
$this->hasPreview = $hasPreview;
}
/**
* @param list<Field> $fields
* @since 30.0.0
*/
public function setFields(array $fields): void {
$this->fields = $fields;
}
/**
* @return array{
* templateType: string,
* templateId: string,
* basename: string,
* etag: string,
* fileid: int,
* filename: string,
* lastmod: int,
* mime: string,
* size: int|float,
* type: string,
* hasPreview: bool,
* previewUrl: ?string,
* fields: list<array{
* index: string,
* type: string,
* alias: ?string,
* tag: ?string,
* id: ?int,
* content?: string,
* checked?: bool,
* }>,
* }
* @since 21.0.0
*/
public function jsonSerialize(): array {
return [
'templateType' => $this->templateType,
'templateId' => $this->templateId,
'basename' => $this->file->getName(),
'etag' => $this->file->getEtag(),
'fileid' => $this->file->getId(),
'filename' => $this->templateId,
'lastmod' => $this->file->getMTime(),
'mime' => $this->file->getMimetype(),
'size' => $this->file->getSize(),
'type' => $this->file->getType(),
'hasPreview' => $this->hasPreview,
'previewUrl' => $this->previewUrl,
'fields' => array_map(static fn (Field $field) => $field->jsonSerialize(), $this->fields),
];
}
}