ORIENT/modules/cms/classes/Layout.php

58 lines
1.4 KiB
PHP
Raw Normal View History

2014-05-14 13:24:20 +00:00
<?php namespace Cms\Classes;
/**
* The CMS layout class.
*
* @package october\cms
* @author Alexey Bobkov, Samuel Georges
*/
class Layout extends CmsCompoundObject
{
const FALLBACK_FILE_NAME = 'fallback';
2014-10-10 23:22:03 +00:00
protected function parseSettings()
{
}
2014-05-14 13:24:20 +00:00
/**
* Returns the directory name corresponding to the object type.
* For pages the directory name is "pages", for layouts - "layouts", etc.
* @return string
*/
public static function getObjectTypeDirName()
{
return 'layouts';
}
/**
* Initializes the fallback layout.
2016-03-04 15:50:58 +00:00
* @param \Cms\Classes\Theme $theme Specifies a theme the file belongs to.
2015-10-05 22:26:29 +00:00
* @return \Cms\Classes\Layout
2014-05-14 13:24:20 +00:00
*/
public static function initFallback($theme)
{
$obj = new self($theme);
$obj->markup = '{% page %}';
$obj->fileName = self::FALLBACK_FILE_NAME;
return $obj;
}
/**
* Returns true if the layout is a fallback layout
* @return boolean
*/
public function isFallBack()
{
return $this->fileName == self::FALLBACK_FILE_NAME;
}
/**
* Returns name of a PHP class to us a parent for the PHP class created for the object's PHP section.
* @return mixed Returns the class name or null.
*/
public function getCodeClassParent()
{
return '\Cms\Classes\LayoutCode';
}
}