fwolf / fwlib

class/mvc-controler.php

<?php
/**
* @package      fwolflib
* @subpackage	mvc
* @copyright    Copyright 2008-2010,, 2018 Fwolf
* @author       Fwolf <fwolf.aide+fwolflib.mvc@gmail.com>
*/


require_once(dirname(__FILE__) . '/fwolflib.php');
require_once(FWOLFLIB . 'func/request.php');
require_once(FWOLFLIB . 'func/string.php');
require_once(FWOLFLIB . 'func/url.php');


/*
// In subclass or subclass for an app,
// the bottom layer class should define P2R first at here, and in this way:
if (!defined('P2R')) define('P2R', './');
// Then you can use P2R to require some app libs.
*/

/**
 * Controler class in MVC
 *
 * 控制系统的哪些功能被调用，主要是对应主系统和子系统根下的index.php文件，这些文件始终是用户调用的文件，对于每个子系统也是这样。同理，全局常量P2R在Contoler中定义。
 *
 * 主系统根下的index.php通过`\$_GET['m']`(module)来确定应该引用哪个子系统的index.php，相当于“进入某个子系统”。
 *
 * 子系统根下的index.php通过`\$_GET['a']`(action)来调用哪个功能相应的Page，类似的功能可以是几个action都在一个页面中处理。
 *
 * 主系统和子系统下的index.php要做到都可以被单独调用。
 *
 * 如果子系统的功能比较多，还可以再设计一层Controler，用于实现功能的选择；也可以采用统一放入子系统的Controler中集中控制的方式。特殊情况下，也可以从主系统根直接调用功能Page。
 *
 * 一般项目中，Controler只起到了用户命令的分流作用，处理较少，大量的页面生成、参数转换和传递都放到了View中。也正因为如此，如果启用了缓存机制，打算将缓存放在Controler中实现。
 *
 * 这里所说的module和action主要是针对系统逻辑的，不要和MVC中的概念混淆。
 *
 * @deprecated  Use Fwlib\Mvc\AbstractControler
 * @package		fwolflib
 * @subpackage	mvc
 * @copyright	Copyright 2008-2010, Fwolf
 * @author		Fwolf <fwolf.aide+fwolflib.mvc@gmail.com>
 * @since		2008-04-06
 * @see			Module
 * @see			View
 */
abstract class Controler extends Fwolflib {

The class Fwolflib has been deprecated with message: Use classes in Fwlib namespace, see PSR-0/1/2

	/**
	 * Run end time, used to caculate run time length
	 * @var	float
	 * @see $fTimeStart
	 */
	protected $fTimeEnd = 0;

	/**
	 * Run start time, used to caculate run time length
	 *
	 * Can only count to time when echo output.
	 * @var	float
	 * @see $fTimeEnd
	 */
	protected $fTimeStart = 0;

	/**
	 * View object
	 * @var	object
	 * @see ViewDisp()
	 */
	protected $oView = null;

	/**
	 * Action parameter, the view command to determin what to display
	 * @var string	// $_GET['a'], means which action user prefered of the module
	 */
	protected $sAction = '';

	/**
	 * Current module param
	 * @var	string	// $_GET['m'], means which module user prefered
	 */
	protected $sModule = '';


	abstract public function ViewErrorDisp($msg);	// Display view show error msg
	abstract public function Go();	// User call starter function


	/**
	 * contruct
	 */
	public function __construct() {
		parent::__construct();

		// Record run start time first
		$this->fTimeStart = microtime(true);

		// Get major parameters
		$this->sModule = GetGet('m');

The function GetGet() has been deprecated with message: Use Fwlib\Util\HttpUtil::getGet()

		$this->sAction = GetGet('a');

The function GetGet() has been deprecated with message: Use Fwlib\Util\HttpUtil::getGet()

	} // end of func __construct


