egroupware/admin/inc/class.admin_cmd_config.inc.php
Ralf Becker 858f2c0119 getting admin_cmd_config history finished:
- deprecate app="phpgwapi" and appname, using now "store_as_api" and changed app
- update script to fix database
- use "config" hook to load application specific options
2019-03-20 11:54:49 +01:00

164 lines
4.0 KiB
PHP

<?php
/**
* EGroupware admin - change EGw configuration
*
* @link http://www.egroupware.org
* @author Ralf Becker <rb@egroupware.org>
* @package setup
* @copyright (c) 2018 by Ralf Becker <rb@egroupware.org>
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
*/
use EGroupware\Api;
/**
* setup command: change EGw configuration
*
* @property-read string $app app whos config to change
* @property-read boolean $store_as_api some apps store their config under app="phpgwapi"
* @property-read array $set config data to set, value of null or "" to remove
* @property-read array $old old values to record
*/
class admin_cmd_config extends admin_cmd
{
/**
* Allow to run this command via setup-cli
*/
//const SETUP_CLI_CALLABLE = true; // need to check how to parse arguments
/**
* Name to use if $this->store_as_api is set
*/
const STORE_AS_API = 'phpgwapi';
/**
* Constructor
*
* @param array|string $data data array or app whos config to change
* @param array $set =null config data to set, value of null or "" to remove
* @param array $old =null old values to record
* @param array $other =null values for keys "requested", "requested_email", "comment", etc
* @param boolean $store_as_api =false true: store under "phpgwapi"
*/
function __construct($data, array $set=null, array $old=null, array $other=null, $store_as_api=false)
{
if (!is_array($data))
{
$data = array(
'app' => $data,
'set' => $set,
'old' => $old,
'store_as_api' => $store_as_api,
)+(array)$other;
}
// fix depreated use of app="phpwapi" or appname!=app
if ($data['app'] === self::STORE_AS_API || !empty($data['appname']))
{
$data['store_as_api'] = true;
$data['app'] = !empty($data['appname']) ? $data['appname'] : 'setup';
unset($data['appname']);
}
//echo __CLASS__.'::__construct()'; _debug_array($domain);
admin_cmd::__construct($data);
}
/**
* run the command: write the configuration to the database
*
* @param boolean $check_only =false only run the checks (and throw the exceptions), but not the command itself
* @return string success message
* @throws Exception(lang('Wrong credentials to access the header.inc.php file!'),2);
* @throws Exception('header.inc.php not found!');
*/
protected function exec($check_only=false)
{
if ($check_only)
{
return true; // no specific checks exist
}
$config = new Api\Config($this->store_as_api ? self::STORE_AS_API : $this->app);
$config->read_repository();
// store the config
foreach($this->set as $name => $value)
{
$config->value($name, $value);
}
$config->save_repository();
return lang('Configuration saved.');
}
/**
* Return a title / string representation for a given command, eg. to display it
*
* @return string
*/
function __tostring()
{
return lang('site configuration').': '.lang($this->app);
}
/**
* Get name of eTemplate used to make the change to derive UI for history
*
* @return string|null etemplate name
*/
function get_etemplate_name()
{
return $this->app.'.config';
}
/**
* Return (human readable) labels for keys of changes
*
* Reimplemented to get ride of "newsettins" namespace
*
* @return array
*/
function get_change_labels()
{
$labels = [];
foreach(parent::get_change_labels() as $id => $label)
{
if (strpos($id, 'newsettings[') === 0)
{
$labels[substr($id, 12, -1)] = $label;
}
}
return $labels;
}
/**
* Return widgets for keys of changes
*
* Reimplemented to get ride of "newsettins" namespace
*
* @return array
*/
function get_change_widgets()
{
$widgets = [];
// get selectbox options from "config" hook
$ret = Api\Hooks::single('config', $this->app);
if (is_array($ret) && isset($ret['sel_options']))
{
$widgets = $ret['sel_options'];
}
// get widgets from eTemplate (with newsettings namespace!)
foreach(parent::get_change_widgets() as $id => $widget)
{
if (strpos($id, 'newsettings[') === 0)
{
$widgets[$id=substr($id, 12, -1)] = $widget;
}
}
return $widgets;
}
}