ViewContextInterface.php 785 Bytes
Newer Older
1 2 3 4 5 6 7 8 9 10
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\base;

/**
11
 * ViewContextInterface is the interface that should implemented by classes who want to support relative view names.
12
 *
13
 * The method [[findViewFile()]] should be implemented to convert a relative view name into a file path.
14 15 16 17
 *
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.0
 */
18
interface ViewContextInterface
19 20
{
	/**
21 22
	 * Finds the view file corresponding to the specified relative view name.
	 * @param string $view a relative view name. The name does NOT start with a slash.
23 24 25
	 * @return string the view file path. Note that the file may not exist.
	 */
	public function findViewFile($view);
26
}