vB4 plugin problem - Not showing in profile

[AfterWorldForum]

Hi everyone,

My forum uses the opt-out forums modification which enables users to select certain (sub) forums from showing up on their "New posts" searches. We're upgrading to vB4 during the weekend, but the mod has not been converted for vB4 yet.

I have attempted converting it myself, in order to ensure my users can continue using the functionality offered by it, but seem to be running into some trouble with getting it to show up. I am hoping someone here might be able to help me figure out where I am going wrong.

Let's have a look at the plugin code first. It's been set to the hook profile_editoptions_start:


function fetch_optout_forumids_array($parentid = -1, $depthmark = '')
{
global $optoutforumids, $vbulletin;
static $indexed_forum_cache;

if ($parentid == -1)
{
$optoutforumids = array();
$indexed_forum_cache = array();
foreach ($vbulletin->forumcache AS $forumid => $forum)
{
$indexed_forum_cache["$forum[parentid]"]["$forumid"] =& $vbulletin->forumcache["$forumid"];
}
}

if (is_array($indexed_forum_cache["$parentid"]))
{
foreach ($indexed_forum_cache["$parentid"] AS $forumid => $forum)
{
$forumperms =& $vbulletin->userinfo['forumpermissions']["$forumid"];
if ($forum['displayorder'] != 0
AND ($forumperms & $vbulletin->bf_ugp_forumpermissions['canview'])
AND ($forumperms & $vbulletin->bf_ugp_forumpermissions['cansearch'])
AND ($forumperms & $vbulletin->bf_ugp_forumpermissions['canoptoutgnp'])
AND ($forum['options'] & $vbulletin->bf_misc_forumoptions['active'])
AND verify_forum_password($forum['forumid'], $forum['password'], false)
)
{
$vbulletin->forumcache["$forumid"]['depthmark'] = $depthmark;
$optoutforumids[] = $forumid;
fetch_optout_forumids_array($forumid, $depthmark . FORUM_PREPEND);
}
}
}
}
fetch_optout_forumids_array();
$optoutforumbits = '';
$haveforum = false;
$gnpoptoutforums = explode(',', $vbulletin->userinfo['excludeforumsgnp']);

foreach ($optoutforumids AS $forumid)
{
$forum =& $vbulletin->forumcache["$forumid"];

if (trim($forum['link']))
{
continue;
}

$optionvalue = $forumid;
$optiontitle = "$forum[depthmark] $forum[title_clean]";
$optionclass = 'fjdpth' . (($forum['depth'] > 4) ? '4' : $forum['depth']);

if (in_array($forumid, $gnpoptoutforums))
{
$optionselected = 'selected="selected"';
$haveforum = true;
}
else
{
$optionselected = '';
}

$templater = vB_Template::create('option');
$templater->register('optionvalue', $optionvalue);
$templater->register('optiontitle', $optiontitle);
$templater->register('optionclass', $optionclass);
$templater->register('optionselected', $optionselected);
$templater->register('show', $show);
$optoutforumbits = $templater->render();
}
$show['optoutgnp'] = sizeof($optoutforumids) > 0;


And this is the changes made to the option template (right below {vb:raw customfields.other})

<div class="blockrow">

<legend>{vb:phrase exclude_forums_from_gnp}</legend>
<div><phrase>{vb:phrase exclude_forums_from_gnp_desc, {session.sessionurl}}</phrase></div>
<label for="sel_optoutgnp">{vb:phrase exclude_forums}:</label>
<select style="width: 100%" size="13" name="optoutgnp[]" id="sel_optoutgnp" multiple="multiple">
<option value="">{vb:phrase none}</option>
{vb:raw optoutforumbits}
</select>
</div>


It looks alright to me, but I cannot see anything happening whenever I go to my profile and select the settings. Any ideas, please?

Thanks in advance :)

Peter

[Lynne]

