Changes between Initial Version and Version 1 of DolphinTutorialMyFirstModule

Timestamp:

Jan 29, 2010, 4:41:18 AM (15 years ago)

Author:

AlexT

Comment:

--

DolphinTutorialMyFirstModule

@@ +1 @@
+
+== Dolphin 7 Tutorial: My First Module ==
+
+
+== 1. Getting Started. ==
+ 
+In this tutorial we will create a simple Dolphin module. In the beginning, this module will show a text page only. Then, we will add an admin section for the module. At the end we will create some basic functionality, like a blog system.
+
+In this tutorial we will create a simple Dolphin module. In the beginning, this module will show a text page only. Then, we will add an admin section for the module. At the end we will create some basic functionality, like a blog system.
+
+This tutorial covers things like a simple module structure, creating user pages and admin pages, creating config values for your module, forms and adding admin menu items.
+
+The main purpose of this tutorial is to help you get started with the new Dolphin 7 modules structure and basic functionality.
+
+To proceed with this tutorial you need:
+
+    * already installed Dolphin 7, you can get the latest Dolphin version [http://www.boonex.com/dolphin/download/ here] and detailed installation instructions are [http://www.boonex.com/trac/dolphin/wiki/DetailedInstall70 here].
+    * basic PHP knowlege, object oriented programming knowledge is more than welcome. You can learn about PHP [http://www.php.net/ here].
+    * basic MySQL queries knowledge, you can learn about MySQL server and MySQL queries syntax [http://www.mysql.com/ here].
+
+
+The things you will not get in this tutorial:
+
+    * will not teach you PHP, MySQL, Javascript, HTML, CSS
+    * will not teach you how to edit and upload files to the server
+    * will not teach you about every Dolphin feature. There are many Dolphin features which are more complex, and mentioning them here may detract you from the main purpose of this tutorial. For a complete list of Dolphin programming features and references to the documentation in the code, check [http://www.boonex.com/trac/dolphin/wiki/DolModDev here].
+    * will not tech you how to create new templates. A templates creation guide is [http://www.boonex.com/trac/dolphin/wiki/DolDesign here].
+    * will not teach you how to translate Dolphin to other languages. A translation manual is [http://www.boonex.com/trac/dolphin/wiki/DolLang here].
+    * will not teach security aspects of writing the code. You are responsible if you are hacked through your own module.
+
+
+Learning Dolphin gives you many advantages:
+
+    * you will be able to make modifications to your site
+    * if you are writing a modification, especially as a Dolphin module, it will allow you to transfer your modification more easily between Dolphin version upgrades.
+    * you can make money by selling your modifications in [http://www.boonex.com/unity/extensions/home Unity Market] or offering your service for others in the same [http://www.boonex.com/unity/extensions/home Unity Market]. 
+    * it will help you to get certified - because there are strict requirements if you want to certify your mod.
+
+
+Let's start with the simplest thing in the beginning.
+
+
+==  2. Simplest module. ==
+
+There is a prepared zip package with the simplest Dolphin 7 module here(TODO:bloggie.zip). Download it, unpack and upload to the '''modules/me/''' folder. Most probably there is no me folder in the modules directory, so just create it by yourself. '''Me''' is a vendor name. For the real module, you need to rename it to the real vendor name, but for now '''me''' is fine for everybody. It will be the '''bloggie''' folder in the  '''modules/me/''' directory. Bloggie is the module name. It is good practice to name the folder where module's files are located with the name of the module, it is just more clear. In the end it will be some type of blog module with the name Bloggie.
+
+Lets describe each file in the module. This is almost the minimal set of files for the module:
+
+'''bloggie/classes''' [[BR]]
+directory with all module classes
+
+'''bloggie/classes/MeBlggConfig.php''' [[BR]]
+Module config class. In most cases you don't need to modify it - it inherits system class which has all the necessary functionality to get configuration values.
+
+'''bloggie/classes/MeBlggDb.php''' [[BR]]
+Module database class. It is strongly recommended that you write all SQL queries in this class only, then you can call ready functions from the code.
+
+'''bloggie/classes/MeBlggModule.php''' [[BR]]
+Module controller class - where the main work happens.
+
+'''bloggie/classes/MeBlggTemplate.php''' [[BR]]
+Module template class. You don't need to change this class. All the necessary functionality is inherited from the base class.
+
+'''bloggie/install''' [[BR]]
+Module installation directory, where all installation files are located, like SQL files and language files.
+
+'''bloggie/install/config.php''' [[BR]]
+Module installation config file. We will take a closer look at this later.
+
+'''bloggie/install/info''' [[BR]]
+Installation information messages folder. If you need to display information messages upon module install/uninstall, you will need to place files here - also special instructions are needed to point to in the install config file to display these messages properly.
+
+'''bloggie/install/installer.php''' [[BR]]
+Module installer class. You can add some custom installation scripts and override default behavior.
+
+'''bloggie/install/langs''' [[BR]]
+Module languages must be located in this dir. The language file name must be a php file with the name of two letters of the language code.
+
+'''bloggie/install/langs/en.php''' [[BR]]
+Default English language file.
+
+'''bloggie/install/sql''' [[BR]]
+SQL script for module install and uninstall are here.
+
+'''bloggie/install/sql/install.sql''' [[BR]]
+Module installation SQL file.
+
+'''bloggie/install/sql/uninstall.sql''' [[BR]]
+Module un-installation SQL file.
+
+'''bloggie/request.php''' [[BR]]
+File which routes all requests to the '''MeBlggModule''' class. You don't need to change it in most cases.
+
+'''bloggie/templates''' [[BR]]
+Module templates directory. You need to place *.html, *.css and image files here, according to the structure below.
+
+'''bloggie/templates/base''' [[BR]]
+Base template folder. You don't need to create a separate folder for each template (but you can do that). Just place all files into the base folder, and regardless of the current chosen template, all template files will be taken from here. Also, all HTML template files are located in this folder.
+
+'''bloggie/templates/base/css''' [[BR]]
+CSS files must be located here.
+
+'''bloggie/templates/base/images''' [[BR]]
+Images files must be located here.
+
+'''bloggie/templates/base/images/icons''' [[BR]]
+Image icons must be located here.
+
+'''bloggie/templates/base/main.html''' [[BR]]
+Our custom template file.
+