J1.5 talk

Developing a MVC Component/Using the Database

From Joomla! Documentation

Revision as of 09:52, 9 April 2011 by Myriad (Talk | contribs)

Although it is mentioned in the article, I think it is important to underline where the install.sql and uninstall.sql files have to be placed:

install.sql and uninstall.sql files have to be mentioned in two places:

  • In one of the file sections. For example:
  <files folder="admin">
  • In the install / uninstall sections.

Of course, the files have to be copied in the correct folder (in the example, it should be the admin folder).

When data is read from a database, it can be retrieved in the class constructor:

  // The constructor accesses the database, and retrieves all properties.
  function __construct($config = array()) {
     parent::__construct($config);           // To transmit configuration to parent class.
     $db =& JFactory::getDBO();             
     $query = 'SELECT greeting FROM #__hello';
     $db->setQuery( $query );
     $this->greeting = $db->loadResult();
  // The private property
  var $greeting;
  // The public property accessor
  function getGreeting() {
     return $this->greeting;

/* 2009-07-21 */

  • Are those file names for "install.utf8.sql" and "uninstall.utf8.sql" correctly written into XML file? I see files "install.sql" and "uninstall.sql", but in the text, there says the files will be named "install.utf8.sql" and "uninstall.utf8.sql"?

Some glitches

I followed the MVC explanation step by step but this section contains some glitches.

The .sql files should NOT contain '.utf' in the file names. The installer will not find the files (verified on Joomla! 1.5.12).

As indicated above, storing the (un)instal.sql should be in admin directory. So to be concrete the last lines of the chapters "Creating the Installation SQL File" and "Creating the uninstall SQL file" should be:

We will ... called ./admin/install.sql
We will ... called ./admin/uninstall.sql

(both glitches are not in the attachment belonging to the article; the component file: com_hello3_01 is correct)
--M.A.S.H 12:09, 2 August 2009 (UTC)

I notice that the queries from the install.sql/uninstall.sql files are duplicated with the XML file. Is there a reason for this redundancy that I am missing?
--Netguysteve 14:30, 29 November 2009 (UTC)

Saving the install/uninstall files

On my system I ran into a problem with the intall.sql / uninstall.sql files. I wanted to avoid using the <query> tags by including them in the script and having JIntaller run them. I created files using MySQL Query Browser testing them to make sure they worked. When the component is installed JInstaller raises a 1064 db error, which did not make any sense. The problem was occurring because I was saving the script as type "SQL Script File UTF-8", which seemed logical because the charset is utf8. The file must be saved as type "SQL Script File ANSI" or you get the 1064 db error.

Using Joomla 1.5.14, MSQL Query Browser 1.2.12, XP sp3

Exps1 13:43, 15 October 2009 (UTC)

I confirm the same problem with "UTF-8". However, I tried "UTF-8 without BOM" for my sql files and that worked. Of course, still remains the question "What if the file contains utf-8 characters?" I don't think that mine did.
At the least this should be resolved. It's not logical that real UTF-8 files are not accepted.
E-builds 14:40, 17 March 2010 (UTC)

Inconsistant 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? ---

com_banners uses banners.xml, as well as several others. I would dare saying there's a naming standard for this - can't look at the moment, but seems to me the change should be against Part 3 instead, moving it to hello.xml.

Myriad 14:52, 9 April 2011 (UTC)