Server : Apache System : Linux indy02.toastserver.com 3.10.0-962.3.2.lve1.5.85.el7.x86_64 #1 SMP Thu Apr 18 15:18:36 UTC 2024 x86_64 User : palandch ( 1163) PHP Version : 7.1.33 Disable Function : NONE Directory : /home/palandch/public_html/core/components/formit/model/formit/ |
<?php
/**
* FormIt
*
* Copyright 2009-2012 by Shaun McCormick <shaun@modx.com>
*
* FormIt is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or (at your option) any
* later version.
*
* FormIt is distributed in the hope that it will be useful, but WITHOUT ANY
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
* A PARTICULAR PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with
* FormIt; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
* Suite 330, Boston, MA 02111-1307 USA
*
* @package formit
*/
/**
* Base class for FormIt. Used for initializing the form processing engine, handling templating and running snippets.
*
* @package formit
*/
class FormIt {
/**
* A reference to the modX instance
* @var modX $modx
*/
public $modx;
/**
* A configuration array
* @var array $config
*/
public $config;
/**
* In debug mode, will monitor execution time.
* @var int $debugTimer
* @access public
*/
public $debugTimer = 0;
/**
* True if the class has been initialized or not.
* @var boolean $_initialized
*/
private $_initialized = false;
/**
* The fiHooks instance for processing preHooks
* @var fiHooks $preHooks
*/
public $preHooks;
/**
* The fiHooks instance for processing postHooks
* @var fiHooks $postHooks
*/
public $postHooks;
/**
* The request handling class
* @var fiRequest $request
*/
public $request;
/**
* An array of cached chunk tpls for processing
* @var array $chunks
*/
public $chunks;
/**
* Used when running unit tests to prevent emails/headers from being sent
* @var boolean $inTestMode
*/
public $inTestMode = false;
/**
* FormIt constructor
*
* @param modX &$modx A reference to the modX instance.
* @param array $config An array of configuration options. Optional.
*/
function __construct(modX &$modx,array $config = array()) {
$this->modx =& $modx;
/* allows you to set paths in different environments
* this allows for easier SVN management of files
*/
$corePath = $this->modx->getOption('formit.core_path',null,MODX_CORE_PATH.'components/formit/');
$assetsPath = $this->modx->getOption('formit.assets_path',null,MODX_ASSETS_PATH.'components/formit/');
$assetsUrl = $this->modx->getOption('formit.assets_url',null,MODX_ASSETS_URL.'components/formit/');
/* loads some default paths for easier management */
$this->config = array_merge(array(
'corePath' => $corePath,
'modelPath' => $corePath.'model/',
'chunksPath' => $corePath.'elements/chunks/',
'snippetsPath' => $corePath.'elements/snippets/',
'controllersPath' => $corePath.'controllers/',
'includesPath' => $corePath.'includes/',
'testsPath' => $corePath.'test/',
'assetsPath' => $assetsPath,
'assetsUrl' => $assetsUrl,
'cssUrl' => $assetsUrl.'css/',
'jsUrl' => $assetsUrl.'js/',
'debug' => $this->modx->getOption('formit.debug',null,false),
'use_multibyte' => (boolean)$this->modx->getOption('use_multibyte',null,false),
'encoding' => $this->modx->getOption('modx_charset',null,'UTF-8'),
),$config);
if ($this->modx->getOption('formit.debug',$this->config,true)) {
$this->startDebugTimer();
}
}
/**
* Initialize the component into a context and provide context-specific
* handling actions.
*
* @access public
* @param string $context The context to initialize FormIt into
* @return mixed
*/
public function initialize($context = 'web') {
switch ($context) {
case 'mgr': break;
case 'web':
default:
$language = isset($this->config['language']) ? $this->config['language'] . ':' : '';
$this->modx->lexicon->load($language.'formit:default');
$this->_initialized = true;
break;
}
return $this->_initialized;
}
/**
* Sees if the FormIt class has been initialized already
* @return boolean
*/
public function isInitialized() {
return $this->_initialized;
}
/**
* Load the fiRequest class
* @return fiRequest
*/
public function loadRequest() {
$className = $this->modx->getOption('request_class',$this->config,'fiRequest');
$classPath = $this->modx->getOption('request_class_path',$this->config,'');
if (empty($classPath)) $classPath = $this->config['modelPath'].'formit/';
if ($this->modx->loadClass($className,$classPath,true,true)) {
$this->request = new fiRequest($this,$this->config);
} else {
$this->modx->log(modX::LOG_LEVEL_ERROR,'[FormIt] Could not load fiRequest class.');
}
return $this->request;
}
/**
* @param string $className
* @param string $serviceName
* @param array $config
* @return fiModule
*/
public function loadModule($className,$serviceName,array $config = array()) {
if (empty($this->$serviceName)) {
$classPath = $this->modx->getOption('formit.modules_path',null,$this->config['modelPath'].'formit/module/');
if ($this->modx->loadClass($className,$classPath,true,true)) {
$this->$serviceName = new $className($this,$config);
} else {
$this->modx->log(modX::LOG_LEVEL_ERROR,'[FormIt] Could not load module: '.$className.' from '.$classPath);
}
}
return $this->$serviceName;
}
/**
* Loads the Hooks class.
*
* @access public
* @param $type string The type of hook to load.
* @param $config array An array of configuration parameters for the
* hooks class
* @return fiHooks An instance of the fiHooks class.
*/
public function loadHooks($type = 'post',$config = array()) {
if (!$this->modx->loadClass('formit.fiHooks',$this->config['modelPath'],true,true)) {
$this->modx->log(modX::LOG_LEVEL_ERROR,'[FormIt] Could not load Hooks class.');
return false;
}
$typeVar = $type.'Hooks';
$this->$typeVar = new fiHooks($this,$config,$type);
return $this->$typeVar;
}
/**
* Gets a unique session-based store key for storing form submissions.
*
* @return string
*/
public function getStoreKey() {
return $this->modx->context->get('key').'/elements/formit/submission/'.md5(session_id());
}
/**
* Gets a Chunk and caches it; also falls back to file-based templates
* for easier debugging.
*
* Will always use the file-based chunk if $debug is set to true.
*
* @access public
* @param string $name The name of the Chunk
* @param array $properties The properties for the Chunk
* @return string The processed content of the Chunk
*/
public function getChunk($name,$properties = array()) {
$chunk = null;
if (!isset($this->chunks[$name])) {
if (!$this->config['debug']) {
$chunk = $this->modx->getObject('modChunk',array('name' => $name),true);
}
if (empty($chunk)) {
$chunk = $this->_getTplChunk($name);
if ($chunk == false) return false;
}
$this->chunks[$name] = $chunk->getContent();
} else {
$o = $this->chunks[$name];
$chunk = $this->modx->newObject('modChunk');
$chunk->setContent($o);
}
$chunk->setCacheable(false);
return $chunk->process($properties);
}
/**
* Returns a modChunk object from a template file.
*
* @access private
* @param string $name The name of the Chunk. Will parse to name.chunk.tpl
* @return modChunk/boolean Returns the modChunk object if found, otherwise
* false.
*/
private function _getTplChunk($name) {
$chunk = false;
if (file_exists($name)) {
$f = $name;
} else {
$lowerCaseName = $this->config['use_multibyte'] ? mb_strtolower($name,$this->config['encoding']) : strtolower($name);
$f = $this->config['chunksPath'].$lowerCaseName.'.chunk.tpl';
}
if (file_exists($f)) {
$o = file_get_contents($f);
/** @var modChunk $chunk */
$chunk = $this->modx->newObject('modChunk');
$chunk->set('name',$name);
$chunk->setContent($o);
}
return $chunk;
}
/**
* Output the final output and wrap in the wrapper chunk. Optional, but
* recommended for debugging as it outputs the execution time to the output.
*
* Also, it is good to output your snippet code with wrappers for easier
* CSS isolation and styling.
*
* @access public
* @param string $output The output to process
* @return string The final wrapped output
*/
public function output($output) {
if ($this->debugTimer !== false) {
$output .= "<br />\nExecution time: ".$this->endDebugTimer()."\n";
}
return $output;
}
/**
* Starts the debug timer.
*
* @access protected
* @return int The start time.
*/
protected function startDebugTimer() {
$mtime = microtime();
$mtime = explode(' ', $mtime);
$mtime = $mtime[1] + $mtime[0];
$tstart = $mtime;
$this->debugTimer = $tstart;
return $this->debugTimer;
}
/**
* Ends the debug timer and returns the total number of seconds script took
* to run.
*
* @access protected
* @return int The end total time to execute the script.
*/
protected function endDebugTimer() {
$mtime= microtime();
$mtime= explode(" ", $mtime);
$mtime= $mtime[1] + $mtime[0];
$tend= $mtime;
$totalTime= ($tend - $this->debugTimer);
$totalTime= sprintf("%2.4f s", $totalTime);
$this->debugTimer = false;
return $totalTime;
}
public function setOption($key,$value) {
$this->config[$key] = $value;
}
public function setOptions($array) {
foreach ($array as $k => $v) {
$this->setOption($k,$v);
}
}
}