mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-05 14:04:57 +02:00
Code Issues Releases Wiki Activity

[ticket/13987] Replaced optional parameter with explicit API

Browse Source 
Added disable_save() and enable_save() to toggle a dry run

PHPBB3-13987
This commit is contained in:
JoshyPHP 2015-07-06 01:57:54 +02:00
parent 7ccb638912
commit cf4cdcda58
6 changed files with 49 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
phpBB/phpbb/console/command/reparser/reparse.php
View File

@ -130,12 +130,19 @@ class reparse extends \phpbb\console\command\command
protected function reparse(InputInterface $input, OutputInterface $output, $name)
{
$reparser = $this->reparsers[$name];
if ($input->getOption('dry-run'))
{
$reparser->disable_save();
}
else
{
$reparser->enable_save();
}
// Start at range-max if specified or at the highest ID otherwise
$max = (is_null($input->getOption('range-max'))) ? $reparser->get_max_id() : $input->getOption('range-max');
$min = $input->getOption('range-min');
$size = $input->getOption('range-size');
$dry_run = $input->getOption('dry-run');
$max = (is_null($input->getOption('range-max'))) ? $reparser->get_max_id() : $input->getOption('range-max');
$min = $input->getOption('range-min');
$size = $input->getOption('range-size');
if ($max === 0)
{
@ -183,7 +190,7 @@ class reparse extends \phpbb\console\command\command
$end = max($min, $current);
$progress->setMessage($this->user->lang('CLI_REPARSER_REPARSE_REPARSING', str_replace('text_reparser.', '', $name), $start, $end));
$reparser->reparse_range($start, $end, $dry_run);
$reparser->reparse_range($start, $end);
$current = $start - 1;
$progress->setProgress($max + 1 - $start);

32
phpBB/phpbb/textreparser/base.php
View File

@ -15,6 +15,11 @@ namespace phpbb\textreparser;
abstract class base implements reparser_interface
{
/**
* @var bool Whether to save changes to the database
*/
protected $save_changes = true;
/**
* {@inheritdoc}
*/
@ -84,6 +89,22 @@ abstract class base implements reparser_interface
return $record;
}
/**
* Disable saving changes to the database
*/
public function disable_save()
{
$this->save_changes = false;
}
/**
* Enable saving changes to the database
*/
public function enable_save()
{
$this->save_changes = true;
}
/**
* Guess whether given BBCode is in use in given record
*
@ -170,21 +191,20 @@ abstract class base implements reparser_interface
/**
* {@inheritdoc}
*/
public function reparse_range($min_id, $max_id, $dry_run = false)
public function reparse_range($min_id, $max_id)
{
foreach ($this->get_records_by_range($min_id, $max_id) as $record)
{
$this->reparse_record($record, $dry_run);
$this->reparse_record($record);
}
}
/**
* Reparse given record
*
* @param array $record Associative array containing the record's data
* @param integer $dry_run If TRUE, do not save the changes
* @param array $record Associative array containing the record's data
*/
protected function reparse_record(array $record, $dry_run)
protected function reparse_record(array $record)
{
$record = $this->add_missing_fields($record);
$flags = ($record['enable_bbcode']) ? OPTION_FLAG_BBCODE : 0;
@ -214,7 +234,7 @@ abstract class base implements reparser_interface
);
// Save the new text if it has changed and it's not a dry run
if ($text !== $record['text'] && !$dry_run)
if ($text !== $record['text'] && $this->save_changes)
{
$record['text'] = $text;
$this->save_record($record);

7
phpBB/phpbb/textreparser/reparser_interface.php
View File

@ -25,9 +25,8 @@ interface reparser_interface
/**
* Reparse all records in given range
*
* @param integer $min_id Lower bound
* @param integer $max_id Upper bound
* @param integer $dry_run If TRUE, do not save the changes
* @param integer $min_id Lower bound
* @param integer $max_id Upper bound
*/
public function reparse_range($min_id, $max_id, $dry_run = false);
public function reparse_range($min_id, $max_id);
}

4
tests/text_reparser/plugins/contact_admin_info_test.php
View File

@ -62,7 +62,8 @@ class phpbb_textreparser_contact_admin_info_test extends phpbb_database_test_cas
{
$old_rows = $this->get_rows();
$reparser = $this->get_reparser();
$reparser->reparse_range(1, 1, true);
$reparser->disable_save();
$reparser->reparse_range(1, 1);
$new_rows = $this->get_rows();
$this->assertEquals($old_rows, $new_rows);
}
@ -70,6 +71,7 @@ class phpbb_textreparser_contact_admin_info_test extends phpbb_database_test_cas
public function test_reparse()
{
$reparser = $this->get_reparser();
$reparser->enable_save();
$reparser->reparse_range(1, 1);
$expected = array(
array(

4
tests/text_reparser/plugins/poll_option_test.php
View File

@ -62,7 +62,8 @@ class phpbb_textreparser_poll_option_test extends phpbb_database_test_case
{
$old_rows = $this->get_rows();
$reparser = $this->get_reparser();
$reparser->reparse_range(1, 1, true);
$reparser->disable_save();
$reparser->reparse_range(1, 1);
$new_rows = $this->get_rows();
$this->assertEquals($old_rows, $new_rows);
}
@ -70,6 +71,7 @@ class phpbb_textreparser_poll_option_test extends phpbb_database_test_case
public function testReparse()
{
$reparser = $this->get_reparser();
$reparser->enable_save();
$reparser->reparse_range(2, 13);
$expected = array(
array(

3
tests/text_reparser/plugins/test_row_based_plugin.php
View File

@ -57,7 +57,8 @@ abstract class phpbb_textreparser_test_row_based_plugin extends phpbb_database_t
{
$old_rows = $this->get_rows(array(1));
$reparser = $this->get_reparser();
$reparser->reparse_range(1, 1, true);
$reparser->disable_save();
$reparser->reparse_range(1, 1);
$new_rows = $this->get_rows(array(1));
$this->assertEquals($old_rows, $new_rows);
}