Creating an Addon.

[DFx]

Should you point out at which step this error happened?

When I was done. I'm going to redo the whole thing.

 

[DarkSign]

Thank you very much. That helped me doing my first steps into developing add-ons for XF

 

[kkm323]

we need more from you Lawrence you earned the title

 

[Mr. Goodie2Shoes]

I need to create a database field when the add-on is installed, what do I have to do? I have created an "Installer.php" file, created call-back class and methods but cant seem to work.

Thanks

 

[Fuhrmann]

I need to create a database field when the add-on is installed, what do I have to do? I have created an "Installer.php" file, created call-back class and methods but cant seem to work.

Thanks

You create a variable to hold the SQL query for you, inside the Installer.php file example:

protected static $table = array(
        'createQuery' => 'CREATE TABLE IF NOT EXISTS `xf_my_table` (
                    `mytable_id` int(10) NOT NULL AUTO_INCREMENT,
                    `other_field` VARCHAR( 50 ) NOT NULL ,
                    `other_2_field` VARCHAR( 50 ) NOT NULL ,
                    `other_3_field` VARCHAR( 50 ) NOT NULL ,                   
                    PRIMARY KEY (`mytable_id`)
        ) ENGINE = InnoDB CHARACTER SET utf8 COLLATE utf8_general_ci;',
        'dropQuery' => 'DROP TABLE IF EXISTS `xf_my_table`'
);

Then, you create two functions, install() and uninstall():

public static function install()
    {
        //We get here the instance of the XenForo db.
        $db = XenForo_Application::get('db');
       
        //Tell the db to query our 'createQuery'.
        $db->query(self::$table['createQuery']);
    }

public static function uninstall()
    {
        //We get here the instance of the XenForo db.
        $db = XenForo_Application::get('db');
       
        //Tell the db to query our 'dropQuery', because we are uinstalling.
        $db->query(self::$table['dropQuery']);
    }

Then after, just set the two callbacks via the add-on manager and it's done!

 

[Mr. Goodie2Shoes]

okay... it works... the only thing I changed was "$table" to something else, was that the problem?

 

[Fuhrmann]

okay... it works... the only thing I changed was "$table" to something else, was that the problem?

No. You can name it whatever you want. Just make sure to change in the functions install() and uninstall() too.

 

[Mr. Goodie2Shoes]

oh sorry... I also changed createQuery and dropQuery... thats the problem?

 

[Fuhrmann]

oh sorry... I also changed createQuery and dropQuery... thats the problem?

Not. I just post it this way, using "dropQuery" and "createQuery" because this is how I use it in all my add-ons. Just make sure, again, to change in the both function too.

 

[Mr. Goodie2Shoes]

Not. I just post it this way, using "dropQuery" and "createQuery" because this is how I use it in all my add-ons. Just make sure, again, to change in the both function too.

and everything was same-to-same... weird... oh well might have missed something

 

[Fuhrmann]

and everything was same-to-same... weird... oh well might have missed something

But you can get it to work now?

 

[Mr. Goodie2Shoes]

But you can get it to work now?

yes, as I have mentioned earlier

okay... it works... the only thing I changed was "$table" to something else, was that the problem?

 

[Fuhrmann]

yes, as I have mentioned earlier

Nice!

 

[Mopquill]

I just wanted to thank you for this, Lawrence. I found it very informative, and I'm really happy someone wrote something like this. Thanks again. =]

 

[Lawrence]

I just wanted to thank you for this, Lawrence. I found it very informative, and I'm really happy someone wrote something like this. Thanks again. =]

Thanks. I may look at creating another one that writes to a database. I just need an idea for something simple that will need to store info. As I continue to develop my RP site, I will eventually come across something fairly simple that I want implemented and others may find beneficial, and that I will turn into a tutorial.

 

[Mopquill]

To an external database, or to XenForo's database? If you want a good educational tutorial, I'd probably suggest something where use of the database is not only necessary, but also helps streamline the process of whatever the addon deals with, especially if it's integrating new options into standard XenForo behavior. It would be a good way to show people how to have their addons work alongside XenForo without messing up the integrity or conventions that XenForo follows. I'm not used to MVC yet, but if there's any help I can offer, don't hesitate to let me know. Good luck. =]

 

[Lawrence]

Thanks for the offer, though I am getting pretty proficient with XF's data writers. I'll be adding a lot of small-ish code to my site and when I come across one that some here will find useful I'll create the tutorial off that.

 

[Luxus]

We can leave this function blank until we create a new options group in the AdminCP. If you are following along with each part, you can turn off this Add-on until we add in the code:

AdminCP home, and uncheck the Add-on Limit Signatures for new Members.

Just wanted to say that you shouldn't turn off the add-on at this point, because if you do, you can't create a new Options Group. You will get an error message that says that you need to turn on the add-on first.

 

[kcmartz]

Thanks! I am learning PHP so eventually I will contribute an add on

 

[digitalpoint]

I totally forgot to thank you for this thread. This is the thread that taught me how to build stuff for XenForo initially.

Kind of funny looking back now... The first hour of mucking with it, I remember I was like, "Deerrrrr what?" I think I've come a little ways since then.