Merge pull request #557 from marc1706/ticket/555

[ticket/555] Allow setting default currency in ACP
This commit is contained in:
Marc Alexander
2015-06-03 14:48:23 +02:00
14 changed files with 183 additions and 89 deletions

View File

@@ -84,8 +84,10 @@ services:
class: board3\portal\modules\donation
arguments:
- @config
- @request
- @template
- @user
- @board3.portal.modules_helper
tags:
- { name: board3.portal.module }

View File

@@ -85,7 +85,8 @@ class modules_helper
public function generate_select_box($key, $select_ary, $selected_options)
{
// Build options
$options = '<select id="' . $key . '" name="' . $key . '[]" multiple="multiple">';
$options = '<select id="' . $key . '" name="' . $key;
$options .= (sizeof($selected_options) > 1) ? '[]" multiple="multiple">' : '">';
foreach ($select_ary as $id => $option)
{
$options .= '<option value="' . $option['value'] . '"' . ((in_array($option['value'], $selected_options)) ? ' selected="selected"' : '') . (!empty($option['disabled']) ? ' disabled="disabled" class="disabled-option"' : '') . '>' . $option['title'] . '</option>';
@@ -113,6 +114,11 @@ class modules_helper
{
$selected_options = explode(',', $this->config[$key]);
}
// Add useless values to force multi drop down list
$selected_options += array(
'-1' => '',
'-2' => '',
);
// Build forum options
foreach ($forum_list as $f_id => $f_row)

View File

@@ -57,9 +57,11 @@ $lang = array_merge($lang, array(
'ILS' => 'Neue Israelische Schekel (ILS)',
// ACP
'ACP_PORTAL_PAYPAL_SETTINGS' => 'Paypal Einstellungen',
'ACP_PORTAL_PAYPAL_SETTINGS' => 'Paypal Einstellungen',
'ACP_PORTAL_PAYPAL_SETTINGS_EXP' => 'Hier kannst du die Paypal Einstellungen ändern.',
'PORTAL_PAY_ACC' => 'Paypal Account',
'PORTAL_PAY_ACC' => 'Paypal Account',
'PORTAL_PAY_ACC_EXP' => 'Gib deine e-mail-Adresse an, die du bei Paypal benutzt, z.B. xxx@xxx.com',
'PORTAL_PAY_CUSTOM' => 'Benutzername an die Paypal Zahlung anhängen',
'PORTAL_PAY_CUSTOM' => 'Benutzername an die Paypal Zahlung anhängen',
'PORTAL_PAY_DEFAULT' => 'Standard-Währung',
'PORTAL_PAY_DEFAULT_EXP' => 'Währung die standardmäßig in der Drop-Down-Liste ausgewählt ist.'
));

View File

@@ -61,5 +61,7 @@ $lang = array_merge($lang, array(
'ACP_PORTAL_PAYPAL_SETTINGS_EXP' => 'This is where you customize the Paypal block.',
'PORTAL_PAY_ACC' => 'Paypal account to use',
'PORTAL_PAY_ACC_EXP' => 'Enter your Paypal e-mail address eg. xxx@xxx.com',
'PORTAL_PAY_CUSTOM' => 'Append username to Paypal donation',
'PORTAL_PAY_CUSTOM' => 'Append username to Paypal donation',
'PORTAL_PAY_DEFAULT' => 'Default currency',
'PORTAL_PAY_DEFAULT_EXP' => 'Currency that will be selected by default in currency drop down list.'
));

View File

@@ -20,6 +20,23 @@ class v210 extends \phpbb\db\migration\migration
{
return array(
array('config.update', array('board3_portal_version', '2.1.0')),
array('custom', array(array($this, 'add_donation_setting'))),
);
}
/**
* Adds default currency setting to already installed donation modules
*/
public function add_donation_setting()
{
$sql = 'SELECT module_id
FROM ' . $this->table_prefix . "portal_modules
WHERE module_classname = '\\\board3\\\portal\\\modules\\\donation'";
$result = $this->db->sql_query($sql);
while ($row = $this->db->sql_fetchrow($result))
{
$this->config->set('board3_pay_default_' . $row['module_id'], 'EUR');
}
$this->db->sql_freeresult($result);
}
}

View File

@@ -44,24 +44,56 @@ class donation extends module_base
/** @var \phpbb\config\config */
protected $config;
/** @var \phpbb\template */
/** @var \phpbb\request\request_interface */
protected $request;
/** @var \phpbb\template\template */
protected $template;
/** @var \phpbb\user */
protected $user;
/** @var \board3\portal\includes\modules_helper */
protected $helper;
/** @var array List of currencies supported in donations */
protected $currencies = array(
'AUD',
'CAD',
'CZK',
'DKK',
'HKD',
'HUF',
'NZD',
'NOK',
'PLN',
'GBP',
'SGD',
'SEK',
'CHF',
'JPY',
'USD',
'EUR',
'MXN',
'ILS',
);
/**
* Construct a stylechanger object
* Construct a donation module object
*
* @param \phpbb\config\config $config phpBB config
* @param \phpbb\template $template phpBB template
* @param \phpbb\request\request_interface $request Request
* @param \phpbb\template\template $template phpBB template
* @param \phpbb\user $user phpBB user object
* @param \board3\portal\includes\modules_helper $helper Board3 Portal modules helper
*/
public function __construct($config, $template, $user)
public function __construct($config, $request, $template, $user, $helper)
{
$this->config = $config;
$this->request = $request;
$this->template = $template;
$this->user = $user;
$this->helper = $helper;
}
/**
@@ -74,6 +106,8 @@ class donation extends module_base
'PAY_CUSTOM_CENTER' => (!empty($this->config['board3_pay_custom_' . $module_id])) ? $this->user->data['username_clean'] : false,
));
$this->build_currency_select($module_id, 'b3p_donation_currency_center');
return 'donation_center.html';
}
@@ -87,6 +121,8 @@ class donation extends module_base
'PAY_CUSTOM_SIDE' => (!empty($this->config['board3_pay_custom_' . $module_id])) ? $this->user->data['username_clean'] : false,
));
$this->build_currency_select($module_id, 'b3p_donation_currency_side', true);
return 'donation_side.html';
}
@@ -101,10 +137,69 @@ class donation extends module_base
'legend1' => 'ACP_PORTAL_PAYPAL_SETTINGS',
'board3_pay_acc_' . $module_id => array('lang' => 'PORTAL_PAY_ACC', 'validate' => 'string', 'type' => 'text:25:100', 'explain' => true),
'board3_pay_custom_' . $module_id => array('lang' => 'PORTAL_PAY_CUSTOM', 'validate' => 'bool', 'type' => 'radio:yes_no', 'explain' => false),
'board3_pay_default_' . $module_id => array('lang' => 'PORTAL_PAY_DEFAULT', 'validate' => 'string', 'type' => 'custom', 'method' => 'select_currency', 'submit' => 'save_currency', 'explain' => true),
)
);
}
/**
* Build currency select for block name
*
* @param int $module_id Module ID
* @param string $block_name Name of template block
* @param bool $short Whether short ISO titles should be used
*/
protected function build_currency_select($module_id, $block_name, $short = false)
{
foreach ($this->currencies as $currency)
{
$this->template->assign_block_vars($block_name, array(
'VALUE' => $currency,
'TITLE' => ($short) ? $currency : $this->user->lang($currency),
'SELECTED' => $currency === $this->config['board3_pay_default_' . $module_id],
));
}
}
/**
* Create select box for attachment filetype
*
* @param mixed $value Value of input
* @param string $key Key name
* @param int $module_id Module ID
*
* @return string Forum select box HTML
*/
public function select_currency($value, $key, $module_id)
{
$currencies = $selected = array();
foreach ($this->currencies as $currency)
{
$currencies[] = array(
'title' => $this->user->lang($currency),
'value' => $currency,
);
if ($currency === $this->config['board3_pay_default_' . $module_id])
{
$selected[] = $currency;
}
}
return $this->helper->generate_select_box($key, $currencies, $selected);
}
/**
* Save currency setting
*
* @param string $key
* @param int $module_id
*/
public function save_currency($key, $module_id)
{
$this->config->set($key, $this->request->variable('board3_pay_default_' . $module_id, ''));
}
/**
* {@inheritdoc}
*/
@@ -112,6 +207,7 @@ class donation extends module_base
{
$this->config->set('board3_pay_acc_' . $module_id, 'your@paypal.com');
$this->config->set('board3_pay_custom_' . $module_id, true);
$this->config->set('board3_pay_default_' . $module_id, 'EUR');
return true;
}
@@ -123,6 +219,7 @@ class donation extends module_base
$del_config = array(
'board3_pay_acc_' . $module_id,
'board3_pay_custom_' . $module_id,
'board3_pay_default_' . $module_id,
);
$sql = 'DELETE FROM ' . CONFIG_TABLE . '
WHERE ' . $db->sql_in_set('config_name', $del_config);

View File

@@ -20,24 +20,9 @@
<!-- ENDIF -->
<input type="text" tabindex="11" name="amount" size="10" maxlength="6" value="" class="inputbox autowidth" title="{L_PAY_MSG}" />
<select name="currency_code" class="autowidth">
<option value="USD">{L_USD}</option>
<option value="AUD">{L_AUD}</option>
<option value="CAD">{L_CAD}</option>
<option value="CZK">{L_CZK}</option>
<option value="DKK">{L_DKK}</option>
<option value="EUR" selected="selected">{L_EUR}</option>
<option value="HKD">{L_HKD}</option>
<option value="HUF">{L_HUF}</option>
<option value="NZD">{L_NZD}</option>
<option value="NOK">{L_NOK}</option>
<option value="PLN">{L_PLN}</option>
<option value="GBP">{L_GBP}</option>
<option value="SGD">{L_SGD}</option>
<option value="SEK">{L_SEK}</option>
<option value="CHF">{L_CHF}</option>
<option value="JPY">{L_JPY}</option>
<option value="MXN">{L_MXN}</option>
<option value="ILS">{L_ILS}</option>
<!-- BEGIN b3p_donation_currency_center -->
<option value="{b3p_donation_currency_center.VALUE"<!-- IF b3p_donation_currency_center.SELECTED --> selected="selected"<!-- ENDIF -->>{b3p_donation_currency_center.TITLE}</option>
<!-- END b3p_donation_currency_center -->
</select>
<input type="submit" name="submit" value="{L_DONATION}" class="button1" />
</div>

View File

@@ -14,22 +14,9 @@
<!-- ENDIF -->
<input type="text" tabindex="10" name="amount" size="10" maxlength="6" value="" class="inputbox autowidth" title="{L_PAY_MSG}" />
<select name="currency_code" class="autowidth">
<option value="USD">USD</option>
<option value="AUD">AUD</option>
<option value="CAD">CAD</option>
<option value="CZK">CZK</option>
<option value="DKK">DKK</option>
<option value="EUR" selected="selected">EUR</option>
<option value="HKD">HKD</option>
<option value="HUF">HUF</option>
<option value="NZD">NZD</option>
<option value="NOK">NOK</option>
<option value="PLN">PLN</option>
<option value="GBP">GBP</option>
<option value="SGD">SGD</option>
<option value="SEK">SEK</option>
<option value="CHF">CHF</option>
<option value="JPY">JPY</option>
<!-- BEGIN b3p_donation_currency_side -->
<option value="{b3p_donation_currency_side.VALUE"<!-- IF b3p_donation_currency_side.SELECTED --> selected="selected"<!-- ENDIF -->>{b3p_donation_currency_side.TITLE}</option>
<!-- END b3p_donation_currency_side -->
</select>
<input type="submit" name="submit" value="{L_DONATION}" class="button1" />
</div>

View File

@@ -21,24 +21,9 @@
<!-- ENDIF -->
<input type="text" tabindex="11" name="amount" size="10" maxlength="6" value="" class="inputbox autowidth" title="{L_PAY_MSG}" />
<select name="currency_code" class="autowidth">
<option value="USD">{L_USD}</option>
<option value="AUD">{L_AUD}</option>
<option value="CAD">{L_CAD}</option>
<option value="CZK">{L_CZK}</option>
<option value="DKK">{L_DKK}</option>
<option value="EUR" selected="selected">{L_EUR}</option>
<option value="HKD">{L_HKD}</option>
<option value="HUF">{L_HUF}</option>
<option value="NZD">{L_NZD}</option>
<option value="NOK">{L_NOK}</option>
<option value="PLN">{L_PLN}</option>
<option value="GBP">{L_GBP}</option>
<option value="SGD">{L_SGD}</option>
<option value="SEK">{L_SEK}</option>
<option value="CHF">{L_CHF}</option>
<option value="JPY">{L_JPY}</option>
<option value="MXN">{L_MXN}</option>
<option value="ILS">{L_ILS}</option>
<!-- BEGIN b3p_donation_currency_center -->
<option value="{b3p_donation_currency_center.VALUE"<!-- IF b3p_donation_currency_center.SELECTED --> selected="selected"<!-- ENDIF -->>{b3p_donation_currency_center.TITLE}</option>
<!-- END b3p_donation_currency_center -->
</select>
<input type="submit" name="submit" value="{L_DONATION}" class="button1" />
</form>

View File

@@ -16,22 +16,9 @@
<!-- ENDIF -->
<input type="text" tabindex="10" name="amount" size="10" maxlength="6" value="" class="inputbox autowidth" title="{L_PAY_MSG}" />
<select name="currency_code" class="autowidth">
<option value="USD">USD</option>
<option value="AUD">AUD</option>
<option value="CAD">CAD</option>
<option value="CZK">CZK</option>
<option value="DKK">DKK</option>
<option value="EUR" selected="selected">EUR</option>
<option value="HKD">HKD</option>
<option value="HUF">HUF</option>
<option value="NZD">NZD</option>
<option value="NOK">NOK</option>
<option value="PLN">PLN</option>
<option value="GBP">GBP</option>
<option value="SGD">SGD</option>
<option value="SEK">SEK</option>
<option value="CHF">CHF</option>
<option value="JPY">JPY</option>
<!-- BEGIN b3p_donation_currency_side -->
<option value="{b3p_donation_currency_side.VALUE"<!-- IF b3p_donation_currency_side.SELECTED --> selected="selected"<!-- ENDIF -->>{b3p_donation_currency_side.TITLE}</option>
<!-- END b3p_donation_currency_side -->
</select>
<input type="submit" name="submit" value="{L_DONATION}" class="button1" />
</form>

View File

@@ -45,16 +45,22 @@ class phpbb_acp_move_module_test extends \board3\portal\tests\testframework\data
->getMock());
// Mock module service collection
$config = new \phpbb\config\config(array());
$auth = $this->getMock('\phpbb\auth\auth', array('acl_get'));
$auth->expects($this->any())
->method('acl_get')
->with($this->anything())
->will($this->returnValue(true));
$controller_helper = new \board3\portal\tests\mock\controller_helper($phpbb_root_path, $phpEx);
$controller_helper->add_route('board3_portal_controller', 'portal');
$modules_helper = new \board3\portal\includes\modules_helper($auth, $config, $controller_helper, new \phpbb_mock_request);
$phpbb_container->set('board3.portal.module_collection',
array(
new \board3\portal\modules\clock($config, $template),
new \board3\portal\modules\birthday_list($config, $template, $this->db, $user),
new \board3\portal\modules\welcome($config, new \phpbb_mock_request, $this->db, $user, $phpbb_root_path, $phpEx),
new \board3\portal\modules\donation($config, $template, $user),
new \board3\portal\modules\donation($config, new \phpbb_mock_request, $template, $user, $modules_helper),
));
$this->portal_helper = new \board3\portal\includes\helper($phpbb_container->get('board3.portal.module_collection'));
$controller_helper = new \board3\portal\tests\mock\controller_helper($phpbb_root_path, $phpEx);
$controller_helper->add_route('board3_portal_controller', 'portal');
$phpbb_container->set('board3.portal.helper', $this->portal_helper);
$phpbb_container->set('board3.portal.modules_helper', new \board3\portal\includes\modules_helper(new \phpbb\auth\auth(), $config, $controller_helper, $request));
$phpbb_container->setParameter('board3.portal.modules.table', $table_prefix . 'portal_modules');
@@ -120,11 +126,6 @@ class phpbb_acp_move_module_test extends \board3\portal\tests\testframework\data
'\board3\portal\modules\clock' => new \board3\portal\modules\clock($config, $template),
);
$portal_helper = new \board3\portal\includes\helper($modules);
$auth = $this->getMock('\phpbb\auth\auth', array('acl_get'));
$auth->expects($this->any())
->method('acl_get')
->with($this->anything())
->will($this->returnValue(true));
$controller_helper = new \board3\portal\controller\helper(
$auth,

View File

@@ -55,7 +55,7 @@ class board3_includes_modules_helper_test extends \board3\portal\tests\testframe
public function data_generate_select_box()
{
return array(
array('<select id="foobar" name="foobar[]" multiple="multiple"><option value="one">one</option><option value="two" selected="selected">two</option></select>',
array('<select id="foobar" name="foobar"><option value="one">one</option><option value="two" selected="selected">two</option></select>',
'foobar',
array(
'1' => array(
@@ -68,7 +68,7 @@ class board3_includes_modules_helper_test extends \board3\portal\tests\testframe
),
),
array('two')),
array('<select id="foobar" name="foobar[]" multiple="multiple"><option value="one" selected="selected">two</option><option value="two">three</option></select>',
array('<select id="foobar" name="foobar"><option value="one" selected="selected">two</option><option value="two">three</option></select>',
'foobar',
array(
'1' => array(
@@ -81,6 +81,19 @@ class board3_includes_modules_helper_test extends \board3\portal\tests\testframe
),
),
array('one')),
array('<select id="foobar" name="foobar[]" multiple="multiple"><option value="one" selected="selected">two</option><option value="two" selected="selected">three</option></select>',
'foobar',
array(
'1' => array(
'value' => 'one',
'title' => 'two',
),
'2' => array(
'value' => 'two',
'title' => 'three',
),
),
array('one', 'two')),
);
}

View File

@@ -47,14 +47,19 @@ class modules_manager_confirm_box_test extends \board3\portal\tests\testframewor
$request =new \phpbb_mock_request();
$this->request = $request;
$this->user = $user;
$auth = new \phpbb\auth\auth();
$config = new \phpbb\config\config(array());
$controller_helper = new \board3\portal\tests\mock\controller_helper($phpbb_root_path, $phpEx);
$controller_helper->add_route('board3_portal_controller', 'portal');
$modules_helper = new \board3\portal\includes\modules_helper($auth, $config, $controller_helper, $this->request);
$this->portal_helper = new \board3\portal\includes\helper(array(
new \board3\portal\modules\clock($config, null),
new \board3\portal\modules\birthday_list($config, null, $this->db, $user),
new \board3\portal\modules\welcome($config, new \phpbb_mock_request, $this->db, $user, $this->phpbb_root_path, $this->phpEx),
new \board3\portal\modules\donation($config, null, $user),
new \board3\portal\modules\donation($config, $this->request, null, $user, $modules_helper),
));
$this->portal_columns = new \board3\portal\portal\columns();

View File

@@ -41,12 +41,17 @@ class board3_portal_modules_manager_test extends \board3\portal\tests\testframew
$request =new \phpbb_mock_request();
$config = new \phpbb\config\config(array());
$auth = new \phpbb\auth\auth();
$controller_helper = new \board3\portal\tests\mock\controller_helper($phpbb_root_path, $phpEx);
$controller_helper->add_route('board3_portal_controller', 'portal');
$modules_helper = new \board3\portal\includes\modules_helper($auth, $config, $controller_helper, $this->request);
$portal_helper = new \board3\portal\includes\helper(array(
new \board3\portal\modules\clock($config, null),
new \board3\portal\modules\birthday_list($config, null, $this->db, $user),
new \board3\portal\modules\welcome($config, new \phpbb_mock_request, $this->db, $user, $this->phpbb_root_path, $this->phpEx),
new \board3\portal\modules\donation($config, null, $user),
new \board3\portal\modules\donation($config, $request, null, $user, $modules_helper),
));
$this->portal_columns = new \board3\portal\portal\columns();