You will need to register (preregister) the variable for use in that template. Cellarius wrote a really good article that you may be interested in - [vB4] Rendering templates and registering variables - a short guide (https://vborg.vbsupport.ru/showthread.php?t=228078)

[AfterWorldForum]

Hi Lynne, and thanks for responding.

The article has been very helpful before, so I definitly used it while converting the rest of my forum. I think I did try the preregister before.

I changed the code just now and tested, but I still cannot see the list I am expecting. Using debug mode, I can see that the option template is being loaded, and that it is actually processed a few times (which would make sense, seeing it loops through the whole list of forums and is supposed to add a line for every forum), but nothing is being rendered.

This seriously has had me stumped for a while now, hence trying to see if anyone would be able to offer some help here. Sometimes one overlooks somethign incredibly simple, and a few other eyes easily will spot the error. Alternatively, are there any good tutorials on writing plugins for vB4 anywhere?

[Lynne]

And what code are you using to preregister it and where?

[AfterWorldForum]

And what code are you using to preregister it and where?

Hi Lynn,

The block of code dealing with the template now looks like this:


$templater = vB_Template::create('mytemplate');
$templater->register('optionvalue', $optionvalue);
$templater->register('optiontitle', $optiontitle);
$templater->register('optionclass', $optionclass);
$templater->register('optionselected', $optionselected);
$templater->register('show', $show);
$templatevalues['$optoutforumbits'] = $templater->render();
vB_Template::preRegister('option', $templatevalues);


I also tried using $templater = vB_Template::create('option'); by the way. Also no luck.

The only other change I made was to replace $vbulletin->userinfo with $bbuserinfo. Other than that, the code is the same as above.

[Lynne]

According to your code, you preregistered to use a variable called "option", but that variable isn't in your template at all.

[AfterWorldForum]

According to your code, you preregistered to use a variable called "option", but that variable isn't in your template at all.

Hi Lynne,

That does not seem to correspond to the article by Cellarius, or this article (http://www.vbulletin.com/forum/entry.php?2387-Pushing-your-variables-to-vBulletin-4-templates).

I take these to mean that the first variable is the name of the template to preregister the variable for. In my case, that is option (I think. I want it in the Settings (Formerly known as User CP) / General Settings).

However, I did notice that I left in a dollarsign in front of the optoutforumbits line prior to the preRegister. Fixing that, however, did nothing to improve the situation :(

[Lynne]

Whoops, I read that wrong. But, this is the format I use to preregister variables (my cheatsheet blurb below):

vB_Template::preRegister('FORUMHOME', array('uid' => $uid)); Now you can use {vb:raw uid} in the FORUMHOME template

According to what you wrote above (without extra $):
$templatevalues['optoutforumbits'] = $templater->render();
vB_Template::preRegister('option', $templatevalues);
The variable you would be using in the template would be {vb:raw templatevalues.optoutforumbits}

[AfterWorldForum]

Thanks, Lynne. I tried substituting my variable and included the templatevalues, but to no result.

I will rewrite the code in the plugin to the way you posted, and see if that does anything.

Thanks again.

[Eric]

Looking at your code, in the foreach loop you may want to change:

$optoutforumbits = $templater->render();

To:
$optoutforumbits .= $templater->render();

[AfterWorldForum]

Looking at your code, in the foreach loop you may want to change:

$optoutforumbits = $templater->render();

To:
$optoutforumbits .= $templater->render();

Ack. I initially had that.

Changed and tested, but still a surprising lack of the control in my options.

I just do not get it. To the best of my knowledge, this should be doing the trick. All articles I read here and all the advice I had seems to suggest this ought to work, but it does not. Very odd, indeed.

I might try and start from scratch with a new plugin and work my way up from there.

[Lynne]

Why don't you post the exact code you are using right now so we can try it out on our own test sites and see what is up.

[AfterWorldForum]

Hi Lynne,

Sure.

Here's the code from the plugin:


function fetch_optout_forumids_array($parentid = -1, $depthmark = '')
{
global $optoutforumids, $vbulletin;
static $indexed_forum_cache;

if ($parentid == -1)
{
$optoutforumids = array();
$indexed_forum_cache = array();
foreach ($vbulletin->forumcache AS $forumid => $forum)
{
$indexed_forum_cache["$forum[parentid]"]["$forumid"] =& $vbulletin->forumcache["$forumid"];
}
}

if (is_array($indexed_forum_cache["$parentid"]))
{
foreach ($indexed_forum_cache["$parentid"] AS $forumid => $forum)
{
$forumperms =& $bbuserinfo['forumpermissions']["$forumid"];
if ($forum['displayorder'] != 0
AND ($forumperms & $vbulletin->bf_ugp_forumpermissions['canview'])
AND ($forumperms & $vbulletin->bf_ugp_forumpermissions['cansearch'])
AND ($forumperms & $vbulletin->bf_ugp_forumpermissions['canoptoutgnp'])
AND ($forum['options'] & $vbulletin->bf_misc_forumoptions['active'])
AND verify_forum_password($forum['forumid'], $forum['password'], false)
)
{
$vbulletin->forumcache["$forumid"]['depthmark'] = $depthmark;
$optoutforumids[] = $forumid;
fetch_optout_forumids_array($forumid, $depthmark . FORUM_PREPEND);
}
}
}
}
fetch_optout_forumids_array();
$optoutforumbits = '';
$haveforum = false;
$gnpoptoutforums = explode(',', $bbuserinfo['excludeforumsgnp']);

foreach ($optoutforumids AS $forumid)
{
$forum =& $vbulletin->forumcache["$forumid"];

if (trim($forum['link']))
{
continue;
}

$optionvalue = $forumid;
$optiontitle = "$forum[depthmark] $forum[title_clean]";
$optionclass = 'fjdpth' . (($forum['depth'] > 4) ? '4' : $forum['depth']);

if (in_array($forumid, $gnpoptoutforums))
{
$optionselected = 'selected="selected"';
$haveforum = true;
}
else
{
$optionselected = '';
}

$templater = vB_Template::create('mytemplate');
$templater->register('optionvalue', $optionvalue);
$templater->register('optiontitle', $optiontitle);
$templater->register('optionclass', $optionclass);
$templater->register('optionselected', $optionselected);
$templater->register('show', $show);
$optoutforumbits = $templater->render();
vB_Template::preRegister('option', array('optoutforumbits' => $optoutforumbits));

}
$show['optoutgnp'] = sizeof($optoutforumids) > 0;

And this is the code from the template (below {vb:raw customfields.other}):


<div class="blockrow">
<legend>{vb:phrase exclude_forums_from_gnp}</legend>
<div><phrase>{vb:phrase exclude_forums_from_gnp_desc, {session.sessionurl}}</phrase></div>
<label for="sel_optoutgnp">{vb:phrase exclude_forums}:</label>
<select style="width: 100%" size="13" name="optoutgnp[]" id="sel_optoutgnp" multiple="multiple">
<option value="">{vb:phrase none}</option>
{vb:raw optoutforumbits}
</select>
</div>


Thanks again for your assistance.

[Lynne]

I'm surprised you were able to save your template when you had {session.sessionurl} instead of {vb:raw session.sessionurl}. It gave me an error until I corrected it.

This is supposed to show up on my Settings > General Settings page, right? I have it there, but it is not the "options" template, it is the "modifyoptions" template that it goes into and needs to be preregistered in. And, you didn't supply me with the contents of "mytemplate", so I can't see any output anyway. But, there is something there, it's just incomplete because you didn't provide me with the other needed info.

[AfterWorldForum]

Hi Lynne,

Thank you. That seems to have done the trick. I now see something happening at least. It's not yet what I expected or needed, but it's way better than not seeing anything at all.

I am assuming it did not work because even though the option template was being evaluated, that was not the right template.

Thanks agian for your help. I'll see what I still need to do to get the rest working, but this is definitly an encouragement :)

Peter