<?php
/* $Id$ */
namespace MCMS\Plugin;

(defined('MCMS') && (basename(__FILE__) != basename($_SERVER['PHP_SELF']))) or die('ACCESS DENIED');

/**
 * Layout plugin interface
 *
 * @author Stefan Daurer <s.daurer@q-spot.org>
 * @package MCMS\System\Plugin
 * @since 1.0.0.0
 */
interface iPlugInLayout extends iPlugIn {
	const _VERSION = '1.1.0.0';
	
	const FRAG_HEADCONTENT = 'HEAD';
	const FRAG_MAINCONTENT = 'CONTENT';
	
	/**
	 *
	 * @return array an list of (name, info)-arrays
	 */
	public function getRegions();

	/**
	 * Register a new layout region
	 *
	 * @param string $name
	 *        	the region name
	 * @since 1.0.0.1
	 */
	public function registerRegion($name);

	public function setRegionContent($region, $content);

	public function getRegionContent($region);

	public function load($name);
	
	/**
	 * Build the result document
	 *
	 * @param string $media
	 *        	the output media type
	 * @return string the document data
	 */
	public function getDocument();
// 	public function getDocument($media, \MCMS\Response $response = NULL);

	public function getMetadata();
	public function getMeta($key);
	public function setMeta($key, $value);
}