101 lines
2.4 KiB
PHP
101 lines
2.4 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\AppFramework\Attribute\Consumable;
|
|
use OCP\Files\GenericFileException;
|
|
|
|
/**
|
|
* @since 21.0.0
|
|
* @psalm-type FilesTemplateFile = array{
|
|
* basename: string,
|
|
* etag: string,
|
|
* fileid: int,
|
|
* filename: ?string,
|
|
* lastmod: int,
|
|
* mime: string,
|
|
* size: int|float,
|
|
* type: string,
|
|
* hasPreview: bool,
|
|
* permissions: int,
|
|
* }
|
|
*/
|
|
#[Consumable(since: '21.0.0')]
|
|
interface ITemplateManager {
|
|
/**
|
|
* Register a template type support
|
|
*
|
|
* @param callable(): TemplateFileCreator $callback A callback which returns the TemplateFileCreator instance to register
|
|
* @since 21.0.0
|
|
*/
|
|
public function registerTemplateFileCreator(callable $callback): void;
|
|
|
|
/**
|
|
* Get a list of available file creators
|
|
*
|
|
* @return array
|
|
* @since 21.0.0
|
|
*/
|
|
public function listCreators(): array;
|
|
|
|
/**
|
|
* Get a list of available file creators and their offered templates
|
|
*
|
|
* @return list<array{app: string, label: string, extension: string, iconClass: ?string, iconSvgInline: ?string, mimetypes: list<string>, ratio: ?float, actionLabel: string, templates: list<Template>}>
|
|
* @since 21.0.0
|
|
*/
|
|
public function listTemplates(): array;
|
|
|
|
/**
|
|
* Get the fields for a given template
|
|
*
|
|
* @param int $fileId
|
|
* @return array
|
|
* @since 32.0.0
|
|
*/
|
|
public function listTemplateFields(int $fileId): array;
|
|
|
|
/**
|
|
* @return bool
|
|
* @since 21.0.0
|
|
*/
|
|
public function hasTemplateDirectory(): bool;
|
|
|
|
/**
|
|
* @param string $path
|
|
* @return void
|
|
* @since 21.0.0
|
|
*/
|
|
public function setTemplatePath(string $path): void;
|
|
|
|
/**
|
|
* @return string
|
|
* @since 21.0.0
|
|
*/
|
|
public function getTemplatePath(): string;
|
|
|
|
/**
|
|
* @param string|null $path
|
|
* @param string|null $userId
|
|
* @since 21.0.0
|
|
*/
|
|
public function initializeTemplateDirectory(?string $path = null, ?string $userId = null, $copyTemplates = true): string;
|
|
|
|
/**
|
|
* @param string $filePath
|
|
* @param string $templateId
|
|
* @param string $templateType
|
|
* @param array $templateFields Since 30.0.0
|
|
* @return FilesTemplateFile
|
|
* @throws GenericFileException
|
|
* @since 21.0.0
|
|
*/
|
|
public function createFromTemplate(string $filePath, string $templateId = '', string $templateType = 'user', array $templateFields = []): array;
|
|
}
|