Hello World Module

[mightofnight]

How to use!

ok i ran out of time for the directions and i will add more detail later, i promise

but here goes.. let me know if i missed anything..


first files: add.php, delete.php, uninstall.php, index.php should not need to be modified.

I made all files load info.php so that they can get the mod name which solvs most of the problems in making a mod.  Otherwise changing the mod name would require changine it's name in probally at least 30 other spots..

Steps to making a mod..
1. edit info.php to your liking.. you can include any global vars that you might need in this file since it's included in all other files

2. Figure out what data you need to save and edit install.php.. look for the sql statement that should start on line 33.  this project only requires 1 variable so i have added this sql statement to add it's field. '`simple_output` VARCHAR(255) NOT NULL,'.  Most other projects will have many other data fields that need to be saved.. in this case i am only saving text that uset enters in a text box.

3. modify the modify.php file.. this is the file that is visiable in the admin section when the user is setting up the new page.

4. modify the save.php file this handels saving the fields from the modify.php file

5. modify the view.php file this handels the actuall output that the user sees..





Either dl attached mod or get it here:
http://mightofnight.com/forum/simple%20mod.zip

[attachment deleted because of being too old]

[pcwacht]

*Looks at documentation team ...

Thanks this will be very handy for the new bakers.

John

[Argos]

Eh.. what is a Hello World module??

[mightofnight]

http://www.mightofnight.com/pages/simple-mod.php  <--- example


it's a mod that is striped to it's smiplest form.  and in this case does one thing.. displays text entered in a text box..

its ment for someone who knows how to program but doesn't know whats needed to make a modual..

I plan on adding more comments and stuff if i get time in class

[Leigh]

This is excellent. IT's the sort of thing I was looking for, and started playing with myself.  I think it should be called "Anatomy of a Module" and put into the documentation. Good job!!

[coeus]

How do I download this? When i click on the link it says:

"It seems that you are not allowed to download or view attachments on this board.
Please login below or register an account with Website Baker 2 Community Forum."

[Woudloper]

How do I download this? When i click on the link it says:

"It seems that you are not allowed to download or view attachments on this board.
Please login below or register an account with Website Baker 2 Community Forum."

You need to login and create an account. As I see you already did this to post this message, so you should be able to download this module now...

[Woudloper]

@ mightofnight: I was looking just today at this 'Hello World' module and I must say I like the idea very much.

Would it be possible to do a bit more explenation in the source of the different files and explain what the use is of a specific file? Furthermore I would like to know how a 'settings' page can be created. Are you able to explain a bit more about that.

And last, but not least. In the source of the 'hello world' module it seems to be that there are some refers to another module (gallery).

[coeus]

You need to login and create an account. As I see you already did this to post this message, so you should be able to download this module now...

No, I can't for some reason, that's why I posted. I registered for an account, logged in, clicked on the link, but got that error message. I did the a bunch of times, can't seem to download the file, can one of the mods check my permissions?

[IrIT]

Hmm, i can't download it either. I log in, but when i want to download it, it says that i have to login. And i'm suddenly not logged in anymore?

[mightofnight]

I put a hard coded link for the DL now..

as far as this comment..
"And last, but not least. In the source of the 'hello world' module it seems to be that there are some refers to another module (gallery)."

this is probally because i took the pickle mod and stripped it down and i must have forgotten a thing or two.. Yes i agree it does need some documetation but i barly fould the time to strip the mod.. i am taking classes working 50+hrs a week.  working on a side project for another company and speining time with my GF..

It's hard to start explaining what it does cause it quicly starts to turn into a programming show and tell.  It is assumed that you are somewhat famiular with php and mysql. 

[Woudloper]

A question about the 'hello world' module, since one part of the module is not completely clear to me. Can someone tell me the logic behind the 'query start', 'query body' and 'query end'?

As some of you might have seen I am working an the Flickr Image Gallery Module and that module shouldn't turn up on the search page. Can I then just remove these lines or are  they used for something else?

[ruebenwurzel]

Hello,

as i see more and more users use this modul to create their own moduls. But i found a bug wich causes that all modules wich are developped with this hello world modul breaks the search.

Have no time yet, to create a bugfixed version will do this in the next days. Problem seems to be in install.php the search entries needs ".galtitle" table wich isn't present in this modul. This entry is from pickle gallery.

Matthias

[ruebenwurzel]

New Version of Hello World Modul

all modules wich are created based on the hello world module from above have the same errors as the hello world modul. This new version fixes (I hope) all this issues.

Changelog

• Fixed - wrong search table entries
• Fixed - search table are now deleted when modul is uninstalled
• Fixed - deleted wrong code from pickle gallery in different files
• Added -  some descriptions to better explain what happens in the different files
• Added - supports now WB 2.6.x
• Updated - all copyright notices include now 2006
• Changed -  All Files stored Unix konform now

Hope you like it

Matthias

[kickarse]

That's great! I've been working with the Paypal cart module and this will come in handy for making my own!

[SHRIKEE]

New Version of Hello World Modul

all modules wich are created based on the hello world module from above have the same errors as the hello world modul. This new version fixes (I hope) all this issues.

Changelog

• Fixed - wrong search table entries
• Fixed - search table are now deleted when modul is uninstalled
• Fixed - deleted wrong code from pickle gallery in different files
• Added -  some descriptions to better explain what happens in the different files
• Added - supports now WB 2.6.x
• Updated - all copyright notices include now 2006
• Changed -  All Files stored Unix konform now

Hope you like it

Matthias

doesnt work for me.
when i try to install it i see no errors.
but it doesn show up anywhere not even in the database wb_addons

i use wb2.6.2 on fc4 amd64

[ruebenwurzel]

Hello,

hello it should be stored in the database addons as "simple". Also you can create a new page or a new section in a page with the "Simple Module".

Matthias

[SHRIKEE]

Yea i figured as much,

but its not added to the addons table. the simple table is added.
Its no big deal tho, i figured out the plugin structure already and am working on one now.
I guess the file works for others...

[Argos]

It installs correctly. No errors, and it can be seen on the server with FTP. But it doesn't show up in the admin, and thus cannot be used, nor uninstalled.

[ruebenwurzel]

Hello,

look a few posts above. Create a new page and choose 'simple module' instead of WYSIWYG.

If the modul is not in the dropdown list, wich version of WB did you use? And maybe you use a table prefix?.

Have tested the modul over and over again and it works here. So i don't know where the issue could be.

Matthias

[Argos]

Hello,

look a few posts above. Create a new page and choose 'simple module' instead of WYSIWYG.

If the modul is not in the dropdown list, wich version of WB did you use? And maybe you use a table prefix?.

Have tested the modul over and over again and it works here. So i don't know where the issue could be.

Matthias

LOL, I know how to use a module

It's not available in the module list after installation. I use version 2.6.0, and no table prefix. The module can be seen in the database as "mod_simple". So it seems it installed fine, apart from being invisible in the admin module list.

[SHRIKEE]

it didnt work for me cuz the files were already online from a previous install. when i remove them it works.

[Argos]

Well, I cannot uninstall because it's not in the module list. And I cannot remove the files with FTP because I don't have the rights. Besides, I never installed it before. So that's no solution for me...

[SHRIKEE]

did you upload the files firsT? if so, remove them.

[Argos]

No, I just installed it like any other module. If I had uploaded the files I would have been able to remove them as well, wouldn't I?