	/**
	 * Get run time length and db query times etc.
	 *
	 * Need fwolflib::View,
	 * and use global var $i_db_query_times set in fwolflib::Adodb::CountDbQueryTimes
	 *
	 * Assign action is done in View::GenFooter.
	 *
	 * Cost about 0.05 more second when have db query.
	 *
	 * Eg: Processed in 0.054994 seconds, 6 db queries.
	 *
	 * @param	object	&$view	View object
	 * @global	int		$i_db_query_times
	 * @return	string
	 * @see	View::GenFooter
	 */
	public function GetDebugInfo(&$view) {
		global $i_db_query_times;

		// Record run end time
		$this->fTimeEnd = microtime(true);
		// Generate info str, time used
		$s = '';
		$time_used = $this->fTimeEnd - $this->fTimeStart;
		$time_used = round($time_used, 4);
		$s .= "<p>Processed in $time_used seconds";
		// Db query times
		if (isset($i_db_query_times))
			$s .= ", $i_db_query_times db queries";

		// Cache, Notice: this msg is delayed if cache on.
		if (true == $view->bCacheOn) {
			$key = $view->CacheKey();
			$s .= ', cache lifetime: ' . $view->CacheLifetime($key);

			// Refresh link, avoid robot claw
			$s .= ' <a href="javascript:';
			$s_t = SetUrlParam(GetSelfUrl(true), 'cache', 0);

The function GetSelfUrl() has been deprecated with message: Use Fwlib\Util\HttpUtil::getSelfUrl()

			// Avoid robot claw, break it to several part
			$ar = preg_split('/(\:|\/|\.|\?|\&)/', $s_t, 0, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE);
			$i = count($ar);	// Impossible =0
			for ($j = 0; $j < $i; $j++)
				// fcr = footer cache refresh
				$s .= "fcr$j='{$ar[$i - $j - 1]}';";
			$s .= 'fcr=';
			for ($j = 0; $j < $i; $j++)
				$s .= 'fcr' . ($i - $j - 1) . '+';
			$s .= '\'\';location.href=fcr;';
			$s .= '">R</a>';
		}

		$s .= ".</p>\n";

		// Add Cache log of get operate
		if (!empty(Cache::$aLogGet)) {
			$s = substr($s, 0, strlen($s) - 6);
			$s .= ', cache <span style="cursor: pointer;"
				onclick="javascript:
				var obj=getElementById(\'fwlib_debuginfo_cache_logget\');
				if (\'none\'==obj.style.display || \'\'==obj.style.display)
					{obj.style.display=\'block\';}
				else
					{obj.style.display=\'none\';};">
				logget</span>.</p>' . "\n";
			$s .= '<ul id="fwlib_debuginfo_cache_logget"
				style="display: none;">' . "\n";
			foreach (Cache::$aLogGet as $v) {
                $v['key'] = filter_var($v['key'], FILTER_SANITIZE_STRING );
                $v['success'] = filter_var($v['success'], FILTER_SANITIZE_STRING );
				$s .= '	<li style="text-align: left">'
					. (($v['success']) ? '√' : '×') . ': '
					. $v['key'] . '</li>' . "\n";
			}
			$s .= '</ul>' . "\n";
		}

		return $s;
	} // end of func GetDebugInfo


	/**
	 * Call a view class, display it's output
	 *
	 * Result echo out directly
	 * @param	string	$view	View define class file
	 * @param	string	$class	View class name, if obmit, will remove '_'&'-'
	 * 								in filename and use ucfirst($view) as class
	 * 								name.
	 * 							Auto remove beginning `v-` from $view is
	 * 							optional, if you use 'v-view.php' naming style,
	 * 							it will auto happen.
	 * @see	$oView
	 */
	protected function ViewDisp($view, $class = '')
	{
		// Check file existence
		if (file_exists($view))
			require_once($view);
		else
			$this->ViewErrorDisp("View define file $view not found!");

		// From ..../page_a.php, get 'page_a'.
		$s_view = substr($view, strrpos($view, '/') + 1);
		$s_view = substr($s_view, 0, strrpos($s_view, '.'));

		// Remove 'v-' from 'v-view.php', optional
		if ('v-' == substr($s_view, 0, 2))
			$s_view = substr($s_view, 2);

		// Then, 'page_a' to 'PageA'
		// Replace '-' in view name to '_'
		if (empty($class))
			$class = 'View' . StrUnderline2Ucfirst($s_view, true);

The function StrUnderline2Ucfirst() has been deprecated with message: Use Fwlib\Util\StringUtil::toStudlyCaps()

		if (class_exists($class))
		{
			$this->oView = new $class($this);
			//$p->oCtl = $this;	// Set caller object	// Moved to __contruct of View class, transfer $this when do new().

			if ($this->oView->bCacheOn)
				echo $this->oView->CacheGetOutput();
			else
				echo $this->oView->GetOutput();
		}
		else
		{
			// Display error
			$this->ViewErrorDisp("View class $class not found!");
		}
	} // end of func ViewDisp


} // end of class Controler

?>

It is not recommended to use PHP's closing tag ?> in files other than templates.