File Source for controller.php

<?php
/**
* <b>Class Description</b>: The Parent Class for all Controller Classes in the System. It contains methods for shaping data that is provided
* to the controller by a Model object into a format required by the Smarty Template. It also offers functionality for
* importing information contained in system configuration files. See {@link controllersPackage.php} for a description of the rvtwo controllers class hierarchy.
* Created On: 30 March 2009
* @author Jan van der Breggen
* @package Controllers
* @subpackage ParentClasses
***/
class Controller extends RvTwoObject
{
/**
* Array containing all data that is passed to the Smarty View
*
* @var array
*/
public $View = array();
public $viewTemplate;
public $uiElements;
protected $package;
protected $subPackage;
protected $className;
/*********************************************************************************************
* Methods for shaping data in preparation for
* passing it to the View for display
**********************************************************************************************/
/**
* converts a rows_array as returned by the ORM and DB classes into an associative array.
* The returned array contains a set of arrays that each
* represent a column of the original query result. These individual arrays are
* associative arrays, the key being the primary key (or other unique value)
* of the database record. The function assumes that this is the first column in the
* query result. If this is not the case the $keyColumn argument should be provided.
*
* @param array 'rows_array' as returned by DB class $array. The rows_array must contain a value that uniquely identifies the database tupple
* @param integer Indicating the column containing the 'key' column
* @return array as described above
*/
function convertRowsArrayToColumnsArray($array, $keyColumn = 0)
{
if (!empty($array[0]))
{
$keys = array_keys($array[0]);
foreach($array as $record)
{
foreach ($keys as $key)
{
$result[$key][$record[$keys[$keyColumn]]] = $record[$key];
}
}
}
return $result;
}
function makeLanguageMenuArray($menuArray)
{
$result = array();
foreach ($menuArray as $key => $value) {
$result[$GLOBALS['lang'][trim($key)]]=$value;
}
return $result;
}
function applyAccessRestrictionsToMenuArray($array)
{
return $array;
}
/**
* Converts the contents of a screen menu configuration file stored in the filesystem location specified by the PATH_CONF constant into an associative array.
* The lefthand value of each line in the config file is treated as an key value of the $GLOBALS['lang']
* array. In other words: it is replaced with the corresponding value in the selected
* application language. This method should only be used when no access restrictions or other operations need
* to be done on the screen menu as the resulting array will have the menu item names
* replaced by the label in the system language.
*
* @param string $fileName
* @param string $lineDelimiter - character that delimits an entry in the config file
* @param string $valueDelimiter - character that separates name and value of an entry in the config file
* @return associative array $config representing the menu configuration file
*/
function convertMenuConfigFileToArray($fileName, $lineDelimiter = ';',$valueDelimiter = ',' )
{
$file = explode($lineDelimiter, file_get_contents(PATH_CONF . "/$fileName"));
$config = array();
foreach($file as $line)
{
$values = explode($valueDelimiter, $line);
if (count($values)==2){
$config[$GLOBALS['lang'][trim($values[0])]] = trim($values[1]);
}
}
return $config;
}
function setPackageInfo($subPackageName, $packageName = "Controllers") {
$this->className = get_class($this);
$this->package = $packageName;
$this->subPackage = $subPackageName;
$this->View['phpDoc'] = URL_PHP_DOC."$this->package/$this->subPackage/$this->className".'.html';
}
}
?>

Source for file controller.php