<?php
/**
 * baserCMS :  Based Website Development Project <https://basercms.net>
 * Copyright (c) NPO baser foundation <https://baserfoundation.org/>
 *
 * @copyright     Copyright (c) NPO baser foundation
 * @link          https://basercms.net baserCMS Project
 * @since         5.0.0
 * @license       https://basercms.net/license/index.html MIT License
 */

namespace BaserCore\Service;

use BaserCore\Annotation\UnitTest;
use BaserCore\Annotation\NoTodo;
use BaserCore\Annotation\Checked;
use BaserCore\Model\Entity\Site;
use Cake\Datasource\EntityInterface;

/**
 * ThemesServiceInterface
 */
interface ThemesServiceInterface
{

    /**
     * 単一データ取得
     *
     * @param string $theme
     * @return EntityInterface
     * @checked
     * @noTodo
     * @unitTest
     */
    public function get(string $theme);

    /**
     * 一覧データ取得
     *
     * @checked
     * @noTodo
     * @unitTest
     */
    public function getIndex(): array;

    /**
     * 新しいテーマをアップロードする
     *
     * @param array $postData
     * @return string
     * @checked
     * @noTodo
     * @unitTest
     */
    public function add(array $postData): string;

    /**
     * テーマを適用する
     *
     * @param string $theme
     * @checked
     * @noTodo
     * @unitTest
     */
    public function apply(Site $site, string $theme): array;

    /**
     * 初期データを読み込む
     *
     * @param string $theme
     * @param string $pattern
     * @checked
     * @noTodo
     * @unitTest
     */
    public function loadDefaultDataPattern(string $currentTheme, string $dbDataPattern): bool;

    /**
     * コピーする
     *
     * @param string $theme
     * @checked
     * @noTodo
     * @unitTest
     */
    public function copy(string $theme): bool;

    /**
     * 削除する
     *
     * @checked
     * @noTodo
     * @unitTest
     */
    public function delete(string $theme): bool;

    /**
     * baserマーケットのテーマ一覧を取得する
     *
     * @checked
     * @noTodo
     * @unitTest
     */
    public function getMarketThemes(): array;

    /**
     * 指定したテーマをダウンロード用のテーマとして一時フォルダに作成する
     *
     * @param string $theme
     * @return string
     * @checked
     * @unitTest
     * @noTodo
     */
    public function createDownloadToTmp(string $theme): string;

}
