brightnucleus/view

View on GitHub
src/View/Engine/EngineFinder.php

Summary

Maintainability
A
0 mins
Test Coverage
<?php declare(strict_types=1);
/**
 * Bright Nucleus View Component.
 *
 * @package   BrightNucleus\View
 * @author    Alain Schlesser <alain.schlesser@gmail.com>
 * @license   MIT
 * @link      http://www.brightnucleus.com/
 * @copyright 2016-2017 Alain Schlesser, Bright Nucleus
 */

namespace BrightNucleus\View\Engine;

use BrightNucleus\View\Support\Finder;

/**
 * Interface EngineFinder.
 *
 * @since   0.1.0
 *
 * @package BrightNucleus\View\Engine
 * @author  Alain Schlesser <alain.schlesser@gmail.com>
 */
interface EngineFinder extends Finder
{
    // Constants to be used for the Config file sections.
    const CLASS_NAME_KEY = 'ClassName';
    const ENGINES_KEY = 'Engines';
    const NULL_OBJECT = 'NullObject';

    /**
     * Get the NullObject.
     *
     * @since 0.1.1
     *
     * @return NullEngine NullObject for the current Finder.
     */
    public function getNullObject(): NullEngine;
}