Add chatbox_menu_template.php and chatbox_menu_shortcodes.php for chatbox_menu plugin.

[arunshekher]

@CaMer0n,
Please review and merge. If there are changes required please advice. Yet to remove old chat_template.php from plugin folder.

Add chatbox_menu_template.php and chatbox_menu_shortcodes.php, Introduce shortcode/template combination to render avatars in chat.php

Changes:

• Add chatbox_menu_template.php and chatbox_menu_shortcodes.php files.
• Add bootstrap3 styling for some elements in chat.php list view markup.
• Cleanup chat.php and chatbox_menu.php code generally and to replace legacy database calls with current standard.

Succeeded Tests:

• Load chatbox_menu_template.php in {e_PLUGIN}/chatbox_menu/templates/chatbox_menu_template.php
• Load chatbox_menu_template.php in {e_THEME}/templates/chatbox_menu/chatbox_menu_template.php

[CaMer0n]

Thanks @arunshekher Have you tested it with v1 theme templates that use the following code or similar?
jayya is one example..

$CHATBOXSTYLE = "
<img src='".e_IMAGE_ABS."admin_images/chatbox_16.png' alt='' style='width: 16px; height: 16px; vertical-align: bottom' />
<b>{USERNAME}</b><br />{TIMEDATE}<br />{MESSAGE}<br /><br />";

[arunshekher]

Yes, seems to render okay!

[arunshekher]

This is the setup I used, tested with PHP 5.6 as well.

[CaMer0n]

Thanks @arunshekher . It appears to be ignoring the template though?
Can you find admin_images/chatbox_16.png in the source?

[arunshekher]

Sure, I'll check that and amend the commit with the changes required.

[arunshekher]

Please re-review, I removed the code block that fetched legacy chatbox_menu template to render chatbox_menu when legacy themes were used.

[CaMer0n]

Thanks @arunshekher . I don't have time to check, but just wanted to confirm that $CHATBOXSTYLE is still respected when found?

[arunshekher]

Okay @CaMer0n, I apologize if it's too obvious, but could you re-confirm if this is what you mean:

In brief should the goal be that..

1. chatbox_menu.php should utilize the variable $CHATBOXSTYLE from legacy themes when available.
2. But be able to remove the static asset admin_images/chatbox_16.png from it which is not resolvable in v2.
3. And use the new $CHATBOX_MENU_TEMPLATE variable from the yet to be added {e_PLUGIN}chatbox_menu/templates/chatbox_menu_template.php in all other cases?

[arunshekher]

@CaMer0n, Is this acceptable:
Tested with jayya, lamb and crahan apart from v2 themes and seems to work as expected.

In chatbox_menu.php :

        global $CHATBOXSTYLE;

	if($CHATBOXSTYLE) // legacy chatbox style
	{
		$legacyChatIcon = e_IMAGE_ABS . 'admin_images/chatbox_16.png';
		$legacySrch = array('{USERNAME}', '{MESSAGE}', '{TIMEDATE}', $legacyChatIcon);
		$legacyRepl = array('{CB_USERNAME}','{CB_MESSAGE}','{CB_TIMEDATE}', '{CB_ICON_16}');


		$CHATBOX_TEMPLATE['start'] = '';
		$CHATBOX_TEMPLATE['item'] = str_replace($legacySrch, $legacyRepl, $CHATBOXSTYLE);
		$CHATBOX_TEMPLATE['end'] = '';
	}
	else 	// default chatbox style
	{
		$CHATBOX_TEMPLATE = e107::getTemplate('chatbox_menu', null, 'menu');
	}

In chatbox_menu_shortcodes.php :

	public function sc_cb_icon_16()
	{
		return e_PLUGIN . 'chatbox_menu/images/chatbox_16.png';
	}

[CaMer0n]

Thanks @arunshekher Looks good!

[arunshekher]

@CaMer0n, I've amended PR after making the changes in chatbox_menu.php file alone as follows:

global $CHATBOXSTYLE;

	if($CHATBOXSTYLE)  // legacy chatbox style
	{
		$legacyIconSrc = e_IMAGE_ABS . 'admin_images/chatbox_16.png';
		$currentIconSrc = e_PLUGIN . 'chatbox_menu/images/chatbox_16.png';

		$legacySrch = array($legacyIconSrc, '{USERNAME}', '{MESSAGE}', '{TIMEDATE}');
		$legacyRepl = array($currentIconSrc, '{CB_USERNAME}','{CB_MESSAGE}','{CB_TIMEDATE}');


		$CHATBOX_TEMPLATE['start'] = '';
		$CHATBOX_TEMPLATE['item'] = str_replace($legacySrch, $legacyRepl, $CHATBOXSTYLE);
		$CHATBOX_TEMPLATE['end'] = '';
	}
	else 	// default chatbox style
	{
		$CHATBOX_TEMPLATE = e107::getTemplate('chatbox_menu', null, 'menu');
	}

[CaMer0n]

This has no cache, so it could lead to a lot of queries. Use return e107::user($userId); instead.

[arunshekher]

@CaMer0n, thank you for the suggestion, I've updated the code in PR.

[CaMer0n]

Thank you @arunshekher !