J3.x:Developing an MVC Component/Developing a Basic Component

2015-02-03T00:31:28Z

Miguel.hidrogo: /* Administrator management */

{{:Developing a Model-View-Controller Component/3.0}}

== The first basic component ==
Let's create a ''Hello World!'' component.
=== Public display ===
With your favorite file manager and editor, create a file ''yoursite/components/com_helloworld/helloworld.php'' containing
<source lang="php">
Hello world
</source>

You can test this basic component by putting ''index.php?option=com_helloworld'' in your browser address (don't forget to prefix this address with your Joomla! 3.x installation path) after installing this component.

=== Administrator management ===
With your favorite file manager and editor, create a file ''yoursite/administrator/components/com_helloworld/helloworld.php'' containing
<source lang="php">
Hello world administration
</source>

You can test this basic component by putting
'''administrator/index.php?option=com_helloworld''' in your browser address after installing the component.

=== Pack an installation zip file ===
If you have used Joomla! before reading this tutorial, you have noticed that extensions are installed using a compressed file containing all the things which are needed for installing and uninstalling them.

With your favorite file manager, create a directory (outside your Joomla! installation directory) containing
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[#site/helloworld.php|site/helloworld.php]]''
* ''[[#index.html|site/index.html]]''
* ''[[#index.html|admin/index.html]]''
* ''[[#admin/helloworld.php|admin/helloworld.php]]''
* ''[[#index.html|admin/sql/index.html]]''
* ''[[#index.html|admin/sql/updates/index.html]]''
* ''[[#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58225/com_helloworld-1.6-part01.zip archive] and install it using the extension manager of Joomla. You can test this basic component by putting ''index.php?option=com_helloworld'' or ''administrator/index.php?option=com_helloworld'' in your browser address. You can also notice that the ''Hello World!'' component is visible in the administrator site of your Joomla installation under the ''Components'' menu.

==File Details==
{{vanchor|admin/sql/updates/mysql/0.0.1.sql}}
is an empty file allowing to initialise schema version of the com_helloworld component.
<source lang="sql">
</source>

{{vanchor|helloworld.xml}}
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2" method="upgrade">

<name>Hello World!</name>

<creationDate>December 2013</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>

<version>0.0.1</version>

<description>Description of the Hello World component ...</description>

<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
</files>

<administration>

<menu link='index.php?option=com_helloworld'>Hello World!</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>helloworld.php</filename>

<folder>sql</folder>
</files>
</administration>

</extension>
</source>

{{vanchor|site/helloworld.php}}
<source lang="php">
Hello World
</source>

{{vanchor|admin/helloworld.php}}
<source lang="php">
Hello World administration
</source>

{{vanchor|index.html}}
common to all folders
<source lang="html4strict">
<html><body bgcolor="#FFFFFF"></body></html>
</source>

{{notice|Please create a pull request or issue at https://github.com/joomla/Joomla-3.2-Hello-World-Component for any code descprepancies or if editing any of the source code on this page.}}

{{:J3.2:Developing a MVC Component/Navigate
|prev=Introduction
|next=Adding a view to the site part}}

<noinclude>[[Category:Component Development]] [[Category:Joomla! 3.0]] [[Category:Joomla! 3.1]][[Category:Joomla! 3.2]]</noinclude>

Joomla! Documentation - User contributions [en]

J3.x:Developing an MVC Component/Developing a Basic Component