Joomla! Documentation - User contributions [en]

Jupgrade database tables

2012-11-15T13:57:35Z

Nibinaear:

It's possible to upgrade a Joomla 1.5 installation to a 2.5 or 3.0 version of Joomla. After doing this you will find that the database you end up with it totally different to the usual 2.5 installation. They will contain a mixture of 2.5 and 1.5 tables.

The jupgraded 2.5 database also seems to contain other differences when compared with a standard Joomla 2.5 installation. This means that it's not possible to port one jupgrade "database" from one Joomla installation to another. You can move any Joomla site but moving just the database breaks the install.

Talk:Jupgrade database tables

2012-11-15T13:47:39Z

Nibinaear: Created page with "==Porting only DB from Joomla 2.5 jupgrade to Joomla 2.5 fresh install== In my experience doing this resulted in a broken installation with only a few lines of code being pri..."

==Porting only DB from Joomla 2.5 jupgrade to Joomla 2.5 fresh install==

In my experience doing this resulted in a broken installation with only a few lines of code being printed out to the browser. There were no debug errors and both installations used the same version of Joomla 2.5 with the same template. If someone could shed some more light on this it would be helpful.

Jupgrade database tables

2012-11-15T13:46:20Z

Nibinaear: Created page with "It's possible to upgrade a Joomla 1.5 installation to a 2.5 or 3.0 version of Joomla. After doing this you will find that the database you end up with it totally different to ..."

It's possible to upgrade a Joomla 1.5 installation to a 2.5 or 3.0 version of Joomla. After doing this you will find that the database you end up with it totally different to the usual 2.5 installation. Consequently the installation contains a mixture of 2.5 and 1.5 tables.

The jupgraded 2.5 database also seems to contain other differences when compared with a standrd Joomla 2.5 installation. This means that it's not possible to port one jupgrade database from one Joomla installation to another.

Talk:What is the Mootools 1.2.4 upgrade plugin?

2011-09-08T14:30:49Z

Nibinaear:

I had to deactivate the plugin because it was in conflict with Joomlart's Mega menu.
I don't know however if it's safe to uninstall.

--[[User:Nibinaear|Nibinaear]] 09:29, 8 September 2011 (CDT)

I have issues when using:

System - Mootools Upgrade
System - jQuery++ Integrator by tushev.org

With Showplus / Sigplus and mod_twitterfeed. The mootools upgrade didn't seem to have any effect on the problem which causes a blank screen to appear in Joomla site.

Talk:What is the Mootools 1.2.4 upgrade plugin?

2011-09-08T14:30:15Z

Nibinaear:

Talk:What is the Mootools 1.2.4 upgrade plugin?

2011-09-08T14:29:52Z

Nibinaear:

I had to deactivate the plugin because it was in conflict with Joomlart's Mega menu.
I don't know however if it's safe to uninstall.

--[[User:Nibinaear|Nibinaear]] 09:29, 8 September 2011 (CDT)
I have issues when using:

System - Mootools Upgrade
System - jQuery++ Integrator by tushev.org

With Showplus / Sigplus and mod_twitterfeed. The mootools upgrade didn't seem to have any effect.

Creating a basic index file

2011-09-08T13:59:57Z

Nibinaear:

The <tt>index.php</tt> file becomes the core of every page that Joomla! delivers. Essentially, you make a page (like any HTML page) but place [[PHP]] code where the content of your site should go. The template works by adding Joomla code into module positions and the component section in your template. Anything added to the template will appear on all pages unless it is added to one of these sections via the Joomla CMS (or customised code).

This page will show the bare-bones code ready for you to cut and paste into your own design.

===Begin===

A Joomla 1.5 template begins with the following lines:

<source lang="php">
<?php defined( '_JEXEC' ) or die( 'Restricted access' );?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"
xml:lang="<?php echo $this->language; ?>" lang="<?php echo $this->language; ?>" >
</source>
The first line stops naughty people looking at your coding and getting up to bad things.

The second line is the doctype which tells the browser (and [[wikipedia:Web crawler|web crawlers]]) what sort of page it is. This doctype is xhtml 1.0 but you can also change this whole line to:

<source lang="php">
<!DOCTYPE HTML>
</source>

Which will make the page html5 instead of "xhtml 1.0 transitional" which will be a bit more up to date. It'll also ensure that you have access to a few new pieces of html code not featured in xhtml 1.0. You should be aware that this will not work in internet explorer 8 or earlier without a hack so unless you know how to add the hack you should leave it as xhtml 1.0.

The third line begins our html document and describes what language the website is in. A html document is divided into two parts, head and body. The head will contain the information about the document and the body will contain the website code which controls the layout.

===Head===

<source lang="php">
<head>
<jdoc:include type="head" />
<link rel="stylesheet" href="<?php echo $this->baseurl ?>/templates/system/css/system.css" type="text/css" />
<link rel="stylesheet" href="<?php echo $this->baseurl ?>/templates/system/css/general.css" type="text/css" />
<link rel="stylesheet" href="<?php echo $this->baseurl ?>/templates/<?php echo $this->template; ?>/css/template.css" type="text/css" />
</head>
</source>

