winter/modules/cms/contracts/CmsObject.php

<?php namespace Cms\Contracts;

interface CmsObject
{
    /**
     * Loads the template.
     *
     * @param  string  $hostObj
     * @param  string  $fileName
     * @return mixed
     */
    public static function load($hostObj, $fileName);

    /**
     * Loads and caches the template.
     *
     * @param  string  $hostObj
     * @param  string  $fileName
     * @return mixed
     */
    public static function loadCached($hostObj, $fileName);

    /**
     * Returns the local file path to the template.
     *
     * @param  string  $fileName
     * @return string
     */
    public function getFilePath($fileName = null);

    /**
     * Returns the file name.
     * @return string
     */
    public function getFileName();

    /**
     * Returns the file name without the extension.
     * @return string
     */
    public function getBaseFileName();

    /**
     * Returns the file content.
     * @return string
     */
    public function getContent();

    /**
     * Returns the Twig content string.
     *
     * @return string
     */
    public function getTwigContent();

    /**
     * Returns the key used by the Twig cache.
     * @return string
     */
    public function getTwigCacheKey();
}