Merge pull request #4612 from javiexin/ticket/14950

[ticket/14950] Add possibility to delete a template block
author: Marc Alexander <admin@m-a-styles.de> 2017-04-15 18:18:32 +0200
committer: Marc Alexander <admin@m-a-styles.de> 2017-04-15 18:18:32 +0200
commit: 269150ed40d8cf42c2b8d755191b15229dc170c2 (patch)
tree: 7be8527b0d529748c53abf2f1fadf22c05626625
parent: 24f9a4165463d9a546c9868cb352c0283d976c27 (diff)
parent: 136c74bd1c3d2ef1f22055d9bb14e6f524d41433 (diff)
download: forums-269150ed40d8cf42c2b8d755191b15229dc170c2.tar
forums-269150ed40d8cf42c2b8d755191b15229dc170c2.tar.gz
forums-269150ed40d8cf42c2b8d755191b15229dc170c2.tar.bz2
forums-269150ed40d8cf42c2b8d755191b15229dc170c2.tar.xz
forums-269150ed40d8cf42c2b8d755191b15229dc170c2.zip
3 files changed, 93 insertions, 3 deletions
diff --git a/phpBB/phpbb/template/context.php b/phpBB/phpbb/template/context.php
index 5d04a09865..5e4f71a2a9 100644
--- a/phpBB/phpbb/template/context.php
+++ b/phpBB/phpbb/template/context.php
@@ -363,10 +363,11 @@ class context
 	* If key is false the position is set to 0
 	* If key is true the position is set to the last entry
 	*
-	* @param	string	$mode		Mode to execute (valid modes are 'insert' and 'change')
+	* @param	string	$mode		Mode to execute (valid modes are 'insert', 'change' and 'delete')
 	*
 	*	If insert, the vararray is inserted at the given position (position counting from zero).
 	*	If change, the current block gets merged with the vararray (resulting in new key/value pairs be added and existing keys be replaced by the new \value).
+	*	If delete, the vararray is ignored, and the block at the given position (counting from zero) is removed.
 	*
 	* Since counting begins by zero, inserting at the last position will result in this array: array(vararray, last positioned array)
 	* and inserting at position 1 will result in this array: array(first positioned array, vararray, following vars)
@@ -502,6 +503,45 @@ class context
 			return true;
 		}
 
+		// Delete Block
+		if ($mode == 'delete')
+		{
+			// If we are exceeding last iteration, do not delete anything
+			if ($key > sizeof($block) || $key < 0)
+			{
+				return false;
+			}
+
+			// If we are positioned at the end, we remove the last element
+			if ($key == sizeof($block))
+			{
+				$key--;
+			}
+
+			// We are deleting the last element in the block, so remove the block
+			if (sizeof($block) === 1)
+			{
+				$block = null; // unset($block); does not work on references
+				return true;
+			}
+
+			// Re-position template blocks
+			for ($i = $key; $i < sizeof($block)-1; $i++)
+			{
+				$block[$i] = $block[$i+1];
+				$block[$i]['S_ROW_COUNT'] = $block[$i]['S_ROW_NUM'] = $i;
+			}
+
+			// Remove the last element
+			unset($block[$i]);
+
+			// Set first and last elements again, in case they were removed
+			$block[0]['S_FIRST_ROW'] = true;
+			$block[sizeof($block)-1]['S_LAST_ROW'] = true;
+
+			return true;
+		}
+
 		return false;
 	}
 
diff --git a/phpBB/phpbb/template/template.php b/phpBB/phpbb/template/template.php
index 9e3d658ca8..d1ec442e9a 100644
--- a/phpBB/phpbb/template/template.php
+++ b/phpBB/phpbb/template/template.php
@@ -160,10 +160,11 @@ interface template
 	* If key is false the position is set to 0
 	* If key is true the position is set to the last entry
 	*
-	* @param	string	$mode		Mode to execute (valid modes are 'insert' and 'change')
+	* @param	string	$mode		Mode to execute (valid modes are 'insert', 'change' and 'delete')
 	*
 	*	If insert, the vararray is inserted at the given position (position counting from zero).
 	*	If change, the current block gets merged with the vararray (resulting in new \key/value pairs be added and existing keys be replaced by the new \value).
+	*	If delete, the vararray is ignored, and the block at the given position (counting from zero) is removed.
 	*
 	* Since counting begins by zero, inserting at the last position will result in this array: array(vararray, last positioned array)
 	* and inserting at position 1 will result in this array: array(first positioned array, vararray, following vars)
diff --git a/tests/template/template_test.php b/tests/template/template_test.php
index ca1414ec45..f86572cae8 100644
--- a/tests/template/template_test.php
+++ b/tests/template/template_test.php
@@ -558,7 +558,7 @@ class phpbb_template_template_test extends phpbb_template_template_test_case
 
 		$this->template->assign_display('test', 'VARIABLE', false);
 
-		$this->assertEquals("pass\npass\npass\n<!-- DUMMY var -->", $this->display('container'), "Testing assign_display($file)");
+		$this->assertEquals("pass\npass\npass\n<!-- DUMMY var -->", $this->display('container'), "Testing assign_display(\$file)");
 	}
 
 	public function test_append_var_without_assign_var()
