Developing a MVC Component/Adding language management
From Joomla! Documentation
< Archived:Developing a MVC Component
This page has been archived. This page contains information for an unsupported Joomla! version or is no longer relevant. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
This article or section is in the process of an expansion or major restructuring. You are welcome to assist in its construction by editing it as well. If this article or section has not been edited in several days, please remove this template.
This article was last edited by Cdemko (talk| contribs) 14 years ago. (Purge)
Articles in this series[edit]
- Developing a Basic Component
- Adding a view to the site part
- Adding a menu type to the backend part
- Adding a model to the site part
- Adding a variable request in the menu type
- Using the database
- Basic backend
- Adding language management
- Adding edit facility
Indroduction[edit]
This tutorial is part of the Developing a Model-View-Controller (MVC) Component for Joomla!1.6 tutorial. You are encouraged to read the previous parts of the tutorial before reading this.
Joomla!1.6 manages languages for components in four different situations:
- displaying a component in the public site
- managing a component in the backend
- managing menus in the backend
- installing a component (new in 1.6)
Joomla!1.6 uses two different location folder for languages:
- one in administrator/language or language
- one in the component folder (administrator/component/*component*/language or component/*component*/language)
It depends how the component is installed.
Adding language translation in the public site[edit]
With your favorite file manager and editor, put a file site/language/en-GB/en-GB.com_helloworld.ini. This file will contain translation for the public part.
site/language/en-GB/en-GB.com_helloworld.ini
# Joomla16.Tutorials
# Copyright (C) 2005 - 2009 Open Source Matters. All rights reserved.
# License GNU General Public License version 2 or later; see LICENSE.txt, see LICENSE.php
# Note : All ini files need to be saved as UTF-8 - No BOM
For the moment, there are no translations strings in this file.
Adding language translation when managing the component[edit]
With your favorite file manager and editor, put a file admin/language/en-GB/en-GB.com_helloworld.ini. This file will contain translation for the backend part.
admin/language/en-GB/en-GB.com_helloworld.ini
# Joomla16.Tutorials
# Copyright (C) 2005 - 2009 Open Source Matters. All rights reserved.
# License GNU General Public License version 2 or later; see LICENSE.txt, see LICENSE.php
# Note : All ini files need to be saved as UTF-8 - No BOM
COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_MSG_LABEL=Message
COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_MSG_DESC=This message will be displayed
COM_HELLOWORLD_HELLOWORLD_ID=Id
COM_HELLOWORLD_HELLOWORLD_GREETING=Greeting
[edit]
With your favorite file manager and editor, put a file admin/language/en-GB/en-GB.com_helloworld.menu.ini. This file will contain translation for the backend part.
# Joomla16.Tutorials
# Copyright (C) 2005 - 2009 Open Source Matters. All rights reserved.
# License GNU General Public License version 2 or later; see LICENSE.txt, see LICENSE.php
# Note : All ini files need to be saved as UTF-8 - No BOM
COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_TITLE=Hello World
COM_HELLOWORLD_HELLOWORLD_VIEW_DEFAULT_DESC=This view display a selected message
Adding translation when installing the component[edit]
With your favorite file manager and editor, put a file language/en-GB/en-GB.ini. This file will contain translation for the install.
language/en-GB/en-GB.ini
# Joomla16.Tutorials
# Copyright (C) 2005 - 2009 Open Source Matters. All rights reserved.
# License GNU General Public License version 2 or later; see LICENSE.txt, see LICENSE.php
# Note : All ini files need to be saved as UTF-8 - No BOM
COM_HELLOWORLD_DESCRIPTION=This is the Hello World description
The COM_HELLOWORLD_DESCRIPTION can be used in the helloworld.xml file
Packaging the component[edit]
Content of your code directory
- helloworld.xml
- site/index.html
- site/helloworld.php
- site/views/index.html
- site/views/helloworld/index.html
- site/views/helloworld/view.html.php
- site/views/helloworld/tmpl/index.html
- site/views/helloworld/tmpl/default.xml
- site/models/index.html
- site/models/helloworld.php
- site/views/helloworld/tmpl/default.php
- site/language/index.html
- site/language/en-GB/index.html
- site/language/en-GB/en-GB.com_helloworld.ini
- admin/index.html
- admin/helloworld.php
- admin/controller.php
- admin/sql/index.html
- admin/sql/install.mysql.utf8.sql
- admin/sql/uninstall.mysql.utf8.sql
- admin/sql/update.mysql.utf8.sql
- admin/models/index.html
- admin/models/fields/index.html
- admin/models/fields/helloworld.php
- admin/models/helloworldlist.php
- admin/views/index.html
- admin/views/helloworldlist/index.html
- admin/views/helloworldlist/view.html.php
- admin/views/helloworldlist/tmpl/index.html
- admin/views/helloworldlist/tmpl/default.php
- admin/views/helloworldlist/tmpl/default_head.php
- admin/views/helloworldlist/tmpl/default_body.php
- admin/views/helloworldlist/tmpl/default_foot.php
- admin/tables/index.html
- admin/tables/helloworld.php
- admin/language/en-GB/en-GB.com_helloworld.ini
- admin/language/en-GB/en-GB.com_helloworld.menu.ini
- language/en-GB/en-GB.ini
Create a compressed file of this directory or directly download the archive and install it using the extension manager of Joomla!1.6. You can add a menu item of this component using the menu manager in the backend.
helloworld.xml
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="1.6.0" method="upgrade">
<name>Hello World!</name>
<creationDate>November 2009</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.8</version>
<description>com_helloworld_Description</description>
<install> <!-- Runs on install -->
<sql>
<file driver="mysql" charset="utf8">sql/install.mysql.utf8.sql</file>
</sql>
</install>
<uninstall> <!-- Runs on uninstall -->
<sql>
<file driver="mysql" charset="utf8">sql/uninstall.mysql.utf8.sql</file>
</sql>
</uninstall>
<update> <!-- Runs on update -->
<sql>
<file driver="mysql" charset="utf8">sql/update.mysql.utf8.sql</file>
</sql>
</update>
<files folder="site">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>views</folder>
<folder>models</folder>
<folder>language</folder>
</files>
<administration>
<menu>Hello World!</menu>
<files folder="admin">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>sql</folder>
<folder>tables</folder>
<folder>models</folder>
<folder>views</folder>
</files>
<languages folder="admin">
<language tag="en-GB">language/en-GB/en-GB.com_helloworld.ini</language>
<language tag="en-GB">language/en-GB/en-GB.com_helloworld.menu.ini</language>
</languages>
</administration>
</extension>
In this helloworld.xml file, languages are installed in:
- administrator/language for the admin part (look at the xml languages tag)
- components/com_helloworld/language for the site part (there are no xml languages tag in the site part of the xml description file, but the language folder is included)