*
* @license http://nucleuscms.org/license.txt GNU General Public License
* @copyright Copyright (C) 2002-2009 The Nucleus Group
- * @version $Id: BaseActions.php 1527 2011-06-21 10:43:44Z sakamocchi $
+ * @version $Id: BaseActions.php 1882 2012-06-17 07:52:43Z sakamocchi $
*/
-class BaseActions {
-
+class BaseActions
+{
+ /**
+ * BaseActions::$parser
+ * Skin class calls parser with action classes succeeded to this class
+ */
+ protected $parser;
+
+
// depth level for includes (max. level is 3)
- var $level;
-
+ private $level;
+
// array of evaluated conditions (true/false). The element at the end is the one for the most nested
// if block.
- var $if_conditions;
-
+ private $if_conditions;
+
// in the "elseif" / "elseifnot" sequences, if one of the conditions become "true" remained conditions should not
// be tested. this variable (actually a stack) holds this information.
- var $if_execute;
-
+ private $if_execute;
+
// at all times, can be evaluated to either true if the current block needs to be displayed. This
// variable is used to decide to skip skinvars in parts that will never be outputted.
- var $if_currentlevel;
-
+ private $if_currentlevel;
+
+
// contains a search string with keywords that need to be highlighted. These get parsed into $aHighlight
- var $strHighlight;
-
+ protected $strHighlight;
+
// array of keywords that need to be highlighted in search results (see the highlight()
// and parseHighlight() methods)
- var $aHighlight;
-
- // reference to the parser object that is using this object as actions-handler
- var $parser;
-
+ private $aHighlight;
+
+ /* NOTE: defined actions for this base class */
+ static private $defined_actions = array(
+ 'benchmark',
+ 'charset',
+ 'else',
+ 'elseif',
+ 'elseifnot',
+ 'endif',
+ 'if',
+ 'ifnot',
+ 'include',
+ 'locale',
+ 'parsedinclude',
+ 'phpinclude',
+ 'set',
+ 'skinfile',
+ 'text'
+ );
+
/**
+ * BaseActions::__construct()
* Constructor for a new BaseAction object
*/
- function BaseActions() {
+ protected function __construct()
+ {
$this->level = 0;
-
+
// if nesting level
- $this->if_conditions = array(); // array on which condition values are pushed/popped
+ $this->if_conditions = array(); // array on which condition values are pushed/popped
$this->if_execute = array(); // array on which condition values are pushed/popped
$this->if_currentlevel = 1; // 1 = current level is displayed; 0 = current level not displayed
-
+
// highlights
- $this->strHighlight = ''; // full highlight
- $this->aHighlight = array(); // parsed highlight
-
+ $this->strHighlight = ''; // full highlight
+ $this->aHighlight = array(); // parsed highlight
+ return;
}
-
+
+ /**
+ * BaseActions::getAvailableActions()
+ *
+ * @param void
+ * @return void
+ */
+ public function getAvailableActions()
+ {
+ return self::$defined_actions;
+ }
+
+ /**
+ * BaseActions::setParser()
+ * Set the parser
+ *
+ * @param object $parser an instance of Parser class
+ * @return void
+ */
+ public function setParser(&$parser)
+ {
+ $this->parser =& $parser;
+ return;
+ }
+
+ /**
+ * BaseActions::parse_charset()
+ * Parse charset to appropriate character set name registered to IANA
+ *
+ * @param void
+ * @return void
+ */
+ public function parse_charset()
+ {
+ global $member;
+
+ if ( i18n::get_forced_charset() !== '' )
+ {
+ echo i18n::get_forced_charset();
+ }
+ else
+ {
+ echo i18n::get_current_charset();
+ }
+
+ return;
+ }
+
+ /**
+ * BaseActions::parse_locale()
+ * Parse locale to language-region according to RFC 4646
+ *
+ * @param void
+ * @return void
+ */
+ public function parse_locale()
+ {
+ echo preg_replace('#(.+)_(.+)_(.+)#', '$1-$3', i18n::get_current_locale());
+ return;
+ }
+
/**
+ * BaseActions::parse_include()
* include file (no parsing of php)
*
* ToDo: function returns nothing and refering to the cross reference it
* isn't called from anywhere
*
- * @param $filename
+ * @param string $filename filename to be included
+ * @return void
*/
- function parse_include($filename) {
+ public function parse_include($filename)
+ {
@readfile($this->getIncludeFileName($filename));
+ return;
}
-
+
/**
+ * BaseActions::parse_phpinclude()
* php-include file
*
- * @param $filename
+ * @param string $filename filename to be included
+ * @return void
*/
- function parse_phpinclude($filename) {
+ public function parse_phpinclude($filename)
+ {
includephp($this->getIncludeFileName($filename));
+ return;
}
-
+
/**
+ * BaseActions::parse_parsedinclude()
* parsed include
*
- * @param $filename
+ * @param string $name filename to be included
+ * @return void
*/
- function parse_parsedinclude($filename) {
+ public function parse_parsedinclude($name)
+ {
// check current level
- if ($this->level > 3) return; // max. depth reached (avoid endless loop)
- $file = $this->getIncludeFileName($filename);
- if (!file_exists($file)) return;
- $contents = file_get_contents($file);
- if (empty($contents)) return;
+ if ( $this->level > 3 )
+ {
+ // max. depth reached (avoid endless loop)
+ return;
+ }
+
+ $file = $this->getIncludeFileName($name);
+ if ( !file_exists($file) && $this->parser->skin != NULL)
+ {
+ $contents = $this->parser->skin->getContentFromDB($name);
+ }
+ else
+ {
+ $contents = file_get_contents($file);
+ }
+
+ if ( empty($contents) )
+ {
+ return;
+ }
$this->level = $this->level + 1;
// parse file contents
$this->parser->parse($contents);
-
+
$this->level = $this->level - 1;
+ return;
}
-
+
/**
+ * BaseActions::getIncludeFileName()
* Returns the correct location of the file to be included, according to
* parser properties
*
* IF IncludeMode = 'skindir' => use skindir
*
- * @param $filename
+ * @param string $filename name of file to be inclluded
+ * @return string name of file with relative path
*/
- function getIncludeFileName($filename) {
+ private function getIncludeFileName($filename)
+ {
// leave absolute filenames and http urls as they are
if (
(i18n::substr($filename,0,1) == '/')
|| (i18n::substr($filename,0,7) == 'http://')
|| (i18n::substr($filename,0,6) == 'ftp://')
)
+ {
return $filename;
-
- $filename = PARSER::getProperty('IncludePrefix') . $filename;
- if (PARSER::getProperty('IncludeMode') == 'skindir') {
+ }
+
+ $filename = Parser::getProperty('IncludePrefix') . $filename;
+
+ if ( Parser::getProperty('IncludeMode') == 'skindir' )
+ {
global $DIR_SKINS;
return $DIR_SKINS . $filename;
- } else {
- return $filename;
}
+ return $filename;
}
-
+
/**
+ * BaseActions::parse_skinfile()
* Inserts an url relative to the skindir (useful when doing import/export)
*
* e.g. <skinfile(default/myfile.sth)>
+ *
+ * @param string $filename name of file to be inclluded
+ * @return void
*/
- function parse_skinfile($filename) {
+ public function parse_skinfile($filename)
+ {
global $CONF;
-
- echo $CONF['SkinsURL'] . PARSER::getProperty('IncludePrefix') . $filename;
+ echo $CONF['SkinsURL'] . Parser::getProperty('IncludePrefix') . $filename;
+ return;
}
/**
+ * BaseActions::parse_set()
* Sets a property for the parser
+ *
+ * @param string $property name of property
+ * @param string $value value of property
+ * @return void
*/
- function parse_set($property, $value) {
- PARSER::setProperty($property, $value);
+ public function parse_set($property, $value)
+ {
+ Parser::setProperty($property, $value);
+ return;
}
-
+
+ /**
+ * BaseActions::parse_text()
+ * Parse text
+ *
+ * @param string $constant named constant
+ * @return void
+ */
+ public function parse_text($constant)
+ {
+ if ( !defined($constant) )
+ {
+ echo $constant;
+ }
+ else
+ {
+ echo constant($constant);
+ }
+ return;
+ }
+
/**
+ * BaseActions::addIfCondition()
* Helper function: add if condition
+ *
+ * @param string $condition condition for if context
+ * @return void
*/
- function _addIfCondition($condition) {
-
+ private function addIfCondition($condition)
+ {
array_push($this->if_conditions,$condition);
-
- $this->_updateTopIfCondition();
-
+ $this->updateTopIfCondition();
ob_start();
+ return;
}
-
+
/**
+ * BaseActions::updateTopIfCondition()
* Helper function: update the Top of the If Conditions Array
+ *
+ * @param void
+ * @return void
*/
- function _updateTopIfCondition() {
- if (sizeof($this->if_conditions) == 0) {
+ private function updateTopIfCondition()
+ {
+ if ( sizeof($this->if_conditions) == 0 )
+ {
$this->if_currentlevel = 1;
}
- else {
+ else
+ {
$this->if_currentlevel = $this->if_conditions[sizeof($this->if_conditions) - 1];
}
+ return;
}
-
+
/**
+ * BaseActions::addIfExecute()
* Helper function for elseif / elseifnot
+ *
+ * @param void
+ * @return void
*/
- function _addIfExecute() {
+ private function addIfExecute()
+ {
array_push($this->if_execute, 0);
+ return;
}
-
+
/**
+ * BaseActions::updateIfExecute()
* Helper function for elseif / elseifnot
- * @param string condition to be fullfilled
+ *
+ * @param string $condition condition to be fullfilled
+ * @return void
*/
- function _updateIfExecute($condition) {
+ private function updateIfExecute($condition)
+ {
$index = sizeof($this->if_execute) - 1;
$this->if_execute[$index] = $this->if_execute[$index] || $condition;
+ return;
}
/**
+ * BaseActions::getTopIfCondition()()
* returns the currently top if condition
+ *
+ * @param void
+ * @return string level
*/
- function _getTopIfCondition() {
+ public function getTopIfCondition()
+ {
return $this->if_currentlevel;
}
-
+
/**
+ * BaseActions::setHighlight(()
* Sets the search terms to be highlighted
*
- * @param $highlight
- * A series of search terms
+ * @param string $highlight A series of search terms
+ * @return void
*/
- function setHighlight($highlight) {
+ public function setHighlight($highlight)
+ {
$this->strHighlight = $highlight;
- if ($highlight) {
+ if ( $highlight )
+ {
$this->aHighlight = parseHighlight($highlight);
}
+ return;
}
-
+
/**
+ * BaseActions::highlight()
* Applies the highlight to the given piece of text
*
- * @param &$data
- * Data that needs to be highlighted
* @see setHighlight
+ * @param string $data Data that needs to be highlighted
+ * @return string hilighted data
*/
- function highlight(&$data) {
- if ($this->aHighlight)
- return highlight($data,$this->aHighlight,$this->template['SEARCH_HIGHLIGHT']);
- else
- return $data;
+ public function highlight($data)
+ {
+ if ( $this->aHighlight )
+ {
+ $data = Entity::highlight($data, $this->aHighlight, $this->template['SEARCH_HIGHLIGHT']);
+ }
+ return $data;
}
-
+
/**
+ * BaseActions::parse_benchmark()
+ *
+ * @param void
+ * @return void
+ */
+ public function parse_benchmark()
+ {
+ global $StartTime;
+ $loadtime = microtime(TRUE) - $StartTime;
+ printf("%.3F sec/%d queries", $loadtime, DB::getExecCount());
+ return;
+ }
+
+ /**
+ * BaseActions::parse_if()
* Parses <%if%> statements
+ *
+ * @param void
+ * @return void
*/
- function parse_if() {
- $this->_addIfExecute();
-
+ public function parse_if()
+ {
+ $this->addIfExecute();
$args = func_get_args();
$condition = call_user_func_array(array(&$this,'checkCondition'), $args);
- $this->_addIfCondition($condition);
+ $this->addIfCondition($condition);
+ return;
}
/**
+ * BaseActions::parse_else()
* Parses <%else%> statements
+ *
+ * @param void
+ * @return void
*/
- function parse_else() {
- if (sizeof($this->if_conditions) == 0) return;
+ public function parse_else()
+ {
+ if ( sizeof($this->if_conditions) == 0 )
+ {
+ return;
+ }
+
array_pop($this->if_conditions);
- if ($this->if_currentlevel) {
+
+ if ( $this->if_currentlevel )
+ {
ob_end_flush();
- $this->_updateIfExecute(1);
- $this->_addIfCondition(0);
- } elseif ($this->if_execute[sizeof($this->if_execute) - 1]) {
+ $this->updateIfExecute(1);
+ $this->addIfCondition(0);
+ }
+ elseif ( $this->if_execute[sizeof($this->if_execute) - 1] )
+ {
ob_end_clean();
- $this->_addIfCondition(0);
- } else {
+ $this->addIfCondition(0);
+ }
+ else
+ {
ob_end_clean();
- $this->_addIfCondition(1);
+ $this->addIfCondition(1);
}
+ return;
}
-
+
/**
+ * BaseActions::parse_elseif()
* Parses <%elseif%> statements
+ *
+ * @param void
+ * @return void
*/
- function parse_elseif() {
- if (sizeof($this->if_conditions) == 0) return;
+ public function parse_elseif()
+ {
+ if ( sizeof($this->if_conditions) == 0 )
+ {
+ return;
+ }
+
array_pop($this->if_conditions);
- if ($this->if_currentlevel) {
+
+ if ( $this->if_currentlevel )
+ {
ob_end_flush();
- $this->_updateIfExecute(1);
- $this->_addIfCondition(0);
- } elseif ($this->if_execute[sizeof($this->if_execute) - 1]) {
+ $this->updateIfExecute(1);
+ $this->addIfCondition(0);
+ }
+ elseif ( $this->if_execute[sizeof($this->if_execute) - 1] )
+ {
ob_end_clean();
- $this->_addIfCondition(0);
- } else {
+ $this->addIfCondition(0);
+ }
+ else
+ {
ob_end_clean();
$args = func_get_args();
$condition = call_user_func_array(array(&$this,'checkCondition'), $args);
- $this->_addIfCondition($condition);
+ $this->addIfCondition($condition);
}
+ return;
}
-
+
/**
+ * BaseActions::parse_ifnot()
* Parses <%ifnot%> statements
+ *
+ * @param void
+ * @return void
*/
- function parse_ifnot() {
- $this->_addIfExecute();
-
+ public function parse_ifnot()
+ {
+ $this->addIfExecute();
+
$args = func_get_args();
$condition = call_user_func_array(array(&$this,'checkCondition'), $args);
- $this->_addIfCondition(!$condition);
+ $this->addIfCondition(!$condition);
+ return;
}
-
+
/**
+ * BaseActions::parse_elseifnot()
* Parses <%elseifnot%> statements
+ *
+ * @param void
+ * @return void
*/
- function parse_elseifnot() {
- if (sizeof($this->if_conditions) == 0) return;
+ public function parse_elseifnot()
+ {
+ if ( sizeof($this->if_conditions) == 0 )
+ {
+ return;
+ }
+
array_pop($this->if_conditions);
- if ($this->if_currentlevel) {
+
+ if ( $this->if_currentlevel )
+ {
ob_end_flush();
- $this->_updateIfExecute(1);
- $this->_addIfCondition(0);
- } elseif ($this->if_execute[sizeof($this->if_execute) - 1]) {
+ $this->updateIfExecute(1);
+ $this->addIfCondition(0);
+ }
+ elseif ( $this->if_execute[sizeof($this->if_execute) - 1] )
+ {
ob_end_clean();
- $this->_addIfCondition(0);
- } else {
+ $this->addIfCondition(0);
+ }
+ else
+ {
ob_end_clean();
$args = func_get_args();
$condition = call_user_func_array(array(&$this,'checkCondition'), $args);
- $this->_addIfCondition(!$condition);
+ $this->addIfCondition(!$condition);
}
+ return;
}
/**
+ * BaseActions::parse_endif()
* Ends a conditional if-block
* see e.g. ifcat (BLOG), ifblogsetting (PAGEFACTORY)
+ *
+ * @param void
+ * @return void
*/
- function parse_endif() {
+ public function parse_endif()
+ {
// we can only close what has been opened
- if (sizeof($this->if_conditions) == 0) return;
-
- if ($this->if_currentlevel) {
+ if ( sizeof($this->if_conditions) == 0 )
+ {
+ return;
+ }
+
+ if ( $this->if_currentlevel )
+ {
ob_end_flush();
- } else {
+ }
+ else
+ {
ob_end_clean();
}
+
array_pop($this->if_conditions);
array_pop($this->if_execute);
-
- $this->_updateTopIfCondition();
+
+ $this->updateTopIfCondition();
+ return;
}
}
-?>
OSDN Git Service
