Documentation Wiki

Team Roster Module Design Walkthrough

Welcome one and all...
I plan on writing this walkthrough as I go along and design this module for a site I am currently 'Postnuking' called Green County Roller Girls∞. Since I don't know what level of programmer you are currently, I will be making a LOT of assumptions. Mostly I will go along with my flow of writing and teaching, if you have a problem with that? Then please visit the main site's Developer Documentation area and be happy. Otherwise, come along and quit yer sniveling.

For Zikula specific Module Design Walkthroughs, please refer back to: Module Programming Part 1
I will try to avoid duplicating detailed instructions from there except where I feel clarification is needed or if a point needs to be made. Also, I have never worked with the pnWikki? package, so it will be a little slow going as I learn both this system, and get better re-acquainted with the Zikula Module system.

I am going to assume that you have done the following:

1. Downloaded and Installed Zikula already.
2. Are comfortable with PHP to at least the level where you can edit PHP files without too much worry.

I am also going to assume that you are working with the new 0.8 MS2 Zikula. Phoenix is a great package, but why settle for the old stuff? Anyway...

With those specifications out of the way, we can move on...

Web Application Development

Zikula Modules are, at their simplest, Web Applications developed Modularly. When developing a Web App ( or any other kind of app ) you generally would create ALL the pieces you need and then package it together. However, with Zikula, you are given a complete system that your module will ADD TO. The basic system is already built for you. User Management, News Management, Security Development, etc. All you have to build the part of your website that ISN'T already put together.

The nice thing about this, besides the obvious, is that your module can tie into other modules, run on its own, or connect with other websites / packages as you see fit. It all boils down to your PHP skills and abilities. If PHP can do it? You can make Zikula do it.

Zikula Module Layout

If you need details on 'How to layout the folder structure of a module' then you should check out the developer documentation on module development.

If you look in the 'Value Addons' folder of modules you will see quite a list of modules. Now remember, think of each folder as a separately installable web application. Autolinks, Downloads, Polls, etc. When developing a module, I 'Very Much' prefer to select one of the Example Modules and edit as needed. It helps to layout the basics ( even those files I won't be using ) and organize my thoughts. However, that was in the old Zikula... Phoenix. 0.7.6.2, we are developing this module for 0.8 MS2. We have '3' different Example Modules.

1. Example : This module seems to resemble the old 0.7.6.2 Zikula Modules the most for me.
2. ExampleDB? : This module uses some new Zikula DB Commands.
   As much as I LOVE Databases ( seriously, I do ), I think I will shy away from this one because it would mean ALOT more learning.
3. ExampleObj? : This module uses a new Object Oriented approach. I will DEFINITELY be using this in the future. But since I don't have the time to learn AND develop a module right now? I will not be going in this direction.

So, we will be developing based on the 'Example' module. This means a certain layout of the directory structure. If you look to the right you should see the directory structure of the Example Module. I will be converting each page of this Module to a linkable page. This way I can adjust each page as needed.

---

Module Development :: Database Design and Layout