<?php
namespace App\CMS\Contracts\Modules;

use App\Http\Requests\Request;
use App\Models\Content\Content;

/**
 * Interface TemplateHandler
 *
 * Inerface used for registering template into CMS core.
 *
 * @package App\CMS\Handlers\Contracts
 */
interface TemplateHandler extends BaseModuleHandler
{
    /**
     * Get list of registered templates and supported modules.
     *
     * Returned array is expected to be array of arrays with following items: module, namespace and templateName.
     * Example:
     * return [
     *    ['module' => 'Article', 'templateName' => 'article::template.name']
     * ];
     *
     * When no "namespace" is specified, value strtolower(module) is used instaed.
     *
     * @return array
     */
    public static function getPublicTemplatePaths();

    /**
     * Modify input data into format which can be understood by edit template
     *
     * @param Content $content
     */
    public static function beforePopulatingEditForm(Content & $content);

    /**
     * Slightly modify Content object before saving into database.
     *
     * This way we can do almost whatever we want - even in template
     *
     * @param Content $content
     * @param  $request
     */
    public static function beforeSave(Content & $content, $request);
}