Joomla! Documentation - User contributions [en]

Selecting data using JDatabase

2015-11-30T02:12:38Z

Waltsjt: Clarify getNumRows() and identify when you should use getAffectedRows()

J3.x:Developing an MVC Component/Adding a view to the site part

2015-11-17T22:58:45Z

Waltsjt: "htdocs" is implicit in the <path_to_com_helloworld> instruction

<noinclude><languages /></noinclude>
{{:J3.1:Developing an MVC Component/<translate>
en</translate>}}

<translate>
==Note== 
</translate>
<translate>
* This tutorial is part of the [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Introduction|Developing a MVC Component for Joomla! 3.x]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.</translate>

<translate>

* You can follow the steps below to add a view to the Hello World! component, or you can directly download the [https://github.com/scionescire/Joomla-3.2-Hello-World-Component/archive/step-2-adding-a-site-view.zip archive]
</translate>

<translate>
==Adding a View to Hello World!== 
</translate>
__TOC__
<translate>
In this article we will cover how to add a view to a basic Joomla! component. For this example we will be continuing our work on the [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Developing_a_Basic_Component| Hello World!]] component.</translate>

<translate>
There are several ways to update a Joomla! component. In this tutorial we will focus option 2.</translate>
{| border=1
| 1
| <translate>
Manually add the files into <tt><path_to_joomla>/</tt></translate>
|-
| 2
| <translate>
Update using the Joomla! Extension Manager and the original directory, non-compressed, used for the component install</translate>
|-
|3
| <translate>
Update using the Joomla! Extension Manager and an [[S:MyLanguage/Deploying_an_Update_Server| Update Server]]</translate>
|}

