README.md

phpBB Forum Mapper

This is used to create presentable phpBB Forum structure.
For example in form of Table, Dropdown, ...etc... , But the most common is Table.

Remember to do the replacement of vendor\ext\path to Actual Path for namespace and use statements in Abstract Class, Extended Class and wherever required.

This is an Abstract Class that need's to be Inherited by Extended Class , as follows :

Example of Extended Class from Abstract Class

namespace vendor\ext\path;

use vendor\ext\path\forum_map;

/**
 * EXT Forum Mapper.
 */
class forum_map_ext extends forum_map
{
	/**
	 * Get forum custom SQL Array.
	 *
	 * @param array		$sql_ary	Forum SQL Array
	 *
	 * @return array
	 * @access protected
	 */
	protected function get_forums_cust_sql_ary($sql_ary)
	{
		// For one forum table column
		$sql_ary['SELECT'] .= ', f.vendor_ext_enable';
		// OR
		// For two or more forum table columns
		$sql_ary['SELECT'] .= ', f.vendor_ext_enable, f.vendor_ext_value';

		return $sql_ary;
	}

	/**
	 * Get forum custom template row.
	 *
	 * @param array		$row	Forum row
	 *
	 * @return array
	 * @access protected
	 */
	protected function get_forum_cust_tpl_row($row)
	{
		$tpl_row = [];
		if ($row['forum_type'] == FORUM_POST)
		{
			// Array to be joined with original `$tpl_row`
			$tpl_row = [
				'ENABLE'	=> $row['vendor_ext_enable'],
				// If more than one
				'VALUE'		=> $row['vendor_ext_value'],
			];
		}
		return $tpl_row;
	}
}

Usage of above Extended Class

global $db, $template, $phpbb_container;

// Class Initialization
$forum_map_rsi = new forum_map_ext($db);
// OR
// phpBB Container Initialization , as-per definition in EXT's `services.yml` here it's `vendor.ext.forum_map_ext`
$forum_map_rsi = $phpbb_container->get('vendor.ext.forum_map_ext');

// Run Main with No Parameter
$forum_tpl_rows = $forum_map_rsi->main();
// OR
// Run Main with Custom `Padding Spacer` Parameter
$forum_tpl_rows = $forum_map_rsi->main(' ');
// OR
// Run Main with Custom `Padding Spacer` & `Padding Symbol` Parameters
$forum_tpl_rows = $forum_map_rsi->main(' ', '↳');

// Use `$forum_tpl_rows` as-per your convenience
foreach ($forum_tpl_rows as $tpl_row)
{
	$template->assign_block_vars('forumrow', $tpl_row);
}

Done. 👍

GitHub Repository : phpbbForumMap

License GPLv2

---

EnJoY 😃
Best Regards. 👍