Go Back   vb.org Archive > vBulletin Article Depository > Read An Article > vBulletin 3 Articles
Reload this Page Creating Custom Datamanagers
FAQ Community Calendar Today's Posts Search

Reply
Page 2 of 3 1 2 3
 
Thread Tools
Creating Custom Datamanagers
Alan @ CIT
Join Date: Nov 2004
Posts: 625

 

South UK
Show Printable Version Email this Page Subscription
Alan @ CIT Alan @ CIT is offline 06-21-2006, 10:00 PM
Note: Originally posted here: https://vborg.vbsupport.ru/showthrea...43#post1013143

-------------------------------------------------

Creating Custom Datamanagers


This article will show you the basics of creating your own fully working Datamanager.
To start with, create your new PHP file to hold your DM code and save it as
includes/class_dm_example.php

Now, the first thing we need to do is check that the vB_Datamanger class exists - without that, we can't do much of anything.

At the top of your new PHP file, put:

PHP Code:
if (!class_exists('vB_DataManager'))
{
exit;
} 
This will end the script if the vB_Datamanger class doesn't exist.

Now we need to extend the vB_DataManager class to make our own Datamanager.

On the next line down in your PHP file, put:

PHP Code:
class vB_DataManager_Example extends vB_DataManager
{ 
This tells PHP that we want to create a Class called "vB_DataManager_Example", and that we want to base it on the vB_DataManager class. This means that our new DM class will inherit all of the vB_DataManagers variables and methods (functions) so we don't have to make our own save() method for example

Now we need to give our new Datamanager some fields to update. For example, the User DM would have fields such as "userid", "username", "email", etc. These fields will usually be the same as the columns in your database table.

These fields all go in an array called $validfields. The $validfields array is in the following format:

PHP Code:
'fieldname' => array(type, required?, verify data?, function name to verify data) 
The verificatoin options (the last 2) are optional.

With that in mind, lets start adding to our own $validfields array. Our example datamanager will have 4 fields:

'exampleid' - this is an auto increment field from the database which is incremented automaticly.
'userid' - a vBulletin user id
'username' - a vBulletin username
'exampletext' - some random text

First things first, lets create our $validfields array variable.

PHP Code:
var $validfields = array( 
Now we can add our first field:

PHP Code:
'exampleid' => array(TYPE_UINT, REQ_INCR, VF_METHOD, 'verify_nonzero'), 
Lets go through this line bit by bit.

First we have the field name - in this case 'exampleid'.
Next we have the type - in this case we're saying it will be an Unsigned Int (ie, a number). A list of valid types can be found at the bottom of this post.
Next we specify that it is required, and that it is an auto-increment value with REQ_INCR. Valid options for this field can be found at the bottom of this post.
Next we tell it that we want to verify the data, with VF_METHOD
And finally, we give it the name of a function to verifiy the data with. In this case, we are using the verify_nonzero() function which is a standard function in the vB_DataManager class.

Now we can add our other 3 fields to the $validfields array:

PHP Code:
'userid' => array(TYPE_UINT, REQ_YES, VF_METHOD, 'verify_nonzero'),
'username' => array(TYPE_STR, REQ_YES),
'exampletext' => array(TYPE_STR, REQ_NO)
); 
This has added a further 3 fields to the $validfields, and closed the $validfields array

Now, the next step is to tell vBulletin what table to save our data in. Your table should match the $validfields array in terms of layout and column names.

In this case, we'll use a table called "example":

PHP Code:
var $table = 'example'; 
Now we have to give vBulletin a temporary array that it uses to store the data we give it when it's saving to out database table that we specified above. It doesn't really matter what this is called, but for convention, try to stick with the name of your DM class

PHP Code:
var $example = array(); 
The final step in our very basic Datamanager is to create our Class Initator method. This is a function that is run automaticly when our Example Datamanager is created using datamanager_init().

PHP Code:
 function vB_DataManager_Example(&$registry, $errtype = ERRTYPE_STANDARD)
{
parent::vB_DataManager($registry, $errtype);
} 
The name of this functoin should be exactly the same as your class name. So in this case, we've called it "vB_DataManager_Example".

You don't need to worry about the rest of the code, and if you understand OOP, you'll know what it means

Now, all we've got left to do is add our closing bracket for our class, and we're done:

PHP Code:
} 
You can now create your new Datamanager as you would any standard Datamanager by using the datamanager_init() function

That's the gist of it anyway, take a look at some of the existing Datamanagers for more advanced options such as Bitfields, custom verify methods, etc.