The first line gets Joomla to put the correct header information in. This includes the page title, meta information as well as system JavaScript.
The rest creates links to two system style sheets and to your own style sheet (if it's named <tt>template.css</tt> and is located in the <tt>''css''</tt> folder of your template directory. So if your temlate is in http://www.mysite.com/templates/my_template/ then the css files will go in http://www.mysite.com/templates/my_template/css/).

===Body Section===

<source lang="php">
<body>
<jdoc:include type="modules" name="top" />
<jdoc:include type="component" />
<jdoc:include type="modules" name="bottom" />
</body>
</source>

Amazingly, this will suffice! Yes, its a very basic layout, but it will do the job. Everything else will be done by Joomla!. Note: you will need to ensure your menu is set to go into the "top" [[Screen.modules.edit.15#Details|module position]].

===Module Positions===

Above the line which says name="top" adds a module position which is called top and allows Joomla to place modules into this section of the template. The type="component" line contains all articles and main content and is very important. It goes in the centre of the template.

Note: You can add your own module lines anywhere you want in the body but you have to add a corresponding line to the templateDetails.xml file which sits alongside the index.php of your template.

Finish it off - one last bit:
<source lang="php">
</html>
</source>
<noinclude>View the [[Basic template index file|full source code]] of this template.</noinclude>
[[Category:Tutorials]][[Category:Template Development]]

===Custom Images===

If you want to add any images to the template you can do so like this:
<source lang="php">
<img src="<?php echo $thebaseurl; ?>/images/stories/myimage.png" alt="Custom image" class="customImage" />
</source>

Here the $baseurl variable will fill in the path to your template for you.

===Custom CSS===

You can add custom css like this:

<source lang="php">
<link rel="stylesheet" href="<?php echo $this->baseurl ?>/templates/<?php echo $this->template;?>/css/styles.css" type="text/css" />
</source>

Every file which is added must have a line in the templateDetails.xml file for the template.

Creating a basic index file

2011-09-08T13:26:43Z

Nibinaear:

The <tt>index.php</tt> file becomes the core of every page that Joomla! delivers. Essentially, you make a page (like any HTML page) but place [[PHP]] code where the content of your site should go. Here is the bare-bones code ready for you to cut and paste.

A Joomla 1.5 template begins with the following lines:

<source lang="php">
<?php defined( '_JEXEC' ) or die( 'Restricted access' );?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"
xml:lang="<?php echo $this->language; ?>" lang="<?php echo $this->language; ?>" >
</source>
The first line stops naughty people looking at your coding and getting up to bad things.

The second line is the doctype which tells the browser (and [[wikipedia:Web crawler|web crawlers]]) what sort of page it is. This doctype is xhtml 1.0 but you can also change this whole line to:

<source lang="php">
<!DOCTYPE HTML>
</source>

Which will make the page html5 instead of "xhtml 1.0 transitional" which will be a bit more up to date. It'll also ensure that you have access to a few new pieces of html code not featured in xhtml 1.0. You should be aware that this will not work in internet explorer 8 or earlier without a hack so unless you know how to add the hack you should leave it as xhtml 1.0.

The third line begins our html document and describes what language the website is in. A html document is divided into two parts, head and body. The head will contain the information about the document and the body will contain the website code which controls the layout.

==Head==

<source lang="php">
<head>
<jdoc:include type="head" />
<link rel="stylesheet" href="<?php echo $this->baseurl ?>/templates/system/css/system.css" type="text/css" />
<link rel="stylesheet" href="<?php echo $this->baseurl ?>/templates/system/css/general.css" type="text/css" />
<link rel="stylesheet" href="<?php echo $this->baseurl ?>/templates/<?php echo $this->template; ?>/css/template.css" type="text/css" />
</head>
</source>

The first line gets Joomla to put the correct header information in. This includes the page title, meta information as well as system JavaScript.
The rest creates links to two system style sheets and to your own style sheet (if it's named <tt>template.css</tt> and is located in the <tt>''css''</tt> folder of your template directory. So if your temlate is in http://www.mysite.com/templates/my_template/ then the css files will go in http://www.mysite.com/templates/my_template/css/).

==Body Section==

<source lang="php">
<body>
<jdoc:include type="modules" name="top" />
<jdoc:include type="component" />
<jdoc:include type="modules" name="bottom" />
</body>
</source>

Amazingly, this will suffice! Yes, its a very basic layout, but it will do the job. Everything else will be done by Joomla!. Note: you will need to ensure your menu is set to go into the "top" [[Screen.modules.edit.15#Details|module position]].

==Module Positions==

Above the line which says name="top" adds a module position which is called top and allows Joomla to place modules into this section of the template. The type="component" line contains all articles and main content and is very important. It goes in the centre of the template.

Note: You can add your own module lines anywhere you want in the body but you have to add a corresponding line to the templateDetails.xml file which sits alongside the index.php of your template.

Finish it off - one last bit:
<source lang="php">
</html>
</source>
<noinclude>View the [[Basic template index file|full source code]] of this template.</noinclude>
[[Category:Tutorials]][[Category:Template Development]]

==Custom Images==

If you want to add any images to the template you can do so like this:
<source lang="php">
<img src="<?php echo $thebaseurl; ?>/images/stories/myimage.png" alt="Custom image" class="customImage" />
</source>

Here the $baseurl variable will fill in the path to your template for you.

==Custom CSS==

You can add custom css like this:

<source lang="php">
<link rel="stylesheet" href="<?php echo $this->baseurl ?>/templates/<?php echo $this->template;?>/css/styles.css" type="text/css" />
</source>

Every file which is added must have a line in the templateDetails.xml file for the template.

J1.5 talk:Developing a MVC Component/Adding Backend Actions

2010-09-06T16:20:38Z

Nibinaear:

== Component tutorial - strange behaviour ==

Thanks for the documentation.

Was not sure where to bring up questions about if the actual component itself has an error in it or not. I have started a topic in the forum [http://forum.joomla.org/viewtopic.php?f=303&t=435482]

== Step 6 is very difficult to follow ==

In the last 3 days i've gone through the tutorial from the start. I've been doing website development for a while (2 years) but am new to both Joomla and the MVC pattern. I hand coded everything into my IDE (netbeans) after reading through the article (I'd skim read through once, then go back and try and create the component) steps 1-3 are very simple and easy to follow.

So when I got stuck I went to compare my component with the zipped one supplied... uh huh... they were/are totally different?

Where did the admin 'controllers' folder come from? 
Why is there only 1 controller file in the admin 'controllers' folder this seems redundant and unexplained - surely you only need a folder for controllers if multiple controllers are required? Doing this to the hello example seems to be complicating things unnessecarily.

Having re-read this step several times I don't think it's mentioned in 'Getting Down and Dirty: Doing the Real Work' you should have created the folder 'controllers' in /administrator/components/com_hello/admin (if it is it's certainly not obvious).

Step 4 begins to get complex and I think maybe where the root of my trouble with step 6 is (I think it would benefit hugely from the suggestions in: http://docs.joomla.org/Talk:Developing_a_Model-View-Controller_Component_-_Part_4_-_Creating_an_Administrator_Interface#Renaming_Part_4 ).

Step 6 doesn't give enough information about where the new admin files should be created and how they'd be named, it seems to supply source code with too little consideration to context in terms of filepaths. It would probably benefit to being broken down again into smaller parts.

I'll try and actually make recommendations about this in the next week or so (i'm at work at the moment so i'll try and do this from home).

== Remarks to above ==

I agree that grasping the concept the first time immediately is a big nut to crack. The bigger the crack the tastier the nut ;). From your comments you may want to re-read [[Developing a Model-View-Controller Component - Part 4 - Creating an Administrator Interface | Part 4 ]], it goes into detail about the configuration and site/administrator deviations.

To a certain extend I too got first lost in the name conventions but this made the deviation clear between site and administrator. The first paragraph of part 5 points out the difference of using the administrator side and the naming conventions, [[Developing_a_Model-View-Controller_Component_-_Part_5_-_Basic_Backend_Framework#Tutorial_specific_naming | Part 5 - Tutorial specific naming]]. Looking back now the naming is more then plausible. I agree that the switch van site component development to administrator needs to be more explicit. I have added a comment now to Part 5 that Part 5 and 6 are only focussed on the admin side and that the site sub directory is not touched any more and there is an explicit reference to the XML file in the example.

In detail to your questions: you need two controllers. One for the default showing and another for the handling of editing/deletion actions. Non-default controllers must be placed in the controllers directory, that is how it is meant to be. This Hello controller might seem a little bit alone in that directory but this if following the MVC implementation ... and trust me, you will need this more then you might expect now (4/5 dedicated controllers are not uncommon, see also book lending example in Part 4). You are right that nowhere a reference to the controllers directory was made, that is corrected by me now.

With respect to your last comment I agree that only using this tutorial is not fully covering the details. On one hand we must improve it but on the other hand the answers are in the attached example file, copying the content of the example files into this tutorial makes it long to read and that is not helping either. The tutorial and example must be used together; adding some more references to the source files might be a good idea. Look at the bright side; by this mistake, I made it too to be honest, the complete architecture and interaction between the files is obvious now ;) This mistake has learned me more that all the things I copied/followed step-by-step.

--[[User:M.A.S.H|M.A.S.H]] 11:18, 27 September 2009 (UTC)

== Found an Error (I think) ==

In the paragraph '''4. Creating the Table Class''' there is a listing of a '''JTable''' class.

This class has the name '''TableHello'''.
Its constructor method is called '''TableHello()''', which is incorrect, as PHP5 classes' constructor should be named '''__construct()'''.

This same mistake exists in the downloadable component, too.

--[[User:UsagiYojimbo|UsagiYojimbo]] 09:10, 12 October 2009 (UTC)

I corrected the listing, but not the downloadable component.

--[[User:UsagiYojimbo|UsagiYojimbo]] 09:33, 19 October 2009 (UTC)

----

== Difficult to Follow Part 5,6==

Apparently, the drills of Part 5 and 6 are difficult to follow even though the material is useful and not difficult.
The talk in the very early beginning about the folder Admin & Site are not clarified anywhere here.
We know Administrator folder in Joomla and if it is under component com_hello, ok but creation of it nor Admin are never mentioned. The difference between Administartor folder and Admin are not found in the page nor in the talks.
In Part 1-3, I did drills 1 -3, but the downloaded com_hello1, 2, 3 woould not work by plug-in. The contents are important, so a simple clue is to re-write the explantions in Part 5 & 6 please.

--[[User:Tommyleung|Tommyleung]] 09:07, 20 April 2010 (UTC)
"The talk in the very early beginning about the folder Admin & Site are not clarified anywhere here." --> Part 4 goes into depth about this! Part 5 is nothing more then a quick step-by-step creation of a non-functional/non-click-able table listing page as done before in parts 1,2 and 3 only now in admin folder (as is clearly stated in Part 4 and in the first 3/4 paragraphs of Part 5). If you have troubles with this I would suggest to re-read Parts 1 to 3 and in mind replace "site" with "admin". For Part 6 I agree that this is not an easy section. To understand PArt 6 though, you conceptually must understand the previous chapters. Parts 5 and 6 are not a step-through guide but expect that the concept of the previous chapters is basically understood.

BTW: the com_hello1, 2, 3 are working so something what you are doing is somewhere going wrong. Maybe a little blunt but programming a component is not something you can do on a Sunday afternoon. It is not copy and paste. The entire example simply helps with the fundamentals. If you find missing clicks in the documentation please discuss these specific items and we will help. Addressing the entire chapters as difficult doesn't add anything to the discussion. Of cause it is difficult, its called programming and that by itself is a profession.
--[[User:M.A.S.H|M.A.S.H]] 14:44, 14 July 2010 (UTC)

== Multiple Tables ==

I have a relatively complex table layout, so naming a single table the same as my component isn't going to work. How can I account for multiple tables?

[[User:BruceH|BruceH]] 19:11, 23 October 2009 (UTC)

I would create different JTable components for each database table.

--[[User:UsagiYojimbo|UsagiYojimbo]] 09:42, 10 November 2009 (UTC)

== Error in admin/controls/hello.php listing ==

I think that there is an error in the code for the file admin/controls/hello.php

line 55 of admin/controls/hello.php
if ($model->store($post)) {

The method save() of the class HellosControllerHello passes the variable $post to the method store() of the class HellosModelHello. The variable $post does not seemed to be defined anywhere, it is not defined in the class HellosControllerHello, or the parent HellosController or in the grandparent JController. Also the function store() defined on line 79 of admin/models/hello.php, is defined as taking no arguments.

I hope that I have correctly identified a problem and not just made a fool of myself.

I would also like to say thank you for this tutorial, I'm totally new to Joomla! and am finding it very helpful. However I would agree with the other people who say that part6 is not as clear as the preceding parts.

'''Answer''':
$POST is a default PHP parameter containing all posted data. This parameter can always be used somewhere in PHP and is therefore not explained explicit.

--[[User:M.A.S.H|M.A.S.H]] 14:18, 14 July 2010 (UTC)
----
I think I have found another possible error.
The method store() of the class HellosModelHello calls the check() method of the TableHello object. However the TableHello class does not override the check() method of the base class JTable, and the method check() in the base class does nothing more than return true. I really can't see the point in calling check(), and I can't see the educational benefit of including it in this tutorial.
'''Answer''': As this is a tutorial, the concept is placed but indeed not used. It doesn't harm anything but can be used easily now for extending to your own taste.

--[[User:M.A.S.H|M.A.S.H]] 14:20, 14 July 2010 (UTC)

==Confusion==
I'd like to second the comments about the confusion of step 6. I managed to follow steps 1-5 with the application of some serious thought but step 6 is mind boggling. This is mostly because the author(s) decided to call the specific model / view and controller the same damned thing as the default one but with one letter different! So we have the models/hellos.php and models/hello.php . We have views/hellos/view.html.php and views/hello/view.html.php.

Why couldn't we have something new like world for the specfic mv and c?! That way we can separate it easily in our minds until the new naming conventions are cemented in.

I found the naming conventions article really helpful on this. I get it now, but I wasted a lot of time trying to follow step 6.

I'd really appreciate it if there were some reminders throughout, such as:

- Remember that the model name is the same as the folder name for the view.
- Remember that the default view file is called, view.html.php etc. If you're just learning these conventions then it is a lot to remember.

Stick these in at relevant points for the newbies.

Talk:Naming conventions

2010-09-06T15:12:40Z

Nibinaear:

I changed the previous utterly long title to something less dramatic. The old title will still be available and redirect to this page. --CirTap 19:21, 28 January 2008 (EST)

== Reserwed words ==

I added a little section with information on reserwed words. It must be expanded with full list of words, but I don't know them. :-( That information is extracted directly from sources (see reference).

Also does anybody knows what's wrong with wiki references and how to use them (see "Reserwed Words")? [[User:Stilgar|Stilgar]] 21:57, 2 March 2010 (UTC)

== View class name ==

As I understand, it contains not a {ComponentName}, but {ControllerName}. I didn't change it because I don't know enough about how that works. [[User:Stilgar|Stilgar]] 22:10, 2 March 2010 (UTC)

== Thanks ==

I don't know whether this is appropriate for a talk page but just wanted to say thanks for the author(s) for writing this as it was really helpful.

Talk:Difference between JRequest methods

2010-08-29T21:31:05Z

Nibinaear: New page: ==JRequest::getVar()== getVar is used to retrieve GET/POST request data. <source lang="php"> JRequest::getVar( 'name' ) </source> ==JRequest::getWord()== JRequest::getWord() is a proxy m...

==JRequest::getVar()==
getVar is used to retrieve GET/POST request data.

<source lang="php">
JRequest::getVar( 'name' )
</source>

==JRequest::getWord()==
JRequest::getWord() is a proxy method to JRequest::getVar() which is used to get a variable from the request and sanitize it. The getWord() part means to pass it through what we call the "word" filter. The word filter allows alphanumeric characters plus underscores and dashes I believe.

<source lang="php">JRequest::getWord( 'name' )</source>

==JRequest::get()==
To recieve a whole array filtered. If you would want to get the post data, you can use this.

<source lang="php">JRequest::get( 'post' )</source>

Talk:Different between JRequest methods

2010-08-29T21:30:36Z

Nibinaear: New page: Sorry created this and then realised how bad the title of the page was. Please delete ''this'' document. Have created difference between JRequest Methods instead.

Sorry created this and then realised how bad the title of the page was. Please delete ''this'' document.

Have created difference between JRequest Methods instead.

J1.5 talk:Developing a MVC Component/Introduction

2010-08-11T14:18:01Z

Nibinaear:

==Creating the View==

One thing that's not mentioned on the page is how Joomla knows to go to view.html.php.

Unlike controller.php, it's not called anywhere in the code.

In fact, this appears to be a default setting in Joomla. See the page on Naming Conventions: http://docs.joomla.org/Naming_conventions.

This page also appears to have a few typos (!) as the file isn't stored at:

site/views/{viewname}

but rather:

site/components/com_{componentname}/views/{componentname}/view.html.php

--[[User:Edwardt|Edwardt]]

== Typo on page? ==
Hi, new to this, so hope this is the right place.

I'm working through the example.

I notice that the code for 'hello.php' has the line:

if($controller = JRequest::getWord('controller')) {

Whereas the accompanying text uses

JRequest::getVar('controller')

It seems to me that the getVar function makes more sense so should the code for hello.php be changed?

--[[User:Edwardt|Edwardt]]

== Question on fonts ==

is there anyway to make the font for ".source-php .kw1" a more printer friendly color yet still be distinguishable as important text? At the very least lets make the font "bold" so it is stronger in contrast. Even in the highest quality setting on printer it appears very washed out to these old eyes.

You can add your own stylesheet to override any of the system-generated styles by adding a special subpage under your user page. In your case, create the page [[User:N6REJ/monobook.css]] and add your CSS rules into it. [[User:Chris Davenport|Chris Davenport]] 08:55, 19 January 2009 (UTC)

== Use lowercase file and folder names in your components! ==

When creating custom components try to use file names and folder names with all lowercase letters. I had created some complex MVC components, naming my folders and files after my classes in the component. This meant that I had upper and lowercase letters in the folder and file names. During testing on my Windows machine everything worked fine, but when I transfered to a remote host running unix, nothing worked properly. The errors provided by the framework were only slightly helpful in identifying the root cause which was that the JPath:: class implicitly calls strtolower() on all paths. Therefore my files were not being found by the framework. I hope this helps save someone some time.

== View naming conventions ==

It should probably be mentioned that the naming of the "view" script is strictly as named here; Joomla looks for "view.html.php" for the class to render HTML, and "view.feed.php" for a feed display, etc. I at first omitted the ".html" double extension from my file, and quickly ran into errors, so it might be best to mention that, the same way the entry point file name has to match the component name. --[[User:MidnightLightning|MidnightLightning]] 16:35, 6 April 2009 (UTC)

== Tutorial articles detected ... ==

Double tutorial detected, older but somehow different (especially Part 4) [[Tutorial:Developing_a_Model-View-Controller_Component_-_Part_1]]. these Tutorial pages are all marked now as double but a manual merge might be needed.

== Inconsistent naming of install.xml file in Part 1 ==

The tutorial begins in Part 1 as naming the XML file the same as the component (ie, hello.xml). Later in Part 3 without any explanation the XML file is now referred to as install.xml.

Should hello.xml in Part 1 be renamed to install.xml?

==Site Directory==

Am I right in thinking that the site directory is the name of the component? Or is it given to represent the path to the place where the files are stored? Wouldn't it be better to have com_hello as the component name? Or to have something like site_path to indicate what we mean instead of just "site"? I just found this a little confusing during following the tutorial.

J1.5:Retrieving and Filtering GET and POST requests with JRequest::getVar

2010-07-12T22:00:45Z

Nibinaear:

{{stub}}
When writing any web application, it is crucial that you filter input data before using it. Joomla! provides a set of filtering libraries to help you accomplish this.

===Defined in===
libraries\joomla\environment\request.php

==Methods==

=== 'getVar' ===
To retrieve GET/POST request data, Joomla! uses the getVar method of the JRequest class (JRequest::getVar()).

'''Retrieving Data'''

If you have a form variable named 'address', you would want to use this code to get it:
<source lang="php">
$address = JRequest::getVar('address');
</source>

Unless other parameters are set, all HTML and trailing whitespace will be filtered out.

'''The DEFAULT Parameter'''

If you want to specify a default value in the event that 'address' is not in the request or is unset, use this code:

<source lang="php">
$address = JRequest::getVar('address', 'Address is empty');
echo $address; // Address is empty
</source>

'''The SOURCE Parameter'''

Frequently, you will expect your variable to be found in a specific portion of the HTTP request (POST, GET, etc...). If this is the case, you should specify which portion; this will slightly increase your extension's security. If you expect 'address' to only be in POST, use this code to enforce that:

<source lang="php">
$address = JRequest::getVar('address', 'default value goes here', 'post');
</source>

'''The VARIABLE TYPE Parameter'''

The fourth parameter of getVar() can be used to specify certain filters to force validation of specific value types for the variable.

<source lang="php">
$address = JRequest::getVar('address', 'default value goes here', 'post','variable type');
</source>

Here is a list of types you can validate:

*INT
*INTEGER
*FLOAT
*DOUBLE
*BOOL
*BOOLEAN
*WORD
*ALNUM
*CMD
*BASE64
*STRING
*ARRAY
*PATH
*USERNAME

'''The FILTER MASK Parameter'''

Finally, there are some mask constants you can pass in as the fifth parameter that allow you to bypass portions of the filtering:
<source lang="php">
$address = JRequest::getVar('address', 'default value goes here', 'post','validation type',mask type);
</source>

*JREQUEST_NOTRIM - prevents trimming of whitespace
*JREQUEST_ALLOWRAW - bypasses filtering
*JREQUEST_ALLOWHTML - allows most HTML. If this is not passed in, HTML is stripped out by default.

Note. These are static variables not strings. Do not use quotes around them

=== 'get' ===
To recieve a whole array filtered. If you would want to get the post data, you can use this.
<source lang="php">JRequest::get( 'post' )</source>
<nowiki>This returns the standard post array. You can use it on a template page if needed, or in the models section if convenient, it returns the most recent post.
Methods of this object were not found in the Framework section where one would expect to find them. </nowiki>
==See also==
* [http://api.joomla.org/Joomla-Framework/Environment/JRequest.html JRequest on api.joomla.org]
* [[JURI]]
* [[JRoute]]

==Security==

Why not just use the Superglobals? If you are familiar with PHP already you may be wondering, why not just use $_GET / $_POST / $_REQUEST? To make Joomla more secure, all global variables should be read through this function. It removes the possibility for code injection and/or SQL injection. You can also define a default value (as you can see in line 6). Copied and changed from [[Tutorial:Hello_World_WIP || Hello World WIP]].

[[Category:Development]]

J1.5:Retrieving and Filtering GET and POST requests with JRequest::getVar

2010-07-12T21:59:57Z

Nibinaear:

J1.5:Retrieving and Filtering GET and POST requests with JRequest::getVar

2010-07-12T21:59:14Z

Nibinaear:

{{stub}}
When writing any web application, it is crucial that you filter input data before using it. Joomla! provides a set of filtering libraries to help you accomplish this.

===Defined in===
libraries\joomla\environment\request.php

==Methods==

=== 'getVar' ===
To retrieve GET/POST request data, Joomla! uses the getVar method of the JRequest class (JRequest::getVar()).

'''Retrieving Data'''

If you have a form variable named 'address', you would want to use this code to get it:
<source lang="php">
$address = JRequest::getVar('address');
</source>

Unless other parameters are set, all HTML and trailing whitespace will be filtered out.

'''The DEFAULT Parameter'''

If you want to specify a default value in the event that 'address' is not in the request or is unset, use this code:

<source lang="php">
$address = JRequest::getVar('address', 'Address is empty');
echo $address; // Address is empty
</source>

'''The SOURCE Parameter'''

Frequently, you will expect your variable to be found in a specific portion of the HTTP request (POST, GET, etc...). If this is the case, you should specify which portion; this will slightly increase your extension's security. If you expect 'address' to only be in POST, use this code to enforce that:

<source lang="php">
$address = JRequest::getVar('address', 'default value goes here', 'post');
</source>

'''The VARIABLE TYPE Parameter'''

The fourth parameter of getVar() can be used to specify certain filters to force validation of specific value types for the variable.

<source lang="php">
$address = JRequest::getVar('address', 'default value goes here', 'post','variable type');
</source>

Here is a list of types you can validate:

*INT
*INTEGER
*FLOAT
*DOUBLE
*BOOL
*BOOLEAN
*WORD
*ALNUM
*CMD
*BASE64
*STRING
*ARRAY
*PATH
*USERNAME

'''The FILTER MASK Parameter'''

Finally, there are some mask constants you can pass in as the fifth parameter that allow you to bypass portions of the filtering:
<source lang="php">
$address = JRequest::getVar('address', 'default value goes here', 'post','validation type',mask type);
</source>

*JREQUEST_NOTRIM - prevents trimming of whitespace
*JREQUEST_ALLOWRAW - bypasses filtering
*JREQUEST_ALLOWHTML - allows most HTML. If this is not passed in, HTML is stripped out by default.

Note. These are static variables not strings. Do not use quotes around them

=== 'get' ===
To recieve a whole array filtered. If you would want to get the post data, you can use this.
<source lang="php">JRequest::get( 'post' )</source>
<nowiki>This returns the standard post array. You can use it on a template page if needed, or in the models section if convenient, it returns the most recent post.
Methods of this object were not found in the Framework section where one would expect to find them. </nowiki>
==See also==
* [http://api.joomla.org/Joomla-Framework/Environment/JRequest.html JRequest on api.joomla.org]
* [[JURI]]
* [[JRoute]]

==Security (Why not just use the Superglobals?)==

If you are familiar with PHP already you may be wondering, why not just use $_GET / $_POST / $_REQUEST? To make Joomla more secure, all global variables should be read through this function. It removes the possibility for code injection and/or SQL injection. You can also define a default value (as you can see in line 6). Copied and changed from [[Tutorial:Hello_World_WIP || Hellow World WIP]].

[[Category:Development]]

Talk:Components:hello world3

2010-07-12T21:19:07Z

Nibinaear: New page: Cool, a link to an article you haven't created yet.. Oh well, please update soon.

Cool, a link to an article you haven't created yet.. Oh well, please update soon.

J1.5 talk:Creating a simple module

2010-07-10T21:23:34Z

Nibinaear:

==Difficult==

It'd be nice if someone could modify this page and add explanations of some of the code. Most of the time the author assumes you should just work it out or something, not very helpful. For instance, what is jtext, what is JModuleHelper::getLayoutPath? There is basically two lines for each block of code at the moment.

==Other guy==

Uh...ok, wow. I don't dare try to modify the main page as I'm absolutely a greenhorn at Joomla, but as I'm absolutely needing to know this information like right now, I'll at least add comments here to help the next guy out.

So, to get started, you can look at the previous version of Joomla to get the ball rolling. A link can be found here:
[http://help.joomla.org/content/view/20/125/ Module Creating a simple module]

Basically, things have changed a bit since that version, so you need to create two files ''modulename''.php and ''modulename''.xml

the PHP file starts like this:

<source lang="php">
<?php
/**
* @version $Id: modulename.php 10079 date time author $
* @package Joomla
* @copyright Copyright (C) whoever. All rights reserved.
* @license GNU/GPL, see LICENSE.php
* See COPYRIGHT.php for copyright notices and details.
*/

// no direct access
defined('_JEXEC') or die('Restricted access');
</source>

Then lays out the code for whatever the module is trying to do.

The XML file follows the following format:
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install type="module" version="1.5.0">
<name>Modulename</name>
<author>Your Name</author>
<creationDate>Date</creationDate>
<copyright>Copyright (C) whoever. All rights reserved.</copyright>
<license>http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL</license>
<authorEmail>your@email.address</authorEmail>
<authorUrl>your.website.address</authorUrl>
<version>1.5.0</version>
<description>This module does whatever function you describe here</description>
<files>
<filename module="modulename">modulename.php</filename>
</files>
<params>
<param name="something" type="whatever" >
<option value="1">option 1</option>
<option value="0">option 2</option>
</param>
</params>
</install>
</source>

The params section is optional.

Once these files are created, you have to place them where either your web browser or your server can get to them, and then use the Joomla Administrator panel to install the module. This creates the necessary database rows to serve the module where you need it to function.

API15:JDocument/getBase

2010-07-08T19:24:47Z

Nibinaear:

===Description===
Return the base URI of the document.

Note: To return the path of the Joomla installation (no domain name), use $this->baseurl within your template files.


<nowiki>[</nowiki>[[Description:JDocument/getBase|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JDocument/getBase}}

===Syntax===
<source lang="php">getBase()</source>

===Returns===
string public

===Defined in===
libraries/joomla/document/document.php
===Importing===
<source lang="php">jimport( 'joomla.document.document' );</source>

===Source Body===
<source lang="php">
function getBase() {
return $this->base;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JDocument/getBase|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JDocument/getBase}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=getBase
category=JDocument
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

API15 talk:JDocument/getBase

2010-07-08T19:00:46Z

Nibinaear: New page: ==$this->baseurl== I wanted to link off to $this->baseurl here but could find no document. I'd like to create one but I'm not familiar with the format of articles for the Joomla wiki.

==$this->baseurl==

I wanted to link off to $this->baseurl here but could find no document. I'd like to create one but I'm not familiar with the format of articles for the Joomla wiki.

API15:JDocument/getBase

2010-07-08T18:59:54Z

Nibinaear:

===Description===
Return the base URI of the document.

Note: To return the base url of the Joomla installation, use $this->baseurl within your template files.


<nowiki>[</nowiki>[[Description:JDocument/getBase|Edit Descripton]]<nowiki>]</nowiki>


{{Description:JDocument/getBase}}

===Syntax===
<source lang="php">getBase()</source>

===Returns===
string public

===Defined in===
libraries/joomla/document/document.php
===Importing===
<source lang="php">jimport( 'joomla.document.document' );</source>

===Source Body===
<source lang="php">
function getBase() {
return $this->base;
}
</source>


<nowiki>[</nowiki>[[SeeAlso:JDocument/getBase|Edit See Also]]<nowiki>]</nowiki>

{{SeeAlso:JDocument/getBase}}

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=getBase
category=JDocument
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>

Splitting an Article into an introduction with a link to read more

2010-07-08T18:56:51Z

Nibinaear:

It is common to display introductory text with a link to the rest of the article. To split an article into an introduction with a link to read more:
#Open the Article for editing either by:
#* Click the '''Content > Article Manager''' menu item to go to the ''Article Manager'', select the Article and click the ''Edit'' toolbar button.
#* Clicking the ''Add New Article'' button in the Control Panel.
#* If logged in to the Front-end, you have appropriate permissions and are viewing the Article you wish to edit: Click the ''Edit'' toolbar button.
#If you have not already done so, write the complete Article text in the editor.
#Decide where you would like the introduction to finish and the read more link to appear. Place the cursor in this position.
#Click the ''Read more...'' editor button at the bottom of the editor. A horizontal rule will appear where the split in the article is placed.
#*The horizontal rule will not be displayed in the Article. It is only used as a marker for the system when displaying the page.
#*The read more link may be removed by deleting in the same way as text. Select by clicking on the line, note the line break will NOT be highlighted when selected, however the horizontal bar icon on the WYSIWYG toolbar will show it is selected, then click delete.
#Click the ''Save'' or ''Apply'' toolbar buttons to save the Article.
# Note: The article title in the read more link can be removed by using output overrides. For general information see [[Understanding_Output_Overrides | Understanding Output Overrides]]. To learn how to copy the folders necessary to perform overrides, see [[Understanding_Output_Overrides#Module_Layout_Overrides | Module Layout Overrides]]. To disable the titles using output overrides, visit the <joomla_root>/templates/<your template>/html/com_content/ folder and visit the folder which correspondes with your chosen layout. For example, to change the frontpage blog layout, visit <joomla_root>/templates/<your template>/html/com_content/frontpage/default_item.php and scroll to line 111 (Joomla v1.5.18). Change the if/else statement to the title of your choice. For example:

Note: If you are unfamiliar with PHP code you should avoid taking this action.

<source lang="javascript">
<?php if ($this->item->readmore_register) :
echo JText::_('Register to read more...');
else :
echo "Read more";
endif;
</source>

Note:

*The "read more" function works only in articles published in blog layout.
*When the read more link is clicked the entire Article will be displayed unless the Article parameter ''Show Intro text'' has been set to '''Hide'''. In this case only the content after the read more link will be displayed.

Splitting an Article into an introduction with a link to read more

2010-07-08T18:53:16Z

Nibinaear:

It is common to display introductory text with a link to the rest of the article. To split an article into an introduction with a link to read more:
#Open the Article for editing either by:
#* Click the '''Content > Article Manager''' menu item to go to the ''Article Manager'', select the Article and click the ''Edit'' toolbar button.
#* Clicking the ''Add New Article'' button in the Control Panel.
#* If logged in to the Front-end, you have appropriate permissions and are viewing the Article you wish to edit: Click the ''Edit'' toolbar button.
#If you have not already done so, write the complete Article text in the editor.
#Decide where you would like the introduction to finish and the read more link to appear. Place the cursor in this position.
#Click the ''Read more...'' editor button at the bottom of the editor. A horizontal rule will appear where the split in the article is placed.
#*The horizontal rule will not be displayed in the Article. It is only used as a marker for the system when displaying the page.
#*The read more link may be removed by deleting in the same way as text. Select by clicking on the line, note the line break will NOT be highlighted when selected, however the horizontal bar icon on the WYSIWYG toolbar will show it is selected, then click delete.
#Click the ''Save'' or ''Apply'' toolbar buttons to save the Article.
# Note: The article title in the read more link can be removed by using output overrides. For general information see [[Understanding_Output_Overrides#Module_Layout_Overrides | Understanding Output Overrides]]. To disable the titles using output overrides, visit the <joomla_root>/templates/<your template>/html/com_content/ folder and visit the folder which correspondes with your chosen layout. For example, to change the frontpage layout, visit <joomla_root>/templates/<your template>/html/com_content/frontpage/default_item.php and scroll to line 111 (Joomla v1.5.18). Change the if/else statement to the title of your choice. For example:

<source lang="javascript">
<?php if ($this->item->readmore_register) :
echo JText::_('Register to read more...');
else :
echo "Read more";
endif;
</source>

Note:

*The "read more" function works only in articles published in blog layout.
*When the read more link is clicked the entire Article will be displayed unless the Article parameter ''Show Intro text'' has been set to '''Hide'''. In this case only the content after the read more link will be displayed.

Talk:Splitting an Article into an introduction with a link to read more

2010-07-08T18:28:29Z

Nibinaear: Removing all content from page

Talk:Splitting an Article into an introduction with a link to read more

2010-07-08T18:27:05Z

Nibinaear: New page: ==Title displayed in read more== I think something should be added about the title being displayed in the read more, is there any way to remove this?

==Title displayed in read more==
I think something should be added about the title being displayed in the read more, is there any way to remove this?