Developing an MVC Component/Developing a Basic Component
From Joomla! Documentation
J3.x:Developing an MVC ComponentRevision as of 03:15, 3 June 2013 by 4yn4a
- REDIRECT J3.x:Developing an MVC Component
Developing a Basic Component
This page goes through the basic steps required to make the simplest possible component that will output Hello, world! to the front-end of a Joomla! website.
First set up the basic public output for this component. Create
yoursite/components/com_helloworld/helloworld.php with the following contents:
<?php echo 'Hello world';
Every extension needs a manifest file that specifies installation and configuration information for the extension. The manifest file is named
componentname.xml. For a simple component we need only include a minimal number of the possible elements in this XML file.
helloworld.xml in the same directory as your
helloworld.php above, with the following contents:
<?xml version="1.0" encoding="utf-8"?> <extension type="component" version="3.1" method="upgrade"> <name>Hello World!</name> <administration > </administration> <files> <filename>helloworld.php</filename> </files> </extension>
Note that the
name element is actually optional, but it makes for easier identification in the next step.
Next, we need to tell Joomla! to 'discover' this new component, so that it can be installed and used. This is done by going to the Extension Manager -> Discover and clicking 'Discover' in the toolbar. This will scan the
components directory (amongst others), looking for components that have not yet been installed.
The new component should be listed in the resulting table, and to install it you just select it (with the checkbox) and click 'Install' in the toolbar.
Note: Don't worry about the message "Component Install: The XML file did not contain an administration element", as our component does not yet have any administration features. We'll add these later in the tutorial.
You can now see the basic component in action, by navigating to
localhost/joomla with your own installation location).