Adding user profile fields with a product

[deadbydawn]

Hi all,

I am creating a product that I'd like to share with the community, but it requires a user-definable option that is placed within the UserCP. It is quite easy to add this manually via the User Profile Field Manager but I'm not finding a way to automate this during installation.

I did see almanni's article on Adding user options in usercp for mod's but frankly I'm still a bit confused and it doesn't seem as clean/easy as using the User Profile Field Manager.

I could simply make it part of the instructions for the installation, but I would love to be able to automate it to make it easier for the community.

Thanks!

[deadbydawn]

Well, I've figured out this much on my own from tearing apart the admincp/profilefield.php script.

PHP Code:

$db->query_write(fetch_query_sql($vbulletin->GPC['profilefield'], 'profilefield'));
$vbulletin->GPC['profilefieldid'] = $db->insert_id();
$db->query_write("ALTER TABLE " . TABLE_PREFIX . "userfield ADD field{$vbulletin->GPC['profilefieldid']} MEDIUMTEXT NOT NULL");
$db->query_write("OPTIMIZE TABLE " . TABLE_PREFIX . "userfield");


$db->query_write("
                        UPDATE " . TABLE_PREFIX . "profilefield SET
                                type = 'radio',
                                data = '" . $db->escape_string('a:2:{i:0;s:7:"Enabled";i:1;s:8:"Disabled";}') . "',
                                def = 0,
                                form = 3,
                                searchable = 0,
                                memberlist = 0
                        WHERE profilefieldid = " . $vbulletin->GPC['profilefieldid'] . "
                ");

$db->query_write("
                REPLACE INTO " . TABLE_PREFIX . "phrase
                        (languageid, fieldname, varname, text, product, username, dateline, version)
                VALUES
                        (
                                0,
                                'cprofilefield',
                                'field" . $db->escape_string($vbulletin->GPC['profilefieldid']) . "_title',
                                '" . $db->escape_string('Enable Quote Truncation') .  "',
                                'vbulletin',
                                '" . $db->escape_string('deadbydawn') . "',
                                " . TIMENOW . ",
                                '" . $db->escape_string($vbulletin->options['templateversion']) . "'
                        ),
                        (
                                0,
                                'cprofilefield',
                                'field" . $db->escape_string($vbulletin->GPC['profilefieldid']) . "_desc',
                                '" . $db->escape_string('This will automatically hide large amounts of text inside of a quote, similar to a spoiler tag') . "',
                                'vbulletin',
                                '" . $db->escape_string('deadbydawn') . "',
                                " . TIMENOW . ",
                                '" . $db->escape_string($vbulletin->options['templateversion']) . "'
                        )
        "); 


This works, but it leaves me with a question:

I need to be able to know which field is created with this process so that I can reference it later within the template as well as the uninstall script. I know that it is stored during the install as $vbulletin->GPC['profilefieldid'], but is there any way I can "store" that? It would be very convenient if there was a way I could reference that variable when creating the TEMPLATE.

The only thing I can think of is creating another db table that stores it, but that seems like overkill to me, and certainly isn't something I would want to add to something that hooks into the ShowThread_complete hook. Any other suggestions?

[consolegaming]

Create a VB Option for it and set it to hidden? And then alter it's value whilst your doing the rest of this stuff?

[Carnage]

That ^ seems like your best option imo.

Would you mind writing this up as an article once you've got it fully figured out; its something I may want to do in the future and having an easy to find reference would be great.

[deadbydawn]

Originally Posted by consolegaming

Create a VB Option for it and set it to hidden? And then alter it's value whilst your doing the rest of this stuff?

Forgive my ignorance here, I'm still learning how to code within the vbulletin world Do you mean creating a vboption in terms of the admincp->Settings->MyProduct sense? I was initially considering something like that, but it still leaves me confused with how to get the result of the db->insertID from the install code to populate something else. If you can give me a bit more of a push in the right direction, that'd be great!

Originally Posted by Carnage-

Would you mind writing this up as an article once you've got it fully figured out; its something I may want to do in the future and having an easy to find reference would be great.

I've actually already started writing part of it up for that exact purpose, just wanted to get some more understanding of it before I did (and I need to work on the removal process for uninstall code as well).

But yes, yes I will

[consolegaming]

Originally Posted by deadbydawn

Forgive my ignorance here, I'm still learning how to code within the vbulletin world Do you mean creating a vboption in terms of the admincp->Settings->MyProduct sense? I was initially considering something like that, but it still leaves me confused with how to get the result of the db->insertID from the install code to populate something else. If you can give me a bit more of a push in the right direction, that'd be great!

Yes I meant creating a setting for your product on the vb options section.

I've not really tried anything like it myself but looking in the DB I can see that settings you create through the method described above get added into the settings DB table. So I'd have thought you could just run a query to UPDATE the value field of the setting you create and searching by varname with whatever you call it.