@@ -919,6 +919,55 @@ EOT
 		$this->assertEquals(false, $this->template->find_key_index('outer.wrong', true), 'Wrong middle block name');
 		$this->assertEquals(false, $this->template->find_key_index('wrong.middle', false), 'Wrong outer block name');
 	}
+
+	public function test_delete_alter_block_array()
+	{
+		$this->template->set_filenames(array('test' => 'loop_nested.html'));
+
+		$this->template->assign_var('TEST_MORE', true);
+
+		// @todo Change this
+		$this->template->assign_block_vars('outer', array('VARIABLE' => 'zero'));
+		$this->template->assign_block_vars('outer', array('VARIABLE' => 'one'));
+		$this->template->assign_block_vars('outer.middle', array('VARIABLE' => '1A'));
+		$this->template->assign_block_vars('outer', array('VARIABLE' => 'two'));
+		$this->template->assign_block_vars('outer.middle', array('VARIABLE' => '2A'));
+		$this->template->assign_block_vars('outer.middle', array('VARIABLE' => '2B'));
+		$this->template->assign_block_vars('outer', array('VARIABLE' => 'three'));
+		$this->template->assign_block_vars('outer.middle', array('VARIABLE' => '3A'));
+		$this->template->assign_block_vars('outer.middle', array('VARIABLE' => '3B'));
+		$this->template->assign_block_vars('outer.middle', array('VARIABLE' => '3C'));
+
+		$expect = 'outer - 0 - zero[outer|4]outer - 1 - one[outer|4]middle - 0 - 1A[middle|1]outer - 2 - two[outer|4]middle - 0 - 2A[middle|2]middle - 1 - 2B[middle|2]outer - 3 - three[outer|4]middle - 0 - 3A[middle|3]middle - 1 - 3B[middle|3]middle - 2 - 3C[middle|3]';
+		$this->assertEquals($expect, str_replace(array("\n", "\r", "\t"), '', $this->display('test')), 'Ensuring template is built correctly before modification');
+
+		$this->template->alter_block_array('outer', array(), false, 'delete');
+
+		$expect = 'outer - 0 - one[outer|3]middle - 0 - 1A[middle|1]outer - 1 - two[outer|3]middle - 0 - 2A[middle|2]middle - 1 - 2B[middle|2]outer - 2 - three[outer|3]middle - 0 - 3A[middle|3]middle - 1 - 3B[middle|3]middle - 2 - 3C[middle|3]';
+		$this->assertEquals($expect, str_replace(array("\n", "\r", "\t"), '', $this->display('test')), 'Deleting at the beginning of outer loop');
+
+		$this->template->alter_block_array('outer[0].middle', array(), true, 'delete');
+
+		$expect = 'outer - 0 - one[outer|3]outer - 1 - two[outer|3]middle - 0 - 2A[middle|2]middle - 1 - 2B[middle|2]outer - 2 - three[outer|3]middle - 0 - 3A[middle|3]middle - 1 - 3B[middle|3]middle - 2 - 3C[middle|3]';
+		$this->assertEquals($expect, str_replace(array("\n", "\r", "\t"), '', $this->display('test')), 'Deleting at the end of first middle loop, delete complete loop');
+
+		$this->template->alter_block_array('outer', array(), 1, 'delete');
+
+		$expect = 'outer - 0 - one[outer|2]outer - 1 - three[outer|2]middle - 0 - 3A[middle|3]middle - 1 - 3B[middle|3]middle - 2 - 3C[middle|3]';
+		$this->assertEquals($expect, str_replace(array("\n", "\r", "\t"), '', $this->display('test')), 'Deleting by index at top level');
+
+		$this->template->alter_block_array('outer.middle', array(), 1, 'delete');
+
+		$expect = 'outer - 0 - one[outer|2]outer - 1 - three[outer|2]middle - 0 - 3A[middle|2]middle - 1 - 3C[middle|2]';
+		$this->assertEquals($expect, str_replace(array("\n", "\r", "\t"), '', $this->display('test')), 'Deleting by index at middle level');
+
+		$this->template->alter_block_array('outer', array(), 4, 'delete');
+
+		$expect = 'outer - 0 - one[outer|2]outer - 1 - three[outer|2]middle - 0 - 3A[middle|2]middle - 1 - 3C[middle|2]';
+		$this->assertEquals($expect, str_replace(array("\n", "\r", "\t"), '', $this->display('test')), 'Deleting by index out of bounds, ignored');
+	}
+
+
 	public function assign_block_vars_array_data()
 	{
 		return array(
author	Marc Alexander <admin@m-a-styles.de>	2017-04-15 18:18:32 +0200
committer	Marc Alexander <admin@m-a-styles.de>	2017-04-15 18:18:32 +0200
commit	269150ed40d8cf42c2b8d755191b15229dc170c2 (patch)
tree	7be8527b0d529748c53abf2f1fadf22c05626625
parent	24f9a4165463d9a546c9868cb352c0283d976c27 (diff)
parent	136c74bd1c3d2ef1f22055d9bb14e6f524d41433 (diff)
download	forums-269150ed40d8cf42c2b8d755191b15229dc170c2.tar forums-269150ed40d8cf42c2b8d755191b15229dc170c2.tar.gz forums-269150ed40d8cf42c2b8d755191b15229dc170c2.tar.bz2 forums-269150ed40d8cf42c2b8d755191b15229dc170c2.tar.xz forums-269150ed40d8cf42c2b8d755191b15229dc170c2.zip