<translate>
To add a view you will need to navigate to <tt>com_helloworld</tt>, which is the original directory we made for our component. Using your preferred file manager, create or update the following files; as you create or update the files, add the source code for each file which is found in [[#File Details|File Details]].</translate>

{| border=1
| 1
| <translate>
Update:</translate> [[#site/helloworld.php| helloworld.php]]
| <tt><path_to_com_helloworld>/site/helloworld.php</tt>
|-
| 2
| <translate>
Create:</translate> [[#site/controller.php| controller.php]]
| <tt><path_to_com_helloworld>/site/controller.php</tt>
|-
| 3
| <translate>
Create:</translate> [[#index.html| index.html]]
| <tt><path_to_com_helloworld>/site/views/index.html</tt>
|-
| 4
| <translate>
Create:</translate> [[#index.html| index.html]]
| <tt><path_to_com_helloworld>/site/views/helloworld/index.html</tt>
|-
| 5
| <translate>
Create:</translate> [[#site/views/helloworld/view.html.php| view.html.php]]
| <tt><path_to_com_helloworld>/site/views/helloworld/view.html.php</tt>
|-
| 6
| <translate>
Create:</translate> [[#site/views/helloworld/tml/default.php| default.php]]
| <tt><path_to_joomla>/components/com_helloworld/views/helloworld/tmpl/default.php</tt>
|-
| 7
| <translate>
Create:</translate> [[#index.html| index.html]]
| <tt><path_to_com_helloworld>/site/views/helloworld/tmpl/index.html</tt>
|-
| 8
| <translate>
Update:</translate> [[#helloworld.xml| helloworld.xml]]
| <tt><path_to_com_helloworld/helloworld.xml</tt>
|}

<translate>
=== Updating the Hello World! Component === 
</translate>
<translate>
To update the Hello World! Component in the Joomla! website, please follow the same steps for the [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Developing_a_Basic_Component#Installing the Hello World! Component |original installation]].</translate>

<translate>
==File Details== 
</translate>
{{vanchor|site/helloworld.php}}
<source lang="php" highlight="1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// Get an instance of the controller prefixed by HelloWorld
$controller = JControllerLegacy::getInstance('HelloWorld');

// Perform the Request task
$input = JFactory::getApplication()->input;
$controller->execute($input->getCmd('task'));

// Redirect if set by the controller
$controller->redirect();
</source>

{{vanchor|site/controller.php}}
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
/**
* Hello World Component Controller
*
* @since 0.0.1
*/
class HelloWorldController extends JControllerLegacy
{
}
</source>

{{vanchor|site/views/helloworld/view.html.php}}
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* HTML View class for the HelloWorld Component
*
* @since 0.0.1
*/
class HelloWorldViewHelloWorld extends JViewLegacy
{
/**
* Display the Hello World view
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return void
*/
function display($tpl = null)
{
// Assign data to the view
$this->msg = 'Hello World';

// Display the view
parent::display($tpl);
}
}

</source>

{{vanchor|site/views/helloworld/tmpl/default.php}}
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');
?>
<h1><?php echo $this->msg; ?></h1>
</source>

{{vanchor|index.html}}
<translate>
Note - the same code is used for all folders</translate>
<source lang="html4strict">
<html><body bgcolor="#FFFFFF"></body></html>
</source>

{{vanchor|helloworld.xml}}
<source lang="xml" highlight="13,30,31">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2.0" 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.2</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>
<filename>controller.php</filename>
<folder>views</folder>
</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>

<translate>
== Code Explanation == 
</translate>
<translate>
In case you were curious as to why this works the way it does.</translate>

=== helloworld.php ===
<source lang="php>
defined('_JEXEC') or die('Restricted access');
</source>

<translate>
This enables for a secure entry point into the Joomla! platform. [[JEXEC| JEXEC]] contains a detailed explanation.</translate>

<source lang="php">
$controller = JControllerLegacy::getInstance('HelloWorld');
</source>

<translate>
''[https://api.joomla.org/cms-3/classes/JControllerLegacy.html JControllerLegacy]'' is a base class for a Joomla! Controller. In order for our website to use controllers, we must extend this class in our component. The ''[https://api.joomla.org/cms-3/classes/JControllerLegacy.html#method_getInstance getInstance]'' static method of the ''JControllerLegacy'' class will create a controller. In the code above, it will instantiate a controller object of a class named ''HelloWorldController''. Joomla will look for the declaration of that class in <tt><path_to_joomla>/htdocs/components/com_helloworld/controller.php</tt>.</translate>

<source lang="php">
$input = JFactory::getApplication()->input;
$controller->execute($input->getCmd('task'));
</source>

<translate>
After the controller is created, we instruct the controller to execute the task, as defined in the URL: <tt><yoursite>/joomla/index.php?option=com_helloworld&task=<task_name></tt>. If no task is set, the default task 'display' will be assumed. When display is used, the 'view' variable will decide what will be displayed. Other common tasks are save, edit, new, etc.</translate>

<source lang="php">
$controller->redirect();
</source>

<translate>
The controller might decide to redirect the page, usually after a task like 'save' has been completed. This last statement takes care of the actual redirection.</translate>

<translate>
The main entry point, helloworld.php, essentially passes control to the controller, which handles performing the task that was specified in the request.</translate>

=== controller.php ===

<source lang="php">
class HelloWorldController extends JControllerLegacy
{
function display($tpl = null)
{
// Assign data to the view
$this->msg = 'Hello World';

// Display the view
parent::display($tpl);
}
}
</source>
<translate>
When no task is given in the request variables, the default task will be executed. It's the display task by default. The JControllerLegacy class has such a task. In our example, it will display a view named HelloWorld.</translate>

=== view.html.php ===

<source lang="php">
class HelloWorldViewHelloWorld extends JViewLegacy
{
</source>

<translate>
''[https://api.joomla.org/cms-3/classes/JViewLegacy.html JViewLegacy]'' is a base class for a Joomla! View. In our case, this method will display data using the tmpl/default.php file.</translate>

=== default.php ===

<source lang="php">
<h1><?php echo $this->msg; ?></h1>
</source>

<translate>
This template file will be included by the JViewLegacy class. Therefore, here, $this refers to the HelloWorldViewHelloWorld class.</translate>

=== helloworld.xml ===

<source lang="xml">
<version>0.0.2</version>
</source>

<translate>
Updates the version number.</translate>

<source lang="xml">
<filename>controller.php</filename>
<folder>views</folder>
</source>

<translate>
Tells installer application to add controller.php and the views/directory</translate>

<translate>
==Component Contents== 
</translate>
<translate>
At this point in the tutorial, your component should contain the following files:</translate>
{| border=1
| 1
| ''[[#helloworld.xml|helloworld.xml]]''
| <translate>
this is an XML (manifest) file that tells Joomla! how to install our component.</translate>
|-
| 2
| ''[[#site/helloworld.php|site/helloworld.php]]''
| <translate>
this is the site entry point to the Hello World! component</translate>
|-
| 3
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 4
| ''[[#site/controller.php|site/controller.php]]''
| <translate>
file representing the controller</translate>
|-
| 5
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 6
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 7
| ''[[#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
| <translate>
file representing the view</translate>
|-
| 8
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 9
| ''[[#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
| <translate>
the default view</translate>
|-
| 10
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 11
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#admin/helloworld.php|admin/helloworld.php]]''
| <translate>
this is the administrator entry point to the Hello World! component</translate>
|-
| 12
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 13
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 14
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
| <translate>
prevents web server from listing directory content</translate>
|-
| 15
| ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
| <translate>
file allowing to initialise schema version of the com_helloworld component.</translate>
|}

{{notice|<translate>
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.</translate>}}

<div class="row">
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_an_MVC_Component/Developing_a_Basic_Component|Prev: Developing a Basic Component</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_a_menu_type_to_the_site_part|Next: Adding a menu type to the site part</translate>|class=expand}}</div>
</div>

<noinclude>
<translate>

[[Category:Joomla! 3.x]]
[[Category:Joomla! 3.0]]
[[Category:Joomla! 3.1]]
[[Category:Joomla! 3.2]]
[[Category:Joomla! 3.3]]
[[Category:Joomla! 3.4]]
[[Category:Beginner Development]]
[[Category:Component Development]]
[[Category:Tutorials]]
[[Category:Tutorials in a Series]]
</translate>
</noinclude>

J3.x:Getting Started with Joomla!

2015-07-20T21:51:36Z

Waltsjt: Remove old reverences to LTS/STS and correct some release dates

{{review|copyedit}}
{{{{FULLPAGENAME}}/Getting Started pages header}}
This series of documents introduces Joomla! to people who have not previously used it. This introduction should help you make the best use of the series.
==Intro==
===Which versions are covered?===
* '''Version 2.5''' (the version version that replaced versions 1.6 & 1.7) was released January 2012 and reached end of scheduled support on December 31, 2014.
* '''Version {{CurrentSTSVer|minor}}''' (Is the current version in the 3.x series in anticipation of Joomla 3.5) scheduled for release in October 2015.

There are many similarities between the versions but this tutorial is for '''Joomla! {{ns}}'''

===Who is it written for?===
The series is for anyone who wants to use Joomla! Its main focus is:
* Users with limited computing experience
* Users who are using Joomla! for a small web site. (e.g. club, association, church or small business)

===See also===
{{other versions}}

==Understanding Joomla!==
If you're having trouble visualizing how Joomla! works, it might be useful for you to think of Joomla! as an [[wp:Operating system|operating system (OS)]], like Microsoft Windows, Apple Mac OS or Linux.

The most important similarity is that both your OS and Joomla! are not really intended for direct use. You need to install applications onto your OS (and extensions for Joomla!) to be able to actually do something useful with your computer (and your web site). Just like your OS, Joomla! comes with a few ''core'' extensions that carry out the most important tasks.

Further similarities and differences can be found in the following table.
===Comparison Table===
{| class="wikitable"
|+ <big>Joomla! compared to an OS (e.g. MS Windows, Mac OS or Linux)</big>
! Joomla! concept
! OS concept
|-
| [[Extension]] || Added Application (e.g. Word, Chrome, Music Player, Photoshop)
|-
| Core extensions || Built-in applications (e.g. Start button, Screen Saver, File Search)
|-
| Database || File system (one type of Files)
|-
| File system || File system (another type of Files)
|-
| Viewing a page || Using an application (Added or Built-in)
|-
| Updating Joomla! || Installing updates for your OS (Security patches and bug fixes)
|-
| Migrating between Joomla! versions || Installing a new version of your OS<br/>(e.g. moving from MS Windows XP to MS Windows 7)
|}

== What You Will Need ==
===An Installed Copy of Joomla!===
For some parts of these tutorials you must have the use of a Joomla! web site. You can follow along just reading the material, but there is no better way of learning than doing. Here are the options available.
* [[Use Joomla! on your own computer| '''Install a copy of Joomla! (with Sample Data) on your own computer.''']] This is sometimes referred to as a 'localhost' installation. Installing with Sample Data enables you to to explore a Joomla! site before you have created one for your own content. This is a good option for beginners.
* [[J3.1:Installing Joomla| '''Install a copy of Joomla! (with Sample Data) on a Hosting server.''']] This is sometimes referred to as a 'remote host' installation. Installing with Sample Data enables you to to explore a Joomla! site before you have created one for your own content. This is a good option for beginners.
* '''Use an existing Joomla! web site'''. If you are going to be adding content to an existing site and do not have much computing experience this is a '''not a good option'''.

===Alternatives===
* '''Use a Demo Installation'''. Many hosts or script installer sites offer 'demo' versions of a Joomla! installation. You will at least be able to make changes, but they will not be permanent. 'Demo installations' are reset back to a 'fresh' installation state at regular intervals.
* '''One-click Installation'''. Many hosts offer a one-click installation of popular web site programs.

== Getting Started ==
===What to Expect===
Joomla! is introduced using detailed 'hands-on' instructions about adding, altering and manipulating content. At the same time, general points about Joomla! are made which are intended to help people to learn and do more. As the tasks require more background knowledge, so there are fewer hands-on instructions and more general pointers to the extensive documentation available for Joomla!
===Topics===
The series is divided into multiple parts as indicated by the browsing menu found at the top of this page. You should move from topic to topic in a left to right progression. Each topic will build upon the previous one. Alternatively, you can go right to the part containing the information sought.
===Remember===
As you move from Tutorial topic to the next, you can always refer to the [[glossary]] if you forget the meaning of common terms.

== Topics ==
These topics should be considered the key building blocks of a Joomla! web site. They will give you a foundation upon which to build your Joomla! web site and knowledge upon.
======Templates======
Templates control how a Joomla! powered web site appears for users. A template provides a method of integration between content (Articles) and Applications (Modules) in a specific, controlled view. Templates are how a Joomla! powered web site is end-user presented.

======Categories======
Every part of Joomla! powered web site or any CMS type of web site needs a method to display and store its content logically. The usual method is by categories and subcategories. Joomla! allows for multiple ways to display and use content controlled by categorisation. This part of the Tutorial will introduce you to the uses of Joomla! categories.

======Articles======
Articles are the core content of any Joomla! powered web site. Everyone needs to know the basics of how to edit and create them. This tutorial will help you to understand the inner workings of Joomla! articles and their integration into a web page.

======Menus======
Every web site has some type of navigation system, or menu. They can vary in style from web site to web site, but they all preform the same function. The menu tutorial will explain how menus control content.

======Modules======
As you have already learned, Extensions and Core Extensions are like a Computer Application (e.g. Word, Excel, Photoshop, Screensaver, File search). Modules are lightweight Joomla! extensions. A module's display is controlled by the Template and 'Menu' Core Extension. They are used as an integration point for Extensions (Applications) along with Articles(Content) into the page views of a Joomla! web site.

==Summary==
After you complete all Tutorial Topics, you should be able to create a simple website.

===Summing it all up===

*Templates control the look of a Joomla! web site.
*Categories create a organisational hierarchy to control web site content.
*Articles are the main type of web site content.
*Menus provide a navigational method to use or browse the web site content(pages).
*Modules provide a means to combine web site content(Articles) with extensions(Applications), regardless of whether they are core or add-on(installed, not core) extensions.

<div class="large-3 columns panel radius floatright" style="background: lightblue; padding:.3em .50em; font-size:115%;"><span style=="color:black;">Proceed to [[J3.0:Getting_Started_with_Templates|Templates →]]</span></div>
{{-}}

==Beyond the Basics==
There is more to learn about Joomla.
* '''Beyond the basics: doing more with Jooomla!''' - this is not yet completed - it points to ways ahead.
* [[References|'''Books, links and helpful resources''']]

<noinclude>
</noinclude>

Using the JTable class

2015-07-16T13:41:26Z

Waltsjt: /* Writing an extension of JTable */ remove &

{{review}}
This tutorial is for {{JVer|3.x}}

== Introduction to JTable ==
The [https://api.joomla.org/cms-3/classes/JTable.html JTable] class is an implementation of the [http://en.wikipedia.org/wiki/Active_record_pattern Active Record] design pattern. It is used throughout Joomla! for [http://en.wikipedia.org/wiki/Create,_read,_update_and_delete creating, reading, updating, and deleting aka CRUD tasks] for records in the database table.

Since JTable is an abstract class that forms the basis for all database table classes. Some of the methods listed will be overridden by the child class so you should check the child class documentation for further information. Also take note that as of Joomla 2.5, JTable properties are automatically generated based on the schema of the specified table, which means you don't need to declare Member variables in your class.

Each physical database table created should have a corresponding class derived from JTable to represent it. JTable provides many methods to make common manipulations to the table much simpler. For example, one of the most common operations you will need to perform is to read a table row into memory given a value for the primary key. This can be done easily using the load method. The table row can then be just as easily updated using the save method, which also performs any predefined sanity checks on the table fields.

== Writing an extension of JTable ==
To use JTable, you will create an extension of the JTable class. In this example, we have a database table "#__recipes" with an autoincrementing primary key "id" containing all of our recipes. We'll store this

The only thing we need to do to start using JTables is create a constructor in our extended JTable class. The class constructor will call the parent constructor to get the table, all it needs is the name of the table, the name of the primary key column, and the database instance.

<source lang="php">
<?php

defined('_JEXEC') or die();

class TableRecipes extends JTable
{
public function __construct($db)
{
parent::__construct( '#__recipes', 'id', $db );
}
}
</source>

If you were using this class as a part of a backend component called 'Recipes', you would place this code in the file /administrator/components/com_recipes/tables/recipes.php.

You can use this functionality in plugins just as components, i.e.. As a general rule you should avoid writing to the database from a module, and use plugins/components for this. Remember to use the built-in [[constants]] when linking to a custom path (outside the 'adminstrator/{com_nameofyourcomponent}/tables' folder).

== Using a JTable class extension ==

Once the table class is in place we can use it in our model getTable() function.

<source lang="php">
public function getTable($type = 'Recipes', $prefix = 'Table', $config = array())
{
return JTable::getInstance($type, $prefix, $config);
}
</source>

You can use your JTable class in any Joomla! extension by using JTable::addIncludePath() in your extension's source code (use com_nameofyourcomponent in place of com_recipes):

<source lang="php">
JTable::addIncludePath(JPATH_ADMINISTRATOR . '/components/com_recipes/tables');
$row = JTable::getInstance('recipes', 'Table', array());
</source>

Notice that the lowercase version of the suffix of your class name is used as the first parameter, with the prefix 'Table' as the second. Also, the getInstance() member function of JTable returns a JTableObject by reference instead of a value;.

=== Reserved Database Field Names ===
Some of the optional features of JTable require the existence of specially-named fields in the database table. If you require this additional functionality you should ensure that these named fields are present in the table. These field names should be considered reserved as any attempts to use them for purposes other than those supported by JTable may result in conflict.
{| class="wikitable"
|-
!Field name
!Methods using the field name
|-
|checked_out
|[[JTable/checkOut|checkOut]], [[JTable/checkIn|checkIn]], [[JTable/isCheckedOut|isCheckedOut]]
|-
|checked_out_time
|[[JTable/checkOut|checkOut]], [[JTable/checkIn|checkIn]], [[JTable/isCheckedOut|isCheckedOut]]
|-
|hits
|[[JTable/hit|hit]]
|-
|ordering
|[[JTable/getNextOrder|getNextOrder]], [[JTable/reorder|reorder]], [[JTable/move|move]]
|-
|published
|[[JTable/publish|publish]]
|}

==== Check-in/check-out ====
Joomla tables implement a simple mechanism for preventing a [[wikipedia:race condition|race condition]] while editing rows in a database. This depends on the existence of database fields called "checked_out" and "checked_out_time" and if these fields are present in the view (JForm) '''JTable''' will automatically support this mechanism so that it can be easily used in your tables too.

==== Hit counter ====
Some Joomla tables contain a field called "hits" which records the number of times that a table row has been accessed. JTable provides a simple method to increment this field: [https://api.joomla.org/cms-3/classes/JTable.html#method_hit hit].

==== Example JForm fields for Reserved database names in JTable ====
<source lang="xml">
<field name="state"
type="list"
label="JSTATUS"
description="JFIELD_PUBLISHED_DESC"
size="1"
default="1">
<option value="1">JPUBLISHED</option>
<option value="0">JUNPUBLISHED</option>
<option value="2">JARCHIVED</option>
<option value="-2">JTRASHED</option>
</field>
<field name="checked_out"
type="hidden"
filter="unset"
/>
<field name="checked_out_time"
type="hidden"
filter="unset"
/>
<field name="created_user_id"
label="JGLOBAL_FIELD_CREATED_BY_LABEL"
type="hidden"
filter="unset"
/>
<field name="created_time"
label="JGLOBAL_FIELD_CREATED_LABEL"
type="hidden"
filter="unset"
/>
<field name="modified_user_id"
label="JGLOBAL_FIELD_MODIFIED_BY_LABEL"
type="hidden"
filter="unset"
/>
<field name="modified_time"
label="JGLOBAL_FIELD_MODIFIED_LABEL"
type="hidden"
filter="unset"
/>
<field name="hits"
type="text"
id="hits"
class="readonly"
label="JGLOBAL_HITS"
size="20"
readonly="true"
filter="unset"
/>
</source>

===Useful Member Functions===
* [[JTable/load]]
* [[JTable/bind]]
* [[JTable/check]]
* [[JTable/store]]
* [[JTable/save]] Method to provide a shortcut to binding, checking and storing a JTable instance to the database table.

===See Also===
* [[J3.2:Developing an MVC Component/Using the database#admin.2Ftables.2Fhelloworld.php | Part 7 of J3.2:Developing an MVC Component/Using the database]]
*[[J2.5:Developing a MVC Component/Adding configuration#admin.2Ftables.2Fhelloworld.php | Part 14 of J2.5:Developing a MVC Component/Adding configuration]]

== Summary ==
When properly extended, JTable gives you all of the basic functions you need for managing and retrieving records in a database table.

<noinclude>
[[Category:Development]]
[[Category:Component Development]]
[[Category:Extension development]]
[[Category:JTable]]
[[Category:Tutorials]]
</noinclude>

Using the JTable class

2015-07-16T13:36:32Z

Waltsjt: Add the acronym CRUD

{{review}}
This tutorial is for {{JVer|3.x}}

== Introduction to JTable ==
The [https://api.joomla.org/cms-3/classes/JTable.html JTable] class is an implementation of the [http://en.wikipedia.org/wiki/Active_record_pattern Active Record] design pattern. It is used throughout Joomla! for [http://en.wikipedia.org/wiki/Create,_read,_update_and_delete creating, reading, updating, and deleting aka CRUD tasks] for records in the database table.

Since JTable is an abstract class that forms the basis for all database table classes. Some of the methods listed will be overridden by the child class so you should check the child class documentation for further information. Also take note that as of Joomla 2.5, JTable properties are automatically generated based on the schema of the specified table, which means you don't need to declare Member variables in your class.

Each physical database table created should have a corresponding class derived from JTable to represent it. JTable provides many methods to make common manipulations to the table much simpler. For example, one of the most common operations you will need to perform is to read a table row into memory given a value for the primary key. This can be done easily using the load method. The table row can then be just as easily updated using the save method, which also performs any predefined sanity checks on the table fields.

== Writing an extension of JTable ==
To use JTable, you will create an extension of the JTable class. In this example, we have a database table "#__recipes" with an autoincrementing primary key "id" containing all of our recipes. We'll store this

The only thing we need to do to start using JTables is create a constructor in our extended JTable class. The class constructor will call the parent constructor to get the table, all it needs is the name of the table, the name of the primary key column, and the database instance.

<source lang="php">
<?php

defined('_JEXEC') or die();

class TableRecipes extends JTable
{
public function __construct(&$db)
{
parent::__construct( '#__recipes', 'id', $db );
}
}
</source>

If you were using this class as a part of a backend component called 'Recipes', you would place this code in the file /administrator/components/com_recipes/tables/recipes.php.

You can use this functionality in plugins just as components, i.e.. As a general rule you should avoid writing to the database from a module, and use plugins/components for this. Remember to use the built-in [[constants]] when linking to a custom path (outside the 'adminstrator/{com_nameofyourcomponent}/tables' folder).

== Using a JTable class extension ==

Once the table class is in place we can use it in our model getTable() function.

<source lang="php">
public function getTable($type = 'Recipes', $prefix = 'Table', $config = array())
{
return JTable::getInstance($type, $prefix, $config);
}
</source>

You can use your JTable class in any Joomla! extension by using JTable::addIncludePath() in your extension's source code (use com_nameofyourcomponent in place of com_recipes):

<source lang="php">
JTable::addIncludePath(JPATH_ADMINISTRATOR . '/components/com_recipes/tables');
$row = JTable::getInstance('recipes', 'Table', array());
</source>

Notice that the lowercase version of the suffix of your class name is used as the first parameter, with the prefix 'Table' as the second. Also, the getInstance() member function of JTable returns a JTableObject by reference instead of a value;.

=== Reserved Database Field Names ===
Some of the optional features of JTable require the existence of specially-named fields in the database table. If you require this additional functionality you should ensure that these named fields are present in the table. These field names should be considered reserved as any attempts to use them for purposes other than those supported by JTable may result in conflict.
{| class="wikitable"
|-
!Field name
!Methods using the field name
|-
|checked_out
|[[JTable/checkOut|checkOut]], [[JTable/checkIn|checkIn]], [[JTable/isCheckedOut|isCheckedOut]]
|-
|checked_out_time
|[[JTable/checkOut|checkOut]], [[JTable/checkIn|checkIn]], [[JTable/isCheckedOut|isCheckedOut]]
|-
|hits
|[[JTable/hit|hit]]
|-
|ordering
|[[JTable/getNextOrder|getNextOrder]], [[JTable/reorder|reorder]], [[JTable/move|move]]
|-
|published
|[[JTable/publish|publish]]
|}

==== Check-in/check-out ====
Joomla tables implement a simple mechanism for preventing a [[wikipedia:race condition|race condition]] while editing rows in a database. This depends on the existence of database fields called "checked_out" and "checked_out_time" and if these fields are present in the view (JForm) '''JTable''' will automatically support this mechanism so that it can be easily used in your tables too.

==== Hit counter ====
Some Joomla tables contain a field called "hits" which records the number of times that a table row has been accessed. JTable provides a simple method to increment this field: [https://api.joomla.org/cms-3/classes/JTable.html#method_hit hit].

==== Example JForm fields for Reserved database names in JTable ====
<source lang="xml">
<field name="state"
type="list"
label="JSTATUS"
description="JFIELD_PUBLISHED_DESC"
size="1"
default="1">
<option value="1">JPUBLISHED</option>
<option value="0">JUNPUBLISHED</option>
<option value="2">JARCHIVED</option>
<option value="-2">JTRASHED</option>
</field>
<field name="checked_out"
type="hidden"
filter="unset"
/>
<field name="checked_out_time"
type="hidden"
filter="unset"
/>
<field name="created_user_id"
label="JGLOBAL_FIELD_CREATED_BY_LABEL"
type="hidden"
filter="unset"
/>
<field name="created_time"
label="JGLOBAL_FIELD_CREATED_LABEL"
type="hidden"
filter="unset"
/>
<field name="modified_user_id"
label="JGLOBAL_FIELD_MODIFIED_BY_LABEL"
type="hidden"
filter="unset"
/>
<field name="modified_time"
label="JGLOBAL_FIELD_MODIFIED_LABEL"
type="hidden"
filter="unset"
/>
<field name="hits"
type="text"
id="hits"
class="readonly"
label="JGLOBAL_HITS"
size="20"
readonly="true"
filter="unset"
/>
</source>

===Useful Member Functions===
* [[JTable/load]]
* [[JTable/bind]]
* [[JTable/check]]
* [[JTable/store]]
* [[JTable/save]] Method to provide a shortcut to binding, checking and storing a JTable instance to the database table.

===See Also===
* [[J3.2:Developing an MVC Component/Using the database#admin.2Ftables.2Fhelloworld.php | Part 7 of J3.2:Developing an MVC Component/Using the database]]
*[[J2.5:Developing a MVC Component/Adding configuration#admin.2Ftables.2Fhelloworld.php | Part 14 of J2.5:Developing a MVC Component/Adding configuration]]

== Summary ==
When properly extended, JTable gives you all of the basic functions you need for managing and retrieving records in a database table.

<noinclude>
[[Category:Development]]
[[Category:Component Development]]
[[Category:Extension development]]
[[Category:JTable]]
[[Category:Tutorials]]
</noinclude>

Web developers

2015-07-16T13:30:30Z

Waltsjt: Add some more information which would be relevant to web developers

<noinclude><languages /></noinclude>
{{Chunk:Web developer profile/<translate>
en</translate>}}

<translate>==What is Joomla! and why should I be interested?== </translate>

<translate>
Joomla! is the second most popular Content Management System in the world according to [http://cmscrawler.com/completelist CMS Crawler], and is freely available to download and install. Released under the General Public License v2 and above - read more at [[S:MyLanguage/Extensions_and_GPL#About_Joomla.21_and_the_GPL|Extensions and GPL]], anybody can work with all parts of the Joomla! CMS, make changes, customize it to fit their needs, and use it for commercial projects</translate>.

<translate>
The world of website design is rapidly moving towards dynamically served content and away from static websites - Joomla! is well equipped to meet these needs and has the added bonus of a vibrant, enthusiastic community and a phenomenal amount of extensions, allowing you to extend the basic Joomla! installation in a multitude of ways - from creating social networks to eCommerce stores, corporate websites to intranets.</translate>

<translate>
Once you understand the basics of how Joomla! works, it is quick and easy to learn how to extend it through writing custom components, adapting existing code, and creating your own templates.</translate>

<translate>==Where do I get started?== </translate>

<translate>
Firstly, see if there are any Joomla! User Groups near you, or a JoomlaDay<sup>TM</sup> event you could attend. Having a community of people you can talk to or ask questions of is really helpful in the process of learning how to use any new system. It often saves hours, if not days of fiddling or researching to just ask the question and have someone give you an answer (or advise where to find the answer).</translate>

[http://community.joomla.org/user-groups.html <translate>
Find your nearest User Group</translate>]

[http://events.joomla.org/joomladays <translate>
Find your nearest JoomlaDay event</translate>]

<translate>
Next, create yourself an account on the Joomla! forums. While the forums are user to user support, there are a LOT of users, and a lot of experienced users for that matter. Make sure you take the time to read the posting guidelines at the top of the forums before you post, and include all the relevant information.</translate>

<translate>
While you're here, see if you might be able to help someone else. Good practice is to answer one post for every post you make asking for help, as a minimum.</translate>

[http://forum.joomla.org/ <translate>
Visit the Joomla! forums</translate>]

<translate>
Next, create yourself an account here on the Joomla! Documentation Project. Newcomers are a great help with documentation, as you often see things with a 'fresh pair of eyes' and can identify mistakes or pick up errors easier.</translate>

<translate>
Just click on the link in the top right, and create your account. If you find any documentation that needs updating or reviewing, simply log in, edit the appropriate item, and submit your revisions. Likewise if you can add any examples (especially to coding/API related documentation) you can do this too!</translate>

<translate>==How do I style a Joomla! website to be like my graphics visuals?== </translate>

<translate>==Getting started with content== </translate>
{{review}}
<translate>
Content is simple to use and manage with Joomla!. This can be done if you are the administrator by using the content manager in the control panel. There are different types of content that can be used.</translate>

<translate>
The 'article' is one type of content. This is usually a piece of text that can be displayed on a portion of the page. It can also include pictures, another type of content, or other links to internal or external sites.</translate>

<translate>
You can also upload pictures and videos to use on your website. As long as the content is there in the server side, it can be embedded or linked to be displayed on your page. It can also work with articles to be placed along with text or just a stand-alone piece of content.</translate>

<translate>==Finding extensions to keep your client happy!== </translate>
{{review}}
<translate>
There are many extensions for Joomla! that will help you to create a website that will fit your client's needs. These can be found [http://extensions.joomla.org/ here]. An extension can be easy to find. They are separated by category and contain small descriptions to let you know if they suite your needs. They also have in-depth descriptions once clicked on and usually have tutorials on how they can be used. There is also a rating system based on other users to give you a better idea of the quality of the extension. This makes things user friendly and helps in making sure that the user gets what they are looking for.</translate>

<translate>==Search engine optimization with Joomla!== </translate>

<translate>==Joomla! Security Guide== </translate>

<translate>

* [[S:MyLanguage/Category:Security_Checklist|Joomla! Security Checklist]]
* [[S:MyLanguage/Security and Performance FAQs|Security and Performance FAQs]]
* [http://vel.joomla.org/ Joomla!® Vulnerable Extensions List]
* [[S:MyLanguage/Top 10 Stupidest Administrator Tricks|Top 10 Stupidest Administrator Tricks]]
</translate>

;<translate>
Joomla! Security Forums</translate>

* [http://forum.joomla.org/viewforum.php?f=372 Joomla! Security Announcements]
* [http://forum.joomla.org/viewforum.php?f=432 Joomla! 1.5 Security Forum]
* [http://forum.joomla.org/viewforum.php?f=267 Joomla! 1.0 Security Forum]

<translate>==See also== </translate>
<translate>
* [[S:MyLanguage/Developers|Developers]]</translate>
* [[S:MyLanguage/Secure_coding_guidelines|Secure Coding Guidelines]]
* [[S:MyLanguage/Securing_Joomla_extensions|Securing Joomla Extensions]]

<noinclude>
<translate>
[[Category:Joomla! user profiles]]</translate>
</noinclude>

Using the JTable class

2015-07-16T13:14:11Z

Waltsjt: This article should be reviewed

{{review}}
This tutorial is for {{JVer|3.x}}

== Introduction to JTable ==
The [https://api.joomla.org/cms-3/classes/JTable.html JTable] class is an implementation of the [http://en.wikipedia.org/wiki/Active_record_pattern Active Record] design pattern. It is used throughout Joomla! for [http://en.wikipedia.org/wiki/Create,_read,_update_and_delete creating, reading, updating, and deleting] records in the database table.

Since JTable is an abstract class that forms the basis for all database table classes. Some of the methods listed will be overridden by the child class so you should check the child class documentation for further information. Also take note that as of Joomla 2.5, JTable properties are automatically generated based on the schema of the specified table, which means you don't need to declare Member variables in your class.

Each physical database table created should have a corresponding class derived from JTable to represent it. JTable provides many methods to make common manipulations to the table much simpler. For example, one of the most common operations you will need to perform is to read a table row into memory given a value for the primary key. This can be done easily using the load method. The table row can then be just as easily updated using the save method, which also performs any predefined sanity checks on the table fields.

== Writing an extension of JTable ==
To use JTable, you will create an extension of the JTable class. In this example, we have a database table "#__recipes" with an autoincrementing primary key "id" containing all of our recipes. We'll store this

The only thing we need to do to start using JTables is create a constructor in our extended JTable class. The class constructor will call the parent constructor to get the table, all it needs is the name of the table, the name of the primary key column, and the database instance.

<source lang="php">
<?php

defined('_JEXEC') or die();

class TableRecipes extends JTable
{
public function __construct(&$db)
{
parent::__construct( '#__recipes', 'id', $db );
}
}
</source>

If you were using this class as a part of a backend component called 'Recipes', you would place this code in the file /administrator/components/com_recipes/tables/recipes.php.

You can use this functionality in plugins just as components, i.e.. As a general rule you should avoid writing to the database from a module, and use plugins/components for this. Remember to use the built-in [[constants]] when linking to a custom path (outside the 'adminstrator/{com_nameofyourcomponent}/tables' folder).

== Using a JTable class extension ==

Once the table class is in place we can use it in our model getTable() function.

<source lang="php">
public function getTable($type = 'Recipes', $prefix = 'Table', $config = array())
{
return JTable::getInstance($type, $prefix, $config);
}
</source>

You can use your JTable class in any Joomla! extension by using JTable::addIncludePath() in your extension's source code (use com_nameofyourcomponent in place of com_recipes):

<source lang="php">
JTable::addIncludePath(JPATH_ADMINISTRATOR . '/components/com_recipes/tables');
$row = JTable::getInstance('recipes', 'Table', array());
</source>

Notice that the lowercase version of the suffix of your class name is used as the first parameter, with the prefix 'Table' as the second. Also, the getInstance() member function of JTable returns a JTableObject by reference instead of a value;.

=== Reserved Database Field Names ===
Some of the optional features of JTable require the existence of specially-named fields in the database table. If you require this additional functionality you should ensure that these named fields are present in the table. These field names should be considered reserved as any attempts to use them for purposes other than those supported by JTable may result in conflict.
{| class="wikitable"
|-
!Field name
!Methods using the field name
|-
|checked_out
|[[JTable/checkOut|checkOut]], [[JTable/checkIn|checkIn]], [[JTable/isCheckedOut|isCheckedOut]]
|-
|checked_out_time
|[[JTable/checkOut|checkOut]], [[JTable/checkIn|checkIn]], [[JTable/isCheckedOut|isCheckedOut]]
|-
|hits
|[[JTable/hit|hit]]
|-
|ordering
|[[JTable/getNextOrder|getNextOrder]], [[JTable/reorder|reorder]], [[JTable/move|move]]
|-
|published
|[[JTable/publish|publish]]
|}

==== Check-in/check-out ====
Joomla tables implement a simple mechanism for preventing a [[wikipedia:race condition|race condition]] while editing rows in a database. This depends on the existence of database fields called "checked_out" and "checked_out_time" and if these fields are present in the view (JForm) '''JTable''' will automatically support this mechanism so that it can be easily used in your tables too.

==== Hit counter ====
Some Joomla tables contain a field called "hits" which records the number of times that a table row has been accessed. JTable provides a simple method to increment this field: [https://api.joomla.org/cms-3/classes/JTable.html#method_hit hit].

==== Example JForm fields for Reserved database names in JTable ====
<source lang="xml">
<field name="state"
type="list"
label="JSTATUS"
description="JFIELD_PUBLISHED_DESC"
size="1"
default="1">
<option value="1">JPUBLISHED</option>
<option value="0">JUNPUBLISHED</option>
<option value="2">JARCHIVED</option>
<option value="-2">JTRASHED</option>
</field>
<field name="checked_out"
type="hidden"
filter="unset"
/>
<field name="checked_out_time"
type="hidden"
filter="unset"
/>
<field name="created_user_id"
label="JGLOBAL_FIELD_CREATED_BY_LABEL"
type="hidden"
filter="unset"
/>
<field name="created_time"
label="JGLOBAL_FIELD_CREATED_LABEL"
type="hidden"
filter="unset"
/>
<field name="modified_user_id"
label="JGLOBAL_FIELD_MODIFIED_BY_LABEL"
type="hidden"
filter="unset"
/>
<field name="modified_time"
label="JGLOBAL_FIELD_MODIFIED_LABEL"
type="hidden"
filter="unset"
/>
<field name="hits"
type="text"
id="hits"
class="readonly"
label="JGLOBAL_HITS"
size="20"
readonly="true"
filter="unset"
/>
</source>

===Useful Member Functions===
* [[JTable/load]]
* [[JTable/bind]]
* [[JTable/check]]
* [[JTable/store]]
* [[JTable/save]] Method to provide a shortcut to binding, checking and storing a JTable instance to the database table.

===See Also===
* [[J3.2:Developing an MVC Component/Using the database#admin.2Ftables.2Fhelloworld.php | Part 7 of J3.2:Developing an MVC Component/Using the database]]
*[[J2.5:Developing a MVC Component/Adding configuration#admin.2Ftables.2Fhelloworld.php | Part 14 of J2.5:Developing a MVC Component/Adding configuration]]

== Summary ==
When properly extended, JTable gives you all of the basic functions you need for managing and retrieving records in a database table.

<noinclude>
[[Category:Development]]
[[Category:Component Development]]
[[Category:Extension development]]
[[Category:JTable]]
[[Category:Tutorials]]
</noinclude>

Using the JTable class

2015-07-14T19:03:37Z

Waltsjt: fix 3.2 link following a -> an in MVC title change

This tutorial is for {{JVer|3.x}}

== Introduction to JTable ==
The [https://api.joomla.org/cms-3/classes/JTable.html JTable] class is an implementation of the [http://en.wikipedia.org/wiki/Active_record_pattern Active Record] design pattern. It is used throughout Joomla! for [http://en.wikipedia.org/wiki/Create,_read,_update_and_delete creating, reading, updating, and deleting] records in the database table.

Since JTable is an abstract class that forms the basis for all database table classes. Some of the methods listed will be overridden by the child class so you should check the child class documentation for further information. Also take note that as of Joomla 2.5, JTable properties are automatically generated based on the schema of the specified table, which means you don't need to declare Member variables in your class.

Each physical database table created should have a corresponding class derived from JTable to represent it. JTable provides many methods to make common manipulations to the table much simpler. For example, one of the most common operations you will need to perform is to read a table row into memory given a value for the primary key. This can be done easily using the load method. The table row can then be just as easily updated using the save method, which also performs any predefined sanity checks on the table fields.

== Writing an extension of JTable ==
To use JTable, you will create an extension of the JTable class. In this example, we have a database table "#__recipes" with an autoincrementing primary key "id" containing all of our recipes. We'll store this

The only thing we need to do to start using JTables is create a constructor in our extended JTable class. The class constructor will call the parent constructor to get the table, all it needs is the name of the table, the name of the primary key column, and the database instance.

<source lang="php">
<?php

defined('_JEXEC') or die();

class TableRecipes extends JTable
{
public function __construct(&$db)
{
parent::__construct( '#__recipes', 'id', $db );
}
}
</source>

If you were using this class as a part of a backend component called 'Recipes', you would place this code in the file /administrator/components/com_recipes/tables/recipes.php.

You can use this functionality in plugins just as components, i.e.. As a general rule you should avoid writing to the database from a module, and use plugins/components for this. Remember to use the built-in [[constants]] when linking to a custom path (outside the 'adminstrator/{com_nameofyourcomponent}/tables' folder).

== Using a JTable class extension ==

Once the table class is in place we can use it in our model getTable() function.

<source lang="php">
public function getTable($type = 'Recipes', $prefix = 'Table', $config = array())
{
return JTable::getInstance($type, $prefix, $config);
}
</source>

You can use your JTable class in any Joomla! extension by using JTable::addIncludePath() in your extension's source code (use com_nameofyourcomponent in place of com_recipes):

<source lang="php">
JTable::addIncludePath(JPATH_ADMINISTRATOR . '/components/com_recipes/tables');
$row = JTable::getInstance('recipes', 'Table', array());
</source>

Notice that the lowercase version of the suffix of your class name is used as the first parameter, with the prefix 'Table' as the second. Also, the getInstance() member function of JTable returns a JTableObject by reference instead of a value;.

=== Reserved Database Field Names ===
Some of the optional features of JTable require the existence of specially-named fields in the database table. If you require this additional functionality you should ensure that these named fields are present in the table. These field names should be considered reserved as any attempts to use them for purposes other than those supported by JTable may result in conflict.
{| class="wikitable"
|-
!Field name
!Methods using the field name
|-
|checked_out
|[[JTable/checkOut|checkOut]], [[JTable/checkIn|checkIn]], [[JTable/isCheckedOut|isCheckedOut]]
|-
|checked_out_time
|[[JTable/checkOut|checkOut]], [[JTable/checkIn|checkIn]], [[JTable/isCheckedOut|isCheckedOut]]
|-
|hits
|[[JTable/hit|hit]]
|-
|ordering
|[[JTable/getNextOrder|getNextOrder]], [[JTable/reorder|reorder]], [[JTable/move|move]]
|-
|published
|[[JTable/publish|publish]]
|}

==== Check-in/check-out ====
Joomla tables implement a simple mechanism for preventing a [[wikipedia:race condition|race condition]] while editing rows in a database. This depends on the existence of database fields called "checked_out" and "checked_out_time" and if these fields are present in the view (JForm) '''JTable''' will automatically support this mechanism so that it can be easily used in your tables too.

==== Hit counter ====
Some Joomla tables contain a field called "hits" which records the number of times that a table row has been accessed. JTable provides a simple method to increment this field: [https://api.joomla.org/cms-3/classes/JTable.html#method_hit hit].

==== Example JForm fields for Reserved database names in JTable ====
<source lang="xml">
<field name="state"
type="list"
label="JSTATUS"
description="JFIELD_PUBLISHED_DESC"
size="1"
default="1">
<option value="1">JPUBLISHED</option>
<option value="0">JUNPUBLISHED</option>
<option value="2">JARCHIVED</option>
<option value="-2">JTRASHED</option>
</field>
<field name="checked_out"
type="hidden"
filter="unset"
/>
<field name="checked_out_time"
type="hidden"
filter="unset"
/>
<field name="created_user_id"
label="JGLOBAL_FIELD_CREATED_BY_LABEL"
type="hidden"
filter="unset"
/>
<field name="created_time"
label="JGLOBAL_FIELD_CREATED_LABEL"
type="hidden"
filter="unset"
/>
<field name="modified_user_id"
label="JGLOBAL_FIELD_MODIFIED_BY_LABEL"
type="hidden"
filter="unset"
/>
<field name="modified_time"
label="JGLOBAL_FIELD_MODIFIED_LABEL"
type="hidden"
filter="unset"
/>
<field name="hits"
type="text"
id="hits"
class="readonly"
label="JGLOBAL_HITS"
size="20"
readonly="true"
filter="unset"
/>
</source>

===Useful Member Functions===
* [[JTable/load]]
* [[JTable/bind]]
* [[JTable/check]]
* [[JTable/store]]
* [[JTable/save]] Method to provide a shortcut to binding, checking and storing a JTable instance to the database table.

===See Also===
* [[J3.2:Developing an MVC Component/Using the database#admin.2Ftables.2Fhelloworld.php | Part 7 of J3.2:Developing an MVC Component/Using the database]]
*[[J2.5:Developing a MVC Component/Adding configuration#admin.2Ftables.2Fhelloworld.php | Part 14 of J2.5:Developing a MVC Component/Adding configuration]]

== Summary ==
When properly extended, JTable gives you all of the basic functions you need for managing and retrieving records in a database table.

<noinclude>
[[Category:Development]]
[[Category:Component Development]]
[[Category:Extension development]]
[[Category:JTable]]
[[Category:Tutorials]]
</noinclude>

API16:JTable/getKeyName

2015-07-14T15:26:16Z

Waltsjt: try fixing links by adding API16: prefix

===Description===
Method to get the primary key field name for the table.

<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JTable/getKeyName|Edit Descripton]]<nowiki>]</nowiki>
</span>

{{Description:API16:JTable/getKeyName}}

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

===Returns===
string The name of the primary key for the table.

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

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

<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[SeeAlso:API16:JTable/getKeyName|Edit See Also]]<nowiki>]</nowiki>
</span>
{{SeeAlso:API16:JTable/getKeyName}}

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

Retrieving request data using JInput

2015-07-13T16:31:30Z

Waltsjt: Remove reference to the J 1.7.1 release, and change the paragraph to make sense with the current release.

J3.x:Developing an MVC Component/Adding ACL

2015-07-09T18:47:33Z

Waltsjt: getCmd() is deprecated use get() instead.

<noinclude><languages /></noinclude>
{{review}}
{{:J3.1:Developing a MVC Component/<translate>
en</translate>}}
<translate>== Introduction == </translate>
<translate>
This tutorial is part of the [[S:MyLanguage/J3.2:Developing a MVC Component | Developing a MVC Component for Joomla! 3.2]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.</translate>

<translate>== Adding Access Control == </translate>
<translate>
With Joomla!'s Access Control we can define which user groups are allowed or denied to do which actions in your component. In this example we use actions that are defined in the core. For the component as a whole: core.admin (access to the configuration) and core.manage (access to the backend). And at various levels actions like create, delete and edit. Besides those core actions you can define your own actions, but that is often not necessary and is not shown in this example. View/Read Access is not managed via those actions but with View Access Levels; see general documentation about Joomla!'s ACL for that.</translate>

<translate>
In the #__assets table the actual list is stored: which user groups are allowed or denied to do which actions on which resources (assets). This is the implementation of the Access Control List (ACL).</translate>

<translate>
In this article we will show how to add and use access permissions at several levels of granularity: for your component as a whole, for the categories and for the individual items.</translate>

<translate>
Note: in this HelloWorld example we are working in the backend, so the only access level available are ''administrator'' and ''superuser''.</translate>
<translate>
To test this tutorial first create a new administrator user and then set its permissions (working as superuser).
After loggin in as administrator you will see the changes.</translate>

<translate>== Minimal ACL requirements at the component level == </translate>
<translate>
There are 2 actions that need to be defined at the component level for a Joomla! 2.5+ component to offer basic ACL support:</translate>
<translate>
* '''Configure''' (core.admin): which groups are allowed to configure the component level permissions via the 'Options' toolbar button?</translate>
<translate>
* '''Access Component''' (core.manage): which groups are allowed to access the component's backend?</translate>

<translate>
This basic ACL support is done in 4 simple steps:</translate>
<translate>
* [[#Add_the_2_minimal_component_level_actions_to_access.xml|Add the 2 minimal component level actions to access.xml]]</translate>
<translate>
* [[#Add_the_permissions_fieldset_to_config.xml|Add the permissions fieldset to config.xml]]</translate>
<translate>
* [[#Add_the_.27Options.27_toolbar_button_when_user_is_authorised_for_it|Add the 'Options' toolbar button]]</translate>
<translate>
* [[#Restrict_the_access_to_the_component.27s_backend_to_authorised_usergroups|Restrict the access to the component's backend]]</translate>

<translate>=== Add the 2 minimal component level actions to access.xml === </translate>
<translate>
A minimal ACL </tt>access.xml</tt> would consist of only those 2 basic actions:</translate>

<tt>Basic admin/access.xml</tt>
<source lang="xml">
<?xml version="1.0" encoding="utf-8" ?>
<access component="com_helloworld">
<section name="component">
<action name="core.admin" title="JACTION_ADMIN" description="JACTION_ADMIN_COMPONENT_DESC" />
<action name="core.manage" title="JACTION_MANAGE" description="JACTION_MANAGE_COMPONENT_DESC" />
</section>
</access>
</source>

<translate>
See ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_categories#admin/access.xml|admin/access.xml]]'' for the current and more elaborate version.</translate>

<translate>=== Add the permissions fieldset to config.xml === </translate>
<translate>
Add the following permissions fieldset to <tt>admin/config.xml</tt> in order to be able to set our component level permissions.</translate>

<source lang="xml">
<fieldset
name="permissions"
label="JCONFIG_PERMISSIONS_LABEL"
description="JCONFIG_PERMISSIONS_DESC"
>
<field
name="rules"
type="rules"
label="JCONFIG_PERMISSIONS_LABEL"
class="inputbox"
validate="rules"
filter="rules"
component="com_helloworld"
section="component"
/>
</fieldset>
</source>

<translate>
See the [[#admin.2Fconfig.xml|more elaborate config.xml example]] further downwards for the exact place where to insert this code.</translate>

<translate>=== Add the 'Options' toolbar button when user is authorised for it === </translate>
<translate>
In the <tt>admin/views/helloworlds/view.html.php</tt> file you can add the following code to check if the user can edit the preferences:</translate>

<source lang="php" highlight="2-3,5">
// Options button.
if (JFactory::getUser()->authorise('core.admin', 'com_helloworld'))
{
JToolBarHelper::preferences('com_helloworld');
}
</source>

<translate>
See further downwards for a [[#admin/views/helloworlds/view.html.php|more elaborated example of ''admin/views/helloworlds/view.html.php'']] where this ''JToolBarHelper::preferences('com_helloworld')'' is done in an addToolBar()-method together with the other toolbar buttons and the ''JUser->authorise()''-check is done with JHelperContent, resulting in the $canDo-property.</translate>

<translate>=== Restrict the access to the component's backend to authorised usergroups === </translate>
<translate>
To control the access to the backend of the component add the following lines to the <tt>admin/helloworld.php</tt> entry-file:</translate>

<source lang="php">
// Access check: is this user allowed to access the backend of this component?
if (!JFactory::getUser()->authorise('core.manage', 'com_helloworld'))
{
throw new Exception(JText::_('JERROR_ALERTNOAUTHOR'));
}
</source>

<translate>
See further downwards for the [[#admin/helloworld.php|whole code of the ''admin/helloworld.php'' file]].</translate>

<translate>== Adding more actions, also at category level and item level == </translate>
<translate>
When adding more actions and more levels, the above described 4 steps are done too:</translate>
<translate>
* [[#Describing_the_actions_you_want_to_control_the_access_to|Add the actions to access.xml; here we can add more actions and levels]]</translate>
<translate>
* [[#Adding_the_setting_of_permissions_in_the_component.27s_Preferences|Add the permissions-fieldset to config.xml]]</translate>
<translate>
* [[#Displaying_only_the_right_toolbar_buttons|Add the 'Options' toolbar button]]</translate>
<translate>
* [[#Restricting_access_to_the_component|Restrict the access to the component's backend
]]</translate>

<translate>
In addition we also have to do the following steps:</translate>
<translate>
* [[#Add_the_asset_id_column_to_the_database_table|Add an asset_id to the item's database table for item level access control]]</translate>
<translate>
* [[#Setting_the_permission_values_in_the_assets_table|Store the permissions in the assets table. Especially take care of setting the asset_id of the parent-asset]]</translate>
<translate>
* [[#Showing_the_setting_of_permissions_on_the_item_level|Make the settings of the permissions at the item level editable]]</translate>
<translate>
* [[#Adding_language_strings|Add some language strings]]</translate>

<translate>=== Describing the actions you want to control the access to === </translate>
<translate>
Each component (or part of it) has its own set of permissions that can be controlled. They are described in an <tt>access.xml</tt> file located at the root of the ''admin'' folder. In this helloworld-example the actions to which access is controlled are divided in three sections: at the component level, the category level and the item level. An 'item' is called a 'message' in our example component, hence the name of the third section.</translate>

<span id="admin/access.xml">
<tt>admin/access.xml</tt>
<source lang="xml" highlight="10-16">
<?xml version="1.0" encoding="utf-8" ?>
<access component="com_helloworld">
<section name="component">
<action name="core.admin" title="JACTION_ADMIN" description="JACTION_ADMIN_COMPONENT_DESC" />
<action name="core.manage" title="JACTION_MANAGE" description="JACTION_MANAGE_COMPONENT_DESC" />
<action name="core.create" title="JACTION_CREATE" description="JACTION_CREATE_COMPONENT_DESC" />
<action name="core.delete" title="JACTION_DELETE" description="JACTION_DELETE_COMPONENT_DESC" />
<action name="core.edit" title="JACTION_EDIT" description="JACTION_EDIT_COMPONENT_DESC" />
</section>
<section name="category">
<action name="core.create" title="JACTION_CREATE" description="COM_CATEGORIES_ACCESS_CREATE_DESC" />
<action name="core.delete" title="JACTION_DELETE" description="COM_CATEGORIES_ACCESS_DELETE_DESC" />
<action name="core.edit" title="JACTION_EDIT" description="COM_CATEGORIES_ACCESS_EDIT_DESC" />
<action name="core.edit.state" title="JACTION_EDITSTATE" description="COM_CATEGORIES_ACCESS_EDITSTATE_DESC" />
<action name="core.edit.own" title="JACTION_EDITOWN" description="COM_CATEGORIES_ACCESS_EDITOWN_DESC" />
</section>
<section name="message">
<action name="core.delete" title="JACTION_DELETE" description="COM_HELLOWORLD_ACCESS_DELETE_DESC" />
<action name="core.edit" title="JACTION_EDIT" description="COM_HELLOWORLD_ACCESS_EDIT_DESC" />
</section>
</access>
</source>
</span>

<translate>=== Adding the setting of permissions in the component's Preferences === </translate>
<translate>
Since we now use Access Control permissions in our component, we need to be able to set them at the component level. That is done in the Preferences of this component: the screen you see after clicking the 'Options' button. The config.xml-file is a form-definition for those Preferences. We could define the component level actions here too, as a child of the "rules" field-tag, but it is now preferred to also put those actions in <tt>access.xml</tt> in that way all access rules for this component are on one spot.</translate>

<span id="admin/config.xml">
<tt>admin/config.xml</tt>
<source lang="xml" highlight="19-34">
<?xml version="1.0" encoding="utf-8"?>
<config>
<fieldset
name="greetings"
label="COM_HELLOWORLD_CONFIG_GREETING_SETTINGS_LABEL"
description="COM_HELLOWORLD_CONFIG_GREETING_SETTINGS_DESC"
>
<field
name="show_category"
type="radio"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_DESC"
default="0"
>
<option value="0">JHIDE</option>
<option value="1">JSHOW</option>
</field>
</fieldset>
<fieldset
name="permissions"
label="JCONFIG_PERMISSIONS_LABEL"
description="JCONFIG_PERMISSIONS_DESC"
>
<field
name="rules"
type="rules"
label="JCONFIG_PERMISSIONS_LABEL"
class="inputbox"
validate="rules"
filter="rules"
component="com_helloworld"
section="component"
/>
</fieldset>
</config>

</source>
</span>

<translate>=== Displaying only the right toolbar buttons === </translate>

<translate>
Which toolbar buttons to display depends on the Access Control permissions for the user. We put all permissions for this user in the $canDo property of the view; so we can eventually refer to it in layouts (in the edit-form for example).</translate>

<translate>
In the <tt>admin/views/helloworlds/view.html.php</tt>, put this code:</translate>

<span id="admin/views/helloworlds/view.html.php">
<tt>admin/views/helloworlds/view.html.php</tt>
<source lang="php" highlight="42-44,83-85,87-89,91-93,95-98,100" >
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* HelloWorlds View
*
* @since 0.0.1
*/
class HelloWorldViewHelloWorlds extends JViewLegacy
{
/**
* Display the Hello World view
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return void
*/
function display($tpl = null)
{

// Get application
$app = JFactory::getApplication();
$context = "helloworld.list.admin.helloworld";
// Get data from the model
$this->items = $this->get('Items');
$this->pagination = $this->get('Pagination');
$this->state = $this->get('State');
$this->filter_order = $app->getUserStateFromRequest($context.'filter_order', 'filter_order', 'greeting', 'cmd');
$this->filter_order_Dir = $app->getUserStateFromRequest($context.'filter_order_Dir', 'filter_order_Dir', 'asc', 'cmd');
$this->filterForm = $this->get('FilterForm');
$this->activeFilters = $this->get('ActiveFilters');

// What Access Permissions does this user have? What can (s)he do?
$this->canDo = JHelperContent::getActions();

// Check for errors.
if (count($errors = $this->get('Errors')))
{
throw new Exception(implode("\n", $errors), 500);
}

// Set the submenu
HelloWorldHelper::addSubmenu('helloworlds');

// Set the toolbar and number of found items
$this->addToolBar();

// Display the template
parent::display($tpl);

// Set the document
$this->setDocument();
}

/**
* Add the page title and toolbar.
*
* @return void
*
* @since 1.6
*/
protected function addToolBar()
{
$title = JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLDS');

if ($this->pagination->total)
{
$title .= "<span style='font-size: 0.5em; vertical-align: middle;'>(" . $this->pagination->total . ")</span>";
}

JToolBarHelper::title($title, 'helloworld');

if ($this->canDo->get('core.create'))
{
JToolBarHelper::addNew('helloworld.add', 'JTOOLBAR_NEW');
}
if ($this->canDo->get('core.edit'))
{
JToolBarHelper::editList('helloworld.edit', 'JTOOLBAR_EDIT');
}
if ($this->canDo->get('core.delete'))
{
JToolBarHelper::deleteList('', 'helloworlds.delete', 'JTOOLBAR_DELETE');
}
if ($this->canDo->get('core.admin'))
{
JToolBarHelper::divider();
JToolBarHelper::preferences('com_helloworld');
}
}
/**
* Method to set up the document properties
*
* @return void
*/
protected function setDocument()
{
$document = JFactory::getDocument();
$document->setTitle(JText::_('COM_HELLOWORLD_ADMINISTRATION'));
}
}
</source>
<span>

In the ''admin/views/helloworld/view.html.php'', put this code

<span id="admin/views/helloworld/view.html.php">
''admin/views/helloworld/view.html.php''
<source lang="php" highlight="23,39-41,76-78,81-89,93-112">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* HelloWorld View
*
* @since 0.0.1
*/
class HelloWorldViewHelloWorld extends JViewLegacy
{
protected $form;
protected $item;
protected $script;
protected $canDo;

/**
* Display the Hello World view
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return void
*/
public function display($tpl = null)
{
// Get the Data
$this->form = $this->get('Form');
$this->item = $this->get('Item');
$this->script = $this->get('Script');

// What Access Permissions does this user have? What can (s)he do?
$this->canDo = JHelperContent::getActions($this->item->id);

// Check for errors.
if (count($errors = $this->get('Errors')))
{
throw new Exception(implode("\n", $errors), 500);
}

// Set the toolbar
$this->addToolBar();

// Display the template
parent::display($tpl);

// Set the document
$this->setDocument();
}

/**
* Add the page title and toolbar.
*
* @return void
*
* @since 1.6
*/
protected function addToolBar()
{
$input = JFactory::getApplication()->input;

// Hide Joomla Administrator Main menu
$input->set('hidemainmenu', true);

$isNew = ($this->item->id == 0);

JToolBarHelper::title($isNew ? JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_NEW')
: JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_EDIT'), 'helloworld');
// Build the actions for new and existing records.
if ($isNew)
{
// For new records, check the create permission.
if ($this->canDo->get('core.create'))
{
JToolBarHelper::apply('helloworld.apply', 'JTOOLBAR_APPLY');
JToolBarHelper::save('helloworld.save', 'JTOOLBAR_SAVE');
JToolBarHelper::custom('helloworld.save2new', 'save-new.png', 'save-new_f2.png',
'JTOOLBAR_SAVE_AND_NEW', false);
}
JToolBarHelper::cancel('helloworld.cancel', 'JTOOLBAR_CANCEL');
}
else
{
if ($this->canDo->get('core.edit'))
{
// We can save the new record
JToolBarHelper::apply('helloworld.apply', 'JTOOLBAR_APPLY');
JToolBarHelper::save('helloworld.save', 'JTOOLBAR_SAVE');

// We can save this record, but check the create permission to see
// if we can return to make a new one.
if ($this->canDo->get('core.create'))
{
JToolBarHelper::custom('helloworld.save2new', 'save-new.png', 'save-new_f2.png',
'JTOOLBAR_SAVE_AND_NEW', false);
}
}
if ($this->canDo->get('core.create'))
{
JToolBarHelper::custom('helloworld.save2copy', 'save-copy.png', 'save-copy_f2.png',
'JTOOLBAR_SAVE_AS_COPY', false);
}
JToolBarHelper::cancel('helloworld.cancel', 'JTOOLBAR_CLOSE');
}
}
/**
* Method to set up the document properties
*
* @return void
*/
protected function setDocument()
{
$isNew = ($this->item->id == 0);
$document = JFactory::getDocument();
$document->setTitle($isNew ? JText::_('COM_HELLOWORLD_HELLOWORLD_CREATING')
: JText::_('COM_HELLOWORLD_HELLOWORLD_EDITING'));
$document->addScript(JURI::root() . $this->script);
$document->addScript(JURI::root() . "/administrator/components/com_helloworld"
. "/views/helloworld/submitbutton.js");
JText::script('COM_HELLOWORLD_HELLOWORLD_ERROR_UNACCEPTABLE');
}
}

</source>
</span>

<translate>
These two files use the ''getActions'' method defined in the <tt>admin/helpers/helloworld.php</tt> file.</translate>

<translate>
In the helper-file, put this code:</translate>

<span id="admin/helpers/helloworld.php">
<tt>admin/helpers/helloworld.php</tt>
<source lang="php" highlight="50-72">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* HelloWorld component helper.
*
* @param string $submenu The name of the active view.
*
* @return void
*
* @since 1.6
*/
abstract class HelloWorldHelper
{
/**
* Configure the Linkbar.
*/
public static function addSubmenu($submenu)
{
JSubMenuHelper::addEntry(
JText::_('COM_HELLOWORLD_SUBMENU_MESSAGES'),
'index.php?option=com_helloworld',
$submenu == 'messages'
);

JSubMenuHelper::addEntry(
JText::_('COM_HELLOWORLD_SUBMENU_CATEGORIES'),
'index.php?option=com_categories&view=categories&extension=com_helloworld',
$submenu == 'categories'
);

// set some global property
$document = JFactory::getDocument();
$document->addStyleDeclaration('.icon-48-helloworld ' .
'{background-image: url(../media/com_helloworld/images/tux-48x48.png);}');
if ($submenu == 'categories')
{
$document->setTitle(JText::_('COM_HELLOWORLD_ADMINISTRATION_CATEGORIES'));
}
}

/**
* Get the actions
*/
public static function getActions($messageId = 0)
{
$result = new JObject;

if (empty($messageId)) {
$assetName = 'com_helloworld';
}
else {
$assetName = 'com_helloworld.message.'.(int) $messageId;
}

$actions = JAccess::getActions('com_helloworld', 'component');

foreach ($actions as $action) {
$result->set($action->name, JFactory::getUser()->authorise($action->name, $assetName));
}

return $result;
}
}

</source>
</span>

<translate>=== Restricting access to the component === </translate>

<translate>
The main idea in ACL is to restrict actions to groups of users. The first action to be restricted is access to the administrative backend of the component itself. With your favorite file editor, edit the <tt>admin/helloworld.php</tt> file and add the lines with the access check.</translate>

<span id="admin/helloworld.php">
<tt>admin/helloworld.php</tt>
<source lang="php" highlight="17-22">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// Set some global property
$document = JFactory::getDocument();
$document->addStyleDeclaration('.icon-helloworld {background-image: url(../media/com_helloworld/images/tux-16x16.png);}');

// Access check: is this user allowed to access the backend of this component?
if (!JFactory::getUser()->authorise('core.manage', 'com_helloworld'))
{
throw new Exception(JText::_('JERROR_ALERTNOAUTHOR'));
}

// Require helper file
JLoader::register('HelloWorldHelper', JPATH_COMPONENT . '/helpers/helloworld.php');

// Get an instance of the controller prefixed by HelloWorld
$controller = JControllerLegacy::getInstance('HelloWorld');

// Perform the Request task
$controller->execute(JFactory::getApplication()->input->get('task'));;

// Redirect if set by the controller
$controller->redirect();

</source>
<span>

<translate>=== Add the asset_id column to the database table === </translate>

<translate>
In order to be able to work with JTable an asset_id column has to be added to the database #__helloworld table.</translate>

<translate>
So, <tt>admin/sql/install.mysql.utf8.sql</tt> becomes:</translate>

<span id="admin/sql/install.mysql.utf8.sql">
<tt>admin/sql/install.mysql.utf8.sql</tt>
<source lang="mysql" highlight="5">
DROP TABLE IF EXISTS `#__helloworld`;

CREATE TABLE `#__helloworld` (
`id` INT(11) NOT NULL AUTO_INCREMENT,
`asset_id` INT(10) NOT NULL DEFAULT '0',
`greeting` VARCHAR(25) NOT NULL,
`published` tinyint(4) NOT NULL,
`catid` int(11) NOT NULL DEFAULT '0',
`params` VARCHAR(1024) NOT NULL DEFAULT '',
PRIMARY KEY (`id`)
)
ENGINE =MyISAM
AUTO_INCREMENT =0
DEFAULT CHARSET =utf8;

INSERT INTO `#__helloworld` (`greeting`) VALUES
('Hello World!'),
('Good bye World!');

</source>
</span>

<translate>
For updates we add a sql-update-file:</translate>

<span id="admin/sql/updates/mysql/0.0.14.sql">
<tt>admin/sql/updates/mysql/0.0.14.sql</tt>
<source lang="mysql">
ALTER TABLE`#__helloworld` ADD COLUMN `asset_id` INT(10) UNSIGNED NOT NULL DEFAULT '0' AFTER `id`;
</source>
</span>

<translate>=== Restricting access to the messages === </translate>

<translate>
So far we have restricted access to the component itself, but we also need to do that at ''message'' level.</translate>

<translate>
To check the '''"core.delete"''' permission you need to modify the model class: <tt>admin/models/helloworld.php</tt> by adding these lines:</translate>

<span id="admin/models/helloworld.php">
<tt>admin/models/helloworld.php</tt>
<source lang='php' highlight="96-105">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* HelloWorld Model
*
* @since 0.0.1
*/
class HelloWorldModelHelloWorld extends JModelAdmin
{
/**
* Method to get a table object, load it if necessary.
*
* @param string $type The table name. Optional.
* @param string $prefix The class prefix. Optional.
* @param array $config Configuration array for model. Optional.
*
* @return JTable A JTable object
*
* @since 1.6
*/
public function getTable($type = 'HelloWorld', $prefix = 'HelloWorldTable', $config = array())
{
return JTable::getInstance($type, $prefix, $config);
}

/**
* Method to get the record form.
*
* @param array $data Data for the form.
* @param boolean $loadData True if the form is to load its own data (default case), false if not.
*
* @return mixed A JForm object on success, false on failure
*
* @since 1.6
*/
public function getForm($data = array(), $loadData = true)
{
// Get the form.
$form = $this->loadForm(
'com_helloworld.helloworld',
'helloworld',
array(
'control' => 'jform',
'load_data' => $loadData
)
);

if (empty($form))
{
return false;
}

return $form;
}
/**
* Method to get the script that have to be included on the form
*
* @return string Script files
*/
public function getScript()
{
return 'administrator/components/com_helloworld/models/forms/helloworld.js';
}
/**
* Method to get the data that should be injected in the form.
*
* @return mixed The data for the form.
*
* @since 1.6
*/
protected function loadFormData()
{
// Check the session for previously entered form data.
$data = JFactory::getApplication()->getUserState(
'com_helloworld.edit.helloworld.data',
array()
);

if (empty($data))
{
$data = $this->getItem();
}

return $data;
}
/**
* Method to check if it's OK to delete a message. Overwrites JModelAdmin::canDelete
*/
protected function canDelete($record)
{
if( !empty( $record->id ) )
{
return JFactory::getUser()->authorise( "core.delete", "com_helloworld.message." . $record->id );
}
}
}

</source>
</span>

<translate>
To check '''"core.edit"''' (and '''core.add''' if you wish) you need to update the sub-controller (''not'' the model). I am not sure why this is so, but that's how other standard Joomla components do it. You need to add the following lines in the file: <tt>admin/controllers/helloworld.php</tt></translate>

<span id="admin/controllers/helloworld.php">
<tt>admin/controllers/helloworld.php</tt>
<source lang='php' highlight="21-49">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* HelloWorld Controller
*
* @package Joomla.Administrator
* @subpackage com_helloworld
* @since 0.0.9
*/
class HelloWorldControllerHelloWorld extends JControllerForm
{
/**
* Implement to allowAdd or not
*
* Not used at this time (but you can look at how other components use it....)
* Overwrites: JControllerForm::allowAdd
*
* @param array $data
* @return bool
*/
protected function allowAdd($data = array())
{
return parent::allowAdd($data);
}
/**
* Implement to allow edit or not
* Overwrites: JControllerForm::allowEdit
*
* @param array $data
* @param string $key
* @return bool
*/
protected function allowEdit($data = array(), $key = 'id')
{
$id = isset( $data[ $key ] ) ? $data[ $key ] : 0;
if( !empty( $id ) )
{
return JFactory::getUser()->authorise( "core.edit", "com_helloworld.message." . $id );
}
}
}

</source>
</span>

<translate>
Please note that ''allowAdd'' simply calls its parent. I've put it here in case you want to actually use it in your component. If you look at your <tt>admin/access.xml</tt> file, you will notice there is no ''core.add'' action defined for "messages", so you will need to add it there as well if you want to be able to configure it in the interface.</translate>

<translate>=== Setting the permission values in the assets table === </translate>

<translate>
In order to store permissions for each message in the assets database table, we have to instruct the table class associated with the model to save those permissions in the assets table.</translate>

<translate>
JTable not only provides an interface for storing the data of the record itself in the item's database table, but also for storing the permissions for that record in the assets database table. Therefore we must add information to the bind()-method about the permission-values. We also have to provide the asset name, asset title and the id of the asset parent via the helloworld JTable. Therefore we override 3 methods:</translate>
<translate>
* _getAssetName(): a unique name for this asset, by which it can be retrieved</translate>
<translate>
* _getAssetTitle(): a more human-friendly way to identify the asset (not necessary unique)</translate>
<translate>
* _getAssetParentId(): the asset_id of the parent in the asset database table (from whom permissions are inherited)</translate>

<span id="admin/tables/helloworld.php">
<tt>admin/tables/helloworld.php</tt>
<source lang="php" highlight="45-52,80-133">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
// No direct access
defined('_JEXEC') or die('Restricted access');

/**
* Hello Table class
*
* @since 0.0.1
*/
class HelloWorldTableHelloWorld extends JTable
{
/**
* Constructor
*
* @param JDatabaseDriver &$db A database connector object
*/
function __construct(&$db)
{
parent::__construct('#__helloworld', 'id', $db);
}
/**
* Overloaded bind function
*
* @param array named array
* @return null|string null is operation was satisfactory, otherwise returns an error
* @see JTable:bind
* @since 1.5
*/
public function bind($array, $ignore = '')
{
if (isset($array['params']) && is_array($array['params']))
{
// Convert the params field to a string.
$parameter = new JRegistry;
$parameter->loadArray($array['params']);
$array['params'] = (string)$parameter;
}

// Bind the rules.
if (isset($array['rules']) && is_array($array['rules']))
{
$rules = new JAccessRules($array['rules']);
$this->setRules($rules);
}

return parent::bind($array, $ignore);
}

/**
* Overloaded load function
*
* @param int $pk primary key
* @param boolean $reset reset data
* @return boolean
* @see JTable:load
*/
public function load($pk = null, $reset = true)
{
if (parent::load($pk, $reset))
{
// Convert the params field to a registry.
$params = new JRegistry;
$params->loadString($this->params, 'JSON');

$this->params = $params;
return true;
}
else
{
return false;
}
}
/**
* Method to compute the default name of the asset.
* The default name is in the form `table_name.id`
* where id is the value of the primary key of the table.
*
* @return string
* @since 2.5
*/
protected function _getAssetName()
{
$k = $this->_tbl_key;
return 'com_helloworld.message.'.(int) $this->$k;
}
/**
* Method to return the title to use for the asset table.
*
* @return string
* @since 2.5
*/
protected function _getAssetTitle()
{
return $this->greeting;
}
/**
* Method to get the asset-parent-id of the item
*
* @return int
*/
protected function _getAssetParentId(JTable $table = NULL, $id = NULL)
{
// We will retrieve the parent-asset from the Asset-table
$assetParent = JTable::getInstance('Asset');
// Default: if no asset-parent can be found we take the global asset
$assetParentId = $assetParent->getRootId();

// Find the parent-asset
if (($this->catid)&& !empty($this->catid))
{
// The item has a category as asset-parent
$assetParent->loadByName('com_helloworld.category.' . (int) $this->catid);
}
else
{
// The item has the component as asset-parent
$assetParent->loadByName('com_helloworld');
}

// Return the found asset-parent-id
if ($assetParent->id)
{
$assetParentId=$assetParent->id;
}
return $assetParentId;
}
}

</source>
</span>

<translate>
This code for _getAssetParentId() above uses JTableAsset to retrieve the asset_id of the asset-parent. This is different from the code in the current version of com_content, where the asset_id of the category is retrieved from the #__categories database table. That is another possibility; many ways leading to Rome. In com_content however, if an item would not be under a category, then the asset_id of the global asset is returned. That would of course not be right, but is fixed there by providing a default category "uncategorised", so that an article is ''always'' under a category. That is why you cannot just copy the code of _getAssetParentId() in com_content to your own component. The code above is more general.</translate>

<translate>=== Showing the setting of permissions on the item level === </translate>

<translate>
Adding the rules field to the form-definition of the edit-form.</translate>

<span id="admin/models/forms/helloworld.xml">
<tt>admin/models/forms/helloworld.xml</tt>
<source lang="xml" highlight="55-74">
<?xml version="1.0" encoding="utf-8"?>
<form
addrulepath="/administrator/components/com_helloworld/models/rules"
>
<fieldset
name="details"
label="COM_HELLOWORLD_HELLOWORLD_DETAILS"
>
<field
name="id"
type="hidden"
/>
<field
name="greeting"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_GREETING_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_GREETING_DESC"
size="40"
class="inputbox validate-greeting"
validate="greeting"
required="true"
default=""
/>
<field
name="catid"
type="category"
extension="com_helloworld"
class="inputbox"
default=""
label="COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_DESC"
required="true"
>
<option value="0">JOPTION_SELECT_CATEGORY</option>
</field>
</fieldset>
<fields name="params">
<fieldset
name="params"
label="JGLOBAL_FIELDSET_DISPLAY_OPTIONS"
>
<field
name="show_category"
type="list"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_DESC"
default=""
>
<option value="">JGLOBAL_USE_GLOBAL</option>
<option value="0">JHIDE</option>
<option value="1">JSHOW</option>
</field>
</fieldset>
</fields>
<fieldset
name="accesscontrol"
label="COM_HELLOWORLD_FIELDSET_RULES"
>
<field
name="asset_id"
type="hidden"
filter="unset"
/>
<field
name="rules"
type="rules"
label="COM_HELLOWORLD_FIELD_RULES_LABEL"
filter="rules"
validate="rules"
class="inputbox"
component="com_helloworld"
section="message"
/>
</fieldset>
</form>

</source>
</span>

<translate>
Now the ACL interface is displayed at the bottom of the Helloworld editform too (the ''edit.php'' file automatically get the fieldsets from the above xml).</translate>

<translate>=== Adding language strings === </translate>
<translate>
We used 4 language strings that have to be added to the backend language-file.</translate>

<span id="admin/language/en-GB/en-GB.com_helloworld.ini">
<tt>admin/language/en-GB/en-GB.com_helloworld.ini</tt>
<source lang="text" highlight="41-44">
; Joomla! Project
; Copyright (C) 2005 - 2015 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

COM_HELLOWORLD_ADMINISTRATION="HelloWorld - Administration"
COM_HELLOWORLD_ADMINISTRATION_CATEGORIES="HelloWorld - Categories"
COM_HELLOWORLD_NUM="#"
COM_HELLOWORLD_HELLOWORLDS_FILTER="Filters"
COM_HELLOWORLD_PUBLISHED="Published"
COM_HELLOWORLD_HELLOWORLDS_NAME="Name"
COM_HELLOWORLD_ID="Id"

COM_HELLOWORLD_HELLOWORLD_CREATING="HelloWorld - Creating"
COM_HELLOWORLD_HELLOWORLD_DETAILS="Details"
COM_HELLOWORLD_HELLOWORLD_EDITING="HelloWorld - Editing"
COM_HELLOWORLD_HELLOWORLD_ERROR_UNACCEPTABLE="Some values are unacceptable"
COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_DESC="The category the messages belongs to"
COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_LABEL="Category"
COM_HELLOWORLD_HELLOWORLD_FIELD_GREETING_DESC="This message will be displayed"
COM_HELLOWORLD_HELLOWORLD_FIELD_GREETING_LABEL="Message"
COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_LABEL="Show category"
COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_DESC="If set to Show, the title of the message’s category will show."
COM_HELLOWORLD_HELLOWORLD_HEADING_GREETING="Greeting"
COM_HELLOWORLD_HELLOWORLD_HEADING_ID="Id"
COM_HELLOWORLD_MANAGER_HELLOWORLD_EDIT="HelloWorld manager: Edit Message"
COM_HELLOWORLD_MANAGER_HELLOWORLD_NEW="HelloWorld manager: New Message"
COM_HELLOWORLD_MANAGER_HELLOWORLDS="HelloWorld manager"
COM_HELLOWORLD_EDIT_HELLOWORLD="Edit message"
COM_HELLOWORLD_N_ITEMS_DELETED_1="One message deleted"
COM_HELLOWORLD_N_ITEMS_DELETED_MORE="%d messages deleted"
COM_HELLOWORLD_N_ITEMS_PUBLISHED="%d message(s) published"
COM_HELLOWORLD_N_ITEMS_UNPUBLISHED="%d message(s) unpublished"
COM_HELLOWORLD_HELLOWORLD_GREETING_LABEL="Greeting"
COM_HELLOWORLD_HELLOWORLD_GREETING_DESC="Add Hello World Greeting"
COM_HELLOWORLD_SUBMENU_MESSAGES="Messages"
COM_HELLOWORLD_SUBMENU_CATEGORIES="Categories"
COM_HELLOWORLD_CONFIGURATION="HelloWorld Configuration"
COM_HELLOWORLD_CONFIG_GREETING_SETTINGS_LABEL="Messages settings"
COM_HELLOWORLD_CONFIG_GREETING_SETTINGS_DESC="Settings that will be applied to all messages by default"
COM_HELLOWORLD_FIELDSET_RULES="Message Permissions"
COM_HELLOWORLD_FIELD_RULES_LABEL="Permissions"
COM_HELLOWORLD_ACCESS_DELETE_DESC="Is this group allowed to edit this message?"
COM_HELLOWORLD_ACCESS_DELETE_DESC="Is this group allowed to delete this message?"

</source>
</span>

<translate>== Further reading == </translate>
<translate>
More information on actions, assets and ACL can be found on the following pages:</translate>
<translate>
* General information and use: [[S:MyLanguage/Access Control List/1.6-2.5/Tutorial|Access Control List/1.6-2.5/Tutorial]]</translate>
<translate>
* Technical information, under construction: [[S:MyLanguage/ACL Technique in Joomla!|ACL Technique in Joomla!]]</translate>
<translate>
* [[S:MyLanguage/How to implement actions in your code|How to implement actions in your code]]</translate>
<translate>
* [[S:MyLanguage/Adding ACL rules to your component|Adding ACL rules to your component]]</translate>

<translate>== Deprecated classes == </translate>
<translate>
For the moment we leave the '''deprecated JError'''-references as they are. They will probably still be available in Joomla! 3.x. We cannot just change them to JLog::add() statements because in Joomla! 2.5 the messages will then not be enqueued (as there is no messagequeue-logger added as is in /libraries/cms.php in Joomla! 3.0). Other solutions, like using $app->enqueueMessage() or directly throwing PHP-exceptions as showstopper are also possible, but then there would still be numerous references to JError throughout the application. For instance in the view, we now check for errors raised in the model with: <span style="color:#900">count($errors = $this->get('Errors'))</span>, which uses JError from the JOBject that was the base for JModel. To get the same functionality without using JError at all, we would have to change the way the Model raises those errors and warnings now. If we want to make an application that would work in Joomla! 2.5 and 3.x we can continue using JError. The moment we want to use our 3.x extensions also in 4.x we will have to change this (and probably a lot more too). This tutorial is now primarily focused on Joomla! 3.x. So: we notice the upcoming change, but leave it there for the moment.</translate>

<translate>
Since Joomla! 2.5.5 the MVC-base-classes JController, JModel and JView got proxies JControllerLegacy, JModelLegacy and JViewLegacy. You are recommended to use those proxies instead of the original classes to be forward compatibility with Joomla! CMS 3.x legacy classes.</translate>

<translate>== Packaging the component == </translate>

<translate>
Content of your code directory</translate>
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#helloworld.xml|helloworld.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/helloworld.php|site/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/controller.php|site/controller.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/models/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/language/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/language/en-GB/index.html]]''
* ''[[S:MyLanguage/J3.x:Developing a MVC Component/Adding language management#site.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.ini|site/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Basic_backend#admin/helloworld.php|admin/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_configuration#admin/config.xml|admin/config.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Basic_backend#admin/controller.php|admin/controller.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_categories#admin/access.xml|admin/access.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_categories#admin/helpers/helloworld.php|admin/helpers/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/helpers/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_categories#admin/sql/updates/mysql/0.0.12.sql|admin/sql/updates/mysql/0.0.12.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_configuration#admin/sql/updates/mysql/0.0.13.sql|admin/sql/updates/mysql/0.0.13.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_ACL#admin/sql/updates/mysql/0.0.14.sql|admin/sql/updates/mysql/0.0.14.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Basic_backend#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/helloworlds.php|admin/models/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/forms/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_verifications#admin/models/forms/helloworld.js|admin/models/forms/helloworld.js]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/forms/helloworld.xml|admin/models/forms/helloworld.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_verifications#admin/models/rules/greeting.php|admin/models/rules/greeting.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/rules/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/controllers/helloworld.php|admin/controllers/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/controllers/helloworlds.php|admin/controllers/helloworlds.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/controllers/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworld/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/views/helloworld/view.html.php|admin/views/helloworld/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/views/helloworld/tmpl/edit.php|admin/views/helloworld/tmpl/edit.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_verifications#admin/views/helloworld/submitbutton.js|admin/views/helloworld/submitbutton.js]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/tables/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#admin/tables/helloworld.php|admin/tables/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/language/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/language/en-GB/index.html]]''
* ''[[S:MyLanguage/J3.x:Developing a MVC Component/Adding language management#admin.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.ini|admin/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[S:MyLanguage/J3.x:Developing a MVC Component/Adding language management#admin.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.sys.ini|admin/language/en-GB/en-GB.com_helloworld.sys.ini]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|media/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|media/images/index.html]]''
* ''[[S:MyLanguage/J3.x:Developing_a_MVC_Component/Adding_decorations_to_the_backend#Adding_some_icons|media/images/tux-16x16.png]]''
* ''[[S:MyLanguage/J3.x:Developing_a_MVC_Component/Adding_decorations_to_the_backend#Adding_some_icons|media/images/tux-48x48.png]]''

<translate>
Create a compressed file of this directory or directly download the [https://github.com/scionescire/Joomla-3.2-Hello-World-Component/archive/step-14-adding-ACL.zip archive] and install it using the extension manager of Joomla. You can add a menu item of this component using the menu manager in the backend.</translate>

<span id="helloworld.xml">
<tt>helloworld.xml</tt>
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2.0" method="upgrade">

<name>COM_HELLOWORLD</name>

<creationDate>February 2015</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.14</version>

<description>COM_HELLOWORLD_DESCRIPTION</description>

<install> 
<sql>
<file driver="mysql" charset="utf8">sql/install.mysql.utf8.sql</file>
</sql>
</install>
<uninstall> 
<sql>
<file driver="mysql" charset="utf8">sql/uninstall.mysql.utf8.sql</file>
</sql>
</uninstall>
<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



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

<languages folder="site/language">
<language tag="en-GB">en-GB/en-GB.com_helloworld.ini</language>
</languages>

<media destination="com_helloworld" folder="media">
<filename>index.html</filename>
<folder>images</folder>
</media>

<administration>

<menu link='index.php?option=com_helloworld' img="../media/com_helloworld/images/tux-16x16.png">COM_HELLOWORLD_MENU</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>config.xml</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<filename>access.xml</filename>

<folder>sql</folder>

<folder>tables</folder>

<folder>models</folder>

<folder>views</folder>

<folder>controllers</folder>

<folder>helpers</folder>
</files>
<languages folder="admin/language">
<language tag="en-GB">en-GB/en-GB.com_helloworld.ini</language>
<language tag="en-GB">en-GB/en-GB.com_helloworld.sys.ini</language>
</languages>
</administration>

</extension>
</source>
</span>

<translate>== Contributors == </translate>
*[[User:Dwarkesh0204|Dwarkesh Soni]]
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]
*[[User:florian_denizot|Florian Denizot]]
*[[User:HermanPeeren|Herman Peeren]]
* TDZweb (Ståle Rolf Sæbøe), Elin Waring, Neil via https://groups.google.com/forum/#!topic/joomla-dev-general/aCH3GNA91m4
*[[User:Scionescire|Scionescire]]

<div class="row">
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_a_MVC_Component/Adding configuration|Prev: Adding configuration</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_a_MVC_Component/Adding an install-uninstall-update script file|Next: Adding an install-uninstall-update script file</translate>|class=expand}}</div>
</div>

<noinclude>
<translate>

[[Category:Joomla! 3.x]]
[[Category:Beginner Development]]
[[Category:Component Development]]
[[Category:Tutorials]]
[[Category:Tutorials in a Series]]
</translate>
</noinclude>

J3.x:Developing an MVC Component/Adding ACL

2015-07-09T18:46:31Z

Waltsjt: This is the J3.x example not J2.5, somethings should just be fixed

<noinclude><languages /></noinclude>
{{review}}
{{:J3.1:Developing a MVC Component/<translate>
en</translate>}}
<translate>== Introduction == </translate>
<translate>
This tutorial is part of the [[S:MyLanguage/J3.2:Developing a MVC Component | Developing a MVC Component for Joomla! 3.2]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.</translate>

<translate>== Adding Access Control == </translate>
<translate>
With Joomla!'s Access Control we can define which user groups are allowed or denied to do which actions in your component. In this example we use actions that are defined in the core. For the component as a whole: core.admin (access to the configuration) and core.manage (access to the backend). And at various levels actions like create, delete and edit. Besides those core actions you can define your own actions, but that is often not necessary and is not shown in this example. View/Read Access is not managed via those actions but with View Access Levels; see general documentation about Joomla!'s ACL for that.</translate>

<translate>
In the #__assets table the actual list is stored: which user groups are allowed or denied to do which actions on which resources (assets). This is the implementation of the Access Control List (ACL).</translate>

<translate>
In this article we will show how to add and use access permissions at several levels of granularity: for your component as a whole, for the categories and for the individual items.</translate>

<translate>
Note: in this HelloWorld example we are working in the backend, so the only access level available are ''administrator'' and ''superuser''.</translate>
<translate>
To test this tutorial first create a new administrator user and then set its permissions (working as superuser).
After loggin in as administrator you will see the changes.</translate>

<translate>== Minimal ACL requirements at the component level == </translate>
<translate>
There are 2 actions that need to be defined at the component level for a Joomla! 2.5+ component to offer basic ACL support:</translate>
<translate>
* '''Configure''' (core.admin): which groups are allowed to configure the component level permissions via the 'Options' toolbar button?</translate>
<translate>
* '''Access Component''' (core.manage): which groups are allowed to access the component's backend?</translate>

<translate>
This basic ACL support is done in 4 simple steps:</translate>
<translate>
* [[#Add_the_2_minimal_component_level_actions_to_access.xml|Add the 2 minimal component level actions to access.xml]]</translate>
<translate>
* [[#Add_the_permissions_fieldset_to_config.xml|Add the permissions fieldset to config.xml]]</translate>
<translate>
* [[#Add_the_.27Options.27_toolbar_button_when_user_is_authorised_for_it|Add the 'Options' toolbar button]]</translate>
<translate>
* [[#Restrict_the_access_to_the_component.27s_backend_to_authorised_usergroups|Restrict the access to the component's backend]]</translate>

<translate>=== Add the 2 minimal component level actions to access.xml === </translate>
<translate>
A minimal ACL </tt>access.xml</tt> would consist of only those 2 basic actions:</translate>

<tt>Basic admin/access.xml</tt>
<source lang="xml">
<?xml version="1.0" encoding="utf-8" ?>
<access component="com_helloworld">
<section name="component">
<action name="core.admin" title="JACTION_ADMIN" description="JACTION_ADMIN_COMPONENT_DESC" />
<action name="core.manage" title="JACTION_MANAGE" description="JACTION_MANAGE_COMPONENT_DESC" />
</section>
</access>
</source>

<translate>
See ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_categories#admin/access.xml|admin/access.xml]]'' for the current and more elaborate version.</translate>

<translate>=== Add the permissions fieldset to config.xml === </translate>
<translate>
Add the following permissions fieldset to <tt>admin/config.xml</tt> in order to be able to set our component level permissions.</translate>

<source lang="xml">
<fieldset
name="permissions"
label="JCONFIG_PERMISSIONS_LABEL"
description="JCONFIG_PERMISSIONS_DESC"
>
<field
name="rules"
type="rules"
label="JCONFIG_PERMISSIONS_LABEL"
class="inputbox"
validate="rules"
filter="rules"
component="com_helloworld"
section="component"
/>
</fieldset>
</source>

<translate>
See the [[#admin.2Fconfig.xml|more elaborate config.xml example]] further downwards for the exact place where to insert this code.</translate>

<translate>=== Add the 'Options' toolbar button when user is authorised for it === </translate>
<translate>
In the <tt>admin/views/helloworlds/view.html.php</tt> file you can add the following code to check if the user can edit the preferences:</translate>

<source lang="php" highlight="2-3,5">
// Options button.
if (JFactory::getUser()->authorise('core.admin', 'com_helloworld'))
{
JToolBarHelper::preferences('com_helloworld');
}
</source>

<translate>
See further downwards for a [[#admin/views/helloworlds/view.html.php|more elaborated example of ''admin/views/helloworlds/view.html.php'']] where this ''JToolBarHelper::preferences('com_helloworld')'' is done in an addToolBar()-method together with the other toolbar buttons and the ''JUser->authorise()''-check is done with JHelperContent, resulting in the $canDo-property.</translate>

<translate>=== Restrict the access to the component's backend to authorised usergroups === </translate>
<translate>
To control the access to the backend of the component add the following lines to the <tt>admin/helloworld.php</tt> entry-file:</translate>

<source lang="php">
// Access check: is this user allowed to access the backend of this component?
if (!JFactory::getUser()->authorise('core.manage', 'com_helloworld'))
{
throw new Exception(JText::_('JERROR_ALERTNOAUTHOR'));
}
</source>

<translate>
See further downwards for the [[#admin/helloworld.php|whole code of the ''admin/helloworld.php'' file]].</translate>

<translate>== Adding more actions, also at category level and item level == </translate>
<translate>
When adding more actions and more levels, the above described 4 steps are done too:</translate>
<translate>
* [[#Describing_the_actions_you_want_to_control_the_access_to|Add the actions to access.xml; here we can add more actions and levels]]</translate>
<translate>
* [[#Adding_the_setting_of_permissions_in_the_component.27s_Preferences|Add the permissions-fieldset to config.xml]]</translate>
<translate>
* [[#Displaying_only_the_right_toolbar_buttons|Add the 'Options' toolbar button]]</translate>
<translate>
* [[#Restricting_access_to_the_component|Restrict the access to the component's backend
]]</translate>

<translate>
In addition we also have to do the following steps:</translate>
<translate>
* [[#Add_the_asset_id_column_to_the_database_table|Add an asset_id to the item's database table for item level access control]]</translate>
<translate>
* [[#Setting_the_permission_values_in_the_assets_table|Store the permissions in the assets table. Especially take care of setting the asset_id of the parent-asset]]</translate>
<translate>
* [[#Showing_the_setting_of_permissions_on_the_item_level|Make the settings of the permissions at the item level editable]]</translate>
<translate>
* [[#Adding_language_strings|Add some language strings]]</translate>

<translate>=== Describing the actions you want to control the access to === </translate>
<translate>
Each component (or part of it) has its own set of permissions that can be controlled. They are described in an <tt>access.xml</tt> file located at the root of the ''admin'' folder. In this helloworld-example the actions to which access is controlled are divided in three sections: at the component level, the category level and the item level. An 'item' is called a 'message' in our example component, hence the name of the third section.</translate>

<span id="admin/access.xml">
<tt>admin/access.xml</tt>
<source lang="xml" highlight="10-16">
<?xml version="1.0" encoding="utf-8" ?>
<access component="com_helloworld">
<section name="component">
<action name="core.admin" title="JACTION_ADMIN" description="JACTION_ADMIN_COMPONENT_DESC" />
<action name="core.manage" title="JACTION_MANAGE" description="JACTION_MANAGE_COMPONENT_DESC" />
<action name="core.create" title="JACTION_CREATE" description="JACTION_CREATE_COMPONENT_DESC" />
<action name="core.delete" title="JACTION_DELETE" description="JACTION_DELETE_COMPONENT_DESC" />
<action name="core.edit" title="JACTION_EDIT" description="JACTION_EDIT_COMPONENT_DESC" />
</section>
<section name="category">
<action name="core.create" title="JACTION_CREATE" description="COM_CATEGORIES_ACCESS_CREATE_DESC" />
<action name="core.delete" title="JACTION_DELETE" description="COM_CATEGORIES_ACCESS_DELETE_DESC" />
<action name="core.edit" title="JACTION_EDIT" description="COM_CATEGORIES_ACCESS_EDIT_DESC" />
<action name="core.edit.state" title="JACTION_EDITSTATE" description="COM_CATEGORIES_ACCESS_EDITSTATE_DESC" />
<action name="core.edit.own" title="JACTION_EDITOWN" description="COM_CATEGORIES_ACCESS_EDITOWN_DESC" />
</section>
<section name="message">
<action name="core.delete" title="JACTION_DELETE" description="COM_HELLOWORLD_ACCESS_DELETE_DESC" />
<action name="core.edit" title="JACTION_EDIT" description="COM_HELLOWORLD_ACCESS_EDIT_DESC" />
</section>
</access>
</source>
</span>

<translate>=== Adding the setting of permissions in the component's Preferences === </translate>
<translate>
Since we now use Access Control permissions in our component, we need to be able to set them at the component level. That is done in the Preferences of this component: the screen you see after clicking the 'Options' button. The config.xml-file is a form-definition for those Preferences. We could define the component level actions here too, as a child of the "rules" field-tag, but it is now preferred to also put those actions in <tt>access.xml</tt> in that way all access rules for this component are on one spot.</translate>

<span id="admin/config.xml">
<tt>admin/config.xml</tt>
<source lang="xml" highlight="19-34">
<?xml version="1.0" encoding="utf-8"?>
<config>
<fieldset
name="greetings"
label="COM_HELLOWORLD_CONFIG_GREETING_SETTINGS_LABEL"
description="COM_HELLOWORLD_CONFIG_GREETING_SETTINGS_DESC"
>
<field
name="show_category"
type="radio"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_DESC"
default="0"
>
<option value="0">JHIDE</option>
<option value="1">JSHOW</option>
</field>
</fieldset>
<fieldset
name="permissions"
label="JCONFIG_PERMISSIONS_LABEL"
description="JCONFIG_PERMISSIONS_DESC"
>
<field
name="rules"
type="rules"
label="JCONFIG_PERMISSIONS_LABEL"
class="inputbox"
validate="rules"
filter="rules"
component="com_helloworld"
section="component"
/>
</fieldset>
</config>

</source>
</span>

<translate>=== Displaying only the right toolbar buttons === </translate>

<translate>
Which toolbar buttons to display depends on the Access Control permissions for the user. We put all permissions for this user in the $canDo property of the view; so we can eventually refer to it in layouts (in the edit-form for example).</translate>

<translate>
In the <tt>admin/views/helloworlds/view.html.php</tt>, put this code:</translate>

<span id="admin/views/helloworlds/view.html.php">
<tt>admin/views/helloworlds/view.html.php</tt>
<source lang="php" highlight="42-44,83-85,87-89,91-93,95-98,100" >
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* HelloWorlds View
*
* @since 0.0.1
*/
class HelloWorldViewHelloWorlds extends JViewLegacy
{
/**
* Display the Hello World view
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return void
*/
function display($tpl = null)
{

// Get application
$app = JFactory::getApplication();
$context = "helloworld.list.admin.helloworld";
// Get data from the model
$this->items = $this->get('Items');
$this->pagination = $this->get('Pagination');
$this->state = $this->get('State');
$this->filter_order = $app->getUserStateFromRequest($context.'filter_order', 'filter_order', 'greeting', 'cmd');
$this->filter_order_Dir = $app->getUserStateFromRequest($context.'filter_order_Dir', 'filter_order_Dir', 'asc', 'cmd');
$this->filterForm = $this->get('FilterForm');
$this->activeFilters = $this->get('ActiveFilters');

// What Access Permissions does this user have? What can (s)he do?
$this->canDo = JHelperContent::getActions();

// Check for errors.
if (count($errors = $this->get('Errors')))
{
throw new Exception(implode("\n", $errors), 500);
}

// Set the submenu
HelloWorldHelper::addSubmenu('helloworlds');

// Set the toolbar and number of found items
$this->addToolBar();

// Display the template
parent::display($tpl);

// Set the document
$this->setDocument();
}

/**
* Add the page title and toolbar.
*
* @return void
*
* @since 1.6
*/
protected function addToolBar()
{
$title = JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLDS');

if ($this->pagination->total)
{
$title .= "<span style='font-size: 0.5em; vertical-align: middle;'>(" . $this->pagination->total . ")</span>";
}

JToolBarHelper::title($title, 'helloworld');

if ($this->canDo->get('core.create'))
{
JToolBarHelper::addNew('helloworld.add', 'JTOOLBAR_NEW');
}
if ($this->canDo->get('core.edit'))
{
JToolBarHelper::editList('helloworld.edit', 'JTOOLBAR_EDIT');
}
if ($this->canDo->get('core.delete'))
{
JToolBarHelper::deleteList('', 'helloworlds.delete', 'JTOOLBAR_DELETE');
}
if ($this->canDo->get('core.admin'))
{
JToolBarHelper::divider();
JToolBarHelper::preferences('com_helloworld');
}
}
/**
* Method to set up the document properties
*
* @return void
*/
protected function setDocument()
{
$document = JFactory::getDocument();
$document->setTitle(JText::_('COM_HELLOWORLD_ADMINISTRATION'));
}
}
</source>
<span>

In the ''admin/views/helloworld/view.html.php'', put this code

<span id="admin/views/helloworld/view.html.php">
''admin/views/helloworld/view.html.php''
<source lang="php" highlight="23,39-41,76-78,81-89,93-112">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* HelloWorld View
*
* @since 0.0.1
*/
class HelloWorldViewHelloWorld extends JViewLegacy
{
protected $form;
protected $item;
protected $script;
protected $canDo;

/**
* Display the Hello World view
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return void
*/
public function display($tpl = null)
{
// Get the Data
$this->form = $this->get('Form');
$this->item = $this->get('Item');
$this->script = $this->get('Script');

// What Access Permissions does this user have? What can (s)he do?
$this->canDo = JHelperContent::getActions($this->item->id);

// Check for errors.
if (count($errors = $this->get('Errors')))
{
throw new Exception(implode("\n", $errors), 500);
}

// Set the toolbar
$this->addToolBar();

// Display the template
parent::display($tpl);

// Set the document
$this->setDocument();
}

/**
* Add the page title and toolbar.
*
* @return void
*
* @since 1.6
*/
protected function addToolBar()
{
$input = JFactory::getApplication()->input;

// Hide Joomla Administrator Main menu
$input->set('hidemainmenu', true);

$isNew = ($this->item->id == 0);

JToolBarHelper::title($isNew ? JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_NEW')
: JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_EDIT'), 'helloworld');
// Build the actions for new and existing records.
if ($isNew)
{
// For new records, check the create permission.
if ($this->canDo->get('core.create'))
{
JToolBarHelper::apply('helloworld.apply', 'JTOOLBAR_APPLY');
JToolBarHelper::save('helloworld.save', 'JTOOLBAR_SAVE');
JToolBarHelper::custom('helloworld.save2new', 'save-new.png', 'save-new_f2.png',
'JTOOLBAR_SAVE_AND_NEW', false);
}
JToolBarHelper::cancel('helloworld.cancel', 'JTOOLBAR_CANCEL');
}
else
{
if ($this->canDo->get('core.edit'))
{
// We can save the new record
JToolBarHelper::apply('helloworld.apply', 'JTOOLBAR_APPLY');
JToolBarHelper::save('helloworld.save', 'JTOOLBAR_SAVE');

// We can save this record, but check the create permission to see
// if we can return to make a new one.
if ($this->canDo->get('core.create'))
{
JToolBarHelper::custom('helloworld.save2new', 'save-new.png', 'save-new_f2.png',
'JTOOLBAR_SAVE_AND_NEW', false);
}
}
if ($this->canDo->get('core.create'))
{
JToolBarHelper::custom('helloworld.save2copy', 'save-copy.png', 'save-copy_f2.png',
'JTOOLBAR_SAVE_AS_COPY', false);
}
JToolBarHelper::cancel('helloworld.cancel', 'JTOOLBAR_CLOSE');
}
}
/**
* Method to set up the document properties
*
* @return void
*/
protected function setDocument()
{
$isNew = ($this->item->id == 0);
$document = JFactory::getDocument();
$document->setTitle($isNew ? JText::_('COM_HELLOWORLD_HELLOWORLD_CREATING')
: JText::_('COM_HELLOWORLD_HELLOWORLD_EDITING'));
$document->addScript(JURI::root() . $this->script);
$document->addScript(JURI::root() . "/administrator/components/com_helloworld"
. "/views/helloworld/submitbutton.js");
JText::script('COM_HELLOWORLD_HELLOWORLD_ERROR_UNACCEPTABLE');
}
}

</source>
</span>

<translate>
These two files use the ''getActions'' method defined in the <tt>admin/helpers/helloworld.php</tt> file.</translate>

<translate>
In the helper-file, put this code:</translate>

<span id="admin/helpers/helloworld.php">
<tt>admin/helpers/helloworld.php</tt>
<source lang="php" highlight="50-72">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* HelloWorld component helper.
*
* @param string $submenu The name of the active view.
*
* @return void
*
* @since 1.6
*/
abstract class HelloWorldHelper
{
/**
* Configure the Linkbar.
*/
public static function addSubmenu($submenu)
{
JSubMenuHelper::addEntry(
JText::_('COM_HELLOWORLD_SUBMENU_MESSAGES'),
'index.php?option=com_helloworld',
$submenu == 'messages'
);

JSubMenuHelper::addEntry(
JText::_('COM_HELLOWORLD_SUBMENU_CATEGORIES'),
'index.php?option=com_categories&view=categories&extension=com_helloworld',
$submenu == 'categories'
);

// set some global property
$document = JFactory::getDocument();
$document->addStyleDeclaration('.icon-48-helloworld ' .
'{background-image: url(../media/com_helloworld/images/tux-48x48.png);}');
if ($submenu == 'categories')
{
$document->setTitle(JText::_('COM_HELLOWORLD_ADMINISTRATION_CATEGORIES'));
}
}

/**
* Get the actions
*/
public static function getActions($messageId = 0)
{
$result = new JObject;

if (empty($messageId)) {
$assetName = 'com_helloworld';
}
else {
$assetName = 'com_helloworld.message.'.(int) $messageId;
}

$actions = JAccess::getActions('com_helloworld', 'component');

foreach ($actions as $action) {
$result->set($action->name, JFactory::getUser()->authorise($action->name, $assetName));
}

return $result;
}
}

</source>
</span>

<translate>=== Restricting access to the component === </translate>

<translate>
The main idea in ACL is to restrict actions to groups of users. The first action to be restricted is access to the administrative backend of the component itself. With your favorite file editor, edit the <tt>admin/helloworld.php</tt> file and add the lines with the access check.</translate>

<span id="admin/helloworld.php">
<tt>admin/helloworld.php</tt>
<source lang="php" highlight="17-22">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// Set some global property
$document = JFactory::getDocument();
$document->addStyleDeclaration('.icon-helloworld {background-image: url(../media/com_helloworld/images/tux-16x16.png);}');

// Access check: is this user allowed to access the backend of this component?
if (!JFactory::getUser()->authorise('core.manage', 'com_helloworld'))
{
throw new Exception(JText::_('JERROR_ALERTNOAUTHOR'));
}

// Require helper file
JLoader::register('HelloWorldHelper', JPATH_COMPONENT . '/helpers/helloworld.php');

// Get an instance of the controller prefixed by HelloWorld
$controller = JControllerLegacy::getInstance('HelloWorld');

// Perform the Request task
$input = JFactory::getApplication()->input;
$controller->execute($input->getCmd('task'));

// Redirect if set by the controller
$controller->redirect();

</source>
<span>

<translate>=== Add the asset_id column to the database table === </translate>

<translate>
In order to be able to work with JTable an asset_id column has to be added to the database #__helloworld table.</translate>

<translate>
So, <tt>admin/sql/install.mysql.utf8.sql</tt> becomes:</translate>

<span id="admin/sql/install.mysql.utf8.sql">
<tt>admin/sql/install.mysql.utf8.sql</tt>
<source lang="mysql" highlight="5">
DROP TABLE IF EXISTS `#__helloworld`;

CREATE TABLE `#__helloworld` (
`id` INT(11) NOT NULL AUTO_INCREMENT,
`asset_id` INT(10) NOT NULL DEFAULT '0',
`greeting` VARCHAR(25) NOT NULL,
`published` tinyint(4) NOT NULL,
`catid` int(11) NOT NULL DEFAULT '0',
`params` VARCHAR(1024) NOT NULL DEFAULT '',
PRIMARY KEY (`id`)
)
ENGINE =MyISAM
AUTO_INCREMENT =0
DEFAULT CHARSET =utf8;

INSERT INTO `#__helloworld` (`greeting`) VALUES
('Hello World!'),
('Good bye World!');

</source>
</span>

<translate>
For updates we add a sql-update-file:</translate>

<span id="admin/sql/updates/mysql/0.0.14.sql">
<tt>admin/sql/updates/mysql/0.0.14.sql</tt>
<source lang="mysql">
ALTER TABLE`#__helloworld` ADD COLUMN `asset_id` INT(10) UNSIGNED NOT NULL DEFAULT '0' AFTER `id`;
</source>
</span>

<translate>=== Restricting access to the messages === </translate>

<translate>
So far we have restricted access to the component itself, but we also need to do that at ''message'' level.</translate>

<translate>
To check the '''"core.delete"''' permission you need to modify the model class: <tt>admin/models/helloworld.php</tt> by adding these lines:</translate>

<span id="admin/models/helloworld.php">
<tt>admin/models/helloworld.php</tt>
<source lang='php' highlight="96-105">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* HelloWorld Model
*
* @since 0.0.1
*/
class HelloWorldModelHelloWorld extends JModelAdmin
{
/**
* Method to get a table object, load it if necessary.
*
* @param string $type The table name. Optional.
* @param string $prefix The class prefix. Optional.
* @param array $config Configuration array for model. Optional.
*
* @return JTable A JTable object
*
* @since 1.6
*/
public function getTable($type = 'HelloWorld', $prefix = 'HelloWorldTable', $config = array())
{
return JTable::getInstance($type, $prefix, $config);
}

/**
* Method to get the record form.
*
* @param array $data Data for the form.
* @param boolean $loadData True if the form is to load its own data (default case), false if not.
*
* @return mixed A JForm object on success, false on failure
*
* @since 1.6
*/
public function getForm($data = array(), $loadData = true)
{
// Get the form.
$form = $this->loadForm(
'com_helloworld.helloworld',
'helloworld',
array(
'control' => 'jform',
'load_data' => $loadData
)
);

if (empty($form))
{
return false;
}

return $form;
}
/**
* Method to get the script that have to be included on the form
*
* @return string Script files
*/
public function getScript()
{
return 'administrator/components/com_helloworld/models/forms/helloworld.js';
}
/**
* Method to get the data that should be injected in the form.
*
* @return mixed The data for the form.
*
* @since 1.6
*/
protected function loadFormData()
{
// Check the session for previously entered form data.
$data = JFactory::getApplication()->getUserState(
'com_helloworld.edit.helloworld.data',
array()
);

if (empty($data))
{
$data = $this->getItem();
}

return $data;
}
/**
* Method to check if it's OK to delete a message. Overwrites JModelAdmin::canDelete
*/
protected function canDelete($record)
{
if( !empty( $record->id ) )
{
return JFactory::getUser()->authorise( "core.delete", "com_helloworld.message." . $record->id );
}
}
}

</source>
</span>

<translate>
To check '''"core.edit"''' (and '''core.add''' if you wish) you need to update the sub-controller (''not'' the model). I am not sure why this is so, but that's how other standard Joomla components do it. You need to add the following lines in the file: <tt>admin/controllers/helloworld.php</tt></translate>

<span id="admin/controllers/helloworld.php">
<tt>admin/controllers/helloworld.php</tt>
<source lang='php' highlight="21-49">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* HelloWorld Controller
*
* @package Joomla.Administrator
* @subpackage com_helloworld
* @since 0.0.9
*/
class HelloWorldControllerHelloWorld extends JControllerForm
{
/**
* Implement to allowAdd or not
*
* Not used at this time (but you can look at how other components use it....)
* Overwrites: JControllerForm::allowAdd
*
* @param array $data
* @return bool
*/
protected function allowAdd($data = array())
{
return parent::allowAdd($data);
}
/**
* Implement to allow edit or not
* Overwrites: JControllerForm::allowEdit
*
* @param array $data
* @param string $key
* @return bool
*/
protected function allowEdit($data = array(), $key = 'id')
{
$id = isset( $data[ $key ] ) ? $data[ $key ] : 0;
if( !empty( $id ) )
{
return JFactory::getUser()->authorise( "core.edit", "com_helloworld.message." . $id );
}
}
}

</source>
</span>

<translate>
Please note that ''allowAdd'' simply calls its parent. I've put it here in case you want to actually use it in your component. If you look at your <tt>admin/access.xml</tt> file, you will notice there is no ''core.add'' action defined for "messages", so you will need to add it there as well if you want to be able to configure it in the interface.</translate>

<translate>=== Setting the permission values in the assets table === </translate>

<translate>
In order to store permissions for each message in the assets database table, we have to instruct the table class associated with the model to save those permissions in the assets table.</translate>

<translate>
JTable not only provides an interface for storing the data of the record itself in the item's database table, but also for storing the permissions for that record in the assets database table. Therefore we must add information to the bind()-method about the permission-values. We also have to provide the asset name, asset title and the id of the asset parent via the helloworld JTable. Therefore we override 3 methods:</translate>
<translate>
* _getAssetName(): a unique name for this asset, by which it can be retrieved</translate>
<translate>
* _getAssetTitle(): a more human-friendly way to identify the asset (not necessary unique)</translate>
<translate>
* _getAssetParentId(): the asset_id of the parent in the asset database table (from whom permissions are inherited)</translate>

<span id="admin/tables/helloworld.php">
<tt>admin/tables/helloworld.php</tt>
<source lang="php" highlight="45-52,80-133">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
// No direct access
defined('_JEXEC') or die('Restricted access');

/**
* Hello Table class
*
* @since 0.0.1
*/
class HelloWorldTableHelloWorld extends JTable
{
/**
* Constructor
*
* @param JDatabaseDriver &$db A database connector object
*/
function __construct(&$db)
{
parent::__construct('#__helloworld', 'id', $db);
}
/**
* Overloaded bind function
*
* @param array named array
* @return null|string null is operation was satisfactory, otherwise returns an error
* @see JTable:bind
* @since 1.5
*/
public function bind($array, $ignore = '')
{
if (isset($array['params']) && is_array($array['params']))
{
// Convert the params field to a string.
$parameter = new JRegistry;
$parameter->loadArray($array['params']);
$array['params'] = (string)$parameter;
}

// Bind the rules.
if (isset($array['rules']) && is_array($array['rules']))
{
$rules = new JAccessRules($array['rules']);
$this->setRules($rules);
}

return parent::bind($array, $ignore);
}

/**
* Overloaded load function
*
* @param int $pk primary key
* @param boolean $reset reset data
* @return boolean
* @see JTable:load
*/
public function load($pk = null, $reset = true)
{
if (parent::load($pk, $reset))
{
// Convert the params field to a registry.
$params = new JRegistry;
$params->loadString($this->params, 'JSON');

$this->params = $params;
return true;
}
else
{
return false;
}
}
/**
* Method to compute the default name of the asset.
* The default name is in the form `table_name.id`
* where id is the value of the primary key of the table.
*
* @return string
* @since 2.5
*/
protected function _getAssetName()
{
$k = $this->_tbl_key;
return 'com_helloworld.message.'.(int) $this->$k;
}
/**
* Method to return the title to use for the asset table.
*
* @return string
* @since 2.5
*/
protected function _getAssetTitle()
{
return $this->greeting;
}
/**
* Method to get the asset-parent-id of the item
*
* @return int
*/
protected function _getAssetParentId(JTable $table = NULL, $id = NULL)
{
// We will retrieve the parent-asset from the Asset-table
$assetParent = JTable::getInstance('Asset');
// Default: if no asset-parent can be found we take the global asset
$assetParentId = $assetParent->getRootId();

// Find the parent-asset
if (($this->catid)&& !empty($this->catid))
{
// The item has a category as asset-parent
$assetParent->loadByName('com_helloworld.category.' . (int) $this->catid);
}
else
{
// The item has the component as asset-parent
$assetParent->loadByName('com_helloworld');
}

// Return the found asset-parent-id
if ($assetParent->id)
{
$assetParentId=$assetParent->id;
}
return $assetParentId;
}
}

</source>
</span>

<translate>
This code for _getAssetParentId() above uses JTableAsset to retrieve the asset_id of the asset-parent. This is different from the code in the current version of com_content, where the asset_id of the category is retrieved from the #__categories database table. That is another possibility; many ways leading to Rome. In com_content however, if an item would not be under a category, then the asset_id of the global asset is returned. That would of course not be right, but is fixed there by providing a default category "uncategorised", so that an article is ''always'' under a category. That is why you cannot just copy the code of _getAssetParentId() in com_content to your own component. The code above is more general.</translate>

<translate>=== Showing the setting of permissions on the item level === </translate>

<translate>
Adding the rules field to the form-definition of the edit-form.</translate>

<span id="admin/models/forms/helloworld.xml">
<tt>admin/models/forms/helloworld.xml</tt>
<source lang="xml" highlight="55-74">
<?xml version="1.0" encoding="utf-8"?>
<form
addrulepath="/administrator/components/com_helloworld/models/rules"
>
<fieldset
name="details"
label="COM_HELLOWORLD_HELLOWORLD_DETAILS"
>
<field
name="id"
type="hidden"
/>
<field
name="greeting"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_GREETING_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_GREETING_DESC"
size="40"
class="inputbox validate-greeting"
validate="greeting"
required="true"
default=""
/>
<field
name="catid"
type="category"
extension="com_helloworld"
class="inputbox"
default=""
label="COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_DESC"
required="true"
>
<option value="0">JOPTION_SELECT_CATEGORY</option>
</field>
</fieldset>
<fields name="params">
<fieldset
name="params"
label="JGLOBAL_FIELDSET_DISPLAY_OPTIONS"
>
<field
name="show_category"
type="list"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_DESC"
default=""
>
<option value="">JGLOBAL_USE_GLOBAL</option>
<option value="0">JHIDE</option>
<option value="1">JSHOW</option>
</field>
</fieldset>
</fields>
<fieldset
name="accesscontrol"
label="COM_HELLOWORLD_FIELDSET_RULES"
>
<field
name="asset_id"
type="hidden"
filter="unset"
/>
<field
name="rules"
type="rules"
label="COM_HELLOWORLD_FIELD_RULES_LABEL"
filter="rules"
validate="rules"
class="inputbox"
component="com_helloworld"
section="message"
/>
</fieldset>
</form>

</source>
</span>

<translate>
Now the ACL interface is displayed at the bottom of the Helloworld editform too (the ''edit.php'' file automatically get the fieldsets from the above xml).</translate>

<translate>=== Adding language strings === </translate>
<translate>
We used 4 language strings that have to be added to the backend language-file.</translate>

<span id="admin/language/en-GB/en-GB.com_helloworld.ini">
<tt>admin/language/en-GB/en-GB.com_helloworld.ini</tt>
<source lang="text" highlight="41-44">
; Joomla! Project
; Copyright (C) 2005 - 2015 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

COM_HELLOWORLD_ADMINISTRATION="HelloWorld - Administration"
COM_HELLOWORLD_ADMINISTRATION_CATEGORIES="HelloWorld - Categories"
COM_HELLOWORLD_NUM="#"
COM_HELLOWORLD_HELLOWORLDS_FILTER="Filters"
COM_HELLOWORLD_PUBLISHED="Published"
COM_HELLOWORLD_HELLOWORLDS_NAME="Name"
COM_HELLOWORLD_ID="Id"

COM_HELLOWORLD_HELLOWORLD_CREATING="HelloWorld - Creating"
COM_HELLOWORLD_HELLOWORLD_DETAILS="Details"
COM_HELLOWORLD_HELLOWORLD_EDITING="HelloWorld - Editing"
COM_HELLOWORLD_HELLOWORLD_ERROR_UNACCEPTABLE="Some values are unacceptable"
COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_DESC="The category the messages belongs to"
COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_LABEL="Category"
COM_HELLOWORLD_HELLOWORLD_FIELD_GREETING_DESC="This message will be displayed"
COM_HELLOWORLD_HELLOWORLD_FIELD_GREETING_LABEL="Message"
COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_LABEL="Show category"
COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_DESC="If set to Show, the title of the message’s category will show."
COM_HELLOWORLD_HELLOWORLD_HEADING_GREETING="Greeting"
COM_HELLOWORLD_HELLOWORLD_HEADING_ID="Id"
COM_HELLOWORLD_MANAGER_HELLOWORLD_EDIT="HelloWorld manager: Edit Message"
COM_HELLOWORLD_MANAGER_HELLOWORLD_NEW="HelloWorld manager: New Message"
COM_HELLOWORLD_MANAGER_HELLOWORLDS="HelloWorld manager"
COM_HELLOWORLD_EDIT_HELLOWORLD="Edit message"
COM_HELLOWORLD_N_ITEMS_DELETED_1="One message deleted"
COM_HELLOWORLD_N_ITEMS_DELETED_MORE="%d messages deleted"
COM_HELLOWORLD_N_ITEMS_PUBLISHED="%d message(s) published"
COM_HELLOWORLD_N_ITEMS_UNPUBLISHED="%d message(s) unpublished"
COM_HELLOWORLD_HELLOWORLD_GREETING_LABEL="Greeting"
COM_HELLOWORLD_HELLOWORLD_GREETING_DESC="Add Hello World Greeting"
COM_HELLOWORLD_SUBMENU_MESSAGES="Messages"
COM_HELLOWORLD_SUBMENU_CATEGORIES="Categories"
COM_HELLOWORLD_CONFIGURATION="HelloWorld Configuration"
COM_HELLOWORLD_CONFIG_GREETING_SETTINGS_LABEL="Messages settings"
COM_HELLOWORLD_CONFIG_GREETING_SETTINGS_DESC="Settings that will be applied to all messages by default"
COM_HELLOWORLD_FIELDSET_RULES="Message Permissions"
COM_HELLOWORLD_FIELD_RULES_LABEL="Permissions"
COM_HELLOWORLD_ACCESS_DELETE_DESC="Is this group allowed to edit this message?"
COM_HELLOWORLD_ACCESS_DELETE_DESC="Is this group allowed to delete this message?"

</source>
</span>

<translate>== Further reading == </translate>
<translate>
More information on actions, assets and ACL can be found on the following pages:</translate>
<translate>
* General information and use: [[S:MyLanguage/Access Control List/1.6-2.5/Tutorial|Access Control List/1.6-2.5/Tutorial]]</translate>
<translate>
* Technical information, under construction: [[S:MyLanguage/ACL Technique in Joomla!|ACL Technique in Joomla!]]</translate>
<translate>
* [[S:MyLanguage/How to implement actions in your code|How to implement actions in your code]]</translate>
<translate>
* [[S:MyLanguage/Adding ACL rules to your component|Adding ACL rules to your component]]</translate>

<translate>== Deprecated classes == </translate>
<translate>
For the moment we leave the '''deprecated JError'''-references as they are. They will probably still be available in Joomla! 3.x. We cannot just change them to JLog::add() statements because in Joomla! 2.5 the messages will then not be enqueued (as there is no messagequeue-logger added as is in /libraries/cms.php in Joomla! 3.0). Other solutions, like using $app->enqueueMessage() or directly throwing PHP-exceptions as showstopper are also possible, but then there would still be numerous references to JError throughout the application. For instance in the view, we now check for errors raised in the model with: <span style="color:#900">count($errors = $this->get('Errors'))</span>, which uses JError from the JOBject that was the base for JModel. To get the same functionality without using JError at all, we would have to change the way the Model raises those errors and warnings now. If we want to make an application that would work in Joomla! 2.5 and 3.x we can continue using JError. The moment we want to use our 3.x extensions also in 4.x we will have to change this (and probably a lot more too). This tutorial is now primarily focused on Joomla! 3.x. So: we notice the upcoming change, but leave it there for the moment.</translate>

<translate>
Since Joomla! 2.5.5 the MVC-base-classes JController, JModel and JView got proxies JControllerLegacy, JModelLegacy and JViewLegacy. You are recommended to use those proxies instead of the original classes to be forward compatibility with Joomla! CMS 3.x legacy classes.</translate>

<translate>== Packaging the component == </translate>

<translate>
Content of your code directory</translate>
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#helloworld.xml|helloworld.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/helloworld.php|site/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/controller.php|site/controller.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/models/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/language/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/language/en-GB/index.html]]''
* ''[[S:MyLanguage/J3.x:Developing a MVC Component/Adding language management#site.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.ini|site/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Basic_backend#admin/helloworld.php|admin/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_configuration#admin/config.xml|admin/config.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Basic_backend#admin/controller.php|admin/controller.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_categories#admin/access.xml|admin/access.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_categories#admin/helpers/helloworld.php|admin/helpers/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/helpers/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_categories#admin/sql/updates/mysql/0.0.12.sql|admin/sql/updates/mysql/0.0.12.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_configuration#admin/sql/updates/mysql/0.0.13.sql|admin/sql/updates/mysql/0.0.13.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_ACL#admin/sql/updates/mysql/0.0.14.sql|admin/sql/updates/mysql/0.0.14.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Basic_backend#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/helloworlds.php|admin/models/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/forms/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_verifications#admin/models/forms/helloworld.js|admin/models/forms/helloworld.js]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/models/forms/helloworld.xml|admin/models/forms/helloworld.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_verifications#admin/models/rules/greeting.php|admin/models/rules/greeting.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/rules/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/controllers/helloworld.php|admin/controllers/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/controllers/helloworlds.php|admin/controllers/helloworlds.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/controllers/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworld/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/views/helloworld/view.html.php|admin/views/helloworld/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_backend_actions#admin/views/helloworld/tmpl/edit.php|admin/views/helloworld/tmpl/edit.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_verifications#admin/views/helloworld/submitbutton.js|admin/views/helloworld/submitbutton.js]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Basic_backend#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/tables/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#admin/tables/helloworld.php|admin/tables/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/language/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/language/en-GB/index.html]]''
* ''[[S:MyLanguage/J3.x:Developing a MVC Component/Adding language management#admin.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.ini|admin/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[S:MyLanguage/J3.x:Developing a MVC Component/Adding language management#admin.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.sys.ini|admin/language/en-GB/en-GB.com_helloworld.sys.ini]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|media/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|media/images/index.html]]''
* ''[[S:MyLanguage/J3.x:Developing_a_MVC_Component/Adding_decorations_to_the_backend#Adding_some_icons|media/images/tux-16x16.png]]''
* ''[[S:MyLanguage/J3.x:Developing_a_MVC_Component/Adding_decorations_to_the_backend#Adding_some_icons|media/images/tux-48x48.png]]''

<translate>
Create a compressed file of this directory or directly download the [https://github.com/scionescire/Joomla-3.2-Hello-World-Component/archive/step-14-adding-ACL.zip archive] and install it using the extension manager of Joomla. You can add a menu item of this component using the menu manager in the backend.</translate>

<span id="helloworld.xml">
<tt>helloworld.xml</tt>
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2.0" method="upgrade">

<name>COM_HELLOWORLD</name>

<creationDate>February 2015</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.14</version>

<description>COM_HELLOWORLD_DESCRIPTION</description>

<install> 
<sql>
<file driver="mysql" charset="utf8">sql/install.mysql.utf8.sql</file>
</sql>
</install>
<uninstall> 
<sql>
<file driver="mysql" charset="utf8">sql/uninstall.mysql.utf8.sql</file>
</sql>
</uninstall>
<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



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

<languages folder="site/language">
<language tag="en-GB">en-GB/en-GB.com_helloworld.ini</language>
</languages>

<media destination="com_helloworld" folder="media">
<filename>index.html</filename>
<folder>images</folder>
</media>

<administration>

<menu link='index.php?option=com_helloworld' img="../media/com_helloworld/images/tux-16x16.png">COM_HELLOWORLD_MENU</menu>


<files folder="admin">

<filename>index.html</filename>
<filename>config.xml</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<filename>access.xml</filename>

<folder>sql</folder>

<folder>tables</folder>

<folder>models</folder>

<folder>views</folder>

<folder>controllers</folder>

<folder>helpers</folder>
</files>
<languages folder="admin/language">
<language tag="en-GB">en-GB/en-GB.com_helloworld.ini</language>
<language tag="en-GB">en-GB/en-GB.com_helloworld.sys.ini</language>
</languages>
</administration>

</extension>
</source>
</span>

<translate>== Contributors == </translate>
*[[User:Dwarkesh0204|Dwarkesh Soni]]
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]
*[[User:florian_denizot|Florian Denizot]]
*[[User:HermanPeeren|Herman Peeren]]
* TDZweb (Ståle Rolf Sæbøe), Elin Waring, Neil via https://groups.google.com/forum/#!topic/joomla-dev-general/aCH3GNA91m4
*[[User:Scionescire|Scionescire]]

<div class="row">
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_a_MVC_Component/Adding configuration|Prev: Adding configuration</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_a_MVC_Component/Adding an install-uninstall-update script file|Next: Adding an install-uninstall-update script file</translate>|class=expand}}</div>
</div>

<noinclude>
<translate>

[[Category:Joomla! 3.x]]
[[Category:Beginner Development]]
[[Category:Component Development]]
[[Category:Tutorials]]
[[Category:Tutorials in a Series]]
</translate>
</noinclude>

J3.x:Developing an MVC Component/Basic backend

2015-07-09T18:26:47Z

Waltsjt: getCmd() is deprecated use get() instead. Also we only need the J 3.x category rather than every J3 version

<noinclude><languages /></noinclude>
{{:J3.1:Developing a MVC Component/<translate>
en</translate>}}
<translate>== Introduction == </translate>
<translate>
This tutorial is part of the [[S:MyLanguage/J3.2:Developing a MVC Component | Developing a MVC Component for Joomla! 3.2]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.</translate>

<translate>== Basic backend == </translate>
<translate>
Designing the backend interface leads us to create at least a Model-View-Controller triptych. We have to modify the administrator entry point of our component, the <tt>admin/helloworld.php</tt> file.</translate>

<span id="admin/helloworld.php">
<tt>'''admin/helloworld.php'''</tt>
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// Get an instance of the controller prefixed by HelloWorld
$controller = JControllerLegacy::getInstance('HelloWorld');

// Perform the Request task
$controller->execute(JFactory::getApplication()->input->get('task'));

// Redirect if set by the controller
$controller->redirect();

</source>
</span>

== Create the general controller ==
The entry point now gets an instance of a ''HelloWorld'' prefixed controller. Let's create a basic controller for the administrator part:

<span id="admin/controller.php">
''admin/controller.php''
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* General Controller of HelloWorld component
*
* @package Joomla.Administrator
* @subpackage com_helloworld
* @since 0.0.7
*/
class HelloWorldController extends JControllerLegacy
{
/**
* The default view for the display method.
*
* @var string
* @since 12.2
*/
protected $default_view = 'helloworlds';
}

</source>
</span>

<translate>
This controller will display the 'HelloWorlds' view by default.</translate>

<translate>== Create the view == </translate>

<translate>
With your favorite file manager and editor, create a file <tt>admin/views/helloworlds/view.html.php</tt> containing:</translate>

<span id="admin/views/helloworlds/view.html.php">
<tt>admin/views/helloworlds/view.html.php</tt>
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* HelloWorlds View
*
* @since 0.0.1
*/
class HelloWorldViewHelloWorlds extends JViewLegacy
{
/**
* Display the Hello World view
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return void
*/
function display($tpl = null)
{
// Get data from the model
$this->items = $this->get('Items');
$this->pagination = $this->get('Pagination');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JError::raiseError(500, implode('<br />', $errors));

return false;
}

// Display the template
parent::display($tpl);
}
}
</source>
</span>

<translate>
In Joomla, views display data using layout. With your favorite file manager and editor, put a file <tt>admin/views/helloworlds/tmpl/default.php</tt> containing</translate>

<span id="admin/views/helloworlds/tmpl/default.php">
<tt>admin/views/helloworlds/tmpl/default.php</tt>
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/

// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<form action="index.php?option=com_helloworld&view=helloworlds" method="post" id="adminForm" name="adminForm">
<table class="table table-striped table-hover">
<thead>
<tr>
<th width="1%"><?php echo JText::_('COM_HELLOWORLD_NUM'); ?></th>
<th width="2%">
<?php echo JHtml::_('grid.checkall'); ?>
</th>
<th width="90%">
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLDS_NAME') ;?>
</th>
<th width="5%">
<?php echo JText::_('COM_HELLOWORLD_PUBLISHED'); ?>
</th>
<th width="2%">
<?php echo JText::_('COM_HELLOWORLD_ID'); ?>
</th>
</tr>
</thead>
<tfoot>
<tr>
<td colspan="5">
<?php echo $this->pagination->getListFooter(); ?>
</td>
</tr>
</tfoot>
<tbody>
<?php if (!empty($this->items)) : ?>
<?php foreach ($this->items as $i => $row) : ?>

<tr>
<td>
<?php echo $this->pagination->getRowOffset($i); ?>
</td>
<td>
<?php echo JHtml::_('grid.id', $i, $row->id); ?>
</td>
<td>
<?php echo $row->greeting; ?>
</td>
<td align="center">
<?php echo JHtml::_('jgrid.published', $row->published, $i, 'helloworlds.', true, 'cb'); ?>
</td>
<td align="center">
<?php echo $row->id; ?>
</td>
</tr>
<?php endforeach; ?>
<?php endif; ?>
</tbody>
</table>
</form>

</source>
</span>

<translate>
''COM_HELLOWORLD_HELLOWORLDS_NAME'', ''COM_HELLOWORLD_ID'' and the others are placeholders which will later be replaced with language-specific text. The [http://api.joomla.org/cms-3/classes/JText.html JText::_] method translates a string into the current language.</translate>

<translate>
<tt>checkAll</tt> is a javascript function defined in the Joomla core able to check all items.</translate>

<translate>
<tt>JHtml::_</tt> is a helper function able to display several HTML output. In this case, it will display a checkbox for the item.</translate>

<translate>
<tt>JPagination</tt> is a Joomla class able to manage and display pagination object.</translate>

<translate>== Create the model == </translate>
<translate>
The ''HelloWorlds'' view asks the model for data. In Joomla, there is a class able to manage a list of data: ''JModelList''. Class ''JModelList'' and inherited classes need only one method:</translate>
<translate>
* ''getListQuery'' which constructs an SQL query</translate>

<translate>
and two states:</translate>
<translate>
* <tt>list.start</tt> for determining the list offset
* <tt>list.limit</tt> for determining the list length</translate>

<translate>
The <tt>getItems</tt> and <tt>getPagination</tt> methods are defined in JModelList class. They don't need to be defined in the <tt>HelloWorldModelHelloWorlds</tt> class.</translate>

<span id="admin/models/helloworlds.php">
<tt>'''admin/models/helloworlds.php'''</tt>
<source lang="php">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* HelloWorldList Model
*
* @since 0.0.1
*/
class HelloWorldModelHelloWorlds extends JModelList
{
/**
* Method to build an SQL query to load the list data.
*
* @return string An SQL query
*/
protected function getListQuery()
{
// Initialize variables.
$db = JFactory::getDbo();
$query = $db->getQuery(true);

// Create the base select statement.
$query->select('*')
->from($db->quoteName('#__helloworld'));

return $query;
}
}

</source>
</span>

<translate>
The <tt>_populateState</tt> method is, by default, automatically called when a state is read by the <tt>getState</tt> method.</translate>

<translate>== Packaging the component == </translate>

<translate>
Content of your code directory</translate>

* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/helloworld.php|site/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/controller.php|site/controller.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Adding_a_view_to_the_site_part#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|site/models/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[#admin/helloworld.php|admin/helloworld.php]]''
* ''[[#admin/controller.php|admin/controller.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/index.html]]''
* ''[[#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/tmpl/index.html]]''
* ''[[#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Developing_a_Basic_Component#index.html|admin/tables/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_a_MVC_Component/Using_the_database#admin/tables/helloworld.php|admin/tables/helloworld.php]]''

<translate>
Create a compressed file of this directory or directly download the [https://github.com/scionescire/Joomla-3.2-Hello-World-Component/archive/step-7-basic-backend.zip archive] and install it using the extension manager of Joomla. You can add a menu item of this component using the menu manager in the backend.</translate>

<span id="helloworld.xml">
<tt>helloworld.xml</tt>
<source lang="xml" highlight="13,56,63-64">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2.0" method="upgrade">

<name>Hello World!</name>

<creationDate>January 2014</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.7</version>

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

<install> 
<sql>
<file driver="mysql" charset="utf8">sql/install.mysql.utf8.sql</file>
</sql>
</install>
<uninstall> 
<sql>
<file driver="mysql" charset="utf8">sql/uninstall.mysql.utf8.sql</file>
</sql>
</uninstall>
<update> 
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
</schemas>
</update>



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

<administration>

<menu link='index.php?option=com_helloworld'>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>
</administration>

</extension>
</source>
</span>

<translate>
Now you can see in your component '''hello-world''' an array with two colums, two rows and checkboxes. You can click the checkboxes in order to select the different options you want.</translate>

{{notice|<translate>
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.</translate>}}

== Contributors ==
*[[User:Gunjanpatel|Gunjan Patel]]
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]
*[[User:presto|Preston Smith]]
*[[User:scionescire|Scionescire]]

<div class="row">
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_a_MVC_Component/Using the database|Prev: Using the database</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|<translate>
S:MyLanguage/J3.x:Developing_a_MVC_Component/Adding language management|Next: Adding language management</translate>|class=expand}}</div>
</div>

<noinclude>
<translate>

[[Category:Joomla! 3.x]]
[[Category:Beginner Development]]
[[Category:Component Development]]
[[Category:Tutorials]]
[[Category:Tutorials in a Series]]
</translate>
</noinclude>

Getting Started with Object Oriented Programming

2015-07-07T22:40:41Z

Waltsjt: Add scope modifiers to functions

PHP is an object oriented language, and to use the MVC structure as implemented by Joomla!, a solid understanding of object oriented programming ''(OOP)'' is required. This document explains the reasons for using objects and the way objects are used in PHP and Joomla.

== Introduction to Objects ==

As we venture into object oriented programming, it is important to note that it is called 'object' oriented for a reason.

Before object oriented programming (OOP), everything was based on ''functions'' and ''variables''. Let's consider an application that calculates a person's BMI. You might have three variables: <code>$height</code> and <code>$weight</code> and <code>$name</code>. These variables would be used to store a person's name, height and weight. You might then have a function called <code>calculateBMI()</code>, which would accept as parameters $height and $weight.

This would look something like:

<syntaxhighlight lang="php">
public function calculateBMI( $height, $weight ) {
return $weight / $height;
}</syntaxhighlight>

But it is very easy to lose track of all these variables in the code, not to mention the fact that only one person is supported at a time. The idea behind objects is to '''encapsulate''' this data '''and''' the functions to manipulate it into one ''package''. The definition of this package is called a ''class''.

So we might have:

<syntaxhighlight lang="php">
class person
{
public $name;
public $height;
public $weight;

public function getBMI() {
return $this->weight / $this->height;
}
}</syntaxhighlight>

Then, if you want to create an object which represents a person, you would do:

<syntaxhighlight lang="php">
$person = new person();
</syntaxhighlight>

This is called ''instantiating'' the class, because it creates an ''instance'' of the class (an object described by the class).

Now, you can modify the variables (which are called ''properties''), using:

<syntaxhighlight lang="php">
$person->height = 2;
$person->weight = 50;
</syntaxhighlight>

Then you can invoke its functions (which are called ''methods'') using:

<syntaxhighlight lang="php">
$bmi = $person->getBMI();
</syntaxhighlight>

Often, many classes are similar, but too different to put into one class. For example, all animals have lungs, and because humans and cats are animals, they could both have a <code>$lung_capacity</code>. However, cats have tails, so should an <code>Animal</code> class have a <code>$tail_length</code>? No, that is not necessary. You can make a class a ''subclass'' or ''child class'' of another, essentially stating that the subclass has everything its parent class has, plus some extensions.

In Joomla, most classes are children of JObject. Now, if we were to make person a child class of JObject, then we would ''inherit'' the capabilities of the JObject class. We would then change the definition to something like:

<syntaxhighlight lang="php">

class person extends JObject
{
public $name;
public $height;
public $weight;

public function getBMI() {
return $this->weight / $this->height;
}
}
</syntaxhighlight>

Then we could ''manipulate'' our person using the <code>get()</code> and <code>set()</code> methods that JObject has:

<syntaxhighlight lang="php">
$person->set( 'name', 'Bob' );
$person->set( 'height', 2 );
$person->set( 'weight', 50 );
$person->get( 'weight' );
echo $person->getBMI();
</syntaxhighlight>

You will notice the use of <code>$this</code> inside classes a lot. <code>$this</code> is a reference to the '''current''' object. So if I am inside a class, and I use say <code>$this->height = 2;</code>, then that means I am setting the property 'height' of the current object to 2. When we use <code>$this->height</code>, we aren't talking about any height, but we're talking about the current object height.

== More on Objects ==

As I said, Objects are called Objects for a reason. If you have a real life object, say a photocopier, there is an external interface (say, a paper tray, the copier glass, the keypad, etc.). Objects in OOP are designed to approximate that setup.

So, I might have a class called copier. Now, what operations do I generally need to do with a copier? Well, the basic functionality I need is copy functionality. So I need a method called 'copy':

<syntaxhighlight lang="php">
class Copier
{
public function copy() {
echo 'One copy made';
}
}
</syntaxhighlight>

Now, this is a very basic copier. What if I wanted to extend the functionality of my Copier? Well, to extend the functionality, I create a child class. ''A child class will inherit all the functionality of the parent class.''

Let's suppose we wanted to create a copier that would keep track of the number of copies it had made. So, we would need to add a property which would keep track of this number, and then we need to somehow adjust this number each time we make a copy.

So here is our child class:

<syntaxhighlight lang="php">
class CopierWithCounter extends Copier
{
public $counter;

public function copy() {
$this->counter++;
parent::copy();
}
}
</syntaxhighlight>

So we now have a property called <code>$counter</code> that keeps track of the number of copies made. Notice that the method we defined has the same name as the method in the Copier class. What this means is that we don't need to learn anything new to use the copier - it behaves in the same way as our old copier, but it just keep track of the number of copies.

You will see that inside of the <code>copy()</code> method there is a line: ''<code>parent::copy()</code>''. The <code>parent</code> keyword references the parent class, which is in this case Copier. So this line will invoke the <code>copy()</code> method of the Copier class. In this way, we don't have to rewrite the functionality to make a copy - we have already done that in the Copier class.

So we have the exact same functionality as the Copier class, except that anytime a copy is made it will increment the $copies property by 1. Just as in real life, the addition of the counter doesn't change the way that I use the copier - I don't need to know anything about the counter to just make a simple copy.

Now, the question arises: what value does <code>$counter</code> have to start with? We know that it increases by one every time a copy is made, but that is all we know.

This value needs to be ''initialized'' to a certain value.

Initializing values is generally done by what is called a ''constructor''. A constructor does just that - it constructs the object. In PHP5, constructors are functions with the name <code>__construct</code>. We will use <code>__construct</code> here.

So our class now becomes:
<syntaxhighlight lang="php">
class CopierWithCounter extends Copier
{
public $counter;

public function __construct() {
$this->counter = 0;
}

public function copy() {
$this->counter++;
parent::copy();
}
}
</syntaxhighlight>

Now suppose we wanted to create an even more advanced copier. We can do that by creating another child class. Let's create a copier that is able to do multiple copies. In order to do this, we need a way to specify how many copies we want and a way to remember this number. We will add a method called 'setCopies()':

<syntaxhighlight lang="php">
class CopierMultipleCopies extends CopierWithCounter
{
public $copies;

public function setCopies( $copies ) {
$this->copies = $copies;
}
}
</syntaxhighlight>
We now have a way to specify how many copies we want to make.

Now, it is appropriate here to say a word about ''scope''. When we talk about scope, we talk about where a certain variable can be seen. You will notice that in our class, we have a property called <code>$copies</code>. But we also have a parameter called <code>$copies</code> in our method <code>setCopies</code>. How do you tell them apart?

Well, the rules of scope tell us which variable we are talking about. If a method takes a parameter, say <code>$copies</code> (as above), then if I use <code>$copies</code> inside that method, I am referring to that parameter. There may be other variables called <code>$copies</code> that are defined in other places, but I don't care about those - I only care about the one inside of my function. If I want to refer to a property of the current object, I use the <code>$this</code> keyword. So, if I use <code>$this->copies</code>, then I am talking about the <code>$copies</code> property that belongs to my current object.

So that aside, our <code>setCopies()</code> method will allow us to set the number of copies that we want to make using our copier. The method takes one parameter - <code>$copies</code>, and stores it in the object.

You will notice that our current class definition for CopierMultipleCopies doesn't define a <code>copy()</code> method or a constructor. But, because it extends CopierWithCounter, it inherits the <code>copy()</code> method from CopierWithCounter, and also inherits the properties. So, without doing any extra work, we already have a Copier with a counter.

But we still want to extend the functionality of the <code>copy()</code> method so that it actually makes the multiple copies. So, we add a method definition to our class. We will also add a constructor that will add the functionality of initializing the number of copies to 1.

<syntaxhighlight lang="php">
class CopierMultipleCopies extends CopierWithCounter
{
public $copies;

public function __construct() {
$this->copies = 1;
parent::__construct();
}

public function setCopies( $copies ) {
$this->copies = $copies;
}

public function copy() {
for ($i = 0; $i < $this->copies; $i++) {
parent::copy();
}
}
}
</syntaxhighlight>

So what have we done here? Well, first, in our constructor we initialized the $copies variable to 1. Thus, if we don't tell our copier otherwise, it will make one copy when the <code>copy()</code> method is invoked. Note that we don't have to rewrite the code to initialize the counter - we just call <code>parent::__construct()</code> and our parent constructor will handle that.

Then, we ''overrode'' the <code>copy()</code> method. Inside of our <code>copy()</code> method we have what is called a ''[[http://en.wikipedia.org/wiki/For_loop|for loop]]''.

In the first line of the for loop, you will see three parts divided by semicolons.

The first part is the ''initialization''. We will use $i as a counter variable, and we will start it at 0. $i will essentially keep track of the number of copies we have made out of the total number that we have to do.

The second part is the ''condition''. At the beginning of each run of the for loop, this condition is checked to determine if it is true or not. If the condition is true, we execute the stuff inside of the braces. If it is not, then we are done the loop.

The last part is the ''incrementor''. This is code that gets executed after every pass through the loop.

So it will run something like:
* take our variable i and set it to 0.
* Check if our variable i is less than the number of copies that we have to make
* if it is, then we will make a copy
* we will increment i by 1 and go back to step 2

You can have much more complex for loops than this, but this is the basic idea.

So that is our copier. Now to use our copier, we can add something like this to our code:
<syntaxhighlight lang="php">
$copier = new CopierMultipleCopies();
$copier->copy();
$copier->copy();
$copier->setCopies( 10 );
$copier->copy();
</syntaxhighlight>

So notice a couple of things:

First, as we made our copier more and more complex, we didn't have to duplicate code. That is, in our most complex copier, we didn't have to worry about creating code to make the actual copy. We just used the method that came with our original copier. Also, in our final copier we didn't have to re-implement the counter - we again just used the method that had already been defined to do this.

Second, our new copier can serve as a drop in replacement for our old copier. Yes, each copier was more advanced than the previous one, but it was still possible with the most advanced one to just create it and invoke the copy() method, and it would create a copy.

If I want to use the more advanced functionality, such as reading the counter or changing the number of copies to be made, I need to know about these features, but I can still ignorantly use the copier as if it was the original Copier. (i.e. the original Copier class had a certain interface that was standard.)

The advanced copiers added more features, but this was separate from the original interface. (just as a car with cruise control has the same basic interface as a car without cruise control, but to take advantage of the cruise control you need to know how to set it).

Object Oriented Programming is an important part of the design of Joomla!.

''**ianmac** put together this OOPs overview for the community; [http://forum.joomla.org/index.php/topic,200185.msg943596.html#msg943596 Post #1] and [http://forum.joomla.org/index.php/topic,200694.msg944114.html#msg944114 Post #2]''

== See Also ==
[http://us3.php.net/manual/en/oop5.intro.php Introduction to PHP 5 OOP]

<noinclude>
[[Category:Development]]
[[Category:Component Development]]
[[Category:Beginner Development]]
[[Category:Development Recommended Reading]]
[[Category:Tutorials]]
</noinclude>

Selecting data using JDatabase

2015-07-07T20:46:13Z

Waltsjt: Add some more catagories

Getting Started with Object Oriented Programming

2015-07-07T18:42:56Z

Waltsjt: Add link to PHP5 OOP

PHP is an object oriented language, and to use the MVC structure as implemented by Joomla!, a solid understanding of object oriented programming ''(OOP)'' is required. This document explains the reasons for using objects and the way objects are used in PHP and Joomla.

== Introduction to Objects ==

As we venture into object oriented programming, it is important to note that it is called 'object' oriented for a reason.

Before object oriented programming (OOP), everything was based on ''functions'' and ''variables''. Let's consider an application that calculates a person's BMI. You might have three variables: <code>$height</code> and <code>$weight</code> and <code>$name</code>. These variables would be used to store a person's name, height and weight. You might then have a function called <code>calculateBMI()</code>, which would accept as parameters $height and $weight.

This would look something like:

<syntaxhighlight lang="php">
function calculateBMI( $height, $weight ) {
return $weight / $height;
}</syntaxhighlight>

But it is very easy to lose track of all these variables in the code, not to mention the fact that only one person is supported at a time. The idea behind objects is to '''encapsulate''' this data '''and''' the functions to manipulate it into one ''package''. The definition of this package is called a ''class''.

So we might have:

<syntaxhighlight lang="php">
class person
{
public $name;
public $height;
public $weight;

function getBMI() {
return $this->weight / $this->height;
}
}</syntaxhighlight>

Then, if you want to create an object which represents a person, you would do:

<syntaxhighlight lang="php">
$person = new person();
</syntaxhighlight>

This is called ''instantiating'' the class, because it creates an ''instance'' of the class (an object described by the class).

Now, you can modify the variables (which are called ''properties''), using:

<syntaxhighlight lang="php">
$person->height = 2;
$person->weight = 50;
</syntaxhighlight>

Then you can invoke its functions (which are called ''methods'') using:

<syntaxhighlight lang="php">
$bmi = $person->getBMI();
</syntaxhighlight>

Often, many classes are similar, but too different to put into one class. For example, all animals have lungs, and because humans and cats are animals, they could both have a <code>$lung_capacity</code>. However, cats have tails, so should an <code>Animal</code> class have a <code>$tail_length</code>? No, that is not necessary. You can make a class a ''subclass'' or ''child class'' of another, essentially stating that the subclass has everything its parent class has, plus some extensions.

In Joomla, most classes are children of JObject. Now, if we were to make person a child class of JObject, then we would ''inherit'' the capabilities of the JObject class. We would then change the definition to something like:

<syntaxhighlight lang="php">

class person extends JObject
{
public $name;
public $height;
public $weight;

function getBMI() {
return $this->weight / $this->height;
}
}
</syntaxhighlight>

Then we could ''manipulate'' our person using the <code>get()</code> and <code>set()</code> methods that JObject has:

<syntaxhighlight lang="php">
$person->set( 'name', 'Bob' );
$person->set( 'height', 2 );
$person->set( 'weight', 50 );
$person->get( 'weight' );
echo $person->getBMI();
</syntaxhighlight>

You will notice the use of <code>$this</code> inside classes a lot. <code>$this</code> is a reference to the '''current''' object. So if I am inside a class, and I use say <code>$this->height = 2;</code>, then that means I am setting the property 'height' of the current object to 2. When we use <code>$this->height</code>, we aren't talking about any height, but we're talking about the current object height.

== More on Objects ==

As I said, Objects are called Objects for a reason. If you have a real life object, say a photocopier, there is an external interface (say, a paper tray, the copier glass, the keypad, etc.). Objects in OOP are designed to approximate that setup.

So, I might have a class called copier. Now, what operations do I generally need to do with a copier? Well, the basic functionality I need is copy functionality. So I need a method called 'copy':

<syntaxhighlight lang="php">
class Copier
{
function copy() {
echo 'One copy made';
}
}
</syntaxhighlight>

Now, this is a very basic copier. What if I wanted to extend the functionality of my Copier? Well, to extend the functionality, I create a child class. ''A child class will inherit all the functionality of the parent class.''

Let's suppose we wanted to create a copier that would keep track of the number of copies it had made. So, we would need to add a property which would keep track of this number, and then we need to somehow adjust this number each time we make a copy.

So here is our child class:

<syntaxhighlight lang="php">
class CopierWithCounter extends Copier
{
public $counter;

function copy() {
$this->counter++;
parent::copy();
}
}
</syntaxhighlight>

So we now have a property called <code>$counter</code> that keeps track of the number of copies made. Notice that the method we defined has the same name as the method in the Copier class. What this means is that we don't need to learn anything new to use the copier - it behaves in the same way as our old copier, but it just keep track of the number of copies.

You will see that inside of the <code>copy()</code> method there is a line: ''<code>parent::copy()</code>''. The <code>parent</code> keyword references the parent class, which is in this case Copier. So this line will invoke the <code>copy()</code> method of the Copier class. In this way, we don't have to rewrite the functionality to make a copy - we have already done that in the Copier class.

So we have the exact same functionality as the Copier class, except that anytime a copy is made it will increment the $copies property by 1. Just as in real life, the addition of the counter doesn't change the way that I use the copier - I don't need to know anything about the counter to just make a simple copy.

Now, the question arises: what value does <code>$counter</code> have to start with? We know that it increases by one every time a copy is made, but that is all we know.

This value needs to be ''initialized'' to a certain value.

Initializing values is generally done by what is called a ''constructor''. A constructor does just that - it constructs the object. In PHP5, constructors are functions with the name <code>__construct</code>. We will use <code>__construct</code> here.

So our class now becomes:
<syntaxhighlight lang="php">
class CopierWithCounter extends Copier
{
public $counter;

function __construct() {
$this->counter = 0;
}

function copy() {
$this->counter++;
parent::copy();
}
}
</syntaxhighlight>

Now suppose we wanted to create an even more advanced copier. We can do that by creating another child class. Let's create a copier that is able to do multiple copies. In order to do this, we need a way to specify how many copies we want and a way to remember this number. We will add a method called 'setCopies()':

<syntaxhighlight lang="php">
class CopierMultipleCopies extends CopierWithCounter
{
public $copies;

function setCopies( $copies ) {
$this->copies = $copies;
}
}
</syntaxhighlight>
We now have a way to specify how many copies we want to make.

Now, it is appropriate here to say a word about ''scope''. When we talk about scope, we talk about where a certain variable can be seen. You will notice that in our class, we have a property called <code>$copies</code>. But we also have a parameter called <code>$copies</code> in our method <code>setCopies</code>. How do you tell them apart?

Well, the rules of scope tell us which variable we are talking about. If a method takes a parameter, say <code>$copies</code> (as above), then if I use <code>$copies</code> inside that method, I am referring to that parameter. There may be other variables called <code>$copies</code> that are defined in other places, but I don't care about those - I only care about the one inside of my function. If I want to refer to a property of the current object, I use the <code>$this</code> keyword. So, if I use <code>$this->copies</code>, then I am talking about the <code>$copies</code> property that belongs to my current object.

So that aside, our <code>setCopies()</code> method will allow us to set the number of copies that we want to make using our copier. The method takes one parameter - <code>$copies</code>, and stores it in the object.

You will notice that our current class definition for CopierMultipleCopies doesn't define a <code>copy()</code> method or a constructor. But, because it extends CopierWithCounter, it inherits the <code>copy()</code> method from CopierWithCounter, and also inherits the properties. So, without doing any extra work, we already have a Copier with a counter.

But we still want to extend the functionality of the <code>copy()</code> method so that it actually makes the multiple copies. So, we add a method definition to our class. We will also add a constructor that will add the functionality of initializing the number of copies to 1.

<syntaxhighlight lang="php">
class CopierMultipleCopies extends CopierWithCounter
{
public $copies;

function __construct() {
$this->copies = 1;
parent::__construct();
}

function setCopies( $copies ) {
$this->copies = $copies;
}

function copy() {
for ($i = 0; $i < $this->copies; $i++) {
parent::copy();
}
}
}
</syntaxhighlight>

So what have we done here? Well, first, in our constructor we initialized the $copies variable to 1. Thus, if we don't tell our copier otherwise, it will make one copy when the <code>copy()</code> method is invoked. Note that we don't have to rewrite the code to initialize the counter - we just call <code>parent::__construct()</code> and our parent constructor will handle that.

Then, we ''overrode'' the <code>copy()</code> method. Inside of our <code>copy()</code> method we have what is called a ''[[http://en.wikipedia.org/wiki/For_loop|for loop]]''.

In the first line of the for loop, you will see three parts divided by semicolons.

The first part is the ''initialization''. We will use $i as a counter variable, and we will start it at 0. $i will essentially keep track of the number of copies we have made out of the total number that we have to do.

The second part is the ''condition''. At the beginning of each run of the for loop, this condition is checked to determine if it is true or not. If the condition is true, we execute the stuff inside of the braces. If it is not, then we are done the loop.

The last part is the ''incrementor''. This is code that gets executed after every pass through the loop.

So it will run something like:
* take our variable i and set it to 0.
* Check if our variable i is less than the number of copies that we have to make
* if it is, then we will make a copy
* we will increment i by 1 and go back to step 2

You can have much more complex for loops than this, but this is the basic idea.

So that is our copier. Now to use our copier, we can add something like this to our code:
<syntaxhighlight lang="php">
$copier = new CopierMultipleCopies();
$copier->copy();
$copier->copy();
$copier->setCopies( 10 );
$copier->copy();
</syntaxhighlight>

So notice a couple of things:

First, as we made our copier more and more complex, we didn't have to duplicate code. That is, in our most complex copier, we didn't have to worry about creating code to make the actual copy. We just used the method that came with our original copier. Also, in our final copier we didn't have to re-implement the counter - we again just used the method that had already been defined to do this.

Second, our new copier can serve as a drop in replacement for our old copier. Yes, each copier was more advanced than the previous one, but it was still possible with the most advanced one to just create it and invoke the copy() method, and it would create a copy.

If I want to use the more advanced functionality, such as reading the counter or changing the number of copies to be made, I need to know about these features, but I can still ignorantly use the copier as if it was the original Copier. (i.e. the original Copier class had a certain interface that was standard.)

The advanced copiers added more features, but this was separate from the original interface. (just as a car with cruise control has the same basic interface as a car without cruise control, but to take advantage of the cruise control you need to know how to set it).

Object Oriented Programming is an important part of the design of Joomla!.

''**ianmac** put together this OOPs overview for the community; [http://forum.joomla.org/index.php/topic,200185.msg943596.html#msg943596 Post #1] and [http://forum.joomla.org/index.php/topic,200694.msg944114.html#msg944114 Post #2]''

== See Also ==
[http://us3.php.net/manual/en/oop5.intro.php Introduction to PHP 5 OOP]

<noinclude>
[[Category:Development]]
[[Category:Component Development]]
[[Category:Beginner Development]]
[[Category:Development Recommended Reading]]
[[Category:Tutorials]]
</noinclude>

How to use the JTable class

2015-07-06T21:58:44Z

Waltsjt: redirect to the current JTable page

#REDIRECT [[Using the JTable class]]

Using multiple models in an MVC component

2015-07-06T21:46:27Z

Waltsjt: Add some more catagories

{{version/tutor|2.5,3.x}}
Sometimes a view needs to assemble information garnered from more than one model.

With just a single model per view it is usually possible to ensure that models and views follow standard naming conventions and the minimum of code is then needed to give the view the data it needs. In a component called MyComponent if there is a view, called My1 (class MyComponentViewMy1) that requires a model, also called My1 (class MyComponentModelMy1), then no additional coding is required as the controller will automatically associate the same-named model with the view.

If a view requires a different model from its same-named counterpart then the controller must explicitly state the model to be used and pass it to the view. For example, suppose view My2 requires data from model My3 instead of My2. Then in the controller task-method you need to state the required model, like this:
<source lang="php">
$view = $this->getView( 'My2', 'html' );
$view->setModel( $this->getModel( 'My3' ), true );
$view->display();
</source>
Here the [[JController/getView|JController->getView]] method instantiates the required view object and the [[JController/getModel|JController->getModel]] method instantiates a model object. The [[JView/setModel|JView->setModel]] method adds the model to the view's internal pool of model objects. Setting the second argument in the [[JView/setModel|JView->setModel]] call to '''true''' establishes My3 as the default model for the view.

Notice that you should not call the ''parent::display()'' method because that will try to instantiate the view and attach the default model to it. You will need to adjust the code in this example if you need to use a format other than 'html', or a non-default layout. See the code for [[JController/display|JController::display]] to see what you need to do.

No changes to the view code are needed. For example, in the My2 view's display method, these statements
<source lang="php">
$item1 = $this->get( 'data1' );
$item2 = $this->get( 'data2' );
</source>
will call the ''getData1'' and ''getData2'' methods in the default My3 model (class MyComponentModelMy3).

If the view requires data from more than one model, then the above code can be extended easily. For example, if view My3 requires data from models My1 as well as My3 then the controller task-method would look something like this:
<source lang="php">
$view = $this->getView( 'My3', 'html' );
$view->setModel( $this->getModel( 'My3' ), true );
$view->setModel( $this->getModel( 'My1' ) );
$view->display();
</source>
Notice that My3 has been set as the default model for the view in this example, but that My1 has also been added to the pool of models available in the view.

Having more than one model available to the view means that some small changes to the view code are now needed in order to specify from which model each data item should be obtained. Continuing with the above example, the My3 view's display method might have need of data like this
<source lang="php">
$item1 = $this->get( 'data1' );
$item2 = $this->get( 'data2', 'My1' );
</source>
which will call the ''getData1'' method in model My3 (class MyComponentModelMy3) and the ''getData2'' method in model My1 (class MyComponentModelMy1).

Notice that it is always the controller's responsibility to determine which models are required by a view and to instantiate and pass the required model objects into the view object.

<noinclude>
[[Category:Development]]
[[Category:Beginner Development]]
[[Category:Component Development]]
[[Category:Tutorials]]
</noinclude>

J2.5:File Structure and Naming Conventions

2015-07-06T21:44:54Z

Waltsjt: missing <references/> tag

{{version/tutor|2.5,3.1}}
{{page|needs version review}}
{{RightTOC}}
Components in Jooomla! 2.5+ can now benefit from the flexibility and power of using Object Oriented Programming (OOP) practices.
Components will follow the Model-View-Controller (MVC) design pattern. This pattern separates the data gathering (Model), presentation (View) and user interaction (Controller) activities of a component. Such separation allows for expanding or revising properties and methods of one section without requiring additional changes to the other sections. Please see [[Developing_a_Model-View-Controller_Component|the MVC tutorial]], then select a Joomla! version for an explanations of the MVC structure.

Joomla!'s file loading system enables developers to work with separate files for controllers, views and models without worrying about importing the right file in the right place. However, for this to work, certain naming conventions need to be observed.

The Joomla! framework is extremely flexible, and it is possible to diverge from these conventions in many ways. It is nonetheless recommended to apply standard naming wherever possible to increase readability and maintainability. Additionally, the framework will take care of the many tedious class management tasks when the files and classes of a component are named correctly.

Throughout this article, {ComponentName} is used to represent the name of the component (for example, Content). Notice also that case is important. {componentname} will refer to the lowercase version of {ComponentName}, eg. <code>CamelCasedController</code> -> <code>camelcasedcontroller</code>.
Similarly, {ViewName} and {viewname}, {ModelName} and {modelname}, {ControllerName} and {controllername}.

== Reserved words ==

There are reserved words which can't be used in names of classes and components.

An example is the word "view" (in any case) for view classes (except "view" that must be second part of that class name)<ref>Reason is in line 420 of file libraries/joomla/application/component/view.php:
<source lang="php">if (!preg_match('/View((view)*(.*(view)?.*))$/i', get_class($this), $r)) {</source></ref>.
Because the first part of the name of view classes is the same as the controller class name, controller class names can't contain the word "view" either. And because of the conventions (although violating of it won't produce an error), controller class names must contain the component name, so component names can't contain the word "view" either. So components can't be named "com_reviews", or if they are, they must violate the naming conventions and have a different base controller class name (or have some other hacks).

== Installation package vs. actual file placement ==

All Joomla! extensions must be packaged as a .zip installation file. According to the most common file arrangement, the package should contain at least the following two folders as a basic structure:
* <code>site</code>
* <code>admin</code>
If you set up your XML manifest file according to standard practice, the contents of <code>site</code> will be installed to <code>/components/com_{componentname}</code>, whereas the contents of <code>admin</code> will be installed to <code>/administrator/components/com_{componentname}</code>.

== The /site folder==
This folder keeps the files for the frontend part of the component.

:'''<code>/site/{componentname}.php</code>'''
:This is the component's main file and entry point ''for the frontend part''.

:'''<code>/site/controller.php</code>'''
:This file holds the default frontend controller, which is a class called <code>{ComponentName}Controller</code>. This class must extend the base class <code>JController</code>.

:'''<code>/site/views</code>'''
:This folder holds the different views for the component.

::'''<code>/site/views/{viewname}</code>'''
::This folder holds the files for the view {ViewName}.

:::'''<code>/site/views/{viewname}/view.html.php</code>'''
:::This file is the entry point for the view {ViewName}. It should declare the class <code>{ComponentName}View{ViewName}</code>. This class must extend the base class <code>JViewLegacy</code>. The <code>.html</code> section of the filename is related to the format the view will be loaded in. For example, if the <code>format</code> URL parameter is set to <code>format=feed</code>, the file <code>view.feed.php</code> will be loaded.

:::'''<code>/site/views/{viewname}/tmpl</code>'''
:::This folder holds the template files for the view {ViewName}.

::::'''<code>/site/views/{viewname}/tmpl/default.php</code>'''
::::This is the default template for the view {ViewName}. In this PHP file, the <code>$this</code> keyword refers to the view class that the template belongs to.

:'''<code>/site/models</code>'''
:This folder holds additional models, if needed by the application.

::'''<code>/site/models/{modelname}.php</code>'''
::This file holds the model class <code>{ComponentName}Model{ModelName}</code>. This class must extend the base class <code>JModelLegacy</code>. Note that the view named {ViewName} will by default load a model called {ViewName} if it exists. Most models are named after the view they are intended to be used with, but this is '''not''' a requirement. See [[Using multiple models in an MVC component]] for more information.

:'''<code>/site/controllers</code>'''
:This folder holds additional controllers, if needed by the application.

::'''<code>/site/controllers/{controllername}.php</code>'''
::This file holds the controller class <code>{ComponentName}Controller{ControllerName}</code>. This class must extend the base class <code>JController</code>.

== The /admin folder ==
The file structure is exactly the same as in the /site folder. Note that the view, models, controllers etc. of the site and admin parts are by default completely separated, and have nothing to do with each other - the site part and the admin part can be thought of as two different components! A view in the /admin folder may have a counterpart with the same name in the /site folder, yet the two views have nothing in common but their name.

However, it might sometimes make sense to share classes between the site and admin parts of the component. Especially models can be shared to avoid duplicating model code. The Joomla! framework supports this strategy. When sharing any code between site and admin applications, the classes should be designed with great care to avoid the possibility of a site user executing admin actions.

<noinclude>
<references/>
[[Category:Development]]
[[Category:Beginner Development]]
[[Category:Component Development]]
</noinclude>

J2.5:File Structure and Naming Conventions

2015-07-06T21:44:07Z

Waltsjt: Add some more catagories

{{version/tutor|2.5,3.1}}
{{page|needs version review}}
{{RightTOC}}
Components in Jooomla! 2.5+ can now benefit from the flexibility and power of using Object Oriented Programming (OOP) practices.
Components will follow the Model-View-Controller (MVC) design pattern. This pattern separates the data gathering (Model), presentation (View) and user interaction (Controller) activities of a component. Such separation allows for expanding or revising properties and methods of one section without requiring additional changes to the other sections. Please see [[Developing_a_Model-View-Controller_Component|the MVC tutorial]], then select a Joomla! version for an explanations of the MVC structure.

Joomla!'s file loading system enables developers to work with separate files for controllers, views and models without worrying about importing the right file in the right place. However, for this to work, certain naming conventions need to be observed.

The Joomla! framework is extremely flexible, and it is possible to diverge from these conventions in many ways. It is nonetheless recommended to apply standard naming wherever possible to increase readability and maintainability. Additionally, the framework will take care of the many tedious class management tasks when the files and classes of a component are named correctly.

Throughout this article, {ComponentName} is used to represent the name of the component (for example, Content). Notice also that case is important. {componentname} will refer to the lowercase version of {ComponentName}, eg. <code>CamelCasedController</code> -> <code>camelcasedcontroller</code>.
Similarly, {ViewName} and {viewname}, {ModelName} and {modelname}, {ControllerName} and {controllername}.

== Reserved words ==

There are reserved words which can't be used in names of classes and components.

An example is the word "view" (in any case) for view classes (except "view" that must be second part of that class name)<ref>Reason is in line 420 of file libraries/joomla/application/component/view.php:
<source lang="php">if (!preg_match('/View((view)*(.*(view)?.*))$/i', get_class($this), $r)) {</source></ref>.
Because the first part of the name of view classes is the same as the controller class name, controller class names can't contain the word "view" either. And because of the conventions (although violating of it won't produce an error), controller class names must contain the component name, so component names can't contain the word "view" either. So components can't be named "com_reviews", or if they are, they must violate the naming conventions and have a different base controller class name (or have some other hacks).

== Installation package vs. actual file placement ==

All Joomla! extensions must be packaged as a .zip installation file. According to the most common file arrangement, the package should contain at least the following two folders as a basic structure:
* <code>site</code>
* <code>admin</code>
If you set up your XML manifest file according to standard practice, the contents of <code>site</code> will be installed to <code>/components/com_{componentname}</code>, whereas the contents of <code>admin</code> will be installed to <code>/administrator/components/com_{componentname}</code>.

== The /site folder==
This folder keeps the files for the frontend part of the component.

:'''<code>/site/{componentname}.php</code>'''
:This is the component's main file and entry point ''for the frontend part''.

:'''<code>/site/controller.php</code>'''
:This file holds the default frontend controller, which is a class called <code>{ComponentName}Controller</code>. This class must extend the base class <code>JController</code>.

:'''<code>/site/views</code>'''
:This folder holds the different views for the component.

::'''<code>/site/views/{viewname}</code>'''
::This folder holds the files for the view {ViewName}.

:::'''<code>/site/views/{viewname}/view.html.php</code>'''
:::This file is the entry point for the view {ViewName}. It should declare the class <code>{ComponentName}View{ViewName}</code>. This class must extend the base class <code>JViewLegacy</code>. The <code>.html</code> section of the filename is related to the format the view will be loaded in. For example, if the <code>format</code> URL parameter is set to <code>format=feed</code>, the file <code>view.feed.php</code> will be loaded.

:::'''<code>/site/views/{viewname}/tmpl</code>'''
:::This folder holds the template files for the view {ViewName}.

::::'''<code>/site/views/{viewname}/tmpl/default.php</code>'''
::::This is the default template for the view {ViewName}. In this PHP file, the <code>$this</code> keyword refers to the view class that the template belongs to.

:'''<code>/site/models</code>'''
:This folder holds additional models, if needed by the application.

::'''<code>/site/models/{modelname}.php</code>'''
::This file holds the model class <code>{ComponentName}Model{ModelName}</code>. This class must extend the base class <code>JModelLegacy</code>. Note that the view named {ViewName} will by default load a model called {ViewName} if it exists. Most models are named after the view they are intended to be used with, but this is '''not''' a requirement. See [[Using multiple models in an MVC component]] for more information.

:'''<code>/site/controllers</code>'''
:This folder holds additional controllers, if needed by the application.

::'''<code>/site/controllers/{controllername}.php</code>'''
::This file holds the controller class <code>{ComponentName}Controller{ControllerName}</code>. This class must extend the base class <code>JController</code>.

== The /admin folder ==
The file structure is exactly the same as in the /site folder. Note that the view, models, controllers etc. of the site and admin parts are by default completely separated, and have nothing to do with each other - the site part and the admin part can be thought of as two different components! A view in the /admin folder may have a counterpart with the same name in the /site folder, yet the two views have nothing in common but their name.

However, it might sometimes make sense to share classes between the site and admin parts of the component. Especially models can be shared to avoid duplicating model code. The Joomla! framework supports this strategy. When sharing any code between site and admin applications, the classes should be designed with great care to avoid the possibility of a site user executing admin actions.

<noinclude>
[[Category:Development]]
[[Category:Beginner Development]]
[[Category:Component Development]]
</noinclude>

Getting Started with Object Oriented Programming

2015-07-06T21:37:30Z

Waltsjt: Remove the PHP 4 method of declaring a variable with the var keyword, we shouldn't suggest a B/C synonym for the public keyword when we could just use public

PHP is an object oriented language, and to use the MVC structure as implemented by Joomla!, a solid understanding of object oriented programming ''(OOP)'' is required. This document explains the reasons for using objects and the way objects are used in PHP.

== Introduction to Objects ==

As we venture into object oriented programming, it is important to note that it is called 'object' oriented for a reason.

Before object oriented programming (OOP), everything was based on ''functions'' and ''variables''. Let's consider an application that calculates a person's BMI. You might have three variables: <code>$height</code> and <code>$weight</code> and <code>$name</code>. These variables would be used to store a person's name, height and weight. You might then have a function called <code>calculateBMI()</code>, which would accept as parameters $height and $weight.

This would look something like:

<syntaxhighlight lang="php">
function calculateBMI( $height, $weight ) {
return $weight / $height;
}</syntaxhighlight>

But it is very easy to lose track of all these variables in the code, not to mention the fact that only one person is supported at a time. The idea behind objects is to '''encapsulate''' this data '''and''' the functions to manipulate it into one ''package''. The definition of this package is called a ''class''.

So we might have:

<syntaxhighlight lang="php">
class person
{
public $name;
public $height;
public $weight;

function getBMI() {
return $this->weight / $this->height;
}
}</syntaxhighlight>

Then, if you want to create an object which represents a person, you would do:

<syntaxhighlight lang="php">
$person = new person();
</syntaxhighlight>

This is called ''instantiating'' the class, because it creates an ''instance'' of the class (an object described by the class).

Now, you can modify the variables (which are called ''properties''), using:

<syntaxhighlight lang="php">
$person->height = 2;
$person->weight = 50;
</syntaxhighlight>

Then you can invoke its functions (which are called ''methods'') using:

<syntaxhighlight lang="php">
$bmi = $person->getBMI();
</syntaxhighlight>

Often, many classes are similar, but too different to put into one class. For example, all animals have lungs, and because humans and cats are animals, they could both have a <code>$lung_capacity</code>. However, cats have tails, so should an <code>Animal</code> class have a <code>$tail_length</code>? No, that is not necessary. You can make a class a ''subclass'' or ''child class'' of another, essentially stating that the subclass has everything its parent class has, plus some extensions.

In Joomla, most classes are children of JObject. Now, if we were to make person a child class of JObject, then we would ''inherit'' the capabilities of the JObject class. We would then change the definition to something like:

<syntaxhighlight lang="php">

class person extends JObject
{
public $name;
public $height;
public $weight;

function getBMI() {
return $this->weight / $this->height;
}
}
</syntaxhighlight>

Then we could ''manipulate'' our person using the <code>get()</code> and <code>set()</code> methods that JObject has:

<syntaxhighlight lang="php">
$person->set( 'name', 'Bob' );
$person->set( 'height', 2 );
$person->set( 'weight', 50 );
$person->get( 'weight' );
echo $person->getBMI();
</syntaxhighlight>

You will notice the use of <code>$this</code> inside classes a lot. <code>$this</code> is a reference to the '''current''' object. So if I am inside a class, and I use say <code>$this->height = 2;</code>, then that means I am setting the property 'height' of the current object to 2. When we use <code>$this->height</code>, we aren't talking about any height, but we're talking about the current object height.

== More on Objects ==

As I said, Objects are called Objects for a reason. If you have a real life object, say a photocopier, there is an external interface (say, a paper tray, the copier glass, the keypad, etc.). Objects in OOP are designed to approximate that setup.

So, I might have a class called copier. Now, what operations do I generally need to do with a copier? Well, the basic functionality I need is copy functionality. So I need a method called 'copy':

<syntaxhighlight lang="php">
class Copier
{
function copy() {
echo 'One copy made';
}
}
</syntaxhighlight>

Now, this is a very basic copier. What if I wanted to extend the functionality of my Copier? Well, to extend the functionality, I create a child class. ''A child class will inherit all the functionality of the parent class.''

Let's suppose we wanted to create a copier that would keep track of the number of copies it had made. So, we would need to add a property which would keep track of this number, and then we need to somehow adjust this number each time we make a copy.

So here is our child class:

<syntaxhighlight lang="php">
class CopierWithCounter extends Copier
{
public $counter;

function copy() {
$this->counter++;
parent::copy();
}
}
</syntaxhighlight>

So we now have a property called <code>$counter</code> that keeps track of the number of copies made. Notice that the method we defined has the same name as the method in the Copier class. What this means is that we don't need to learn anything new to use the copier - it behaves in the same way as our old copier, but it just keep track of the number of copies.

You will see that inside of the <code>copy()</code> method there is a line: ''<code>parent::copy()</code>''. The <code>parent</code> keyword references the parent class, which is in this case Copier. So this line will invoke the <code>copy()</code> method of the Copier class. In this way, we don't have to rewrite the functionality to make a copy - we have already done that in the Copier class.

So we have the exact same functionality as the Copier class, except that anytime a copy is made it will increment the $copies property by 1. Just as in real life, the addition of the counter doesn't change the way that I use the copier - I don't need to know anything about the counter to just make a simple copy.

Now, the question arises: what value does <code>$counter</code> have to start with? We know that it increases by one every time a copy is made, but that is all we know.

This value needs to be ''initialized'' to a certain value.

Initializing values is generally done by what is called a ''constructor''. A constructor does just that - it constructs the object. In PHP4, constructors were functions that always had the same name as the class. In PHP5, constructors are functions with the name <code>__construct</code>. We will use <code>__construct</code> here.

So our class now becomes:
<syntaxhighlight lang="php">
class CopierWithCounter extends Copier
{
public $counter;

function __construct() {
$this->counter = 0;
}

function copy() {
$this->counter++;
parent::copy();
}
}
</syntaxhighlight>

Now suppose we wanted to create an even more advanced copier. We can do that by creating another child class. Let's create a copier that is able to do multiple copies. In order to do this, we need a way to specify how many copies we want and a way to remember this number. We will add a method called 'setCopies()':

<syntaxhighlight lang="php">
class CopierMultipleCopies extends CopierWithCounter
{
public $copies;

function setCopies( $copies ) {
$this->copies = $copies;
}
}
</syntaxhighlight>
We now have a way to specify how many copies we want to make.

Now, it is appropriate here to say a word about ''scope''. When we talk about scope, we talk about where a certain variable can be seen. You will notice that in our class, we have a property called <code>$copies</code>. But we also have a parameter called <code>$copies</code> in our method <code>setCopies</code>. How do you tell them apart?

Well, the rules of scope tell us which variable we are talking about. If a method takes a parameter, say <code>$copies</code> (as above), then if I use <code>$copies</code> inside that method, I am referring to that parameter. There may be other variables called <code>$copies</code> that are defined in other places, but I don't care about those - I only care about the one inside of my function. If I want to refer to a property of the current object, I use the <code>$this</code> keyword. So, if I use <code>$this->copies</code>, then I am talking about the <code>$copies</code> property that belongs to my current object.

So that aside, our <code>setCopies()</code> method will allow us to set the number of copies that we want to make using our copier. The method takes one parameter - <code>$copies</code>, and stores it in the object.

You will notice that our current class definition for CopierMultipleCopies doesn't define a <code>copy()</code> method or a constructor. But, because it extends CopierWithCounter, it inherits the <code>copy()</code> method from CopierWithCounter, and also inherits the properties. So, without doing any extra work, we already have a Copier with a counter.

But we still want to extend the functionality of the <code>copy()</code> method so that it actually makes the multiple copies. So, we add a method definition to our class. We will also add a constructor that will add the functionality of initializing the number of copies to 1.

<syntaxhighlight lang="php">
class CopierMultipleCopies extends CopierWithCounter
{
public $copies;

function __construct() {
$this->copies = 1;
parent::__construct();
}

function setCopies( $copies ) {
$this->copies = $copies;
}

function copy() {
for ($i = 0; $i < $this->copies; $i++) {
parent::copy();
}
}
}
</syntaxhighlight>

So what have we done here? Well, first, in our constructor we initialized the $copies variable to 1. Thus, if we don't tell our copier otherwise, it will make one copy when the <code>copy()</code> method is invoked. Note that we don't have to rewrite the code to initialize the counter - we just call <code>parent::__construct()</code> and our parent constructor will handle that.

Then, we ''overrode'' the <code>copy()</code> method. Inside of our <code>copy()</code> method we have what is called a ''[[http://en.wikipedia.org/wiki/For_loop|for loop]]''.

In the first line of the for loop, you will see three parts divided by semicolons.

The first part is the ''initialization''. We will use $i as a counter variable, and we will start it at 0. $i will essentially keep track of the number of copies we have made out of the total number that we have to do.

The second part is the ''condition''. At the beginning of each run of the for loop, this condition is checked to determine if it is true or not. If the condition is true, we execute the stuff inside of the braces. If it is not, then we are done the loop.

The last part is the ''incrementor''. This is code that gets executed after every pass through the loop.

So it will run something like:
* take our variable i and set it to 0.
* Check if our variable i is less than the number of copies that we have to make
* if it is, then we will make a copy
* we will increment i by 1 and go back to step 2

You can have much more complex for loops than this, but this is the basic idea.

So that is our copier. Now to use our copier, we can add something like this to our code:
<syntaxhighlight lang="php">
$copier = new CopierMultipleCopies();
$copier->copy();
$copier->copy();
$copier->setCopies( 10 );
$copier->copy();
</syntaxhighlight>

So notice a couple of things:

First, as we made our copier more and more complex, we didn't have to duplicate code. That is, in our most complex copier, we didn't have to worry about creating code to make the actual copy. We just used the method that came with our original copier. Also, in our final copier we didn't have to re-implement the counter - we again just used the method that had already been defined to do this.

Second, our new copier can serve as a drop in replacement for our old copier. Yes, each copier was more advanced than the previous one, but it was still possible with the most advanced one to just create it and invoke the copy() method, and it would create a copy.

If I want to use the more advanced functionality, such as reading the counter or changing the number of copies to be made, I need to know about these features, but I can still ignorantly use the copier as if it was the original Copier. (i.e. the original Copier class had a certain interface that was standard.)

The advanced copiers added more features, but this was separate from the original interface. (just as a car with cruise control has the same basic interface as a car without cruise control, but to take advantage of the cruise control you need to know how to set it).

This idea is an important part of the design of Joomla!.

''**ianmac** put together this OOPs overview for the community; [http://forum.joomla.org/index.php/topic,200185.msg943596.html#msg943596 Post #1] and [http://forum.joomla.org/index.php/topic,200694.msg944114.html#msg944114 Post #2]''

<noinclude>
[[Category:Development]]
[[Category:Component Development]]
[[Category:Beginner Development]]
[[Category:Development Recommended Reading]]
[[Category:Tutorials]]
</noinclude>

Retrieving request data using JInput

2015-07-06T21:19:08Z

Waltsjt: Include in Category:Tutorials

Using the JTable class

2015-07-02T19:42:48Z

Waltsjt: Add some more catagories

This tutorial is for {{JVer|3.x}}

== Introduction to JTable ==
The [https://api.joomla.org/cms-3/classes/JTable.html JTable] class is an implementation of the [http://en.wikipedia.org/wiki/Active_record_pattern Active Record] design pattern. It is used throughout Joomla! for [http://en.wikipedia.org/wiki/Create,_read,_update_and_delete creating, reading, updating, and deleting] records in the database table.

Since JTable is an abstract class that forms the basis for all database table classes. Some of the methods listed will be overridden by the child class so you should check the child class documentation for further information. Also take note that as of Joomla 2.5, JTable properties are automatically generated based on the schema of the specified table, which means you don't need to declare Member variables in your class.

Each physical database table created should have a corresponding class derived from JTable to represent it. JTable provides many methods to make common manipulations to the table much simpler. For example, one of the most common operations you will need to perform is to read a table row into memory given a value for the primary key. This can be done easily using the load method. The table row can then be just as easily updated using the save method, which also performs any predefined sanity checks on the table fields.

== Writing an extension of JTable ==
To use JTable, you will create an extension of the JTable class. In this example, we have a database table "#__recipes" with an autoincrementing primary key "id" containing all of our recipes. We'll store this

The only thing we need to do to start using JTables is create a constructor in our extended JTable class. The class constructor will call the parent constructor to get the table, all it needs is the name of the table, the name of the primary key column, and the database instance.

<source lang="php">
<?php

defined('_JEXEC') or die();

class TableRecipes extends JTable
{
public function __construct(&$db)
{
parent::__construct( '#__recipes', 'id', $db );
}
}
</source>

If you were using this class as a part of a backend component called 'Recipes', you would place this code in the file /administrator/components/com_recipes/tables/recipes.php.

You can use this functionality in plugins just as components, i.e.. As a general rule you should avoid writing to the database from a module, and use plugins/components for this. Remember to use the built-in [[constants]] when linking to a custom path (outside the 'adminstrator/{com_nameofyourcomponent}/tables' folder).

== Using a JTable class extension ==

Once the table class is in place we can use it in our model getTable() function.

<source lang="php">
public function getTable($type = 'Recipes', $prefix = 'Table', $config = array())
{
return JTable::getInstance($type, $prefix, $config);
}
</source>

You can use your JTable class in any Joomla! extension by using JTable::addIncludePath() in your extension's source code (use com_nameofyourcomponent in place of com_recipes):

<source lang="php">
JTable::addIncludePath(JPATH_ADMINISTRATOR . '/components/com_recipes/tables');
$row = JTable::getInstance('recipes', 'Table', array());
</source>

Notice that the lowercase version of the suffix of your class name is used as the first parameter, with the prefix 'Table' as the second. Also, the getInstance() member function of JTable returns a JTableObject by reference instead of a value;.

=== Reserved Database Field Names ===
Some of the optional features of JTable require the existence of specially-named fields in the database table. If you require this additional functionality you should ensure that these named fields are present in the table. These field names should be considered reserved as any attempts to use them for purposes other than those supported by JTable may result in conflict.
{| class="wikitable"
|-
!Field name
!Methods using the field name
|-
|checked_out
|[[JTable/checkOut|checkOut]], [[JTable/checkIn|checkIn]], [[JTable/isCheckedOut|isCheckedOut]]
|-
|checked_out_time
|[[JTable/checkOut|checkOut]], [[JTable/checkIn|checkIn]], [[JTable/isCheckedOut|isCheckedOut]]
|-
|hits
|[[JTable/hit|hit]]
|-
|ordering
|[[JTable/getNextOrder|getNextOrder]], [[JTable/reorder|reorder]], [[JTable/move|move]]
|-
|published
|[[JTable/publish|publish]]
|}

==== Check-in/check-out ====
Joomla tables implement a simple mechanism for preventing a [[wikipedia:race condition|race condition]] while editing rows in a database. This depends on the existence of database fields called "checked_out" and "checked_out_time" and if these fields are present in the view (JForm) '''JTable''' will automatically support this mechanism so that it can be easily used in your tables too.

==== Hit counter ====
Some Joomla tables contain a field called "hits" which records the number of times that a table row has been accessed. JTable provides a simple method to increment this field: [https://api.joomla.org/cms-3/classes/JTable.html#method_hit hit].

==== Example JForm fields for Reserved database names in JTable ====
<source lang="xml">
<field name="state"
type="list"
label="JSTATUS"
description="JFIELD_PUBLISHED_DESC"
size="1"
default="1">
<option value="1">JPUBLISHED</option>
<option value="0">JUNPUBLISHED</option>
<option value="2">JARCHIVED</option>
<option value="-2">JTRASHED</option>
</field>
<field name="checked_out"
type="hidden"
filter="unset"
/>
<field name="checked_out_time"
type="hidden"
filter="unset"
/>
<field name="created_user_id"
label="JGLOBAL_FIELD_CREATED_BY_LABEL"
type="hidden"
filter="unset"
/>
<field name="created_time"
label="JGLOBAL_FIELD_CREATED_LABEL"
type="hidden"
filter="unset"
/>
<field name="modified_user_id"
label="JGLOBAL_FIELD_MODIFIED_BY_LABEL"
type="hidden"
filter="unset"
/>
<field name="modified_time"
label="JGLOBAL_FIELD_MODIFIED_LABEL"
type="hidden"
filter="unset"
/>
<field name="hits"
type="text"
id="hits"
class="readonly"
label="JGLOBAL_HITS"
size="20"
readonly="true"
filter="unset"
/>
</source>

===Useful Member Functions===
* [[JTable/load]]
* [[JTable/bind]]
* [[JTable/check]]
* [[JTable/store]]
* [[JTable/save]] Method to provide a shortcut to binding, checking and storing a JTable instance to the database table.

===See Also===
* [[J3.2:Developing a MVC Component/Using the database#admin.2Ftables.2Fhelloworld.php | Part 7 of J3.2:Developing a MVC Component/Using the database]]
*[[J2.5:Developing a MVC Component/Adding configuration#admin.2Ftables.2Fhelloworld.php | Part 14 of J2.5:Developing a MVC Component/Adding configuration]]

== Summary ==
When properly extended, JTable gives you all of the basic functions you need for managing and retrieving records in a database table.

<noinclude>
[[Category:Development]]
[[Category:Component Development]]
[[Category:Extension development]]
[[Category:JTable]]
[[Category:Tutorials]]
</noinclude>

Using the JTable class

2015-07-02T17:23:41Z

Waltsjt: Add Example JForm fields for Reserved database names in JTable

This tutorial is for {{JVer|3.x}}

== Introduction to JTable ==
The [https://api.joomla.org/cms-3/classes/JTable.html JTable] class is an implementation of the [http://en.wikipedia.org/wiki/Active_record_pattern Active Record] design pattern. It is used throughout Joomla! for [http://en.wikipedia.org/wiki/Create,_read,_update_and_delete creating, reading, updating, and deleting] records in the database table.

Since JTable is an abstract class that forms the basis for all database table classes. Some of the methods listed will be overridden by the child class so you should check the child class documentation for further information. Also take note that as of Joomla 2.5, JTable properties are automatically generated based on the schema of the specified table, which means you don't need to declare Member variables in your class.

Each physical database table created should have a corresponding class derived from JTable to represent it. JTable provides many methods to make common manipulations to the table much simpler. For example, one of the most common operations you will need to perform is to read a table row into memory given a value for the primary key. This can be done easily using the load method. The table row can then be just as easily updated using the save method, which also performs any predefined sanity checks on the table fields.

== Writing an extension of JTable ==
To use JTable, you will create an extension of the JTable class. In this example, we have a database table "#__recipes" with an autoincrementing primary key "id" containing all of our recipes. We'll store this

The only thing we need to do to start using JTables is create a constructor in our extended JTable class. The class constructor will call the parent constructor to get the table, all it needs is the name of the table, the name of the primary key column, and the database instance.

<source lang="php">
<?php

defined('_JEXEC') or die();

class TableRecipes extends JTable
{
public function __construct(&$db)
{
parent::__construct( '#__recipes', 'id', $db );
}
}
</source>

If you were using this class as a part of a backend component called 'Recipes', you would place this code in the file /administrator/components/com_recipes/tables/recipes.php.

You can use this functionality in plugins just as components, i.e.. As a general rule you should avoid writing to the database from a module, and use plugins/components for this. Remember to use the built-in [[constants]] when linking to a custom path (outside the 'adminstrator/{com_nameofyourcomponent}/tables' folder).

== Using a JTable class extension ==

Once the table class is in place we can use it in our model getTable() function.

<source lang="php">
public function getTable($type = 'Recipes', $prefix = 'Table', $config = array())
{
return JTable::getInstance($type, $prefix, $config);
}
</source>

You can use your JTable class in any Joomla! extension by using JTable::addIncludePath() in your extension's source code (use com_nameofyourcomponent in place of com_recipes):

<source lang="php">
JTable::addIncludePath(JPATH_ADMINISTRATOR . '/components/com_recipes/tables');
$row = JTable::getInstance('recipes', 'Table', array());
</source>

Notice that the lowercase version of the suffix of your class name is used as the first parameter, with the prefix 'Table' as the second. Also, the getInstance() member function of JTable returns a JTableObject by reference instead of a value;.

=== Reserved Database Field Names ===
Some of the optional features of JTable require the existence of specially-named fields in the database table. If you require this additional functionality you should ensure that these named fields are present in the table. These field names should be considered reserved as any attempts to use them for purposes other than those supported by JTable may result in conflict.
{| class="wikitable"
|-
!Field name
!Methods using the field name
|-
|checked_out
|[[JTable/checkOut|checkOut]], [[JTable/checkIn|checkIn]], [[JTable/isCheckedOut|isCheckedOut]]
|-
|checked_out_time
|[[JTable/checkOut|checkOut]], [[JTable/checkIn|checkIn]], [[JTable/isCheckedOut|isCheckedOut]]
|-
|hits
|[[JTable/hit|hit]]
|-
|ordering
|[[JTable/getNextOrder|getNextOrder]], [[JTable/reorder|reorder]], [[JTable/move|move]]
|-
|published
|[[JTable/publish|publish]]
|}

==== Check-in/check-out ====
Joomla tables implement a simple mechanism for preventing a [[wikipedia:race condition|race condition]] while editing rows in a database. This depends on the existence of database fields called "checked_out" and "checked_out_time" and if these fields are present in the view (JForm) '''JTable''' will automatically support this mechanism so that it can be easily used in your tables too.

==== Hit counter ====
Some Joomla tables contain a field called "hits" which records the number of times that a table row has been accessed. JTable provides a simple method to increment this field: [https://api.joomla.org/cms-3/classes/JTable.html#method_hit hit].

==== Example JForm fields for Reserved database names in JTable ====
<source lang="xml">
<field name="state"
type="list"
label="JSTATUS"
description="JFIELD_PUBLISHED_DESC"
size="1"
default="1">
<option value="1">JPUBLISHED</option>
<option value="0">JUNPUBLISHED</option>
<option value="2">JARCHIVED</option>
<option value="-2">JTRASHED</option>
</field>
<field name="checked_out"
type="hidden"
filter="unset"
/>
<field name="checked_out_time"
type="hidden"
filter="unset"
/>
<field name="created_user_id"
label="JGLOBAL_FIELD_CREATED_BY_LABEL"
type="hidden"
filter="unset"
/>
<field name="created_time"
label="JGLOBAL_FIELD_CREATED_LABEL"
type="hidden"
filter="unset"
/>
<field name="modified_user_id"
label="JGLOBAL_FIELD_MODIFIED_BY_LABEL"
type="hidden"
filter="unset"
/>
<field name="modified_time"
label="JGLOBAL_FIELD_MODIFIED_LABEL"
type="hidden"
filter="unset"
/>
<field name="hits"
type="text"
id="hits"
class="readonly"
label="JGLOBAL_HITS"
size="20"
readonly="true"
filter="unset"
/>
</source>

===Useful Member Functions===
* [[JTable/load]]
* [[JTable/bind]]
* [[JTable/check]]
* [[JTable/store]]
* [[JTable/save]] Method to provide a shortcut to binding, checking and storing a JTable instance to the database table.

===See Also===
* [[J3.2:Developing a MVC Component/Using the database#admin.2Ftables.2Fhelloworld.php | Part 7 of J3.2:Developing a MVC Component/Using the database]]
*[[J2.5:Developing a MVC Component/Adding configuration#admin.2Ftables.2Fhelloworld.php | Part 14 of J2.5:Developing a MVC Component/Adding configuration]]

== Summary ==
When properly extended, JTable gives you all of the basic functions you need for managing and retrieving records in a database table.

<noinclude>[[Category:Development]][[Category:JTable]]</noinclude>

File form field type

2015-07-01T18:23:48Z

Waltsjt: Add Labelclass and showon. Include some more catagories

{{Ambox|type=notice|text=In Joomla! 1.5, [[Form field|form fields]] were [[Parameter|parameters]]. For that version, you may want to use the corresponding [[Text parameter type]].}}

Intro: todo

* '''type''' (mandatory) must be ''file''.
* '''name''' (mandatory) is the unique name of the field.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
* '''default''' (optional) (not translatable) is the default value, but doesn't mean much for a file.
* '''size''' (optional) is the width of the file box in characters.
* [http://www.w3schools.com/tags/att_input_accept.asp '''accept'''] (optional) Tells the browser what MIME types your form will allow to be uploaded.
* '''class''' (optional) is a CSS class name for the HTML form field.
* '''labelclass''' (optional) adds a CSS class for form field's label; for Joomla 2.5.4+
* '''disabled''' (optional) HTML equivalent attribute
* '''onchange''' (optional) HTML equivalent attribute (javascript use)
* '''required''' (optional) For Joomla form validating it to be filled in
* '''validate''' (optional) Whether to Joomla validate the field according to rules
* '''showon''' (optional) Allows you to hide the field based on the value(s) of another field; for Joomla 3.2.4+

'''Note:'''
When using the file input type you should always add the attribute enctype="multipart/form-data" to your form tag. Otherwise, the uploaded files will not be attached correctly.

'''Note 2:'''
You can put a soft limit file size by adding a hidden field with name="MAX_FILE_SIZE" and value the maximum allowed bytes which is handled by php, but you must also handle it in your code with or without it.
Example XML field definition:

<source lang="xml">
<field name="myfilevalue" type="file" label="Enter some text" description="Choose an image from your computer with maximum 100KB" size="10" accept="image/*" />
</source>

=== See also ===

* [[Standard form field types|List of standard form field types]]
<noinclude>
[[Category:Standard form field types]]
[[Category:Form fields]]
[[Category:Development]]
</noinclude>

J3.x:Using the JToolbar class in the frontend

2015-06-26T11:39:31Z

Waltsjt: Update based on Joomla 3 backend views

{{page|needs review}}{{RightTOC}}

NOTE: This documentation was not previously updated for Joomla! 3.2. I have made some updates to bring it closer to what is needed for Joomla! 3 but admittedly, I still don't have this functionality working. Additional corrections and contributions would be greatly appreciated! Erik Jorgensen 12/10/2013.

== Using JToolBar ==

It's now simpler to use JToolBar in the front end than it was in Joomla! 1.5 as it only requires two steps.

{{clear}}
===Step 1===
Add the toolbar to your view display function
<source lang="php>
function display($tpl = null)
{
...
// Set the toolbar
$input->set('hidemainmenu', true);
$this->addToolbar();
parent::display($tpl);
}
</source>

===Step 2===
Add an addToolbar() function to view.html.php file in the view you wish to add the toolbar to (this function could possibly be placed in a helper function).
<source lang="php>
protected function addToolbar()
{
$input = JFactory::getApplication()->input;

// Add whatever buttons you require
JToolBarHelper::save('yourcom.save');
JToolbarHelper::divider();
JToolBarHelper::cancel('yourcom.cancel');
JToolbarHelper::divider();
}
</source>

[[Category:Development]]
[[Category:Needs to be marked for translation]]

Using the JTable class

2015-06-26T11:04:51Z

Waltsjt: recreate JTable use example for joomla 3 (also pull in text from other examples by Chris Davenport)

This tutorial is for {{JVer|3.x}}

== Introduction to JTable ==
The [https://api.joomla.org/cms-3/classes/JTable.html JTable] class is an implementation of the [http://en.wikipedia.org/wiki/Active_record_pattern Active Record] design pattern. It is used throughout Joomla! for [http://en.wikipedia.org/wiki/Create,_read,_update_and_delete creating, reading, updating, and deleting] records in the database table.

Since JTable is an abstract class that forms the basis for all database table classes. Some of the methods listed will be overridden by the child class so you should check the child class documentation for further information. Also take note that as of Joomla 2.5, JTable properties are automatically generated based on the schema of the specified table, which means you don't need to declare Member variables in your class.

Each physical database table created should have a corresponding class derived from JTable to represent it. JTable provides many methods to make common manipulations to the table much simpler. For example, one of the most common operations you will need to perform is to read a table row into memory given a value for the primary key. This can be done easily using the load method. The table row can then be just as easily updated using the save method, which also performs any predefined sanity checks on the table fields.

== Writing an extension of JTable ==
To use JTable, you will create an extension of the JTable class. In this example, we have a database table "#__recipes" with an autoincrementing primary key "id" containing all of our recipes. We'll store this

The only thing we need to do to start using JTables is create a constructor in our extended JTable class. The class constructor will call the parent constructor to get the table, all it needs is the name of the table, the name of the primary key column, and the database instance.

<source lang="php">
<?php

defined('_JEXEC') or die();

class TableRecipes extends JTable
{
public function __construct(&$db)
{
parent::__construct( '#__recipes', 'id', $db );
}
}
</source>

If you were using this class as a part of a backend component called 'Recipes', you would place this code in the file /administrator/components/com_recipes/tables/recipes.php.

You can use this functionality in plugins just as components, i.e.. As a general rule you should avoid writing to the database from a module, and use plugins/components for this. Remember to use the built-in [[constants]] when linking to a custom path (outside the 'adminstrator/{com_nameofyourcomponent}/tables' folder).

== Using a JTable class extension ==

Once the table class is in place we can use it in our model getTable() function.

<source lang="php">
public function getTable($type = 'Recipes', $prefix = 'Table', $config = array())
{
return JTable::getInstance($type, $prefix, $config);
}
</source>

You can use your JTable class in any Joomla! extension by using JTable::addIncludePath() in your extension's source code (use com_nameofyourcomponent in place of com_recipes):

<source lang="php">
JTable::addIncludePath(JPATH_ADMINISTRATOR . '/components/com_recipes/tables');
$row = JTable::getInstance('recipes', 'Table', array());
</source>

Notice that the lowercase version of the suffix of your class name is used as the first parameter, with the prefix 'Table' as the second. Also, the getInstance() member function of JTable returns a JTableObject by reference instead of a value;.

=== Reserved Database Field Names ===
Some of the optional features of JTable require the existence of specially-named fields in the database table. If you require this additional functionality you should ensure that these named fields are present in the table. These field names should be considered reserved as any attempts to use them for purposes other than those supported by JTable may result in conflict.
{| class="wikitable"
|-
!Field name
!Methods using the field name
|-
|checked_out
|[[JTable/checkOut|checkOut]], [[JTable/checkIn|checkIn]], [[JTable/isCheckedOut|isCheckedOut]]
|-
|checked_out_time
|[[JTable/checkOut|checkOut]], [[JTable/checkIn|checkIn]], [[JTable/isCheckedOut|isCheckedOut]]
|-
|hits
|[[JTable/hit|hit]]
|-
|ordering
|[[JTable/getNextOrder|getNextOrder]], [[JTable/reorder|reorder]], [[JTable/move|move]]
|-
|published
|[[JTable/publish|publish]]
|}

==== Check-in/check-out ====
Joomla tables implement a simple mechanism for preventing a [[wikipedia:race condition|race condition]] while editing rows in a database. This depends on the existence of database fields called "checked_out" and "checked_out_time" and if these fields are present '''JTable''' will automatically support this mechanism so that it can be easily used in your tables too.

==== Hit counter ====
Some Joomla tables contain a field called "hits" which records the number of times that a table row has been accessed. JTable provides a simple method to increment this field: [https://api.joomla.org/cms-3/classes/JTable.html#method_hit hit].

===Useful Member Functions===
* [[JTable/load]]
* [[JTable/bind]]
* [[JTable/check]]
* [[JTable/store]]
* [[JTable/save]] Method to provide a shortcut to binding, checking and storing a JTable instance to the database table.

===See Also===
* [[J3.2:Developing a MVC Component/Using the database#admin.2Ftables.2Fhelloworld.php | Part 7 of J3.2:Developing a MVC Component/Using the database]]
*[[J2.5:Developing a MVC Component/Adding configuration#admin.2Ftables.2Fhelloworld.php | Part 14 of J2.5:Developing a MVC Component/Adding configuration]]

== Summary ==
When properly extended, JTable gives you all of the basic functions you need for managing and retrieving records in a database table.

<noinclude>[[Category:Development]][[Category:JTable]]</noinclude>

API16:JTable

2015-06-26T11:04:08Z

Waltsjt: fix content duplication

{{Description:JTable}}

===Defined in===
libraries/joomla/database/table.php
===Methods===
{| class="wikitable sortable"
|-
!Method name
!Description
|-
|[[API16:JTable/__construct|__construct]]
|Object constructor to set table and key fields. In most cases this will be overridden by child classes to explicitly set the table and key fields for a particular database table.
|-
|[[API16:JTable/getFields|getFields]]
|Get the columns from database table.
|-
|[[API16:JTable/getTableName|getTableName]]
|Method to get the database table name for the class.
|-
|[[API16:JTable/getKeyName|getKeyName]]
|Method to get the primary key field name for the table.
|-
|[[API16:JTable/getDbo|getDbo]]
|Method to get the JDatabase connector object.
|-
|[[API16:JTable/setDBO|setDBO]]
|Method to set the JDatabase connector object.
|-
|[[API16:JTable/setRules|setRules]]
|Method to set rules for the record.
|-
|[[API16:JTable/getRules|getRules]]
|Method to get the rules for the record.
|-
|[[API16:JTable/reset|reset]]
|Method to reset class properties to the defaults set in the class definition. It will ignore the primary key as well as any private class properties.
|-
|[[API16:JTable/bind|bind]]
|Method to bind an associative array or object to the JTable instance.This method only binds properties that are publicly accessible and optionally takes an array of properties to ignore when binding.
|-
|[[API16:JTable/load|load]]
|Method to load a row from the database by primary key and bind the fields to the JTable instance properties.
|-
|[[API16:JTable/check|check]]
|Method to perform sanity checks on the JTable instance properties to ensure they are safe to store in the database. Child classes should override this method to make sure the data they are storing in the database is safe and as expected before storage.
|-
|[[API16:JTable/store|store]]
|Method to store a row in the database from the JTable instance properties. If a primary key value is set the row with that primary key value will be updated with the instance property values. If no primary key value is set a new row will be inserted into the database with the properties from the JTable instance.
|-
|[[API16:JTable/save|save]]
|Method to provide a shortcut to binding, checking and storing a JTable instance to the database table. The method will check a row in once the data has been stored and if an ordering filter is present will attempt to reorder the table rows based on the filter. The ordering filter is an instance property name. The rows that will be reordered are those whose value matches the JTable instance for the property specified.
|-
|[[API16:JTable/delete|delete]]
|Method to delete a row from the database table by primary key value.
|-
|[[API16:JTable/checkOut|checkOut]]
|Method to check a row out if the necessary properties/fields exist. To prevent race conditions while editing rows in a database, a row can be checked out if the fields 'checked_out' and 'checked_out_time' are available. While a row is checked out, any attempt to store the row by a user other than the one who checked the row out should be held until the row is checked in again.
|-
|[[API16:JTable/checkIn|checkIn]]
|Method to check a row in if the necessary properties/fields exist. Checking a row in will allow other users the ability to edit the row.
|-
|[[API16:JTable/hit|hit]]
|Method to increment the hits for a row if the necessary property/field exists.
|-
|[[API16:JTable/isCheckedOut|isCheckedOut]]
|TODO: This either needs to be static or not.
|-
|[[API16:JTable/getNextOrder|getNextOrder]]
|Method to get the next ordering value for a group of rows defined by an SQL WHERE clause. This is useful for placing a new item last in a group of items in the table.
|-
|[[API16:JTable/reorder|reorder]]
|Method to compact the ordering values of rows in a group of rows defined by an SQL WHERE clause.
|-
|[[API16:JTable/move|move]]
|Method to move a row in the ordering sequence of a group of rows defined by an SQL WHERE clause. Negative numbers move the row up in the sequence and positive numbers move it down.
|-
|[[API16:JTable/publish|publish]]
|Method to set the publishing state for a row or list of rows in the database table. The method respects checked out rows by other users and will attempt to checkin rows that it can after adjustments are made.
|-
|[[API16:JTable/canDelete|canDelete]]
|Generic check for whether dependancies exist for this object in the database schema
|-
|[[API16:JTable/toXML|toXML]]
|Method to export the JTable instance properties to an XML string.
|-
|[[API16:JTable/getInstance|getInstance]]
|Static method to get an instance of a JTable class if it can be found in the table include paths. To add include paths for searching for JTable classes JTable::addIncludePath().

|-
|[[API16:JTable/addIncludePath|addIncludePath]]
|Add a filesystem path where JTable should search for table class files. You may either pass a string or an array of paths.
|}

===Importing===
<source lang="php">jimport( 'joomla.database.table' );</source>

===Examples===
<noinclude>[[Category:Development]][[Category:JTable]][[Category:CodeExample]][[Category:ClassExample]]</noinclude>

API16:JForm/setValue

2015-06-24T19:23:42Z

Waltsjt: Remove edit junk

===Description===
Method to set the value of a field.

===Syntax===
<source lang="php">setValue($field, $value, $group= '_default')</source>

{| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $field
|
| $field The field to set.
|-
| $value
|
| $value The value to set the field to.
|-
| $group
| '_default'
| $group The group the field is in.
|}

===Returns===
boolean True if field exists, false otherwise.

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

===Source Body===
<source lang="php">
public function setValue($field, $value, $group = '_default')
{
// Set the field if it exists.
if (isset($this->_groups[$group][$field]) && is_object($this->_groups[$group][$field])) {
$this->_data[$group][$field] = $value;
return true;
} else {
return false;
}
}
</source>

<span class="editsection" style="font-size:76%;">
<nowiki>[<! removed edit link to red link >]</nowiki>
</span>
<! removed transcluded page call, red link never existed >

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=setValue
category=JForm
category=CodeExample
category=MethodExample
include=*
format= ,,,
</dpl>
[[Category:Archived pages API16]]

Model-View-Controller

2015-06-24T17:07:30Z

Waltsjt: Format fix due to translate tags

<noinclude><languages/></noinclude>

{{Chunk:Model-View-Controller/en}}
==See Also== 
* [[Understanding Output Overrides]]
* [[Developers]]
* [http://api.joomla.org/11.4/Joomla-Platform/Application/JModel.html JModel]
* [https://api.joomla.org/cms-3/classes/JModelLegacy.html JModelLegacy {{JVer|2.5}} and newer]
* [https://api.joomla.org/cms-3/classes/JModelAdmin.html JModelAdmin {{JVer|2.5}} and newer]
* [https://api.joomla.org/cms-3/classes/JModelBase.html JModelBase {{JVer|3.x}}]
* [http://api.joomla.org/11.4/Joomla-Platform/Application/JView.html JView]
* [https://api.joomla.org/cms-3/classes/JViewLegacy.html JViewLegacy {{JVer|2.5}} and newer]
* [https://api.joomla.org/cms-3/classes/JViewBase.html JViewBase {{JVer|3.x}}]
* [http://api.joomla.org/11.4/Joomla-Platform/Application/JController.html JController]
* [https://api.joomla.org/cms-3/classes/JControllerForm.html JControllerForm {{JVer|2.5}} and newer]
* [https://api.joomla.org/cms-3/classes/JControllerAdmin.html JControllerAdmin {{JVer|2.5}} and newer]
* [https://api.joomla.org/cms-3/classes/JControllerBase.html JControllerBase {{JVer|3.x}}]

===Component development series=== 
<div class="large-6 column">
====Developing a MVC Component for J3.x ==== 
[[J3.2:Developing a MVC Component/Introduction|Introduction to Developing a 3.x MVC]]
</div>
<div class="large-6 column">
====Developing a MVC Component for J2.5 ==== 
[[J2.5:Developing a MVC Component/Introduction|Introduction to Developing a 2.5 MVC]]
</div>

[[Category:Landing Pages]][[Category:Glossary]]
<noinclude>
[[Category:Development]]
[[Category:Beginner Development]]
</noinclude>
__NOTOC__

Model-View-Controller

2015-06-24T17:05:44Z

Waltsjt: Add some of the newer MVC items

<noinclude><languages/></noinclude><translate>

{{Chunk:Model-View-Controller/en}}</translate>
<translate>==See Also== </translate><translate>
* [[Understanding Output Overrides]]
* [[Developers]]
* [http://api.joomla.org/11.4/Joomla-Platform/Application/JModel.html JModel]
* [https://api.joomla.org/cms-3/classes/JModelLegacy.html JModelLegacy {{JVer|2.5}} and newer]
* [https://api.joomla.org/cms-3/classes/JModelAdmin.html JModelAdmin {{JVer|2.5}} and newer]
* [https://api.joomla.org/cms-3/classes/JModelBase.html JModelBase {{JVer|3.x}}]
* [http://api.joomla.org/11.4/Joomla-Platform/Application/JView.html JView]
* [https://api.joomla.org/cms-3/classes/JViewLegacy.html JViewLegacy {{JVer|2.5}} and newer]
* [https://api.joomla.org/cms-3/classes/JViewBase.html JViewBase {{JVer|3.x}}]
* [http://api.joomla.org/11.4/Joomla-Platform/Application/JController.html JController]
* [https://api.joomla.org/cms-3/classes/JControllerForm.html JControllerForm {{JVer|2.5}} and newer]
* [https://api.joomla.org/cms-3/classes/JControllerAdmin.html JControllerAdmin {{JVer|2.5}} and newer]
* [https://api.joomla.org/cms-3/classes/JControllerBase.html JControllerBase {{JVer|3.x}}]
</translate>
<translate>===Component development series=== </translate>
<div class="large-6 column">
<translate>====Developing a MVC Component for J3.x ==== </translate><translate>
[[J3.2:Developing a MVC Component/Introduction|Introduction to Developing a 3.x MVC]]</translate>
</div>
<div class="large-6 column">
<translate>====Developing a MVC Component for J2.5 ==== </translate>
<translate>[[J2.5:Developing a MVC Component/Introduction|Introduction to Developing a 2.5 MVC]]</translate>
</div>
<translate>
[[Category:Landing Pages]][[Category:Glossary]]
<noinclude>
[[Category:Development]]
[[Category:Beginner Development]]
</noinclude>
__NOTOC__</translate>

JController and its subclass usage overview

2015-06-24T17:00:59Z

Waltsjt: Update some controller info

{{Version|1.5,2.5,3.x}}
=== Preface ===
You should be familiar with the [[MVC|Joomla! MVC pattern]] before reading this topic.

=== Introduction ===
In Joomla! 2.5 and 3.x, lots of MVC improvements were added. These improvements make a developer's task easier. In Joomla! 1.5, there is only one Controller class named JController. In Joomla! 2.5, '''JControllerAdmin''' and '''JControllerForm''' have been added as subclasses of '''JControllerLegacy'''. So there is a different usage for these three classes in Joomla! component development. This is a pattern used by most of the Joomla! core components such as [https://github.com/joomla/joomla-cms/tree/2.5.x/administrator/components/com_content com_content] and [https://github.com/joomla/joomla-cms/tree/2.5.x/administrator/components/com_banners com_banners].

{| class="wikitable"
|-
! {{JVer|1.5}}
! {{JVer|2.5}}
! {{JVer|3.0}} and newer
|-
| JController
| JController
(since 2.5.5 use JControllerLegacy for forward compatibility)
| JControllerLegacy
|-
|
| JControllerAdmin
| JControllerAdmin
|-
|
| JControllerForm
| JControllerForm
|-
|
|
| JControllerBase (new MVC)
|}

If you look at the admin code for [https://github.com/joomla/joomla-cms/tree/2.5.x/administrator/components/com_content '''com_content'''], you will find controller classes located in two places: the root folder and the controllers folder. In the root folder there is a file named 'controller.php', this is the master controller of the component. It is a direct subclass of '''JControllerLegacy'''. In the controllers folder, there are many files named according to entities in the component e.g. article and articles. These controllers subclass either '''JControllerAdmin''' or '''JControllerForm'''.

=== Master Controller ===

The master controller found in the root folder is only responsible for the display task. This is the default task for JControllerLegacy. If you look at JControllerLegacy::getInstance in com_content/content.php, only the component name was passed as a parameter. In JControllerLegacy, it uses the task variable (from the request) to determine what Controller class to load. If the task variable contains a dot (.), it assumes that this variable is in the form of controller.task or controller.method. You should know that task variable specifies method of controller to run. Then in this case, it will load controller class in controllers folder and rewrite task variable to real task. If the task does not contain a dot (.), JControllerLegacy will load the master controller located in the root folder. To simplify, we will refer to controllers in 'controllers' folder as subcontroller. You may notice that in the master controller, a default view is also specified. If there is no view variable in the URL request, this one will be used. So in general, we can conclude:
* To use the master controller, specify a view variable as view name to use or the default one will be used.
* To use a subcontroller, specify the task variable in the form of controller.task, clearly specified CONTROLLER_NAME.CONTROLLER_METHOD.

We can categorize display into two types: presenting a list of records ('''list view''') and showing a detailed record item to the user (e.g. '''edit form'''). If we look at the articles view in com_content which displays a list of records to the user, we may notice that toolbar buttons are added according to user rights.

<span id="editToolbar">
[https://github.com/joomla/joomla-cms/blob/2.5.x/administrator/components/com_content/views/articles/view.html.php ''$JOOMLA_INSTALL/administrator/components/com_content/views/articles/view.html.php'']
<source lang="php">

protected function addToolbar()
{
...

if (($canDo->get('core.edit')) || ($canDo->get('core.edit.own'))) {
JToolBarHelper::editList('article.edit');
}

...
}

</source>
</span>

For example, to edit an article the task variable would be article.edit. This will cause the article subcontroller to be loaded and the edit method to be executed. You may have a question, this mean we will display edit form to user. That is right! In general we do that, but in Joomla! 2.5 core component, it just sets the article id to be edit in the user session and redirects it to an URL like &view=article&layout=edit. And this will be handled by master controller and edit form will be presented to user. So in this case, all display will be handled by master controller and needed views.

* If a view name is not defined in URL, default view is used and a default task (display) will be executed. We use this to display a list of records. For example, index.php?option=com_content.
* If a view is defined but the task is not, master controller loads specified view and executes display method. This is also used to display a list of records. For example, index.php?option=com_content&view=articles.
* If a view is specified with a task (but not in the dot format), master controller loads the specified view and executes method specified by task. This case is used to display edit form, or to present one item of record to user. An example is index.php?option=com_content&view=article&layout=edit.

When the master controller a creates view, it normally loads a model having the same name as the view and pushes model into the view. Then the view's display method is called. Doing this, in view we can get data from model using function like $this->get("Items"). In this case, view will look for method getItems in model and execute it. Doing this, we can use one controller for display all information type in component. But many views still required. This reduces the controller class and, of course, reduces code produced by developer.

=== Subcontrollers ===
Subcontrollers will handle all CRUD tasks. For tasks such as save, delete & publish that clearly do not need a view, the subcontroller just deletes or updates records and redirects the user back to list view. In this case the user must select at least one item of record, and we usually give the name of the controller in plural form such as "articles.delete", "articles.publish_up" or "articles.publish_down". This subcontroller is generally inherited from JControllerAdmin which suppress display method by default.

The other type of CRUD, such as add or edit, at a first glance should prepare data and present the form to user. But in the core component for Joomla! 2.5, they did not do that. Looking at this kind of subcontrollers (for example ContentControllerArticle) one can see that they always are inherited from JControllerForm. But no form was presented to user in this request, it just stores item (the ID of the article) in user's session variable and redirects to master controller. As a task variable was not specified, the display method is executed as a default task.

For example: first request being processed by subcontroller may contain task=article.edit and cid[]=3. Subcontroller will create URL like "index.php?option=com_content&view=article&layout=edit" and redirect the user to master controller.

=== Contributors ===
*[[User:Mrs.siam|Prasit Gebsaap]]
*[[User:mcormier|Matthieu Cormier]]

<noinclude>
[[category:Joomla! 2.5]]
[[Category:Joomla! 3.x]]
[[Category:Development]]
[[Category:Beginner Development]]
[[Category:Component Development]]
[[Category:Needs to be marked for translation]]
</noinclude>

Talk:Standard form field types

2015-05-22T20:43:53Z

Waltsjt:

== type captcha ==

The type captcha doesn't provide a list of captcha options available, that is type plugin, folder captcha. The type captcha provides an input for validating. And that applies to the default captcha, others could provide different ways. Should both be described? How to type the plugin folder captcha? [[User:Sovainfo|Sovainfo]] ([[User talk:Sovainfo|talk]]) 14:49, 10 September 2013 (CDT)

== desired content? ==

Would like to change the format of these documents. Wonder what kind of information people are looking for. Instead of providing all the options on all documents would like to point to one document with all options in alpha order. Maybe in table format with checks which styles support which option. [[User:Sovainfo|Sovainfo]] ([[User talk:Sovainfo|talk]]) 07:17, 16 September 2013 (CDT)

:I think such a page is coming. One of the GSOC students (Achal) has been working on the form fields generally for Joomla 3 (see [[Text_form_field_type/3.2]]) - and that's how his page seems to be shaping up. So I'd hold on this for now until that is complete. However in my opinion we still need a list of all the form fields we have available in the core like we have now (even if we don't keep the subpages). --[[User:Wilsonge|Wilsonge]] ([[User talk:Wilsonge|talk]]) 18:17, 16 September 2013 (CDT)
:: Hope he'll reconsider the layout. I prefer a concise one page above the tabbed window. Considering it is information for developers you might start with the example code! Maybe mention what script implements it. Or even show the script itself. [[User:Sovainfo|Sovainfo]] ([[User talk:Sovainfo|talk]]) 15:16, 17 September 2013 (CDT)

== combo ==

Haven't found the combo field type. Can it be removed? [[User:Sovainfo|Sovainfo]] ([[User talk:Sovainfo|talk]]) 07:19, 16 September 2013 (CDT)

:I don't think the core doesn't use it - you're right - but it still seems to exist in the core code for people to use so we should be documenting it. https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/form/fields/combo.php . --[[User:Wilsonge|Wilsonge]] ([[User talk:Wilsonge|talk]]) 18:12, 16 September 2013 (CDT)
:: ok, will work on it. [[User:Sovainfo|Sovainfo]] ([[User talk:Sovainfo|talk]]) 15:16, 17 September 2013 (CDT)

Standard form field types

2015-05-22T20:40:33Z

Waltsjt:

Numerous types of [[form field]] are built into Joomla!. The following table lists these standard types and their availability. Use the [[/Single-page reference|single-page reference]] if you want to print all existing form field documentation.

{{JVer|1.5}} Please note that many of these fields are available as [[Parameter|parameter types]] in Joomla! 1.5. For a list of parameter types, see [[J1.5:Standard parameter types]]. For a comparison between form field and parameter types, see [[Standard form field and parameter types]].
{| class="wikitable" style="vertical-align:top; border:1px solid Sienna; background-color:Cornsilk;"
|- style="background-color:Wheat; font-weight:bold; text-align: left;"
!width=15%|Type
!width=65%|Description
!width=20%|Availability
|-
|[[Accesslevel form field type|accesslevel]]
|provides a drop down list of viewing access levels.
|{{JVer|2.5}} and newer
|-
|[[Cachehandler form field type|cachehandler]]
|provides a list of available cache handling options.
|{{JVer|2.5}} and newer
|-
|[[Calendar form field type|calendar]]
|provides a text box for entry of a date. An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value.
|{{JVer|2.5}} and newer
|-
|[[Captcha form field type|captcha]]
|provides a drop down list of the captcha plugins.
|{{JVer|2.5}} and newer
|-
|[[Category form field type|category]]
|provides a drop down list of categories for an extension.
|{{JVer|2.5}} and newer
|-
|[[Checkbox form field type|checkbox]]
|provides a single checkbox to be checked or unchecked
|{{JVer|2.5}} and newer
|-
|[[Checkboxes form field type|checkboxes]]
|provides unlimited checkboxes that can be used for multi-select.
|{{JVer|2.5}} and newer
|-
|[[ChromeStyle form field type|Chrome Style]]
|provides a list of template chrome style options grouped by template.
|{{JVer|3.0}} and newer
|-
|[[Color form field type|color]]
|provides a color picker when clicking the input box.
|{{JVer|2.5}} and newer
|-
|[[ContentLanguage form field type|Content Language]]
|Provides a list of content languages.
|{{JVer|2.5}} and newer
|-
|[[Contenttype form field type|Content Type]]
|Provides a list of content types.
|{{JVer|3.1}} and newer
|-
|[[Combo form field type|combo]]
|provides a combo box field.
|{{JVer|2.5}} and newer
|-
|[[Componentlayout form field type|componentlayout]]
|provides a grouped list of core and template alternate layouts for a component item.
|{{JVer|2.5}} and newer
|-
|[[Contentlanguage form field type|contentlanguage]]
|provides a list of installed content languages for use in conjunction with the language switcher plugin.
|{{JVer|2.5}} and newer
|-
|[[DatabaseConnection form field type|Database Connection]]
|Provides a list of available database connections, optionally limiting to a given list.
|{{JVer|2.5}} and newer
|-
|[[Editor form field type|editor]]
|provides an editor area field.
|{{JVer|1.6}} and newer
|-
|[[Editors form field type|editors]]
|Provides a drop down list of the available WYSIWYG editors. Since {{JVer|2.5}} use [[Plugins form field type|plugins form field]] instead.
|{{JVer|1.6}}
|-
|[[Email form field type|email]]
|provides an email field.
|{{JVer|2.5}} and newer
|-
|[[File form field type|file]]
|Provides an input field for files
|{{JVer|2.5}} and newer
|-
|[[Filelist form field type|filelist]]
|provides a drop down list of files from a specified directory.
|{{JVer|2.5}} and newer
|-
|[[Folderlist form field type|folderlist]]
|provides a drop down list of folders from a specified directory.
|{{JVer|2.5}} and newer
|-
|[[Groupedlist form field type|groupedlist]]
|provides a drop down list of items organized into groups.
|{{JVer|2.5}} and newer
|-
|[[HeaderTag form field type|header tag]]
|provides a drop down list of the header tags (h1-h6).
|{{JVer|3.0}} and newer
|-
|[[Helpsite form field type|helpsite]]
|provides a drop down list of the help sites for your Joomla installation.
|{{JVer|2.5}} and newer
|-
|[[Hidden form field type|hidden]]
|provides a hidden field for saving a form field whose value cannot be altered directly by a user in the Administrator (it can be altered in code or by editing the ''params.ini'' file).
|{{JVer|2.5}} and newer
|-
|[[Imagelist form field type|imagelist]]
|provides a drop down list of image files in a specified directory.
|{{JVer|2.5}} and newer
|-
|-
|[[Integer form field type|integer]]
|provides a drop down list of integers between a minimum and maximum.
|{{JVer|2.5}} and newer
|-
|[[Language form field type|language]]
|provides a drop down list of the installed languages for the Front-end or Back-end.
|{{JVer|2.5}} and newer
|-
|[[List form field type|list]]
|provides a drop down list of custom-defined entries.
|{{JVer|2.5}} and newer
|-
|[[Media form field type|media]]
|provides modal access to the media manager for insertion of images with upload for users with appropriate permissions.
|{{JVer|2.5}} and newer
|-
|[[Menu form field type|menu]]
|provides a drop down list of the available menus from your Joomla site.
|{{JVer|2.5}} and newer
|-
|[[Menuitem form field type|Menu Item]]
|provides a drop down list of the available menu items from your Joomla site.
|{{JVer|2.5}} and newer
|-
|[[Meter form field type|meter]]
|Provides a meter to show value in a range.
|{{JVer|3.2}} and newer
|-
|[[Modulelayout form field type|Module Layout]]
|provides a list of alternative layout for a module grouped by core and template.
|{{JVer|2.5}} and newer
|-
|[[ModuleOrder form field type|Module Order]]
|Provides a drop down to set the ordering of module in a given position
|{{JVer|2.5}} and newer
|-
|[[ModulePosition form field type|Module Position]]
|provides a text input to set the position of a module.
|{{JVer|2.5}} and newer
|-
|[[ModuleTag form field type|Module Tag]]
|provides a list of html5 elements (used to wrap a module in).
|{{JVer|3.0}} and newer
|-
|[[Note form field type|note]]
|supports a one line text field.
|{{JVer|3.1}} and newer
|-
|[[Number form field type|number]]
|Provides a one line text box with up-down handles to set a number in the field.
|{{JVer|3.2}} and newer
|-
|[[Password form field type|password]]
|provides a text box for entry of a password. The password characters will be obscured as they are entered.
|{{JVer|2.5}} and newer
|-
|[[Plugins form field type|plugins]]
|provides a list of plugins from a given folder.
|{{JVer|2.5}} and newer
|-
|[[Predefined List form field type|predefinedlist]]
|Form Field to load a list of predefined values.
|{{JVer|3.2}} and newer
|-
|[[Radio form field type|radio]]
|provides radio buttons to select different options.
|{{JVer|2.5}} and newer
|-
|[[Range form field type|range]]
|Provides a horizontal scroll bar to specify a value in a range.
|{{JVer|3.2}} and newer
|-
|[[Repeatable form field type|repeatable]]
|Allows form fields which can have as many options as the user desires.
|{{JVer|3.2}} and newer
|-
|[[Rules form field type|rules]]
|provides a matrix of group by action options for managing access control. Display depends on context.
|{{JVer|2.5}} and newer
|-
|[[Sessionhandler form field type|sessionhandler]]
|provides a drop down list of session handler options.
|{{JVer|2.5}} and newer
|-
|[[Spacer form field type|spacer]]
|provides a visual separator between form fields. It is purely a visual aid and no value is stored.
|{{JVer|2.5}} and newer
|-
|[[SQL form field type|sql]]
|provides a drop down list of entries obtained by running a query on the Joomla Database. The first results column returned by the query provides the values for the drop down box.
|{{JVer|2.5}} and newer
|-
|[[Tag form field type|tag]]
|provides an entry point for tags (either AJAX or Nested).
|{{JVer|3.1}} and newer
|-
|[[Tel form field type|tel]]
|provides an input field for a telephone number.
|{{JVer|2.5}} and newer
|-
|[[Templatestyle form field type|templatestyle]]
|provides a drop down list of template styles.
|{{JVer|2.5}} and newer
|-
|[[Text form field type|text]]
|provides a text box for data entry.
|{{JVer|2.5}} and newer
|-
|[[Textarea form field type|textarea]]
|provides a text area for entry of multi-line text.
|{{JVer|2.5}} and newer
|-
|[[Timezone form field type|timezone]]
|provides a drop down list of time zones.
|{{JVer|2.5}} and newer
|-
|[[URL form field type|URL]]
|provides a URL text input field.
|{{JVer|2.5}} and newer
|-
|[[User form field type|user]]
|Field to select a user from a modal list. Displays User Name and stores User ID
|{{JVer|1.6}} and newer
|-
|[[UserActive form field type|useractive]]
|Field to show a list of available user active statuses.
|{{JVer|3.2}} and newer
|
|-
|[[Usergroup form field type|usergroup]]
|provides a drop down list of user groups. Since {{JVer|3.2}} use [[User Group List form field type|usergrouplist]] instead.
|{{JVer|2.5}} and newer
|
|-
|[[User Group List form field type|usergrouplist]]
|Field to load a drop down list of available user groups. Replaces usergroup form field type.
|{{JVer|3.2}} and newer
|
|-
|[[User State form field type|userstate]]
|Field to load a list of available users statuses.
|{{JVer|3.2}} and newer
|}

[[Category:Form fields]]
[[Category:Development Reference]]
[[Category:Needs to be marked for translation]]

Standard form field types

2015-05-22T20:32:00Z

Waltsjt: add since version use___ to Usergroup form field type

Numerous types of [[form field]] are built into Joomla!. The following table lists these standard types and their availability. Use the [[/Single-page reference|single-page reference]] if you want to print all existing form field documentation.

{{JVer|1.5}} Please note that many of these fields are available as [[Parameter|parameter types]] in Joomla! 1.5. For a list of parameter types, see [[J1.5:Standard parameter types]]. For a comparison between form field and parameter types, see [[Standard form field and parameter types]].
{| class="wikitable" style="vertical-align:top; border:1px solid Sienna; background-color:Cornsilk;"
|- style="background-color:Wheat; font-weight:bold; text-align: left;"
!width=15%|Type
!width=65%|Description
!width=20%|Availability
|-
|[[Accesslevel form field type|accesslevel]]
|provides a drop down list of viewing access levels.
|{{JVer|2.5}} and newer
|-
|[[Cachehandler form field type|cachehandler]]
|provides a list of available cache handling options.
|{{JVer|2.5}} and newer
|-
|[[Calendar form field type|calendar]]
|provides a text box for entry of a date. An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value.
|{{JVer|2.5}} and newer
|-
|[[Captcha form field type|captcha]]
|provides a drop down list of the captcha plugins.
|{{JVer|2.5}} and newer
|-
|[[Category form field type|category]]
|provides a drop down list of categories for an extension.
|{{JVer|2.5}} and newer
|-
|[[Checkbox form field type|checkbox]]
|provides a single checkbox to be checked or unchecked
|{{JVer|2.5}} and newer
|-
|[[Checkboxes form field type|checkboxes]]
|provides unlimited checkboxes that can be used for multi-select.
|{{JVer|2.5}} and newer
|-
|[[ChromeStyle form field type|Chrome Style]]
|provides a list of template chrome style options grouped by template.
|{{JVer|3.0}} and newer
|-
|[[Color form field type|color]]
|provides a color picker when clicking the input box.
|{{JVer|2.5}} and newer
|-
|[[ContentLanguage form field type|Content Language]]
|Provides a list of content languages.
|{{JVer|2.5}} and newer
|-
|[[Contenttype form field type|Content Type]]
|Provides a list of content types.
|{{JVer|3.1}} and newer
|-
|[[Combo form field type|combo]]
|provides a combo box field.
|{{JVer|2.5}} and newer
|-
|[[Componentlayout form field type|componentlayout]]
|provides a grouped list of core and template alternate layouts for a component item.
|{{JVer|2.5}} and newer
|-
|[[Contentlanguage form field type|contentlanguage]]
|provides a list of installed content languages for use in conjunction with the language switcher plugin.
|{{JVer|2.5}} and newer
|-
|[[DatabaseConnection form field type|Database Connection]]
|Provides a list of available database connections, optionally limiting to a given list.
|{{JVer|2.5}} and newer
|-
|[[Editor form field type|editor]]
|provides an editor area field.
|{{JVer|2.5}} and newer
|-
|[[Editors form field type|editors]]
|Provides a drop down list of the available WYSIWYG editors. Since {{JVer|2.5}} use [[Plugins form field type|plugins form field]] instead.
|{{JVer|2.5}}
|-
|[[Email form field type|email]]
|provides an email field.
|{{JVer|2.5}} and newer
|-
|[[File form field type|file]]
|Provides an input field for files
|{{JVer|2.5}} and newer
|-
|[[Filelist form field type|filelist]]
|provides a drop down list of files from a specified directory.
|{{JVer|2.5}} and newer
|-
|[[Folderlist form field type|folderlist]]
|provides a drop down list of folders from a specified directory.
|{{JVer|2.5}} and newer
|-
|[[Groupedlist form field type|groupedlist]]
|provides a drop down list of items organized into groups.
|{{JVer|2.5}} and newer
|-
|[[HeaderTag form field type|header tag]]
|provides a drop down list of the header tags (h1-h6).
|{{JVer|3.0}} and newer
|-
|[[Helpsite form field type|helpsite]]
|provides a drop down list of the help sites for your Joomla installation.
|{{JVer|2.5}} and newer
|-
|[[Hidden form field type|hidden]]
|provides a hidden field for saving a form field whose value cannot be altered directly by a user in the Administrator (it can be altered in code or by editing the ''params.ini'' file).
|{{JVer|2.5}} and newer
|-
|[[Imagelist form field type|imagelist]]
|provides a drop down list of image files in a specified directory.
|{{JVer|2.5}} and newer
|-
|-
|[[Integer form field type|integer]]
|provides a drop down list of integers between a minimum and maximum.
|{{JVer|2.5}} and newer
|-
|[[Language form field type|language]]
|provides a drop down list of the installed languages for the Front-end or Back-end.
|{{JVer|2.5}} and newer
|-
|[[List form field type|list]]
|provides a drop down list of custom-defined entries.
|{{JVer|2.5}} and newer
|-
|[[Media form field type|media]]
|provides modal access to the media manager for insertion of images with upload for users with appropriate permissions.
|{{JVer|2.5}} and newer
|-
|[[Menu form field type|menu]]
|provides a drop down list of the available menus from your Joomla site.
|{{JVer|2.5}} and newer
|-
|[[Menuitem form field type|Menu Item]]
|provides a drop down list of the available menu items from your Joomla site.
|{{JVer|2.5}} and newer
|-
|[[Meter form field type|meter]]
|Provides a meter to show value in a range.
|{{JVer|3.2}} and newer
|-
|[[Modulelayout form field type|Module Layout]]
|provides a list of alternative layout for a module grouped by core and template.
|{{JVer|2.5}} and newer
|-
|[[ModuleOrder form field type|Module Order]]
|Provides a drop down to set the ordering of module in a given position
|{{JVer|2.5}} and newer
|-
|[[ModulePosition form field type|Module Position]]
|provides a text input to set the position of a module.
|{{JVer|2.5}} and newer
|-
|[[ModuleTag form field type|Module Tag]]
|provides a list of html5 elements (used to wrap a module in).
|{{JVer|3.0}} and newer
|-
|[[Note form field type|note]]
|supports a one line text field.
|{{JVer|3.1}} and newer
|-
|[[Number form field type|number]]
|Provides a one line text box with up-down handles to set a number in the field.
|{{JVer|3.2}} and newer
|-
|[[Password form field type|password]]
|provides a text box for entry of a password. The password characters will be obscured as they are entered.
|{{JVer|2.5}} and newer
|-
|[[Plugins form field type|plugins]]
|provides a list of plugins from a given folder.
|{{JVer|2.5}} and newer
|-
|[[Predefined List form field type|predefinedlist]]
|Form Field to load a list of predefined values.
|{{JVer|3.2}} and newer
|-
|[[Radio form field type|radio]]
|provides radio buttons to select different options.
|{{JVer|2.5}} and newer
|-
|[[Range form field type|range]]
|Provides a horizontal scroll bar to specify a value in a range.
|{{JVer|3.2}} and newer
|-
|[[Repeatable form field type|repeatable]]
|Allows form fields which can have as many options as the user desires.
|{{JVer|3.2}} and newer
|-
|[[Rules form field type|rules]]
|provides a matrix of group by action options for managing access control. Display depends on context.
|{{JVer|2.5}} and newer
|-
|[[Sessionhandler form field type|sessionhandler]]
|provides a drop down list of session handler options.
|{{JVer|2.5}} and newer
|-
|[[Spacer form field type|spacer]]
|provides a visual separator between form fields. It is purely a visual aid and no value is stored.
|{{JVer|2.5}} and newer
|-
|[[SQL form field type|sql]]
|provides a drop down list of entries obtained by running a query on the Joomla Database. The first results column returned by the query provides the values for the drop down box.
|{{JVer|2.5}} and newer
|-
|[[Tag form field type|tag]]
|provides an entry point for tags (either AJAX or Nested).
|{{JVer|3.1}} and newer
|-
|[[Tel form field type|tel]]
|provides an input field for a telephone number.
|{{JVer|2.5}} and newer
|-
|[[Templatestyle form field type|templatestyle]]
|provides a drop down list of template styles.
|{{JVer|2.5}} and newer
|-
|[[Text form field type|text]]
|provides a text box for data entry.
|{{JVer|2.5}} and newer
|-
|[[Textarea form field type|textarea]]
|provides a text area for entry of multi-line text.
|{{JVer|2.5}} and newer
|-
|[[Timezone form field type|timezone]]
|provides a drop down list of time zones.
|{{JVer|2.5}} and newer
|-
|[[URL form field type|URL]]
|provides a URL text input field.
|{{JVer|2.5}} and newer
|-
|[[User form field type|user]]
|Field to select a user from a modal list. Displays User Name and stores User ID
|{{JVer|1.6}} and newer
|-
|[[UserActive form field type|useractive]]
|Field to show a list of available user active statuses.
|{{JVer|3.2}} and newer
|
|-
|[[Usergroup form field type|usergroup]]
|provides a drop down list of user groups. Since {{JVer|3.2}} use [[User Group List form field type|usergrouplist]] instead.
|{{JVer|2.5}} and newer
|
|-
|[[User Group List form field type|usergrouplist]]
|Field to load a drop down list of available user groups. Replaces usergroup form field type.
|{{JVer|3.2}} and newer
|
|-
|[[User State form field type|userstate]]
|Field to load a list of available users statuses.
|{{JVer|3.2}} and newer
|}

[[Category:Form fields]]
[[Category:Development Reference]]
[[Category:Needs to be marked for translation]]

Standard form field types

2015-05-22T20:22:48Z

Waltsjt: extra } removed

Numerous types of [[form field]] are built into Joomla!. The following table lists these standard types and their availability. Use the [[/Single-page reference|single-page reference]] if you want to print all existing form field documentation.

{{JVer|1.5}} Please note that many of these fields are available as [[Parameter|parameter types]] in Joomla! 1.5. For a list of parameter types, see [[J1.5:Standard parameter types]]. For a comparison between form field and parameter types, see [[Standard form field and parameter types]].
{| class="wikitable" style="vertical-align:top; border:1px solid Sienna; background-color:Cornsilk;"
|- style="background-color:Wheat; font-weight:bold; text-align: left;"
!width=15%|Type
!width=65%|Description
!width=20%|Availability
|-
|[[Accesslevel form field type|accesslevel]]
|provides a drop down list of viewing access levels.
|{{JVer|2.5}} and newer
|-
|[[Cachehandler form field type|cachehandler]]
|provides a list of available cache handling options.
|{{JVer|2.5}} and newer
|-
|[[Calendar form field type|calendar]]
|provides a text box for entry of a date. An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value.
|{{JVer|2.5}} and newer
|-
|[[Captcha form field type|captcha]]
|provides a drop down list of the captcha plugins.
|{{JVer|2.5}} and newer
|-
|[[Category form field type|category]]
|provides a drop down list of categories for an extension.
|{{JVer|2.5}} and newer
|-
|[[Checkbox form field type|checkbox]]
|provides a single checkbox to be checked or unchecked
|{{JVer|2.5}} and newer
|-
|[[Checkboxes form field type|checkboxes]]
|provides unlimited checkboxes that can be used for multi-select.
|{{JVer|2.5}} and newer
|-
|[[ChromeStyle form field type|Chrome Style]]
|provides a list of template chrome style options grouped by template.
|{{JVer|3.0}} and newer
|-
|[[Color form field type|color]]
|provides a color picker when clicking the input box.
|{{JVer|2.5}} and newer
|-
|[[ContentLanguage form field type|Content Language]]
|Provides a list of content languages.
|{{JVer|2.5}} and newer
|-
|[[Contenttype form field type|Content Type]]
|Provides a list of content types.
|{{JVer|3.1}} and newer
|-
|[[Combo form field type|combo]]
|provides a combo box field.
|{{JVer|2.5}} and newer
|-
|[[Componentlayout form field type|componentlayout]]
|provides a grouped list of core and template alternate layouts for a component item.
|{{JVer|2.5}} and newer
|-
|[[Contentlanguage form field type|contentlanguage]]
|provides a list of installed content languages for use in conjunction with the language switcher plugin.
|{{JVer|2.5}} and newer
|-
|[[DatabaseConnection form field type|Database Connection]]
|Provides a list of available database connections, optionally limiting to a given list.
|{{JVer|2.5}} and newer
|-
|[[Editor form field type|editor]]
|provides an editor area field.
|{{JVer|2.5}} and newer
|-
|[[Editors form field type|editors]]
|Provides a drop down list of the available WYSIWYG editors. Since {{JVer|2.5}} use [[Plugins form field type|plugins form field]] instead.
|{{JVer|2.5}}
|-
|[[Email form field type|email]]
|provides an email field.
|{{JVer|2.5}} and newer
|-
|[[File form field type|file]]
|Provides an input field for files
|{{JVer|2.5}} and newer
|-
|[[Filelist form field type|filelist]]
|provides a drop down list of files from a specified directory.
|{{JVer|2.5}} and newer
|-
|[[Folderlist form field type|folderlist]]
|provides a drop down list of folders from a specified directory.
|{{JVer|2.5}} and newer
|-
|[[Groupedlist form field type|groupedlist]]
|provides a drop down list of items organized into groups.
|{{JVer|2.5}} and newer
|-
|[[HeaderTag form field type|header tag]]
|provides a drop down list of the header tags (h1-h6).
|{{JVer|3.0}} and newer
|-
|[[Helpsite form field type|helpsite]]
|provides a drop down list of the help sites for your Joomla installation.
|{{JVer|2.5}} and newer
|-
|[[Hidden form field type|hidden]]
|provides a hidden field for saving a form field whose value cannot be altered directly by a user in the Administrator (it can be altered in code or by editing the ''params.ini'' file).
|{{JVer|2.5}} and newer
|-
|[[Imagelist form field type|imagelist]]
|provides a drop down list of image files in a specified directory.
|{{JVer|2.5}} and newer
|-
|-
|[[Integer form field type|integer]]
|provides a drop down list of integers between a minimum and maximum.
|{{JVer|2.5}} and newer
|-
|[[Language form field type|language]]
|provides a drop down list of the installed languages for the Front-end or Back-end.
|{{JVer|2.5}} and newer
|-
|[[List form field type|list]]
|provides a drop down list of custom-defined entries.
|{{JVer|2.5}} and newer
|-
|[[Media form field type|media]]
|provides modal access to the media manager for insertion of images with upload for users with appropriate permissions.
|{{JVer|2.5}} and newer
|-
|[[Menu form field type|menu]]
|provides a drop down list of the available menus from your Joomla site.
|{{JVer|2.5}} and newer
|-
|[[Menuitem form field type|Menu Item]]
|provides a drop down list of the available menu items from your Joomla site.
|{{JVer|2.5}} and newer
|-
|[[Meter form field type|meter]]
|Provides a meter to show value in a range.
|{{JVer|3.2}} and newer
|-
|[[Modulelayout form field type|Module Layout]]
|provides a list of alternative layout for a module grouped by core and template.
|{{JVer|2.5}} and newer
|-
|[[ModuleOrder form field type|Module Order]]
|Provides a drop down to set the ordering of module in a given position
|{{JVer|2.5}} and newer
|-
|[[ModulePosition form field type|Module Position]]
|provides a text input to set the position of a module.
|{{JVer|2.5}} and newer
|-
|[[ModuleTag form field type|Module Tag]]
|provides a list of html5 elements (used to wrap a module in).
|{{JVer|3.0}} and newer
|-
|[[Note form field type|note]]
|supports a one line text field.
|{{JVer|3.1}} and newer
|-
|[[Number form field type|number]]
|Provides a one line text box with up-down handles to set a number in the field.
|{{JVer|3.2}} and newer
|-
|[[Password form field type|password]]
|provides a text box for entry of a password. The password characters will be obscured as they are entered.
|{{JVer|2.5}} and newer
|-
|[[Plugins form field type|plugins]]
|provides a list of plugins from a given folder.
|{{JVer|2.5}} and newer
|-
|[[Predefined List form field type|predefinedlist]]
|Form Field to load a list of predefined values.
|{{JVer|3.2}} and newer
|-
|[[Radio form field type|radio]]
|provides radio buttons to select different options.
|{{JVer|2.5}} and newer
|-
|[[Range form field type|range]]
|Provides a horizontal scroll bar to specify a value in a range.
|{{JVer|3.2}} and newer
|-
|[[Repeatable form field type|repeatable]]
|Allows form fields which can have as many options as the user desires.
|{{JVer|3.2}} and newer
|-
|[[Rules form field type|rules]]
|provides a matrix of group by action options for managing access control. Display depends on context.
|{{JVer|2.5}} and newer
|-
|[[Sessionhandler form field type|sessionhandler]]
|provides a drop down list of session handler options.
|{{JVer|2.5}} and newer
|-
|[[Spacer form field type|spacer]]
|provides a visual separator between form fields. It is purely a visual aid and no value is stored.
|{{JVer|2.5}} and newer
|-
|[[SQL form field type|sql]]
|provides a drop down list of entries obtained by running a query on the Joomla Database. The first results column returned by the query provides the values for the drop down box.
|{{JVer|2.5}} and newer
|-
|[[Tag form field type|tag]]
|provides an entry point for tags (either AJAX or Nested).
|{{JVer|3.1}} and newer
|-
|[[Tel form field type|tel]]
|provides an input field for a telephone number.
|{{JVer|2.5}} and newer
|-
|[[Templatestyle form field type|templatestyle]]
|provides a drop down list of template styles.
|{{JVer|2.5}} and newer
|-
|[[Text form field type|text]]
|provides a text box for data entry.
|{{JVer|2.5}} and newer
|-
|[[Textarea form field type|textarea]]
|provides a text area for entry of multi-line text.
|{{JVer|2.5}} and newer
|-
|[[Timezone form field type|timezone]]
|provides a drop down list of time zones.
|{{JVer|2.5}} and newer
|-
|[[URL form field type|URL]]
|provides a URL text input field.
|{{JVer|2.5}} and newer
|-
|[[User form field type|user]]
|Field to select a user from a modal list. Displays User Name and stores User ID
|{{JVer|1.6}} and newer
|-
|[[UserActive form field type|useractive]]
|Field to show a list of available user active statuses.
|{{JVer|3.2}} and newer
|
|-
|[[Usergroup form field type|usergroup]]
|provides a drop down list of user groups.
|{{JVer|2.5}} and newer
|
|-
|[[User Group List form field type|usergrouplist]]
|Field to load a drop down list of available user groups. Replaces Usergroup form field type.
|{{JVer|3.2}} and newer
|
|-
|[[User State form field type|userstate]]
|Field to load a list of available users statuses.
|{{JVer|3.2}} and newer
|}

[[Category:Form fields]]
[[Category:Development Reference]]
[[Category:Needs to be marked for translation]]

Standard form field types

2015-05-22T20:21:30Z

Waltsjt: Add more missing field types - correct some since versions

Numerous types of [[form field]] are built into Joomla!. The following table lists these standard types and their availability. Use the [[/Single-page reference|single-page reference]] if you want to print all existing form field documentation.

{{JVer|1.5}} Please note that many of these fields are available as [[Parameter|parameter types]] in Joomla! 1.5. For a list of parameter types, see [[J1.5:Standard parameter types]]. For a comparison between form field and parameter types, see [[Standard form field and parameter types]].
{| class="wikitable" style="vertical-align:top; border:1px solid Sienna; background-color:Cornsilk;"
|- style="background-color:Wheat; font-weight:bold; text-align: left;"
!width=15%|Type
!width=65%|Description
!width=20%|Availability
|-
|[[Accesslevel form field type|accesslevel]]
|provides a drop down list of viewing access levels.
|{{JVer|2.5}} and newer
|-
|[[Cachehandler form field type|cachehandler]]
|provides a list of available cache handling options.
|{{JVer|2.5}} and newer
|-
|[[Calendar form field type|calendar]]
|provides a text box for entry of a date. An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value.
|{{JVer|2.5}} and newer
|-
|[[Captcha form field type|captcha]]
|provides a drop down list of the captcha plugins.
|{{JVer|2.5}} and newer
|-
|[[Category form field type|category]]
|provides a drop down list of categories for an extension.
|{{JVer|2.5}} and newer
|-
|[[Checkbox form field type|checkbox]]
|provides a single checkbox to be checked or unchecked
|{{JVer|2.5}} and newer
|-
|[[Checkboxes form field type|checkboxes]]
|provides unlimited checkboxes that can be used for multi-select.
|{{JVer|2.5}} and newer
|-
|[[ChromeStyle form field type|Chrome Style]]
|provides a list of template chrome style options grouped by template.
|{{JVer|3.0}} and newer
|-
|[[Color form field type|color]]
|provides a color picker when clicking the input box.
|{{JVer|2.5}} and newer
|-
|[[ContentLanguage form field type|Content Language]]
|Provides a list of content languages.
|{{JVer|2.5}} and newer
|-
|[[Contenttype form field type|Content Type]]
|Provides a list of content types.
|{{JVer|3.1}} and newer
|-
|[[Combo form field type|combo]]
|provides a combo box field.
|{{JVer|2.5}} and newer
|-
|[[Componentlayout form field type|componentlayout]]
|provides a grouped list of core and template alternate layouts for a component item.
|{{JVer|2.5}} and newer
|-
|[[Contentlanguage form field type|contentlanguage]]
|provides a list of installed content languages for use in conjunction with the language switcher plugin.
|{{JVer|2.5}} and newer
|-
|[[DatabaseConnection form field type|Database Connection]]
|Provides a list of available database connections, optionally limiting to a given list.
|{{JVer|2.5}} and newer
|-
|[[Editor form field type|editor]]
|provides an editor area field.
|{{JVer|2.5}} and newer
|-
|[[Editors form field type|editors]]
|Provides a drop down list of the available WYSIWYG editors. Since {{JVer|2.5}} use [[Plugins form field type|plugins form field]] instead.
|{{JVer|2.5}}
|-
|[[Email form field type|email]]
|provides an email field.
|{{JVer|2.5}} and newer
|-
|[[File form field type|file]]
|Provides an input field for files
|{{JVer|2.5}} and newer
|-
|[[Filelist form field type|filelist]]
|provides a drop down list of files from a specified directory.
|{{JVer|2.5}} and newer
|-
|[[Folderlist form field type|folderlist]]
|provides a drop down list of folders from a specified directory.
|{{JVer|2.5}} and newer
|-
|[[Groupedlist form field type|groupedlist]]
|provides a drop down list of items organized into groups.
|{{JVer|2.5}} and newer
|-
|[[HeaderTag form field type|header tag]]
|provides a drop down list of the header tags (h1-h6).
|{{JVer|3.0}} and newer
|-
|[[Helpsite form field type|helpsite]]
|provides a drop down list of the help sites for your Joomla installation.
|{{JVer|2.5}} and newer
|-
|[[Hidden form field type|hidden]]
|provides a hidden field for saving a form field whose value cannot be altered directly by a user in the Administrator (it can be altered in code or by editing the ''params.ini'' file).
|{{JVer|2.5}} and newer
|-
|[[Imagelist form field type|imagelist]]
|provides a drop down list of image files in a specified directory.
|{{JVer|2.5}} and newer
|-
|-
|[[Integer form field type|integer]]
|provides a drop down list of integers between a minimum and maximum.
|{{JVer|2.5}} and newer
|-
|[[Language form field type|language]]
|provides a drop down list of the installed languages for the Front-end or Back-end.
|{{JVer|2.5}} and newer
|-
|[[List form field type|list]]
|provides a drop down list of custom-defined entries.
|{{JVer|2.5}} and newer
|-
|[[Media form field type|media]]
|provides modal access to the media manager for insertion of images with upload for users with appropriate permissions.
|{{JVer|2.5}} and newer
|-
|[[Menu form field type|menu]]
|provides a drop down list of the available menus from your Joomla site.
|{{JVer|2.5}} and newer
|-
|[[Menuitem form field type|Menu Item]]
|provides a drop down list of the available menu items from your Joomla site.
|{{JVer|2.5}} and newer
|-
|[[Meter form field type|meter]]
|Provides a meter to show value in a range.
|{{JVer|3.2}} and newer
|-
|[[Modulelayout form field type|Module Layout]]
|provides a list of alternative layout for a module grouped by core and template.
|{{JVer|2.5}} and newer
|-
|[[ModuleOrder form field type|Module Order]]
|Provides a drop down to set the ordering of module in a given position
|{{JVer|2.5}} and newer
|-
|[[ModulePosition form field type|Module Position]]
|provides a text input to set the position of a module.
|{{JVer|2.5}} and newer
|-
|[[ModuleTag form field type|Module Tag]]
|provides a list of html5 elements (used to wrap a module in).
|{{JVer|3.0}} and newer
|-
|[[Note form field type|note]]
|supports a one line text field.
|{{JVer|3.1}} and newer
|-
|[[Number form field type|number]]
|Provides a one line text box with up-down handles to set a number in the field.
|{{JVer|3.2}} and newer
|-
|[[Password form field type|password]]
|provides a text box for entry of a password. The password characters will be obscured as they are entered.
|{{JVer|2.5}} and newer
|-
|[[Plugins form field type|plugins]]
|provides a list of plugins from a given folder.
|{{JVer|2.5}} and newer
|-
|[[Predefined List form field type|predefinedlist]]
|Form Field to load a list of predefined values.
|{{JVer|3.2}} and newer
|-
|[[Radio form field type|radio]]
|provides radio buttons to select different options.
|{{JVer|2.5}} and newer
|-
|[[Range form field type|range]]
|Provides a horizontal scroll bar to specify a value in a range.
|{{JVer|3.2}} and newer
|-
|[[Repeatable form field type|repeatable]]
|Allows form fields which can have as many options as the user desires.
|{{JVer|3.2}} and newer
|-
|[[Rules form field type|rules]]
|provides a matrix of group by action options for managing access control. Display depends on context.
|{{JVer|2.5}} and newer
|-
|[[Sessionhandler form field type|sessionhandler]]
|provides a drop down list of session handler options.
|{{JVer|2.5}} and newer
|-
|[[Spacer form field type|spacer]]
|provides a visual separator between form fields. It is purely a visual aid and no value is stored.
|{{JVer|2.5}} and newer
|-
|[[SQL form field type|sql]]
|provides a drop down list of entries obtained by running a query on the Joomla Database. The first results column returned by the query provides the values for the drop down box.
|{{JVer|2.5}} and newer
|-
|[[Tag form field type|tag]]
|provides an entry point for tags (either AJAX or Nested).
|{{JVer|3.1}} and newer
|-
|[[Tel form field type|tel]]
|provides an input field for a telephone number.
|{{JVer|2.5}} and newer
|-
|[[Templatestyle form field type|templatestyle]]
|provides a drop down list of template styles.
|{{JVer|2.5}} and newer
|-
|[[Text form field type|text]]
|provides a text box for data entry.
|{{JVer|2.5}} and newer
|-
|[[Textarea form field type|textarea]]
|provides a text area for entry of multi-line text.
|{{JVer|2.5}} and newer
|-
|[[Timezone form field type|timezone]]
|provides a drop down list of time zones.
|{{JVer|2.5}} and newer
|-
|[[URL form field type|URL]]
|provides a URL text input field.
|{{JVer|2.5}} and newer
|-
|[[User form field type|user]]
|Field to select a user from a modal list. Displays User Name and stores User ID
|{{JVer|1.6}} and newer
|-
|[[UserActive form field type|useractive]]
|Field to show a list of available user active statuses.
|{{JVer|3.2}} and newer
|}
|-
|[[Usergroup form field type|usergroup]]
|provides a drop down list of user groups.
|{{JVer|2.5}} and newer
|}
|-
|[[User Group List form field type|usergrouplist]]
|Field to load a drop down list of available user groups. Replaces Usergroup form field type.
|{{JVer|3.2}} and newer
|}
|-
|[[User State form field type|userstate]]
|Field to load a list of available users statuses.
|{{JVer|3.2}} and newer
|}

[[Category:Form fields]]
[[Category:Development Reference]]
[[Category:Needs to be marked for translation]]

Standard form field types

2015-05-20T23:50:27Z

Waltsjt: correct since versions for a few fields (at least since 3 not since 2.5)

Numerous types of [[form field]] are built into Joomla!. The following table lists these standard types and their availability. Use the [[/Single-page reference|single-page reference]] if you want to print all existing form field documentation.

{{JVer|1.5}} Please note that many of these fields are available as [[Parameter|parameter types]] in Joomla! 1.5. For a list of parameter types, see [[J1.5:Standard parameter types]]. For a comparison between form field and parameter types, see [[Standard form field and parameter types]].
{| class="wikitable" style="vertical-align:top; border:1px solid Sienna; background-color:Cornsilk;"
|- style="background-color:Wheat; font-weight:bold; text-align: left;"
!width=15%|Type
!width=65%|Description
!width=20%|Availability
|-
|[[Accesslevel form field type|accesslevel]]
|provides a drop down list of viewing access levels.
|{{JVer|2.5}} and newer
|-
|[[Cachehandler form field type|cachehandler]]
|provides a list of available cache handling options.
|{{JVer|2.5}} and newer
|-
|[[Calendar form field type|calendar]]
|provides a text box for entry of a date. An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value.
|{{JVer|2.5}} and newer
|-
|[[Captcha form field type|captcha]]
|provides a drop down list of the captcha plugins.
|{{JVer|2.5}} and newer
|-
|[[Category form field type|category]]
|provides a drop down list of categories for an extension.
|{{JVer|2.5}} and newer
|-
|[[Checkbox form field type|checkbox]]
|provides a single checkbox to be checked or unchecked
|{{JVer|2.5}} and newer
|-
|[[Checkboxes form field type|checkboxes]]
|provides unlimited checkboxes that can be used for multi-select.
|{{JVer|2.5}} and newer
|-
|[[ChromeStyle form field type|Chrome Style]]
|provides a list of template chrome style options grouped by template.
|{{JVer|3.0}} and newer
|-
|[[Color form field type|color]]
|provides a color picker when clicking the input box.
|{{JVer|2.5}} and newer
|-
|[[ContentLanguage form field type|Content Language]]
|Provides a list of content languages.
|{{JVer|2.5}} and newer
|-
|[[Contenttype form field type|Content Type]]
|Provides a list of content types.
|{{JVer|3.1}} and newer
|-
|[[Combo form field type|combo]]
|provides a combo box field.
|{{JVer|2.5}} and newer
|-
|[[Componentlayout form field type|componentlayout]]
|provides a grouped list of core and template alternate layouts for a component item.
|{{JVer|2.5}} and newer
|-
|[[Contentlanguage form field type|contentlanguage]]
|provides a list of installed content languages for use in conjunction with the language switcher plugin.
|{{JVer|2.5}} and newer
|-
|[[DatabaseConnection form field type|Database Connection]]
|Provides a list of available database connections, optionally limiting to a given list.
|{{JVer|2.5}} and newer
|-
|[[Editor form field type|editor]]
|provides an editor area field.
|{{JVer|2.5}} and newer
|-
|[[Editors form field type|editors]]
|Provides a drop down list of the available WYSIWYG editors. Since {{JVer|2.5}} use [[Plugins form field type|plugins form field]] instead.
|{{JVer|2.5}}
|-
|[[Email form field type|email]]
|provides an email field.
|{{JVer|2.5}} and newer
|-
|[[File form field type|file]]
|Provides an input field for files
|{{JVer|2.5}} and newer
|-
|[[Filelist form field type|filelist]]
|provides a drop down list of files from a specified directory.
|{{JVer|2.5}} and newer
|-
|[[Folderlist form field type|folderlist]]
|provides a drop down list of folders from a specified directory.
|{{JVer|2.5}} and newer
|-
|[[Groupedlist form field type|groupedlist]]
|provides a drop down list of items organized into groups.
|{{JVer|2.5}} and newer
|-
|[[HeaderTag form field type|header tag]]
|provides a drop down list of the header tags (h1-h6).
|{{JVer|3.0}} and newer
|-
|[[Helpsite form field type|helpsite]]
|provides a drop down list of the help sites for your Joomla installation.
|{{JVer|2.5}} and newer
|-
|[[Hidden form field type|hidden]]
|provides a hidden field for saving a form field whose value cannot be altered directly by a user in the Administrator (it can be altered in code or by editing the ''params.ini'' file).
|{{JVer|2.5}} and newer
|-
|[[Imagelist form field type|imagelist]]
|provides a drop down list of image files in a specified directory.
|{{JVer|2.5}} and newer
|-
|-
|[[Integer form field type|integer]]
|provides a drop down list of integers between a minimum and maximum.
|{{JVer|2.5}} and newer
|-
|[[Language form field type|language]]
|provides a drop down list of the installed languages for the Front-end or Back-end.
|{{JVer|2.5}} and newer
|-
|[[List form field type|list]]
|provides a drop down list of custom-defined entries.
|{{JVer|2.5}} and newer
|-
|[[Media form field type|media]]
|provides modal access to the media manager for insertion of images with upload for users with appropriate permissions.
|{{JVer|2.5}} and newer
|-
|[[Menu form field type|menu]]
|provides a drop down list of the available menus from your Joomla site.
|{{JVer|2.5}} and newer
|-
|[[Menuitem form field type|Menu Item]]
|provides a drop down list of the available menu items from your Joomla site.
|{{JVer|2.5}} and newer
|-
|[[Meter form field type|meter]]
|Provides a meter to show value in a range.
|{{JVer|3.0}} and newer
|-
|[[Modulelayout form field type|Module Layout]]
|provides a list of alternative layout for a module grouped by core and template.
|{{JVer|2.5}} and newer
|-
|[[ModuleOrder form field type|Module Order]]
|Provides a drop down to set the ordering of module in a given position
|{{JVer|2.5}} and newer
|-
|[[ModulePosition form field type|Module Position]]
|provides a text input to set the position of a module.
|{{JVer|2.5}} and newer
|-
|[[ModuleTag form field type|Module Tag]]
|provides a list of html5 elements (used to wrap a module in).
|{{JVer|3.0}} and newer
|-
|[[Note form field type|note]]
|supports a one line text field.
|{{JVer|3.1}} and newer
|-
|[[Number form field type|number]]
|Provides a one line text box with up-down handles to set a number in the field.
|{{JVer|3.0}} and newer
|-
|[[Password form field type|password]]
|provides a text box for entry of a password. The password characters will be obscured as they are entered.
|{{JVer|2.5}} and newer
|-
|[[Plugins form field type|plugins]]
|provides a list of plugins from a given folder.
|{{JVer|2.5}} and newer
|-
|[[Predefined List form field type|predefinedlist]]
|Form Field to load a list of predefined values.
|{{JVer|3.0}} and newer
|-
|[[Radio form field type|radio]]
|provides radio buttons to select different options.
|{{JVer|2.5}} and newer
|-
|[[Range form field type|range]]
|Provides a horizontal scroll bar to specify a value in a range.
|{{JVer|3.0}} and newer
|-
|[[Repeatable form field type|repeatable]]
|Allows form fields which can have as many options as the user desires.
|{{JVer|3.2}} and newer
|-
|[[Rules form field type|rules]]
|provides a matrix of group by action options for managing access control. Display depends on context.
|{{JVer|2.5}} and newer
|-
|[[Sessionhandler form field type|sessionhandler]]
|provides a drop down list of session handler options.
|{{JVer|2.5}} and newer
|-
|[[Spacer form field type|spacer]]
|provides a visual separator between form fields. It is purely a visual aid and no value is stored.
|{{JVer|2.5}} and newer
|-
|[[SQL form field type|sql]]
|provides a drop down list of entries obtained by running a query on the Joomla Database. The first results column returned by the query provides the values for the drop down box.
|{{JVer|2.5}} and newer
|-
|[[Tag form field type|tag]]
|provides an entry point for tags (either AJAX or Nested).
|{{JVer|3.1}} and newer
|-
|[[Tel form field type|tel]]
|provides an input field for a telephone number.
|{{JVer|2.5}} and newer
|-
|[[Templatestyle form field type|templatestyle]]
|provides a drop down list of template styles.
|{{JVer|2.5}} and newer
|-
|[[Text form field type|text]]
|provides a text box for data entry.
|{{JVer|2.5}} and newer
|-
|[[Textarea form field type|textarea]]
|provides a text area for entry of multi-line text.
|{{JVer|2.5}} and newer
|-
|[[Timezone form field type|timezone]]
|provides a drop down list of time zones.
|{{JVer|2.5}} and newer
|-
|[[URL form field type|URL]]
|provides a URL text input field.
|{{JVer|2.5}} and newer
|-
|[[User form field type|user]]
|provides a modal list of users.
|{{JVer|2.5}} and newer
|-
|[[Usergroup form field type|usergroup]]
|provides a drop down list of user groups.
|{{JVer|2.5}} and newer
|}

[[Category:Form fields]]
[[Category:Development Reference]]
[[Category:Needs to be marked for translation]]

Creating a custom form field type

2015-05-02T19:32:00Z

Waltsjt: added Category:Extension development

<noinclude><languages /></noinclude>

<noinclude>{{Joomla version|version=3.x|comment=<translate>
series</translate>}}</noinclude>
{{-}}
{{page|needs review}}

<translate>

[[S:MyLanguage/JForm|JForm]], a feature introduced in Joomla! 2.5, lets you easily create HTML forms (<code><form></code>). Forms created using JForm consist of [[S:MyLanguage/Form field|form fields]], implemented as [[S:MyLanguage/JFormField|JFormFields]]. There is a JFormField for each different field type you can find in a form, such as a text field type and a date field type. JForm supports a large selection of standard field types. For a full list, see [[S:MyLanguage/Standard form field types|Standard form field types]].
</translate>

<translate>

Joomla! 2.5 makes it possible to extend standard field types or define your own. For example, if your component manages phone book entries, you might want to define a form field type that outputs a select list of cities. There are several advantages to defining a custom form field type:
</translate>

<translate>

* You will be able to mix standard field types with your custom field type in a JForm-based form.
* You will eventually have a reusable code package that can be used easily throughout your code.
* Extensions that collaborate with your extension will be able to create form fields without meddling with your database tables and other internals.
</translate>

<translate>== Form field type class requirements == </translate>

<translate>

A form field type is defined in a [[S:MyLanguage/wikipedia:Class (computer programming)|class]] that must be a (not necessarily direct) subclass of JFormField. To work correctly, the class must define at least two methods:
</translate>

* <code>public function getLabel()</code>
<translate>
*: This function will be called to create the label that belongs to your field and must return a HTML string containing it. Since JFormField defines a ready-to-use <code>getLabel()</code> implementation, custom form field types usually do not define their own <code>getLabel()</code>. If you leave it out, the inherited method of creating labels will be used. It is recommended to leave out the <code>getLabel()</code> method for consistency and speed unless you actually want to modify the label's HTML.</translate>
* <code>public function getInput()</code>
<translate>
*: This function will be called to create the field itself and must return a HTML string containing it. This is also where most of the processing usually happens. In our phone book City field example, this function will have to retrieve a list of available cities and return a HTML <code><select></code> with the cities inserted as <code><option></code>s.</translate>

<translate>

Inside your code, you will have to process the attributes set by the field's user in the XML form definition. Some of those attributes are accessible via protected member variables of JFormField. For example, the <code>name</code> attribute is available in your code as <code>$this->name</code>. Similarly, <code>label</code>, <code>description</code>, <code>default</code>, <code>multiple</code> and <code>class</code> are also available as properties of <code>$this</code>. Other parameters you might have defined can be accessed through the <code>$this->element</code> array: the attribute <code>size</code> will be in <code>$this->element['size']</code>.
</translate>

<translate>== Which class to subclass? == </translate>

<translate>

For a form field type to be usable in JForm, it needs to be a subclass of JFormField. However, it does not have to be a direct child of that class: you can also subclass an existing (standard or custom) form field type and thereby inherit useful code.
</translate>

<translate>

'''If your form field type is quite similar to an existing type,''' you should subclass that type. Especially if your form field type is a '''list''', please subclass [[S:MyLanguage/JFormFieldList|JFormFieldList]]. You only have to override <code>getOptions()</code> method to return the options to be shown; the <code>getInput()</code> method will convert those options to HTML.
</translate>

<translate>
To subclass an existing type, for example JFormFieldList, load it by adding the following to after <code>jimport('joomla.form.formfield');</code>:</translate>

<source lang="php">
jimport('joomla.form.helper');
JFormHelper::loadFieldClass('list');
</source>

<translate>
'''If your form field type is unlike any existing type,''' subclass JFormField directly.</translate>

<translate>== Location of files == </translate>

<translate>
* The standard form field types are located in <code>libraries/joomla/form/fields/</code>. You should not store custom fields there, nor should you have to use this path in your own code, but the standard types are usually good examples.</translate>
<translate>
* The custom field types that belong to your component are usually located in <code>administrator/components/<name of your component>/models/fields</code>. You can specify this or another path in your code:</translate>
<source lang="php">JForm::addFieldPath(JPATH_COMPONENT . '/models/fields');</source>
<translate>
* The XML files that define forms are usually located in <code>administrator/components/<name of your component>/models/forms</code>. Use something like the following snippet to specify a path to your forms:</translate>
<source lang="php">JForm::addFormPath(JPATH_COMPONENT . '/models/forms');</source>

<translate>== Naming conventions and skeleton == </translate>

<translate>
In this section, <ComponentName> represents the camel-cased name of your component and <FieldName> represents the camel-cased name of your form field type. The field's class should be placed in <code>administrator/components/<name of your component>/models/fields/<name of your field>.php</code>, and look like this:</translate>

<source lang="php"><?php
// Check to ensure this file is included in Joomla!
defined('_JEXEC') or die('Restricted access');

jimport('joomla.form.formfield');

// The class name must always be the same as the filename (in camel case)
class JFormField<FieldName> extends JFormField {

//The field class must know its own type through the variable $type.
protected $type = '<FieldName>';

public function getLabel() {
// code that returns HTML that will be shown as the label
}

public function getInput() {
// code that returns HTML that will be shown as the form field
}
}
</source>

<translate>=== Grouping custom field types === </translate>

<translate>
'''Warning: this information is partially incorrect and needs to be improved.'''</translate>

<translate>
Custom field types can be grouped by using an underscore in the field name. A field class with a name for example like "JFormFieldMy_randomField" must be stored in <code>administrator/components/<name of your component>/models/fields/my/randomField.php</code>. We can prefix our form field names with some group name, then we put an underscore and then a name of a field.</translate>

<translate>== An example custom field type == </translate>

<translate>
Suppose you're working on your component named ''com_phonebook'' and you want to define a field that contains cities. Create the file <code>administrator/components/com_phonebook/models/fields/city.php</code> and write something similar to the following:</translate>

<source lang="php"><?php
// Check to ensure this file is included in Joomla!
defined('_JEXEC') or die('Restricted access');

jimport('joomla.form.formfield');

class JFormFieldCity extends JFormField {

protected $type = 'City';

// getLabel() left out

public function getInput() {
return '<select id="'.$this->id.'" name="'.$this->name.'">'.
'<option value="1" >New York</option>'.
'<option value="2" >Chicago</option>'.
'<option value="3" >San Francisco</option>'.
'</select>';
}
}
</source>

<translate>=== Using the custom field type === </translate>
<translate>==== Linked with a form ==== </translate>
<translate>
To use the field type City, we need to update the XML file that contains the form fields. Open your XML file located in <code>administrator/components/com_phonebook/models/forms</code> and add the field in the usual way:</translate>

<source lang="xml"><field name="title" type="City" label="JGLOBAL_TITLE"
description="JFIELD_TITLE_DESC"
required="true" /></source>

<translate>
The type name is cAsE-sEnSiTiVe.</translate>

<translate>
In addition, you may need to add the field path to the parent <fieldset>:</translate>

<source lang="xml">
<fieldset addfieldpath="/administrator/components/<component name>/models/fields">
</source>

<translate>==== Not linked with a form ==== </translate>
<translate>
E.g. when you need the field as a dropdown in a component as admin/site filter.</translate>

<source lang="php">
//Get custom field
JFormHelper::addFieldPath(JPATH_COMPONENT . '/models/fields');
$cities = JFormHelper::loadFieldType('City', false);
$cityOptions=$cities->getOptions(); // works only if you set your field getOptions on public!!
</source>

<translate>== Overriding <code>getLabel()</code> == </translate>

<translate>
As mentioned in the section [[#Form field type class requirements|Form field type class requirements]], custom form field types usually do not define their own <code>getLabel()</code>. If you do want to create a custom label, you can still make use of the <code>getLabel()</code> that every field type class inherits from JFormField, for example by defining it as follows:</translate>

<source lang="php">public function getLabel() {
return '<span style="text-decoration: underline;">' . parent::getLabel() . '</span>';
} </source>

<translate>
This code will underline your form labels. (Please note that if your goal is to underline form labels, using [[CSS]] is the preferred way.)


If you want to do something completely different, you can of course also override it completely:</translate>

<source lang="php">public function getLabel() {
// Initialize variables.
$label = '';
$replace = '';

// Get the label text from the XML element, defaulting to the element name.
$text = $this->element['label'] ? (string) $this->element['label'] : (string) $this->element['name'];

// Build the class for the label.
$class = !empty($this->description) ? 'hasTip' : '';
$class = $this->required == true ? $class.' required' : $class;

// Add replace checkbox
$replace = '<input type="checkbox" name="update['.$this->name.']" value="1" />';

// Add the opening label tag and main attributes attributes.
$label .= '<label id="'.$this->id.'-lbl" for="'.$this->id.'" class="'.$class.'"';

// If a description is specified, use it to build a tooltip.
if (!empty($this->description)) {
$label .= ' title="'.htmlspecialchars(trim(JText::_($text), ':').'::' .
JText::_($this->description), ENT_COMPAT, 'UTF-8').'"';
}

// Add the label text and closing tag.
$label .= '>'.$replace.JText::_($text).'</label>';

return $label;
}</source>

<translate>
This example will add a checkbox inside the label.</translate>

<noinclude>
<translate>

[[Category:Development]]
[[Category:Extension development]]
[[Category:Form fields]]
[[Category:Joomla! 2.5]]
[[Category:Joomla! 3.x]]
</translate>
</noinclude>

Manifest files

2015-05-02T19:30:21Z

Waltsjt: added Category:Development

{{version|2.5,3.x}}

Within Joomla there are manifest files for all of the extensions. These files include the general installation information as well as parameters for the configuration of the [[extension]] itself. Since Joomla! 2.5 {{JVer|2.5}}, there are very few differences between the manifest file formats for the different [[S:MyLanguage/Extension types (technical definitions)|types of extensions]], allowing each type to access the full power of the Joomla! installer.

==Naming conventions==
The file must be named <tt>manifest.xml</tt> or <tt><extension_name>.xml</tt> and located in the root directory of the installation package.

==Syntax==

=== Root element ===
The primary tag of the installation file is:
<source lang=xml><extension></extension></source>

This starting and closing tags are now valid for all extensions. The new tag <code><extension></code> replaces the old <code><install></install></code> from Joomla {{JVer|1.5}}. The following attributes are allowed within the tag:

{|class="wikitable"
|-
! style="width: 150px" | Attribute || style="width: 150px" | Values || Applicable to || Description
|-
| type || <code>component</code><br /><code>file</code><br /><code>language</code><br /><code>library</code><br /><code>module</code><br /><code>package</code><br /><code>plugin</code><br /><code>template</code> || All extensions
| This attribute describes the type of the extension for the installer. Based on this type further requirements to sub-tags apply.
|-
| version
| <code>2.5</code><br /><code>3.0</code> || All extensions
| String that identifies the version of Joomla for which this extension is developed.
|-
| method
| <code>install</code><br /><code>upgrade</code> || All extensions
| The default value <code>install</code> will be also used if the method attribute is not used. The <code>install</code> value means the installer will gracefully stop if it finds any existing file/folder of the new extension.
|-
| client
| <code>site</code><br /><code>administrator</code> || Modules
| The client attribute allows you to specify for which application client the new module is available.
|-
| group
| ''string'' || Plugins
| The group name specifies for which group of plugins the new plugin is available. The existing groups are the folder names within the directory <tt>/plugins</tt>. The installer will create new folder names for group names that do not exist yet.
|}

=== Metadata ===

The following elements can be used to insert metadata. None of these elements are required; if they are present, they must be a child of the root element.

<pre>
<name> – raw component name (e.g. com_banners).
<author> – author's name (e.g. Joomla! Project)
<creationDate> – date of creation or release (e.g. April 2006)
<copyright> – a copyright statement (e.g. (C) 2005 - 2011 Open Source Matters. All rights reserved.)
<license> – a license statement (e.g. NU General Public License version 2 or later; see LICENSE.txt)
<authorEmail> – author's email address (e.g. admin@joomla.org)
<authorUrl> – URL to the author's website (e.g. www.joomla.org)
<version> – the version number of the extension (e.g. 1.6.0)
<description> – the description of the component. This is a translatable field. (e.g. COM_BANNERS_XML_DESCRIPTION)
</pre>

Note: The <name> and <description> tags are also translatable fields so that the name and description of the extension can be shown to the user in their native language.

=== Front-end files ===

<source lang="xml">
<files folder="from-folder">
<filename>example.php</filename>
<folder>examples</folder>
</files>
</source>

Files to copy to the front-end directory should be placed in the <code><files></code> element. You can use the optional <code>folder</code> attribute to specify a directory '''in the ZIP package''' to copy '''from'''. Each file to copy must be represented by a <code><filename></code> element. If you want to copy an entire folder at once, you can define it as a <code><folder></code>.

=== Media files ===

<source lang="xml>
<media folder="media" destination="com_example">
<filename>com_example_logo.png</filename>
<folder>css</folder>
<folder>js</folder>
</media>
</source>

This example will copy the file(s) (<tt>/media/com_example_logo.png</tt>) and folders ( <tt>/media/css/</tt> and <tt>/media/js/</tt> ) listed to <tt>/media/com_example/</tt>, creating the <tt>com_example</tt> folder if required. You can use the optional <code>folder</code> attribute to specify a directory '''in the ZIP package''' to copy '''from''' (in this case, <tt>media</tt>).

Extensions should be storing assets they need to be web accessible (JS, CSS, images etc) in <code>media</code>. Amongst other things this feature was added as step in the progression to multi-site support and the eventual move of code files (PHP) out of the web accessible areas of the server.

Ref:
* [https://groups.google.com/forum/#!msg/joomla-dev-cms/4CAASJqFY-k/PvPj14gP29EJ Google Groups - joomla-dev-cms thread]
* [https://groups.google.com/forum/#!msg/joomla-dev-cms/uNmhX98sKbE/p8p68Jke680J Google Groups - joomla-dev-cms thread]

=== Administration section ===

<source lang="xml">
<administration>

</administration>
</source>

The administration section is defined in the <code><administration></code> element. Since only [[S:MyLanguage/Component|components]] apply to both the [[S:MyLanguage/Site (Application)|site]] and the [[S:MyLanguage/Administrator (Application)|administrator]], '''only component manifests can include this element'''.

==== Back-end files ====

Files to copy to the back-end directory should be placed in the <code><files></code> element under the <code><administration></code>. You can use the optional <code>folder</code> attribute to specify a directory '''in the ZIP package''' to copy '''from'''. See ''Front-end files'' for further rules.

==== Menu links and submenus ====
{{dablink|'''Version Note:''' Prior to Joomla 3.4 not having a menu tag in your XML file still led to a menu item being created. This bug was fixed in Joomla 3.4 so if no menu item was created then no admin menu item is created for the component.}}

<source lang="xml">
<menu>COM_EXAMPLE</menu>
<submenu>

<menu link="anoption=avalue&anoption1=avalue1">COM_EXAMPLE_SUBMENU_ANOPTION</menu>
<menu view="viewname">COM_EXAMPLE_SUBMENU_VIEWNAME</menu>
</submenu>
</source>

The text for the main menu item for the component is defined in the <code><menu></code> item, a child of <code><administration></code>. A <code><submenu></code> element may also be present (also a child of <code><administration></code>), which may contain more menu items defined by <code><menu></code>.

Additionally, each <code><menu></code> item can define the following attributes:

{| class="wikitable"
! style="width: 150px" | Attribute || Description
|-
| link || A link to send the user to when the menu item is clicked
|-
| img || The (relative) path to an image (16x16 pixels) to appear beside the menu item.
<u>Must be an url compatible as a file too (e.g. no spaces) !</u>
|-
| alt ||
|-
| ''string'' || An URL parameter to add to the link. For example, <code><menu view="cpanel">COM_EXAMPLE</menu></code> in com_example's XML manifest would cause the URL of the menu item to be <tt>index.php?option=com_example&view=cpanel</tt>.
|-
|}

The value inside the tag is the menu's label. Unlike Joomla! 1.5, you can not use a natural language string. For example, if you would enter "Example Component" instead of COM_EXAMPLE, it would result in your component name appearing as example-component in the menu and you would be unable to provide a translation. In order to provide a translation you need to create a file named en-GB.com_example.sys.ini in administrator/languages/en-GB (you can use the manifest's <code><languages></code> tag to copy it during installation) or in administrator/components/com_example/language/en-GB. In the latter case, you must not include the translation file in the <code><languages></code> tag. As long as you have placed the language directory in your <code><files></code> tag, it will be copied along when the component is being installed.

The contents of that file should be:
<source>
COM_EXAMPLE="Example Component"
COM_EXAMPLE_SUBMENU_ANOPTION="Another Option"
COM_EXAMPLE_SUBMENU_VIEWNAME="Another View"
</source>

Please note that the language string must be enclosed in double quotes, as per Joomla!'s translation standards. Important note: Joomla! 1.6 and later sorts the Component menu items based on the actual translation of the key you supply in your XML manifest. This means that the sorting order is correct no matter what you call your translation key and no matter which language the site is being displayed in. Essentially, Joomla! 1.6 fixed the wrong sorting of the Components menu experienced under Joomla! 1.5 for the majority (non-English speaking!) of Joomla! users.

=== Configuration ===
{{warning|Components '''do not support''' configuration definitions '''in the manifest'''. This is a way implemented in Joomla! 1.5. They can define configuration options for multiple levels using [[Component configuration metadata]].}}
The <code><config></code> element, a child of the root, describes the configuration options for the extension. If applicable, the options will be shown by the appropriate Manager (Plugin Manager, Module Manager or Template Manager). '''Configuration options can also be defined in a separate file named <code>config.xml</code>. Its root element should be <code><config></code>.'''

{{:XML JForm form definitions}}

=== SQL ===

<source lang="xml">
<install>
<sql>
<file driver="mysql" charset="utf8">sql/example.install.sql</file>
</sql>
</install>
<uninstall>
<sql>
<file driver="mysql" charset="utf8">sql/example.uninstall.sql</file>
</sql>
</uninstall>
</source>

In the above example, we put the SQL files in the <tt>admin/sql</tt> folder of the installation package. You have to include the <tt>sql</tt> folder in the administration files (as described in ''Back-end files'').

You can execute SQL during the installation and/or uninstallation using the <code><install></code> and <code><uninstall></code> elements, respectively. A <code><sql></code> element should appear as a child of these elements. <code><sql></code> can contain any number of <code><file></code> elements, each defining a single SQL file to execute. Their database driver types are described by the <code>driver</code> attribute, their character sets by the <code>charset</code> attribute.

==== Update of the SQL schema ====

<source lang="xml">
<update>
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
<schemapath type="sqlsrv">sql/updates/sqlsrv</schemapath>
</schemas>
</update>
</source>

Since 1.6, there is also an <code><update></code> tag, which allows you to provide a series of SQL files to update the current schema.

=== Language files ===
In Joomla! 1.5, extension developers had to put extension language files in the Joomla! main language file, using the <languages>..</languages> tag as shown below. '''This method can still be used in''' {{rarr|2.5,3.x}}.

<source lang="xml">

<languages folder="langfiles">
<language tag="en-GB">en-GB.com_example.ini</language>
</languages>
</source>

Since Joomla! 1.6 it has been encouraged placing your extension's language files in your extension folder. Joomla! will then automatically load your extension's language files.

By storing extension language files in the extension folder, you gain the benefit of isolating and protecting your extension's language files. For example, an administrator removes a language from their Joomla! installation. Your extension's language files will not be removed. They will remain in place and will be available if the language is installed again.

The structure of the language folder for frontend and backend is the same. You put them in the language tag (e.g. '''en-GB''' ) of each language in your language folder i.e. '''language/en-GB/'''. You have to specify those folders in the front-end and back-end files too.

In your manifest you simply include the ''''language'''' folder in your files section, the sub-directories for each language automatically be copied. Inside the <files> group you simply add a <folder> element alongside the items in the '''<files>''' group as shown in this example:

<source lang="xml">
<files>
<filename plugin="alpha">alpha.php</filename>
<folder>sql</folder>
<folder>language</folder>
</files>
</source>

It is also notable that both ways can work together. Here is an example from core:
<source lang="xml">
<files>
<filename plugin="languagecode">languagecode.php</filename>
<filename>index.html</filename>
<folder>language</folder>
</files>
<languages>
<language tag="en-GB">language/en-GB/en-GB.plg_system_languagecode.ini</language>
<language tag="en-GB">language/en-GB/en-GB.plg_system_languagecode.sys.ini</language>
</languages>
</source>

The advantages of this solution are the following:

All ini files present in the core folder have precedence over the files in the extension language/ folder.
For example a sys.ini file will always be loaded from core folders in back-end if it exists, except when installing an extension which contains a sys.ini file in a language folder. In that case and only that case, the sys.ini file in the extension folder will display its translated content at install time. This is very handy as a developer can have 2 sys.ini files with different contents. A description of the successful install as well as a tutorial in back-end for example.

Also, it is much easier for a user needing an ini file for an extension that does not provide it in the language desired, to add it in the main folders. No risk for it to be deleted in case of uninstalling the extension by mistake or any other reason.

See also:
*[[J2.5:Making non-core language packs|Making non-core language packs]]
*[[Creating language packs for extensions in Joomla 2.5]]

During development you can turn on language debugging in the Joomla! global configuration. So you can investigate if a problems arises. As of 3.2, this is necessary to help debug as en-GB is '''always''' loaded first when not in debug mode to prevent displaying Constants.

=== Script file ===

<source lang="xml">
<scriptfile>example.script.php</scriptfile>
</source>

An optional '''script file''' (PHP code that is run before, during and/or after installation, uninstallation and upgrading) can be defined using a <code><scriptfile></code> element. This file should contain a class named "<element_name>InstallerScript" where <element_name> is the name of your extension (e.g. com_componentname, mod_modulename, etc.). Plugins requires to state the group (e.g. plgsystempluginname). Library packages do not support scriptfiles. The structure of the class is as follows:

<source lang="php">

class com_componentnameInstallerScript
{
/**
* Constructor
*
* @param JAdapterInstance $adapter The object responsible for running this script
*/
public function __construct(JAdapterInstance $adapter);

/**
* Called before any type of action
*
* @param string $route Which action is happening (install|uninstall|discover_install|update)
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function preflight($route, JAdapterInstance $adapter);

/**
* Called after any type of action
*
* @param string $route Which action is happening (install|uninstall|discover_install|update)
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function postflight($route, JAdapterInstance $adapter);

/**
* Called on installation
*
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function install(JAdapterInstance $adapter);

/**
* Called on update
*
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function update(JAdapterInstance $adapter);

/**
* Called on uninstallation
*
* @param JAdapterInstance $adapter The object responsible for running this script
*/
public function uninstall(JAdapterInstance $adapter);
}

</source>

=== Update servers ===

<source lang="xml">
<updateservers>
<server type="extension" priority="1" name="Extension Update Site">http://example.com/extension.xml</server>
<server type="collection" priority="2" name="Collection Update Site">http://example.com/collection.xml</server>
</updateservers>
</source>

Update servers can be defined in the <code><updateservers></code> element, a child of the root. This element may contain one or more <code><server></code> element, each describing a location to fetch updates from. Each <code><server></code> item can define the following attributes:

{| class="wikitable"
! style="width: 150px" | Attribute || style="width: 150px" | Values || Description
|-
| type || <code>extension</code><br /><code>collection</code> || The update server type
|-
| priority || ''integer'' || The priority of the update server
|-
| name || ''string'' || The name of the update server
|}

More info:
* [[J2.5:Developing a MVC Component/Adding an update server|Building a Joomla! Extension - Adding an update server]]
* [[J2.5:Managing Component Updates|Managing Component Updates in Joomla 2.5]]

== Examples ==
For a real-life example, see [https://github.com/joomla/joomla-cms/blob/2.5.x/administrator/components/com_banners/banners.xml the manifest of the Banner component in the latest version of Joomla! 2.5].

The Joomla testing process uses several extensions to test whether the installer works correctly. The latest versions of the manifests of these extensions are:

* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/com_alpha/alpha.xml com_alpha manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/mod_alpha/mod_alpha.xml mod_alpha manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/plg_system_alpha/alpha.xml plg_system_alpha manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/tpl_simple/templateDetails.xml tpl_simple manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/lng_xx-XX/xx-XX.xml lng_xx-XX manifest]

== Contributors ==
*[[User:akede|Alex Kempkens]]
*[[User:dperaza|Daniel Peraza]]
*[[User:nikosdion|Nicholas K. Dionysopoulos]]
*[[User:mrs.siam|Prasit Gebsaap]]
*[[User:cppl|Craig Phillips]]

[[Category:Development]]
[[Category:Extension development]]
[[Category:Specifications]]
[[Category:Needs to be marked for translation]]

Talk:Standard form field types

2015-05-01T20:48:43Z

Waltsjt: /* Possible missing documentation for Standard form field types */

Standard form field types

2015-05-01T19:45:35Z

Waltsjt: Add description for field type file --~~~~

Numerous types of [[form field]] are built into Joomla!. The following table lists these standard types and their availability. Use the [[/Single-page reference|single-page reference]] if you want to print all existing form field documentation.

{{JVer|1.5}} Please note that many of these fields are available as [[Parameter|parameter types]] in Joomla! 1.5. For a list of parameter types, see [[J1.5:Standard parameter types]]. For a comparison between form field and parameter types, see [[Standard form field and parameter types]].
{| class="wikitable" style="vertical-align:top; border:1px solid Sienna; background-color:Cornsilk;"
|- style="background-color:Wheat; font-weight:bold; text-align: left;"
!width=15%|Type
!width=65%|Description
!width=20%|Availability
|-
|[[Accesslevel form field type|accesslevel]]
|provides a drop down list of viewing access levels.
|{{JVer|2.5}} and newer
|-
|[[Cachehandler form field type|cachehandler]]
|provides a list of available cache handling options.
|{{JVer|2.5}} and newer
|-
|[[Calendar form field type|calendar]]
|provides a text box for entry of a date. An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value.
|{{JVer|2.5}} and newer
|-
|[[Captcha form field type|captcha]]
|provides a drop down list of the captcha plugins.
|{{JVer|2.5}} and newer
|-
|[[Category form field type|category]]
|provides a drop down list of categories for an extension.
|{{JVer|2.5}} and newer
|-
|[[Checkbox form field type|checkbox]]
|provides a single checkbox to be checked or unchecked
|{{JVer|2.5}} and newer
|-
|[[Checkboxes form field type|checkboxes]]
|provides unlimited checkboxes that can be used for multi-select.
|{{JVer|2.5}} and newer
|-
|[[ChromeStyle form field type|Chrome Style]]
|provides a list of template chrome style options grouped by template.
|{{JVer|3.0}} and newer
|-
|[[Color form field type|color]]
|provides a color picker when clicking the input box.
|{{JVer|2.5}} and newer
|-
|[[ContentLanguage form field type|Content Language]]
|Provides a list of content languages.
|{{JVer|2.5}} and newer
|-
|[[Contenttype form field type|Content Type]]
|Provides a list of content types.
|{{JVer|3.1}} and newer
|-
|[[Combo form field type|combo]]
|provides a combo box field.
|{{JVer|2.5}} and newer
|-
|[[Componentlayout form field type|componentlayout]]
|provides a grouped list of core and template alternate layouts for a component item.
|{{JVer|2.5}} and newer
|-
|[[Contentlanguage form field type|contentlanguage]]
|provides a list of installed content languages for use in conjunction with the language switcher plugin.
|{{JVer|2.5}} and newer
|-
|[[DatabaseConnection form field type|Database Connection]]
|Provides a list of available database connections, optionally limiting to a given list.
|{{JVer|2.5}} and newer
|-
|[[Editor form field type|editor]]
|provides an editor area field.
|{{JVer|2.5}} and newer
|-
|[[Editors form field type|editors]]
|Provides a drop down list of the available WYSIWYG editors. Since {{JVer|2.5}} use [[Plugins form field type|plugins form field]] instead.
|{{JVer|2.5}}
|-
|[[Email form field type|email]]
|provides an email field.
|{{JVer|2.5}} and newer
|-
|[[File form field type|file]]
|Provides an input field for files
|{{JVer|2.5}} and newer
|-
|[[Filelist form field type|filelist]]
|provides a drop down list of files from a specified directory.
|{{JVer|2.5}} and newer
|-
|[[Folderlist form field type|folderlist]]
|provides a drop down list of folders from a specified directory.
|{{JVer|2.5}} and newer
|-
|[[Groupedlist form field type|groupedlist]]
|provides a drop down list of items organized into groups.
|{{JVer|2.5}} and newer
|-
|[[HeaderTag form field type|header tag]]
|provides a drop down list of the header tags (h1-h6).
|{{JVer|3.0}} and newer
|-
|[[Helpsite form field type|helpsite]]
|provides a drop down list of the help sites for your Joomla installation.
|{{JVer|2.5}} and newer
|-
|[[Hidden form field type|hidden]]
|provides a hidden field for saving a form field whose value cannot be altered directly by a user in the Administrator (it can be altered in code or by editing the ''params.ini'' file).
|{{JVer|2.5}} and newer
|-
|[[Imagelist form field type|imagelist]]
|provides a drop down list of image files in a specified directory.
|{{JVer|2.5}} and newer
|-
|-
|[[Integer form field type|integer]]
|provides a drop down list of integers between a minimum and maximum.
|{{JVer|2.5}} and newer
|-
|[[Language form field type|language]]
|provides a drop down list of the installed languages for the Front-end or Back-end.
|{{JVer|2.5}} and newer
|-
|[[List form field type|list]]
|provides a drop down list of custom-defined entries.
|{{JVer|2.5}} and newer
|-
|[[Media form field type|media]]
|provides modal access to the media manager for insertion of images with upload for users with appropriate permissions.
|{{JVer|2.5}} and newer
|-
|[[Menu form field type|menu]]
|provides a drop down list of the available menus from your Joomla site.
|{{JVer|2.5}} and newer
|-
|[[Menuitem form field type|Menu Item]]
|provides a drop down list of the available menu items from your Joomla site.
|{{JVer|2.5}} and newer
|-
|[[Meter form field type|meter]]
|Provides a meter to show value in a range.
|{{JVer|2.5}} and newer
|-
|[[Modulelayout form field type|Module Layout]]
|provides a list of alternative layout for a module grouped by core and template.
|{{JVer|2.5}} and newer
|-
|[[ModuleOrder form field type|Module Order]]
|Provides a drop down to set the ordering of module in a given position
|{{JVer|2.5}} and newer
|-
|[[ModulePosition form field type|Module Position]]
|provides a text input to set the position of a module.
|{{JVer|2.5}} and newer
|-
|[[ModuleTag form field type|Module Tag]]
|provides a list of html5 elements (used to wrap a module in).
|{{JVer|3.0}} and newer
|-
|[[Note form field type|note]]
|supports a one line text field.
|{{JVer|3.1}} and newer
|-
|[[Number form field type|number]]
|Provides a one line text box with up-down handles to set a number in the field.
|{{JVer|2.5}} and newer
|-
|[[Password form field type|password]]
|provides a text box for entry of a password. The password characters will be obscured as they are entered.
|{{JVer|2.5}} and newer
|-
|[[Plugins form field type|plugins]]
|provides a list of plugins from a given folder.
|{{JVer|2.5}} and newer
|-
|[[Predefined List form field type|predefinedlist]]
|Form Field to load a list of predefined values.
|{{JVer|2.5}} and newer
|-
|[[Radio form field type|radio]]
|provides radio buttons to select different options.
|{{JVer|2.5}} and newer
|-
|[[Range form field type|range]]
|Provides a horizontal scroll bar to specify a value in a range.
|{{JVer|2.5}} and newer
|-
|[[Repeatable form field type|repeatable]]
|Allows form fields which can have as many options as the user desires.
|{{JVer|3.2}} and newer
|-
|[[Rules form field type|rules]]
|provides a matrix of group by action options for managing access control. Display depends on context.
|{{JVer|2.5}} and newer
|-
|[[Sessionhandler form field type|sessionhandler]]
|provides a drop down list of session handler options.
|{{JVer|2.5}} and newer
|-
|[[Spacer form field type|spacer]]
|provides a visual separator between form fields. It is purely a visual aid and no value is stored.
|{{JVer|2.5}} and newer
|-
|[[SQL form field type|sql]]
|provides a drop down list of entries obtained by running a query on the Joomla Database. The first results column returned by the query provides the values for the drop down box.
|{{JVer|2.5}} and newer
|-
|[[Tag form field type|tag]]
|provides an entry point for tags (either AJAX or Nested).
|{{JVer|3.1}} and newer
|-
|[[Tel form field type|tel]]
|provides an input field for a telephone number.
|{{JVer|2.5}} and newer
|-
|[[Templatestyle form field type|templatestyle]]
|provides a drop down list of template styles.
|{{JVer|2.5}} and newer
|-
|[[Text form field type|text]]
|provides a text box for data entry.
|{{JVer|2.5}} and newer
|-
|[[Textarea form field type|textarea]]
|provides a text area for entry of multi-line text.
|{{JVer|2.5}} and newer
|-
|[[Timezone form field type|timezone]]
|provides a drop down list of time zones.
|{{JVer|2.5}} and newer
|-
|[[URL form field type|URL]]
|provides a URL text input field.
|{{JVer|2.5}} and newer
|-
|[[User form field type|user]]
|provides a modal list of users.
|{{JVer|2.5}} and newer
|-
|[[Usergroup form field type|usergroup]]
|provides a drop down list of user groups.
|{{JVer|2.5}} and newer
|}

[[Category:Form fields]]
[[Category:Development Reference]]
[[Category:Needs to be marked for translation]]

Standard form field types

2015-05-01T19:40:16Z

Waltsjt: missing documentation for Standard form field types: meter, number, predefinedlist, and range --~~~~

Numerous types of [[form field]] are built into Joomla!. The following table lists these standard types and their availability. Use the [[/Single-page reference|single-page reference]] if you want to print all existing form field documentation.

{{JVer|1.5}} Please note that many of these fields are available as [[Parameter|parameter types]] in Joomla! 1.5. For a list of parameter types, see [[J1.5:Standard parameter types]]. For a comparison between form field and parameter types, see [[Standard form field and parameter types]].
{| class="wikitable" style="vertical-align:top; border:1px solid Sienna; background-color:Cornsilk;"
|- style="background-color:Wheat; font-weight:bold; text-align: left;"
!width=15%|Type
!width=65%|Description
!width=20%|Availability
|-
|[[Accesslevel form field type|accesslevel]]
|provides a drop down list of viewing access levels.
|{{JVer|2.5}} and newer
|-
|[[Cachehandler form field type|cachehandler]]
|provides a list of available cache handling options.
|{{JVer|2.5}} and newer
|-
|[[Calendar form field type|calendar]]
|provides a text box for entry of a date. An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value.
|{{JVer|2.5}} and newer
|-
|[[Captcha form field type|captcha]]
|provides a drop down list of the captcha plugins.
|{{JVer|2.5}} and newer
|-
|[[Category form field type|category]]
|provides a drop down list of categories for an extension.
|{{JVer|2.5}} and newer
|-
|[[Checkbox form field type|checkbox]]
|provides a single checkbox to be checked or unchecked
|{{JVer|2.5}} and newer
|-
|[[Checkboxes form field type|checkboxes]]
|provides unlimited checkboxes that can be used for multi-select.
|{{JVer|2.5}} and newer
|-
|[[ChromeStyle form field type|Chrome Style]]
|provides a list of template chrome style options grouped by template.
|{{JVer|3.0}} and newer
|-
|[[Color form field type|color]]
|provides a color picker when clicking the input box.
|{{JVer|2.5}} and newer
|-
|[[ContentLanguage form field type|Content Language]]
|Provides a list of content languages.
|{{JVer|2.5}} and newer
|-
|[[Contenttype form field type|Content Type]]
|Provides a list of content types.
|{{JVer|3.1}} and newer
|-
|[[Combo form field type|combo]]
|provides a combo box field.
|{{JVer|2.5}} and newer
|-
|[[Componentlayout form field type|componentlayout]]
|provides a grouped list of core and template alternate layouts for a component item.
|{{JVer|2.5}} and newer
|-
|[[Contentlanguage form field type|contentlanguage]]
|provides a list of installed content languages for use in conjunction with the language switcher plugin.
|{{JVer|2.5}} and newer
|-
|[[DatabaseConnection form field type|Database Connection]]
|Provides a list of available database connections, optionally limiting to a given list.
|{{JVer|2.5}} and newer
|-
|[[Editor form field type|editor]]
|provides an editor area field.
|{{JVer|2.5}} and newer
|-
|[[Editors form field type|editors]]
|Provides a drop down list of the available WYSIWYG editors. Since {{JVer|2.5}} use [[Plugins form field type|plugins form field]] instead.
|{{JVer|2.5}}
|-
|[[Email form field type|email]]
|provides an email field.
|{{JVer|2.5}} and newer
|-
|[[File form field type|file]]
|
|{{JVer|2.5}} and newer
|-
|[[Filelist form field type|filelist]]
|provides a drop down list of files from a specified directory.
|{{JVer|2.5}} and newer
|-
|[[Folderlist form field type|folderlist]]
|provides a drop down list of folders from a specified directory.
|{{JVer|2.5}} and newer
|-
|[[Groupedlist form field type|groupedlist]]
|provides a drop down list of items organized into groups.
|{{JVer|2.5}} and newer
|-
|[[HeaderTag form field type|header tag]]
|provides a drop down list of the header tags (h1-h6).
|{{JVer|3.0}} and newer
|-
|[[Helpsite form field type|helpsite]]
|provides a drop down list of the help sites for your Joomla installation.
|{{JVer|2.5}} and newer
|-
|[[Hidden form field type|hidden]]
|provides a hidden field for saving a form field whose value cannot be altered directly by a user in the Administrator (it can be altered in code or by editing the ''params.ini'' file).
|{{JVer|2.5}} and newer
|-
|[[Imagelist form field type|imagelist]]
|provides a drop down list of image files in a specified directory.
|{{JVer|2.5}} and newer
|-
|-
|[[Integer form field type|integer]]
|provides a drop down list of integers between a minimum and maximum.
|{{JVer|2.5}} and newer
|-
|[[Language form field type|language]]
|provides a drop down list of the installed languages for the Front-end or Back-end.
|{{JVer|2.5}} and newer
|-
|[[List form field type|list]]
|provides a drop down list of custom-defined entries.
|{{JVer|2.5}} and newer
|-
|[[Media form field type|media]]
|provides modal access to the media manager for insertion of images with upload for users with appropriate permissions.
|{{JVer|2.5}} and newer
|-
|[[Menu form field type|menu]]
|provides a drop down list of the available menus from your Joomla site.
|{{JVer|2.5}} and newer
|-
|[[Menuitem form field type|Menu Item]]
|provides a drop down list of the available menu items from your Joomla site.
|{{JVer|2.5}} and newer
|-
|[[Meter form field type|meter]]
|Provides a meter to show value in a range.
|{{JVer|2.5}} and newer
|-
|[[Modulelayout form field type|Module Layout]]
|provides a list of alternative layout for a module grouped by core and template.
|{{JVer|2.5}} and newer
|-
|[[ModuleOrder form field type|Module Order]]
|Provides a drop down to set the ordering of module in a given position
|{{JVer|2.5}} and newer
|-
|[[ModulePosition form field type|Module Position]]
|provides a text input to set the position of a module.
|{{JVer|2.5}} and newer
|-
|[[ModuleTag form field type|Module Tag]]
|provides a list of html5 elements (used to wrap a module in).
|{{JVer|3.0}} and newer
|-
|[[Note form field type|note]]
|supports a one line text field.
|{{JVer|3.1}} and newer
|-
|[[Number form field type|number]]
|Provides a one line text box with up-down handles to set a number in the field.
|{{JVer|2.5}} and newer
|-
|[[Password form field type|password]]
|provides a text box for entry of a password. The password characters will be obscured as they are entered.
|{{JVer|2.5}} and newer
|-
|[[Plugins form field type|plugins]]
|provides a list of plugins from a given folder.
|{{JVer|2.5}} and newer
|-
|[[Predefined List form field type|predefinedlist]]
|Form Field to load a list of predefined values.
|{{JVer|2.5}} and newer
|-
|[[Radio form field type|radio]]
|provides radio buttons to select different options.
|{{JVer|2.5}} and newer
|-
|[[Range form field type|range]]
|Provides a horizontal scroll bar to specify a value in a range.
|{{JVer|2.5}} and newer
|-
|[[Repeatable form field type|repeatable]]
|Allows form fields which can have as many options as the user desires.
|{{JVer|3.2}} and newer
|-
|[[Rules form field type|rules]]
|provides a matrix of group by action options for managing access control. Display depends on context.
|{{JVer|2.5}} and newer
|-
|[[Sessionhandler form field type|sessionhandler]]
|provides a drop down list of session handler options.
|{{JVer|2.5}} and newer
|-
|[[Spacer form field type|spacer]]
|provides a visual separator between form fields. It is purely a visual aid and no value is stored.
|{{JVer|2.5}} and newer
|-
|[[SQL form field type|sql]]
|provides a drop down list of entries obtained by running a query on the Joomla Database. The first results column returned by the query provides the values for the drop down box.
|{{JVer|2.5}} and newer
|-
|[[Tag form field type|tag]]
|provides an entry point for tags (either AJAX or Nested).
|{{JVer|3.1}} and newer
|-
|[[Tel form field type|tel]]
|provides an input field for a telephone number.
|{{JVer|2.5}} and newer
|-
|[[Templatestyle form field type|templatestyle]]
|provides a drop down list of template styles.
|{{JVer|2.5}} and newer
|-
|[[Text form field type|text]]
|provides a text box for data entry.
|{{JVer|2.5}} and newer
|-
|[[Textarea form field type|textarea]]
|provides a text area for entry of multi-line text.
|{{JVer|2.5}} and newer
|-
|[[Timezone form field type|timezone]]
|provides a drop down list of time zones.
|{{JVer|2.5}} and newer
|-
|[[URL form field type|URL]]
|provides a URL text input field.
|{{JVer|2.5}} and newer
|-
|[[User form field type|user]]
|provides a modal list of users.
|{{JVer|2.5}} and newer
|-
|[[Usergroup form field type|usergroup]]
|provides a drop down list of user groups.
|{{JVer|2.5}} and newer
|}

[[Category:Form fields]]
[[Category:Development Reference]]
[[Category:Needs to be marked for translation]]

Talk:Standard form field types

2015-04-30T22:06:47Z

Waltsjt: start discussion about possible missing documentation --~~~~