The Joomla! Forum ™

Download

Demo


Board index » Joomla! Official Sites & Infrastructure » Documentation - Feedback/Information/Suggestions

Forum rules


Please click here to view the forum rules



Post new topic Reply to topic  Page 1 of 1
  [ 4 posts ] 
  Print view Previous topic | Next topic 
Author Message
Doz
 Post subject: Module reference
PostPosted: Fri Sep 16, 2005 1:03 am 
User avatar
Joomla! Apprentice
Joomla! Apprentice

Joined: Wed Aug 24, 2005 11:44 pm
Posts: 35
HI,

I've made remarks on this in another forum, but I believe that, while the reference for the GUI is essential for new users (and their clients) the most needed reference is the one for programmers. Specifically documents that reveal the essential tools required for mod/com/bot development are what has been missing, at least for me. These kinds of docs are likely to make the CMS popular.

I do not claim to be a great programmer of any sort but I manage by making use of good references.

I have started in my own poor effort of creating a crib sheet of sorts to help me get along when writing modules. I like a simple tree style that can be made in XML or any subset like OPML, but also reads well and is easily searched and indexed. Please look at the list below. There may be errors in it but that's not the point. It is very sparse as well but a properly set-up reference of this sort would be of enormous use to a new user with some knowledge.

Would you be interested in helping me persue it?

(Naturally this is posted in the wrong place at the wrong time. Forgive it please and move on if you will. Sorry)

Quote:
*Essential
* defined( '_VALID_MOS' ) or die( 'Direct Access to this location is not allowed.' );
Prevent your document from loading if it is not included by the CMS
(Specific syntax likely to change in Joomla)
* Useful Globals
    * $sectionid
    The database ID number of the section being viewed
    * $task
    * $my
        * ->username
                  the username
        * ->usertype
                  The permissions level of the user
    * $database
        * ->setQuery("QUERY")
                  Set the Query to run in $query()
        * ->query()
                  run the Query set by setQuery()
        * ->loadObjectList()
        * ->loadResult()
        * ->->getErrorNum();
        The MySQL Error Number
        * ->->getErrorMsg();
        The MySQL Error Message
* Modules
* $params
* ->get('parameter')
  Obtains module parameters from back-end configuration form.
* Useful PHP functions
    * htmlspecialchars()
              Encodes special characters that otherwise might be
              executed by the browser. Prevents javascript attacks.
              Useful for placing user input into a database safely.


Last edited by Doz on Fri Sep 16, 2005 1:40 am, edited 1 time in total.

Top
 Profile  
 
kenmcd
 Post subject: Re: Module reference
PostPosted: Fri Sep 16, 2005 4:36 am 
User avatar
Joomla! Champion
Joomla! Champion

Joined: Thu Aug 18, 2005 2:09 am
Posts: 5154
Location: California
Moderator note: split and moved to Dev Doc forum

_________________
██ AllMedia4Joomla Project
██ http://sourceforge.net/projects/allmedia4joomla/
██ AllMedia YouTube Feed Gallery module released
██ Download: http://sourceforge.net/projects/allmedia4joomla/files/
Top
 Profile  
 
joho68
 Post subject: Re: Module reference
PostPosted: Tue Nov 15, 2005 8:40 pm 
User avatar
Joomla! Apprentice
Joomla! Apprentice

Joined: Mon Sep 12, 2005 7:50 pm
Posts: 17
Location: Stockholm, Sweden
kenmcd wrote:
Moderator note: split and moved to Dev Doc forum


Perhaps a "final link" in this thread, to the new thread, might be a good idea? Just a suggestion.

-joho

_________________
At the end of a smile, there's a laugh and a 1/2 [DAD]
Top
 Profile  
 
kenmcd
 Post subject: Re: Module reference
PostPosted: Tue Nov 15, 2005 9:11 pm 
User avatar
Joomla! Champion
Joomla! Champion

Joined: Thu Aug 18, 2005 2:09 am
Posts: 5154
Location: California
joho68 wrote:
kenmcd wrote:
Moderator note: split and moved to Dev Doc forum


Perhaps a "final link" in this thread, to the new thread, might be a good idea? Just a suggestion.

-joho


To avoid forum clutter, the "Moved to" links are removed after a period.

_________________
██ AllMedia4Joomla Project
██ http://sourceforge.net/projects/allmedia4joomla/
██ AllMedia YouTube Feed Gallery module released
██ Download: http://sourceforge.net/projects/allmedia4joomla/files/
Top
 Profile  
 
Display posts from previous:  Sort by  
Post new topic Reply to topic  Page 1 of 1
  [ 4 posts ] 


Board index » Joomla! Official Sites & Infrastructure » Documentation - Feedback/Information/Suggestions

Who is online

Users browsing this forum: No registered users and 7 guests

You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot post attachments in this forum

Jump to:  
Powered by phpBB® Forum Software © phpBB Group