Valid field types:
  • TYPE_NOCLEAN - Any value - it won't be checked/cleaned
  • TYPE_INT - An signed integer
  • TYPE_UINT - An un-signed integer
  • TYPE_NUM - A number
  • TYPE_UNUM - An un-signed number
  • TYPE_UNIXTIME - A unix timestamp (time())
  • TYPE_STR - A string
  • TYPE_NOTRIM - A string that won't have trim() run on it
  • TYPE_NOHTML - A string that will have the HTML made-safe
  • TYPE_FILE - A file upload (ie, $_FILES)
  • TYPE_BOOL - A bool (true or false)
You can also pass Arrays of these items. For example to pass an array of INT's, use TYPE_ARRAY_INT. To pass an array of Strings, use TYPE_ARRAY_STR

Valid Requirement Options:

(The following is taken directly from vBulletin's DataManager documentation)

Quote:
REQ_YES - the field is required

REQ_NO - the field is not required

REQ_AUTO - the field can be automatically generated. The does not have any effect on code execution at this time. This is appropriate for things like post times that can be reasonably guessed before inserting the new data. (You will still need to write code to generate the appropriate value!)

REQ_INCR - this field is an AUTO_INCREMENT field in the database, and thus will be automatically generated upon insertion.
-------------------------------------------------

Good luck using your new found knowledge of the vBulletin Input Cleaner class, and remember: If you get stuck, just ask! Knowledge sharing is what vBulletin.org is all about!

(Note: If you want to reproduce this article anywhere, I have no objections, but I do request that you give me credit for writing it, and a PM letting me know would be appreciated )
Attached Files
File Type: php class_dm_example.php (678 Bytes, 280 views)
Reply With Quote
  #12  
Old 07-09-2006, 10:31 PM
Code Monkey's Avatar
Code Monkey Code Monkey is offline
 
Join Date: May 2004
Posts: 1,080
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Well, I tried it with a simple table and nothing got inserted. So there must be something more to this.
Reply With Quote
  #13  
Old 07-10-2006, 05:58 AM
Alan @ CIT Alan @ CIT is offline
 
Join Date: Nov 2004
Location: South UK
Posts: 625
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Check the $errors array to see if there where any problems.

Alternativly, PM me your datamanager PHP file, and the PHP your using to test it, and I'll take a look.

The code above will (well, works here) work without changes though

Thanks,
Alan.
Reply With Quote
  #14  
Old 07-10-2006, 07:14 AM
Guest190829
Guest
  
Posts: n/a
Default
Alan,

Shouldn't

PHP Code:
'username' => array(TYPE_STR, REQ_YES, VF_METHOD), 
be:

PHP Code:
'username' => array(TYPE_STR, REQ_YES), 
As verify_username does not exist in the base class. (It does in class_dm_user.php)
Reply With Quote
  #15  
Old 07-10-2006, 10:05 AM
Alan @ CIT Alan @ CIT is offline
 
Join Date: Nov 2004
Location: South UK
Posts: 625
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
That'll teach me to base my example of the User DM

Edited first post
Reply With Quote
  #16  
Old 07-17-2006, 06:24 PM
Antivirus's Avatar
Antivirus Antivirus is offline
 
Join Date: Sep 2004
Location: Black Lagoon
Posts: 1,090
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
So with the help of this tuitorial, I could create a data manager for creating User Notes about members, correct?
Reply With Quote
  #17  
Old 07-17-2006, 06:25 PM
Alan @ CIT Alan @ CIT is offline
 
Join Date: Nov 2004
Location: South UK
Posts: 625
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Correct.

Thanks,
Alan.
Reply With Quote
  #18  
Old 07-17-2006, 10:19 PM
Antivirus's Avatar
Antivirus Antivirus is offline
 
Join Date: Sep 2004
Location: Black Lagoon
Posts: 1,090
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
sweet, going to give this a try shortly. thanks!
Reply With Quote
  #19  
Old 01-25-2007, 08:39 PM
stryka stryka is offline
 
Join Date: Aug 2002
Posts: 201
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
THis was a great tutorial... and I am able to use it for inserting records... But what about the UDPATE function?

Can you spell out how the UPDATE function works when using a Custom DataManager?

I am not sure how it works and how it gets the current record...

I'd like to also know when DM's should be used.... vs a simple INSERT statement within the file...

thanx
Reply With Quote
  #20  
Old 03-17-2007, 04:58 AM
harmor19 harmor19 is offline
 
Join Date: Apr 2005
Posts: 1,324
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
Quote:
Originally Posted by stryka View Post
THis was a great tutorial... and I am able to use it for inserting records... But what about the UDPATE function?


Can you spell out how the UPDATE function works when using a Custom DataManager?

I am not sure how it works and how it gets the current record...

I'd like to also know when DM's should be used.... vs a simple INSERT statement within the file...

thanx

I believe you would use $var->condition = "exampleid = 1";

PHP Code:
$example =& vB_DataManager_Example($vbulletin, ERRTYPE_ARRAY);  
$example->condition = "exampleid = 1";
$example->set('userid', 1);
$example->set('username', 'harmor19');
$example->set('exampletext', 'Testing');
$example->save(); 
If I'm right it should update the table where exampleid is equal to "1".
Reply With Quote
  #21  
Old 06-02-2007, 02:31 PM
Antivirus's Avatar
Antivirus Antivirus is offline
 
Join Date: Sep 2004
Location: Black Lagoon
Posts: 1,090
Благодарил(а): 0 раз(а)
Поблагодарили: 0 раз(а) в 0 сообщениях
Default
So i have written two custom datamanagers, one saves/updates the main info, while I use the other (within a loop) to update the related records.

I have to call the database from within each of the DMs to update some other tables with related info as well, and while looking at vbulletin's existing datamanagers, i see more than one method of calling the database, for example:

Within class_dm_threadpost some calls to thge database are made like this:
Code:
$this->dbobject->query_write
However within class_dm_infraction, calls are made like this:
Code:
$this->registry->db->query_write
What I want to know, is why is one method used in one instance, and another in another? I think both acheive exactly the same results but why are jelsoft using different methods to call the database?
Reply With Quote
Reply
Page 2 of 3 1 2 3

« Previous Thread | Next Thread »

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts
BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Forum Jump


All times are GMT. The time now is 06:08 PM.

Contact Us - Archive - Top

Powered by vBulletin® Version 3.8.12 by vBS
Copyright ©2000 - 2024, vBulletin Solutions Inc.
X vBulletin 3.8.12 by vBS Debug Information
  • Page Generation 0.05076 seconds
  • Memory Usage 2,353KB
  • Queries Executed 26 (?)
More Information
Template Usage:
  • (1)SHOWTHREAD
  • (1)ad_footer_end
  • (1)ad_footer_start
  • (1)ad_header_end
  • (1)ad_header_logo
  • (1)ad_navbar_below
  • (1)ad_showthread_beforeqr
  • (2)bbcode_code
  • (13)bbcode_php
  • (2)bbcode_quote
  • (1)footer
  • (1)forumjump
  • (1)forumrules
  • (1)gobutton
  • (1)header
  • (1)headinclude
  • (1)modsystem_article
  • (1)navbar
  • (4)navbar_link
  • (120)option
  • (1)pagenav
  • (1)pagenav_curpage
  • (2)pagenav_pagelink
  • (11)post_thanks_box
  • (11)post_thanks_button
  • (1)post_thanks_javascript
  • (1)post_thanks_navbar_search
  • (11)post_thanks_postbit_info
  • (10)postbit
  • (1)postbit_attachment
  • (10)postbit_onlinestatus
  • (11)postbit_wrapper
  • (1)spacer_close
  • (1)spacer_open
  • (1)tagbit_wrapper 
Phrase Groups Available:
  • global
  • inlinemod
  • postbit
  • posting
  • reputationlevel
  • showthread
Included Files:
  • ./showthread.php
  • ./global.php
  • ./includes/init.php
  • ./includes/class_core.php
  • ./includes/config.php
  • ./includes/functions.php
  • ./includes/class_hook.php
  • ./includes/modsystem_functions.php
  • ./includes/functions_bigthree.php
  • ./includes/class_postbit.php
  • ./includes/class_bbcode.php
  • ./includes/functions_reputation.php
  • ./includes/functions_post_thanks.php 
Hooks Called:
  • init_startup
  • init_startup_session_setup_start
  • init_startup_session_setup_complete
  • cache_permissions
  • fetch_threadinfo_query
  • fetch_threadinfo
  • fetch_foruminfo
  • style_fetch
  • cache_templates
  • global_start
  • parse_templates
  • global_setup_complete
  • showthread_start
  • showthread_getinfo
  • forumjump
  • showthread_post_start
  • showthread_query_postids
  • showthread_query
  • bbcode_fetch_tags
  • bbcode_create
  • showthread_postbit_create
  • postbit_factory
  • postbit_display_start
  • post_thanks_function_post_thanks_off_start
  • post_thanks_function_post_thanks_off_end
  • post_thanks_function_fetch_thanks_start
  • post_thanks_function_fetch_thanks_end
  • post_thanks_function_thanked_already_start
  • post_thanks_function_thanked_already_end
  • fetch_musername
  • postbit_imicons
  • bbcode_parse_start
  • bbcode_parse_complete_precache
  • bbcode_parse_complete
  • postbit_attachment
  • postbit_display_complete
  • post_thanks_function_can_thank_this_post_start
  • pagenav_page
  • pagenav_complete
  • tag_fetchbit_complete
  • forumrules
  • navbits
  • navbits_complete
  • showthread_complete