Joomla! Documentation - User contributions [en]

Basic form guide

2020-04-04T12:02:32Z

ThiagoG: Add J in front of Factory

== Introduction ==
This is one of a series of [[API Guides]], which aim to help you understand how to use the Joomla APIs through providing detailed explanations and sample code which you can easily install and run.

The Joomla Form class and API enables you to easily develop HTML forms and handle the user's input.

This page describes how you interact in general with the Joomla Form class and provides the code of a simple component which you can install to demonstrate use of this API.

Joomla itself also has a specific way of designing form functionality, and this page includes tutorial material to help you understand and develop your component to align with these principles.

== Overall Description ==
The diagram below shows the basic use of the Joomla Form class.

[[File:basicform.jpg|Using Joomla Forms]]

Firstly, you need to define your form in XML using Joomla [[Standard form field types]]. See the component code below for an example. In basic terms, each field element in your XML file maps to an HTML (mostly "input") element in the form, with the XML field attributes mapping to the (input) element attributes. Many of the possible field attributes are listed in [[Text form field type]].

=== Step 1 Loading the Form ===
The user clicks on the URL of your form, and Joomla routes the HTTP GET request through to your component code. You need to call <tt>Form::getInstance()</tt> passing the name of your XML file with your form definition. The Joomla Form code creates a Form instance, and then (in <tt>Form::loadFile()</tt>) reads the file into memory (as a PHP <tt>SimpleXMLElement</tt>) and parses the XML to ensure it's valid. The main parameters passed to <tt>getInstance()<tt> are:
* name – a string specifying the identity to give to this form – it just needs to be unique, so that it doesn't clash with any other Joomla forms on the same webpage
* data – the name of the XML file which has your form definition
* options – an array of options, with the "control" element specifying the name of the array which the POST parameters will be held in. For example, the sample code has <tt>array("control"=>"myform")</tt> which means that the HTML input elements will have name attributes set to "myform[message]", "myform[email]", etc,. They will be passed in POST parameters that way, and it's then very easy to get these into a PHP array.

=== Step 2 Providing Pre-fill Data ===
You provide values for any form element you wish. For example, if this form is being used to edit a record in the database, then you would pre-populate it with existing field values from the database. You can provide values by setting up an associative array <tt>$data</tt> and passing it to <tt>Form::bind($data)</tt> method, and Joomla Form then stores this data locally within the Form instance.

=== Step 3 Outputting the Form in HTML ===
You call <tt>renderField(fieldName)</tt> on the Form instance and you get returned the HTML which you can echo to the output. Joomla processes its XML representation of your form to obtain the section relating to the passed-in fieldName, generates the HTML for this HTML element and includes the "value" attribute based on the pre-populated data which you passed in step 2.
When outputting the form you also need to surround the input elements in a <tt><form></tt> element and add a submit button.

=== Step 4 User Submitting the Form ===
The user enters data into your HTML form and clicks on the submit button. The browser generates an HTTP POST request to the URL specified in the <tt><form></tt> element and passes to the server in POST parameters the values entered by the user; each parameter keyed by the "name" attribute of the HTML input element.

Joomla routes this POST through to your component. As this is a new HTTP request the previous Form instance no longer exists, so you have to again call <tt>Form::getInstance()</tt>, passing the filename of your form XML, and Joomla (as before) creates a Form instance and reads this file into memory.

=== Step 5 Handling the HTTP POST Data ===
In this step you process the submitted data. This involves:
# Getting the POST data using <tt>Factory::getApplication->input->get()<tt>. Usually the "name" attributes of the input elements are defined so that the POST parameters appear as an array, and you can use the ARRAY filter from [[Retrieving_request_data_using_JInput]] to read these directly into a PHP array. However, this means that the individual elements are not filtered at all.
# Filtering. This applies filtering on each of the input values. The filter applied to a field is governed by the "filter=..." attribute on that field in your form XML file, or if not present then the default filter will remove HTML tags etc from your data values. The possible filters are in the <tt>filterField()</tt> method of the Form class (and see https://joomla.stackexchange.com/questions/5764/what-are-possible-filters-in-joomla-form-fields). Note that these form field filters are different from the jinput filters.
# Validation. You validate the data which the user has entered by calling validate($data) on your Form instance, passing an associative array of the (filtered) user data. Joomla compares the user-entered data with the validation you defined in your form XML file, and generates errors for fields which fail the validation.

If there are validation errors then you should display those errors to the user, and redisplay the form, pre-populating the fields with the (filtered) data which the user entered previously.

If there are no errors then you can confirm this to the user, and show the next web page.

== Sample Form 1 ==
Below is the code for a small component which you can install to demonstrate basic use of Joomla forms. Place the following 3 files into a folder called "com_sample_form1". Then zip up the folder to create <tt>com_sample_form1.zip</tt> and install this as a component on your Joomla instance.

<tt>com_sample_form1.xml</tt> Manifest file for the component
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.1.0" method="upgrade">

<name>com_sample_form1</name>
<version>1.0.0</version>
<description>Sample form 1</description>

<administration>
</administration>

<files folder="site">
<filename>sample_form1.php</filename>
<filename>sample_form.xml</filename>
</files>
</extension>
</source>

<tt>sample_form.xml</tt> File containing the XML for the form definition
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<form>
<field
name="message"
type="text"
label="Enter message"
size="40"
class="inputbox"
required="true" />
<field name="email"
type="email"
label="Enter email"
required="true"
size="40"
class="inputbox" />
<field name="telephone"
type="tel"
label="Enter telephone number"
required="true"
size="40"
class="inputbox"
validate="tel" />
</form>
</source>

<tt>sample_form1.php</tt> Component code.
<source lang="php">
<?php
defined('_JEXEC') or die('Restricted access');

use Joomla\CMS\Form\Form;
use Joomla\CMS\Factory;

$form = Form::getInstance("sample", __DIR__ . "/sample_form.xml", array("control" => "myform"));
$prefillData = array("email" => ".@.");

if ($_SERVER['REQUEST_METHOD'] === 'POST')
{
$app = JFactory::getApplication();
$data = $app->input->post->get('myform', array(), "array");
echo "Message was " . $data["message"] .
", email was " . $data["email"] .
", and telephone was " . $data["telephone"] . "<br>";
$filteredData = $form->filter($data);
$result = $form->validate($filteredData);
if ($result)
{
echo "Validation passed ok<br>";
}
else
{
echo "Validation failed<br>";
$errors = $form->getErrors();
foreach ($errors as $error)
{
echo $error->getMessage() . "<br>";
}
// in the redisplayed form show what the user entered (after data is filtered)
$prefillData = $filteredData;
}
}

$form->bind($prefillData);
?>
<form action="<?php echo JRoute::_('index.php?option=com_sample_form1'); ?>"
method="post" name="sampleForm" id="adminForm" enctype="multipart/form-data">

<?php echo $form->renderField('message'); ?>

<?php echo $form->renderField('email'); ?>

<?php echo $form->renderField('telephone'); ?>

<button type="submit">Submit</button>
</form>
</source>

Once installed navigate to your site and add the following parameter to the URL:
<tt>&option=com_sample_form1<tt>. You should then see the form displayed with 3 required fields:
* a general text input field for a message
* an email input field, pre-populated with the string ".@."
* a telephone number input field.
and using your browser's development tools you can compare the html attributes with the attributes in your XML form definition.

Note that modern browsers will do some validation on the values you enter, specifically they will validate the email address and will force you to enter something into fields with the "required" attribute set, but don't (currently) do validation on telephone number fields.

Once you enter valid data into the fields and press Submit, then the data will be sent to the server and the POST leg of the sample code will be run. This runs the filtering and validation routines. If there are validation errors then the code outputs the error messages, and prefills the form with the data which the user entered before redisplaying it.

== MVC and other considerations ==
The way that the code above is written isn't the best approach if you are developing a genuine Joomla component. Instead you should follow the way that the Joomla core code is designed, in particular splitting your component into controllers, models, views and layouts, and the revised component code in the section after this follows this approach. The remainder of this section describes these and other design decisions, which should make the sample code easier to understand.

=== Joomla MVC split ===
In general terms Joomla splits components into separate types of functionality:
* the controller contains the "business logic" of the application, including deciding what view and model to use
* the model provides access to the data
* the view decides what data is necessary for outputting on the web page and obtains this data from the model
* the layout outputs the HTML, and includes in the output the data which has been collated by the view. The layout runs within the context of the view, and so has direct access to the variables of the view code.

=== Post/Request/Get pattern ===
In Joomla all of the HTML output (such as the display of a form) is performed in response to an HTTP GET, following the https://en.wikipedia.org/wiki/Post/Redirect/Get pattern. The sample code above doesn't follow this pattern, but instead outputs the validation errors and re-displays the form in the response to the HTTP POST request.

To follow the Joomla pattern, in the code which handles the POST we should include a HTTP GET redirect to the form URL. As that GET will then be a new HTTP request/response we must store in the user session the data to be shown when the form is redisplayed:
* the validation error messages are stored and output using the <tt>enqueueMessage()</tt> method (which stores data in the user session automatically for us)
* the user-entered data is stored using <tt>setUserState()</tt> and retrieved using <tt>getUserState()</tt>, and keyed by a <tt>context</tt> which should be unique to this form. The code which provides the data for the form <tt>bind()</tt> operation must first check using <tt>getUserState()<tt> if there is any prefill data in the session. And if the user enters data which successfully passes validation then <tt>setUserState()<tt> should be called to clear this prefill data in the session, otherwise it will appear whenever the user next displays the form.

=== Separate Controllers ===
In response to a GET or POST, Joomla always runs the same component file, sample_form1.php in the sample component example above and the top-level sample_form2.php in the example below. The sample_form2.php code below follows the example of the core Joomla components, and has code which passes control to different methods in different controllers based on the value of the HTTP parameter <tt>task</tt>. This parameter is set by Joomla core javascript based on the submit button, eg in the example below:

onclick="Joomla.submitbutton('myform.submit')"

The task parameter is in this example set to "myform.submit". In general the task parameter is of the form "firstpart.secondpart" and for a component called "com_example" Joomla will try to run an instance method called <tt>secondpart()</tt> of a controller class <tt>ExampleControllerFirstpart</tt> in a file <tt>firstpart.php</tt> in the <tt>controllers</tt> directory.

If the task parameter is not set then Joomla will try to run the <tt>display()</tt> method of the <tt>ExampleController</tt> class which it will expect to find in <tt>controller.php</tt>.

In terms of code:

<tt>$controller = JControllerLegacy::getInstance('Sample_form2');</tt>

uses the <tt>task</tt> parameter to identify the appropriate controller file to include, and then creates an instance of that controller class.

<tt>$controller->execute($input->getCmd('task'));</tt>

executes the appropriate method (<tt>secondpart()</tt> - or in the case below, <tt>submit()</tt> - or <tt>display()</tt>) of that class.

In this way controller functionality handling GETs (generally in the file <tt>controller.php</tt>) is separated from that handling POSTs (generally in the files in the <tt>controllers</tt> folder).

=== Joomla MVC classes ===

Joomla provides feature-rich controller, view and model classes from which your component controllers, views and models can inherit. The model code below inherits from <tt>FormModel</tt> which shields somewhat the Joomla <tt>Form</tt> API. In this case our model calls <tt>FormModel::loadForm()</tt>, and this then executes a callback to our <tt>loadFormData()</tt> to provide the data to <tt>bind()</tt> to the form.

You can also use <tt>FormController</tt> and <tt>AdminController</tt> classes, but these assume that your component is using a database table to store the data. The Joomla MVC Component Development tutorial takes this approach in [[J3.x:Developing an MVC Component/Adding backend actions]].

=== Security Token ===
Joomla uses a security token on forms to prevent CSRF attacks (see https://en.wikipedia.org/wiki/Cross-site_request_forgery). The token is output in the layout file

<tt><?php echo JHtml::_('form.token'); ?></tt>

and checked within the controller handling the POST:

<tt>$this->checkToken();</tt>

If the token is found to be invalid then <tt>checkToken()</tt> outputs a warning and redirects the user back to the previous page.

=== Client-side Validation ===
In addition to the server-side validation included through the form XML definition, Joomla also provides a way of including javascript which performs client-side validation on the browser. This is NOT included below, as it's deemed beyond the scope of this tutorial, but you can find details of it in [[J3.x:Developing an MVC Component/Adding verifications]] and [[Client-side_form_validation|Client-side form validation]].

== Sample Form 2 ==
This second sample component incorporates the design decisions described above and structures the code according to the Joomla paradigm. The overall file structure is shown in the diagram below.

[[File:Sample-form-files.jpg|Sample Form 2 file structure]].

Starting at the bottom of this diagram and going upwards the file contents are:

<tt>com_sample_form2/sample_form2.php</tt> Entry point for the component. This is the first file which Joomla runs.
<source lang="php">
<?php
defined('_JEXEC') or die('Restricted access');
// Load the appropriate controller class
$controller = JControllerLegacy::getInstance('Sample_form2');

$input = JFactory::getApplication()->input;
// Run the task method, or display() if no task parameter
$controller->execute($input->getCmd('task'));

$controller->redirect();
</source>

<tt>com_sample_form2/controller.php</tt> The controller for handling HTTP GET requests
<source lang="php">
<?php
defined('_JEXEC') or die('Restricted access');
use Joomla\CMS\MVC\Controller\BaseController;

class Sample_form2Controller extends BaseController
{
// Joomla will look for this class within the controller.php file
// It will (usually) call the display() method, and will find this is in the BaseController class
}
</source>

<tt>com_sample_form2/sample_form2.xml</tt> Manifest file for the component.
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.1.0" method="upgrade">

<name>com_sample_form2</name>
<version>1.0.0</version>
<description>Sample form 2</description>

<administration>
</administration>

<files folder="site">
<filename>sample_form2.php</filename>
<filename>controller.php</filename>
<folder>controllers</folder>
<folder>views</folder>
<folder>models</folder>
</files>
</extension>
</source>

<tt>com_sample_form2/views/form/view.html.php</tt> View file for displaying the form. The controller <tt>display()</tt> function will create instances of the model and view, and call the view <tt>display()</tt> function below.
<source lang="php">
<?php
defined('_JEXEC') or die('Restricted access');

use Joomla\CMS\MVC\View\HtmlView;
use Joomla\CMS\Factory;

class Sample_form2ViewForm extends HtmlView
{
public function display($tpl = null)
{
if (!$this->form = $this->get('form'))
{
echo "Can't load form<br>";
return;
}
parent::display($tpl); // this will include the layout file edit.php
}
}
</source>

<tt>com_sample_form2/views/form/tmpl/edit.php</tt> Layout file for displaying the form
<source lang="php">
<?php
defined('_JEXEC') or die('Restricted access');
?>
<form action="<?php echo JRoute::_('index.php?option=com_sample_form2&view=form&layout=edit'); ?>"
method="post" name="adminForm" id="adminForm" enctype="multipart/form-data">

<?php echo $this->form->renderField('message'); ?>

<?php echo $this->form->renderField('email'); ?>

<?php echo $this->form->renderField('telephone'); ?>

<button type="button" class="btn btn-primary" onclick="Joomla.submitbutton('myform.submit')">Submit</button>

<input type="hidden" name="task" />
<?php echo JHtml::_('form.token'); ?>
</form>
</source>

<tt>com_sample_form2/models/form.php</tt> Model associated with displaying the form. The view <tt>get('form')</tt> gets mapped to the model <tt>getForm()</tt> method call.
<source lang="php">
<?php
defined('_JEXEC') or die('Restricted access');

use Joomla\CMS\MVC\Model\FormModel;

class Sample_form2ModelForm extends FormModel
{

public function getForm($data = array(), $loadData = true)
{
$form = $this->loadForm(
'com_sample_form2.sample', // just a unique name to identify the form
'sample_form', // the filename of the XML form definition
// Joomla will look in the models/forms folder for this file
array(
'control' => 'jform', // the name of the array for the POST parameters
'load_data' => $loadData // will be TRUE
)
);

if (empty($form))
{
$errors = $this->getErrors();
throw new Exception(implode("\n", $errors), 500);
}

return $form;
}

protected function loadFormData()
{
// Check the session for previously entered form data.
$data = JFactory::getApplication()->getUserState(
'com_sample_form2.sample', // a unique name to identify the data in the session
array("telephone" => "0") // prefill data if no data found in session
);

return $data;
}

}
</source>

<tt>com_sample_form2/models/forms/sample_form.xml</tt> XML file containing the form definition
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<form>
<field
name="message"
type="text"
label="Enter message"
size="40"
class="inputbox"
required="true" />
<field name="email"
type="email"
label="Enter email"
required="true"
size="40"
class="inputbox" />
<field name="telephone"
type="tel"
label="Enter telephone number"
required="true"
size="40"
class="inputbox"
validate="tel" />
</form>
</source>

<tt>com_sample_form2/controllers/Myform.php</tt> Controller which handles the HTTP POST
<source lang="php">
<?php
defined('_JEXEC') or die('Restricted access');

use Joomla\CMS\MVC\Controller\BaseController;
use Joomla\CMS\Factory;

class Sample_form2ControllerMyform extends BaseController
{
public function submit($key = null, $urlVar = null)
{
$this->checkToken();

$app = JFactory::getApplication();
$model = $this->getModel('form');
$form = $model->getForm($data, false);
if (!$form)
{
$app->enqueueMessage($model->getError(), 'error');
return false;
}

// name of array 'jform' must match 'control' => 'jform' line in the model code
$data = $this->input->post->get('jform', array(), 'array');

// This is validate() from the FormModel class, not the Form class
// FormModel::validate() calls both Form::filter() and Form::validate() methods
$validData = $model->validate($form, $data);

if ($validData === false)
{
$errors = $model->getErrors();

foreach ($errors as $error)
{
if ($error instanceof \Exception)
{
$app->enqueueMessage($error->getMessage(), 'warning');
}
else
{
$app->enqueueMessage($error, 'warning');
}
}

// Save the form data in the session, using a unique identifier
$app->setUserState('com_sample_form2.sample', $data);
}
else
{
$app->enqueueMessage("Data successfully validated", 'notice');
// Clear the form data in the session
$app->setUserState('com_sample_form2.sample', null);
}

// Redirect back to the form in all cases
$this->setRedirect(JRoute::_('index.php?option=com_sample_form2&view=form&layout=edit', false));
}
}
</source>

After creating the files as described above, zip up the <tt>com_sample_form2</tt> folder to create com_sample_form2.zip and install this component. Then navigate to your Joomla site and add into the URL the parameters <tt>&option=com_sample_form2&view=form&layout=edit<tt>. This should display the form, and should work in a similar fashion to previous sample form, except that errors etc will appear in the message part of the Joomla display.

[[Category:Development]]
[[Category:Tutorials]]
[[Category:Module Development]]
[[Category:Plugin Development]]
[[Category:Component Development]]

Basic form guide

2020-04-04T11:48:55Z

ThiagoG: Adding J in front of Factory

== Introduction ==
This is one of a series of [[API Guides]], which aim to help you understand how to use the Joomla APIs through providing detailed explanations and sample code which you can easily install and run.

The Joomla Form class and API enables you to easily develop HTML forms and handle the user's input.

This page describes how you interact in general with the Joomla Form class and provides the code of a simple component which you can install to demonstrate use of this API.

Joomla itself also has a specific way of designing form functionality, and this page includes tutorial material to help you understand and develop your component to align with these principles.

== Overall Description ==
The diagram below shows the basic use of the Joomla Form class.

[[File:basicform.jpg|Using Joomla Forms]]

Firstly, you need to define your form in XML using Joomla [[Standard form field types]]. See the component code below for an example. In basic terms, each field element in your XML file maps to an HTML (mostly "input") element in the form, with the XML field attributes mapping to the (input) element attributes. Many of the possible field attributes are listed in [[Text form field type]].

=== Step 1 Loading the Form ===
The user clicks on the URL of your form, and Joomla routes the HTTP GET request through to your component code. You need to call <tt>Form::getInstance()</tt> passing the name of your XML file with your form definition. The Joomla Form code creates a Form instance, and then (in <tt>Form::loadFile()</tt>) reads the file into memory (as a PHP <tt>SimpleXMLElement</tt>) and parses the XML to ensure it's valid. The main parameters passed to <tt>getInstance()<tt> are:
* name – a string specifying the identity to give to this form – it just needs to be unique, so that it doesn't clash with any other Joomla forms on the same webpage
* data – the name of the XML file which has your form definition
* options – an array of options, with the "control" element specifying the name of the array which the POST parameters will be held in. For example, the sample code has <tt>array("control"=>"myform")</tt> which means that the HTML input elements will have name attributes set to "myform[message]", "myform[email]", etc,. They will be passed in POST parameters that way, and it's then very easy to get these into a PHP array.

=== Step 2 Providing Pre-fill Data ===
You provide values for any form element you wish. For example, if this form is being used to edit a record in the database, then you would pre-populate it with existing field values from the database. You can provide values by setting up an associative array <tt>$data</tt> and passing it to <tt>Form::bind($data)</tt> method, and Joomla Form then stores this data locally within the Form instance.

=== Step 3 Outputting the Form in HTML ===
You call <tt>renderField(fieldName)</tt> on the Form instance and you get returned the HTML which you can echo to the output. Joomla processes its XML representation of your form to obtain the section relating to the passed-in fieldName, generates the HTML for this HTML element and includes the "value" attribute based on the pre-populated data which you passed in step 2.
When outputting the form you also need to surround the input elements in a <tt><form></tt> element and add a submit button.

=== Step 4 User Submitting the Form ===
The user enters data into your HTML form and clicks on the submit button. The browser generates an HTTP POST request to the URL specified in the <tt><form></tt> element and passes to the server in POST parameters the values entered by the user; each parameter keyed by the "name" attribute of the HTML input element.

Joomla routes this POST through to your component. As this is a new HTTP request the previous Form instance no longer exists, so you have to again call <tt>Form::getInstance()</tt>, passing the filename of your form XML, and Joomla (as before) creates a Form instance and reads this file into memory.

=== Step 5 Handling the HTTP POST Data ===
In this step you process the submitted data. This involves:
# Getting the POST data using <tt>Factory::getApplication->input->get()<tt>. Usually the "name" attributes of the input elements are defined so that the POST parameters appear as an array, and you can use the ARRAY filter from [[Retrieving_request_data_using_JInput]] to read these directly into a PHP array. However, this means that the individual elements are not filtered at all.
# Filtering. This applies filtering on each of the input values. The filter applied to a field is governed by the "filter=..." attribute on that field in your form XML file, or if not present then the default filter will remove HTML tags etc from your data values. The possible filters are in the <tt>filterField()</tt> method of the Form class (and see https://joomla.stackexchange.com/questions/5764/what-are-possible-filters-in-joomla-form-fields). Note that these form field filters are different from the jinput filters.
# Validation. You validate the data which the user has entered by calling validate($data) on your Form instance, passing an associative array of the (filtered) user data. Joomla compares the user-entered data with the validation you defined in your form XML file, and generates errors for fields which fail the validation.

If there are validation errors then you should display those errors to the user, and redisplay the form, pre-populating the fields with the (filtered) data which the user entered previously.

If there are no errors then you can confirm this to the user, and show the next web page.

== Sample Form 1 ==
Below is the code for a small component which you can install to demonstrate basic use of Joomla forms. Place the following 3 files into a folder called "com_sample_form1". Then zip up the folder to create <tt>com_sample_form1.zip</tt> and install this as a component on your Joomla instance.

<tt>com_sample_form1.xml</tt> Manifest file for the component
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.1.0" method="upgrade">

<name>com_sample_form1</name>
<version>1.0.0</version>
<description>Sample form 1</description>

<administration>
</administration>

<files folder="site">
<filename>sample_form1.php</filename>
<filename>sample_form.xml</filename>
</files>
</extension>
</source>

<tt>sample_form.xml</tt> File containing the XML for the form definition
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<form>
<field
name="message"
type="text"
label="Enter message"
size="40"
class="inputbox"
required="true" />
<field name="email"
type="email"
label="Enter email"
required="true"
size="40"
class="inputbox" />
<field name="telephone"
type="tel"
label="Enter telephone number"
required="true"
size="40"
class="inputbox"
validate="tel" />
</form>
</source>

<tt>sample_form1.php</tt> Component code.
<source lang="php">
<?php
defined('_JEXEC') or die('Restricted access');

use Joomla\CMS\Form\Form;
use Joomla\CMS\Factory;

$form = Form::getInstance("sample", __DIR__ . "/sample_form.xml", array("control" => "myform"));
$prefillData = array("email" => ".@.");

if ($_SERVER['REQUEST_METHOD'] === 'POST')
{
$app = JFactory::getApplication();
$data = $app->input->post->get('myform', array(), "array");
echo "Message was " . $data["message"] .
", email was " . $data["email"] .
", and telephone was " . $data["telephone"] . "<br>";
$filteredData = $form->filter($data);
$result = $form->validate($filteredData);
if ($result)
{
echo "Validation passed ok<br>";
}
else
{
echo "Validation failed<br>";
$errors = $form->getErrors();
foreach ($errors as $error)
{
echo $error->getMessage() . "<br>";
}
// in the redisplayed form show what the user entered (after data is filtered)
$prefillData = $filteredData;
}
}

$form->bind($prefillData);
?>
<form action="<?php echo JRoute::_('index.php?option=com_sample_form1'); ?>"
method="post" name="sampleForm" id="adminForm" enctype="multipart/form-data">

<?php echo $form->renderField('message'); ?>

<?php echo $form->renderField('email'); ?>

<?php echo $form->renderField('telephone'); ?>

<button type="submit">Submit</button>
</form>
</source>

Once installed navigate to your site and add the following parameter to the URL:
<tt>&option=com_sample_form1<tt>. You should then see the form displayed with 3 required fields:
* a general text input field for a message
* an email input field, pre-populated with the string ".@."
* a telephone number input field.
and using your browser's development tools you can compare the html attributes with the attributes in your XML form definition.

Note that modern browsers will do some validation on the values you enter, specifically they will validate the email address and will force you to enter something into fields with the "required" attribute set, but don't (currently) do validation on telephone number fields.

Once you enter valid data into the fields and press Submit, then the data will be sent to the server and the POST leg of the sample code will be run. This runs the filtering and validation routines. If there are validation errors then the code outputs the error messages, and prefills the form with the data which the user entered before redisplaying it.

== MVC and other considerations ==
The way that the code above is written isn't the best approach if you are developing a genuine Joomla component. Instead you should follow the way that the Joomla core code is designed, in particular splitting your component into controllers, models, views and layouts, and the revised component code in the section after this follows this approach. The remainder of this section describes these and other design decisions, which should make the sample code easier to understand.

=== Joomla MVC split ===
In general terms Joomla splits components into separate types of functionality:
* the controller contains the "business logic" of the application, including deciding what view and model to use
* the model provides access to the data
* the view decides what data is necessary for outputting on the web page and obtains this data from the model
* the layout outputs the HTML, and includes in the output the data which has been collated by the view. The layout runs within the context of the view, and so has direct access to the variables of the view code.

=== Post/Request/Get pattern ===
In Joomla all of the HTML output (such as the display of a form) is performed in response to an HTTP GET, following the https://en.wikipedia.org/wiki/Post/Redirect/Get pattern. The sample code above doesn't follow this pattern, but instead outputs the validation errors and re-displays the form in the response to the HTTP POST request.

To follow the Joomla pattern, in the code which handles the POST we should include a HTTP GET redirect to the form URL. As that GET will then be a new HTTP request/response we must store in the user session the data to be shown when the form is redisplayed:
* the validation error messages are stored and output using the <tt>enqueueMessage()</tt> method (which stores data in the user session automatically for us)
* the user-entered data is stored using <tt>setUserState()</tt> and retrieved using <tt>getUserState()</tt>, and keyed by a <tt>context</tt> which should be unique to this form. The code which provides the data for the form <tt>bind()</tt> operation must first check using <tt>getUserState()<tt> if there is any prefill data in the session. And if the user enters data which successfully passes validation then <tt>setUserState()<tt> should be called to clear this prefill data in the session, otherwise it will appear whenever the user next displays the form.

=== Separate Controllers ===
In response to a GET or POST, Joomla always runs the same component file, sample_form1.php in the sample component example above and the top-level sample_form2.php in the example below. The sample_form2.php code below follows the example of the core Joomla components, and has code which passes control to different methods in different controllers based on the value of the HTTP parameter <tt>task</tt>. This parameter is set by Joomla core javascript based on the submit button, eg in the example below:

onclick="Joomla.submitbutton('myform.submit')"

The task parameter is in this example set to "myform.submit". In general the task parameter is of the form "firstpart.secondpart" and for a component called "com_example" Joomla will try to run an instance method called <tt>secondpart()</tt> of a controller class <tt>ExampleControllerFirstpart</tt> in a file <tt>firstpart.php</tt> in the <tt>controllers</tt> directory.

If the task parameter is not set then Joomla will try to run the <tt>display()</tt> method of the <tt>ExampleController</tt> class which it will expect to find in <tt>controller.php</tt>.

In terms of code:

<tt>$controller = JControllerLegacy::getInstance('Sample_form2');</tt>

uses the <tt>task</tt> parameter to identify the appropriate controller file to include, and then creates an instance of that controller class.

<tt>$controller->execute($input->getCmd('task'));</tt>

executes the appropriate method (<tt>secondpart()</tt> - or in the case below, <tt>submit()</tt> - or <tt>display()</tt>) of that class.

In this way controller functionality handling GETs (generally in the file <tt>controller.php</tt>) is separated from that handling POSTs (generally in the files in the <tt>controllers</tt> folder).

=== Joomla MVC classes ===

Joomla provides feature-rich controller, view and model classes from which your component controllers, views and models can inherit. The model code below inherits from <tt>FormModel</tt> which shields somewhat the Joomla <tt>Form</tt> API. In this case our model calls <tt>FormModel::loadForm()</tt>, and this then executes a callback to our <tt>loadFormData()</tt> to provide the data to <tt>bind()</tt> to the form.

You can also use <tt>FormController</tt> and <tt>AdminController</tt> classes, but these assume that your component is using a database table to store the data. The Joomla MVC Component Development tutorial takes this approach in [[J3.x:Developing an MVC Component/Adding backend actions]].

=== Security Token ===
Joomla uses a security token on forms to prevent CSRF attacks (see https://en.wikipedia.org/wiki/Cross-site_request_forgery). The token is output in the layout file

<tt><?php echo JHtml::_('form.token'); ?></tt>

and checked within the controller handling the POST:

<tt>$this->checkToken();</tt>

If the token is found to be invalid then <tt>checkToken()</tt> outputs a warning and redirects the user back to the previous page.

=== Client-side Validation ===
In addition to the server-side validation included through the form XML definition, Joomla also provides a way of including javascript which performs client-side validation on the browser. This is NOT included below, as it's deemed beyond the scope of this tutorial, but you can find details of it in [[J3.x:Developing an MVC Component/Adding verifications]] and [[Client-side_form_validation|Client-side form validation]].

== Sample Form 2 ==
This second sample component incorporates the design decisions described above and structures the code according to the Joomla paradigm. The overall file structure is shown in the diagram below.

[[File:Sample-form-files.jpg|Sample Form 2 file structure]].

Starting at the bottom of this diagram and going upwards the file contents are:

<tt>com_sample_form2/sample_form2.php</tt> Entry point for the component. This is the first file which Joomla runs.
<source lang="php">
<?php
defined('_JEXEC') or die('Restricted access');
// Load the appropriate controller class
$controller = JControllerLegacy::getInstance('Sample_form2');

$input = JFactory::getApplication()->input;
// Run the task method, or display() if no task parameter
$controller->execute($input->getCmd('task'));

$controller->redirect();
</source>

<tt>com_sample_form2/controller.php</tt> The controller for handling HTTP GET requests
<source lang="php">
<?php
defined('_JEXEC') or die('Restricted access');
use Joomla\CMS\MVC\Controller\BaseController;

class Sample_form2Controller extends BaseController
{
// Joomla will look for this class within the controller.php file
// It will (usually) call the display() method, and will find this is in the BaseController class
}
</source>

<tt>com_sample_form2/sample_form2.xml</tt> Manifest file for the component.
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.1.0" method="upgrade">

<name>com_sample_form2</name>
<version>1.0.0</version>
<description>Sample form 2</description>

<administration>
</administration>

<files folder="site">
<filename>sample_form2.php</filename>
<filename>controller.php</filename>
<folder>controllers</folder>
<folder>views</folder>
<folder>models</folder>
</files>
</extension>
</source>

<tt>com_sample_form2/views/form/view.html.php</tt> View file for displaying the form. The controller <tt>display()</tt> function will create instances of the model and view, and call the view <tt>display()</tt> function below.
<source lang="php">
<?php
defined('_JEXEC') or die('Restricted access');

use Joomla\CMS\MVC\View\HtmlView;
use Joomla\CMS\Factory;

class Sample_form2ViewForm extends HtmlView
{
public function display($tpl = null)
{
if (!$this->form = $this->get('form'))
{
echo "Can't load form<br>";
return;
}
parent::display($tpl); // this will include the layout file edit.php
}
}
</source>

<tt>com_sample_form2/views/form/tmpl/edit.php</tt> Layout file for displaying the form
<source lang="php">
<?php
defined('_JEXEC') or die('Restricted access');
?>
<form action="<?php echo JRoute::_('index.php?option=com_sample_form2&view=form&layout=edit'); ?>"
method="post" name="adminForm" id="adminForm" enctype="multipart/form-data">

<?php echo $this->form->renderField('message'); ?>

<?php echo $this->form->renderField('email'); ?>

<?php echo $this->form->renderField('telephone'); ?>

<button type="button" class="btn btn-primary" onclick="Joomla.submitbutton('myform.submit')">Submit</button>

<input type="hidden" name="task" />
<?php echo JHtml::_('form.token'); ?>
</form>
</source>

<tt>com_sample_form2/models/form.php</tt> Model associated with displaying the form. The view <tt>get('form')</tt> gets mapped to the model <tt>getForm()</tt> method call.
<source lang="php">
<?php
defined('_JEXEC') or die('Restricted access');

use Joomla\CMS\MVC\Model\FormModel;

class Sample_form2ModelForm extends FormModel
{

public function getForm($data = array(), $loadData = true)
{
$form = $this->loadForm(
'com_sample_form2.sample', // just a unique name to identify the form
'sample_form', // the filename of the XML form definition
// Joomla will look in the models/forms folder for this file
array(
'control' => 'jform', // the name of the array for the POST parameters
'load_data' => $loadData // will be TRUE
)
);

if (empty($form))
{
$errors = $this->getErrors();
throw new Exception(implode("\n", $errors), 500);
}

return $form;
}

protected function loadFormData()
{
// Check the session for previously entered form data.
$data = JFactory::getApplication()->getUserState(
'com_sample_form2.sample', // a unique name to identify the data in the session
array("telephone" => "0") // prefill data if no data found in session
);

return $data;
}

}
</source>

<tt>com_sample_form2/models/forms/sample_form.xml</tt> XML file containing the form definition
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<form>
<field
name="message"
type="text"
label="Enter message"
size="40"
class="inputbox"
required="true" />
<field name="email"
type="email"
label="Enter email"
required="true"
size="40"
class="inputbox" />
<field name="telephone"
type="tel"
label="Enter telephone number"
required="true"
size="40"
class="inputbox"
validate="tel" />
</form>
</source>

<tt>com_sample_form2/controllers/Myform.php</tt> Controller which handles the HTTP POST
<source lang="php">
<?php
defined('_JEXEC') or die('Restricted access');

use Joomla\CMS\MVC\Controller\BaseController;
use Joomla\CMS\Factory;

class Sample_form2ControllerMyform extends BaseController
{
public function submit($key = null, $urlVar = null)
{
$this->checkToken();

$app = Factory::getApplication();
$model = $this->getModel('form');
$form = $model->getForm($data, false);
if (!$form)
{
$app->enqueueMessage($model->getError(), 'error');
return false;
}

// name of array 'jform' must match 'control' => 'jform' line in the model code
$data = $this->input->post->get('jform', array(), 'array');

// This is validate() from the FormModel class, not the Form class
// FormModel::validate() calls both Form::filter() and Form::validate() methods
$validData = $model->validate($form, $data);

if ($validData === false)
{
$errors = $model->getErrors();

foreach ($errors as $error)
{
if ($error instanceof \Exception)
{
$app->enqueueMessage($error->getMessage(), 'warning');
}
else
{
$app->enqueueMessage($error, 'warning');
}
}

// Save the form data in the session, using a unique identifier
$app->setUserState('com_sample_form2.sample', $data);
}
else
{
$app->enqueueMessage("Data successfully validated", 'notice');
// Clear the form data in the session
$app->setUserState('com_sample_form2.sample', null);
}

// Redirect back to the form in all cases
$this->setRedirect(JRoute::_('index.php?option=com_sample_form2&view=form&layout=edit', false));
}
}
</source>

After creating the files as described above, zip up the <tt>com_sample_form2</tt> folder to create com_sample_form2.zip and install this component. Then navigate to your Joomla site and add into the URL the parameters <tt>&option=com_sample_form2&view=form&layout=edit<tt>. This should display the form, and should work in a similar fashion to previous sample form, except that errors etc will appear in the message part of the Joomla display.

[[Category:Development]]
[[Category:Tutorials]]
[[Category:Module Development]]
[[Category:Plugin Development]]
[[Category:Component Development]]

J3.x:Developing an MVC Component/Adding Levels

2020-03-23T12:14:49Z

ThiagoG:

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

en</translate>}}

<translate> This tutorial is part of the [[S:MyLanguage/J3.2:Developing an MVC Component | Developing an MVC Component for Joomla! 3.2]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.</translate>

<translate> In this step we add levels to our helloworld component, which basically means that we're implementing a tree structure on our helloworld records.</translate>

<translate> You can view an accompanying video at [https://youtu.be/vpchQZFQlso Adding levels].</translate>

{{#widget:YouTube|id=vpchQZFQlso}}

<translate>
== Introduction == 
</translate>
<translate> Joomla implements menuitems and categories as tree structures. This means, for example, that menuitems on a menu can have submenus off them (as can be seen on the Joomla admin menu) and those submenuitems can in turn have submenus off them, and so on. The submenus are ordered, so you can define which order the submenuitems appear.</translate>
<translate> Some terminology:</translate>
<translate>
# each of our records is a node within the tree structure
# there is a root node which occupies the highest position in the hierarchy; within Joomla we define this root node as being at level 0
# the root node has a number of children, and these will be at level 1. Each of these children's parent is the root node
# these children may in turn have children of their own, at level 2, and so on.</translate>

[[File:NestedSetModel.png|right|Nested Set Model]]

{| class="wikitable"
|-
! style="text-align:left;"| Node
! Left
! Right
|-
|Clothing
|1
|22
|-
|Men's
|2
|9
|-
|Suits
|3
|8
|-
|Slacks
|4
|5
|-
|Jackets
|6
|7
|-
|Women's
|10
|21
|-
|Dresses
|11
|16
|-
|Evening Gowns
|12
|13
|-
|Sun Dresses
|14
|15
|-
|Skirts
|17
|18
|-
|Blouses
|19
|20
|}

<translate> To implement this tree structure within a relational database Joomla uses the [https://en.wikipedia.org/wiki/Nested_set_model Nested Set Model]. This involves assigning to each record a left (in Joomla lft) and a right (in Joomla rgt) field, as shown in the diagram and associated table. You should be able to see how using the lft and rgt values you can determine for any node its level in the tree, its parent, and for nodes with the same parent, the ordering of those nodes.</translate>

<translate> While having lft and rgt values may be sufficient to define a tree completely in theory, in practice adding additional fields give more opportunity for navigating the tree efficiently, and in Joomla there are 5 fields associated with a tree structure:</translate>
<translate>
* lft and rgt fields
* parent id – the id of the parent node
* level - the level in the hierarchy, level 0 (Clothing in the example above) being the highest
* path</translate>
<translate> The path is like the path in a directory structure, and is a join of the alias values going from the root node to the node in question, with a slash separating the aliases. For example, referring to the diagram above, if Clothing is the root node, then the path for Jackets would be Men-s/Suits/Jackets.</translate>

<translate> Notice how the additional fields provide us with efficient mechanisms for navigating the tree. For instance, we can do a query selecting records WHERE parent is Suits, and ORDER BY lft, and that will give us Slacks and Jackets in order. These sorts of operations are generally done on the front end, where we want the site to perform well. By contrast, admin operations can involve many updates. For example, if we move Blouses to be the first child under Men's then it will involve updating the lft and rgt values of nearly all the records in the database table.</translate>

<translate> As you might expect, Joomla provides library functions to help with positioning a new node in the tree, reparenting an item, deleting an item (and all of its children), reordering items, etc.</translate>

<translate>
== Functionality == 
</translate>
<translate> Firstly, we'll want our install of this step to build the tree structure in our helloworld table.</translate>

<translate> In our admin helloworlds view we will show the level of the record by indenting the title, as is done for categories and menuitems. We'll also display the values of our new fields – really for our own diagnostic purposes, as you wouldn't do this in a real application.</translate>

<translate> In the previous step we introduced functionality which enabled the administrator to drag the records to reorder them. We'll continue using this mechanism, but reordering will be limited to records having the same parent (ie siblings), and the records will have to be ordered in ascending order first (sorting by "Ordering descending" won't do).</translate>

<translate> If we delete an item, then all of its children will be moved up the hierarchy, to have as parent the parent of the deleted record.</translate>

<translate>
In the admin edit view we'll allow the administrator to:
* specify a new parent for the item
* specify the positioning of this item within the order of its siblings
(albeit, if we change the parent, then the new siblings will appear only after Save).</translate>

<translate> We'll also ensure that New and Save as Copy functionality works as expected.</translate>

<translate> In the frontend we'll change the page which displays a HelloWorld record to present as well the parent and the descendants of that record.</translate>

<translate> We'll also update the frontend form for creating a new helloworld record so that it prompts for the parent as well.</translate>

<translate>
== Approach == 
</translate>

<translate> Initially we'll need to set up our database as a nested set tree. We'll want record with id=1 to be the root of the tree, so if there's an existing record with id=1 we'll give it a new number, and we'll change any associated records in the Assets and Associations table. After the root record is in place, we'll set the other helloworld records as direct children of the root, and set the new fields accordingly. As this is too complex to do in SQL script, we'll code this within the install <tt>script.php</tt> file.</translate>

<translate> The code for performing operations on the nested set database fields is within <tt>JTableNested</tt>, so we change our helloworld table class to inherit from it instead of <tt>JTable</tt>. We'll use a number of methods from within this class to apply database changes arising from admin operations:</translate>
* <translate> <tt>setLocation($referenceId, $position)</tt> to define how the current record is positioned (for ordering) with respect to its siblings - we'll use this when the administrator uses the helloworld edit form and changes the parent or the ordering of the record with respect to its siblings</translate>
* <translate> <tt>saveorder($idArray, $lft_array)</tt> to store a revised order of siblings - we'll use this whenever the administrator uses the drag record functionality to move a record</translate>
* <translate> <tt>store($updateNulls)</tt> to store a new or updated record - this will be called by the <tt>save()</tt> method in <tt>JModelAdmin</tt></translate>
* <translate> <tt>delete($pk, $children)</tt> to delete a record and (optionally) all of its descendants - we'll use this whenever the administrator deletes one or more helloworld records, and we'll use the option of NOT deleting the descendants.</translate>
* <translate> <tt>rebuild(...)</tt> to recalculate the lft, rgt and path values for the helloworld records - we'll use this after we reposition a record by changing its parent or ordering in the edit form.</translate>

<translate> In our Helloworlds layout file the display of the new fields is straightforward. The other changes involve the following.</translate>
# <translate> To indent the records based on the level (as is done for menus and categories) we'll use the standard joomla layout in layouts/joomla/html/treeprefix.php</translate>
# <translate> To support dragging the rows to reorder, the javascript code in sortablelist.js which we encountered in the previous step [[S:MyLanguage/J3.x:Developing an MVC Component/Adding Ordering|Adding Ordering]] will be used again, but for handing the nested set we specify different parameters to the function, and we need to add different attributes to the <tr> elements.</translate>

<translate> In our Helloworld (edit) layout we'll display the input elements to capture</translate>
* <translate> the record's parent – this will be a list of all the helloworld records, but excluding the record itself (as a record can't have itself as its parent) and its descendants (as this would form a loop in the tree), and,</translate>
* <translate> its position with respect to the record's siblings – for outputting the siblings in order.</translate>

<translate> Because of the specific requirements of these select lists, neither can be implemented using a standard Joomla form field and XML, and we'll define a custom form field for each and define the list of possible values dynamically.</translate>

<translate> In the front end we'll use another Nested Table function <tt>getTree()</tt> to find the descendants of the record we're displaying. And in the front-end form for creating a new record we'll reuse the admin custom form field for presenting the list of records to choose a parent.</translate>

<translate> Where in the previous tutorial step we used the <tt>ordering</tt> database field for ordering, in this step we will use the <tt>lft</tt> database field. So that is a global change within both our admin and site code.</translate>

<translate>
== Database and Install == 
</translate>

<translate> Updated SQL install file:</translate>

<span id="admin/sql/install.mysql.utf8.sql">
<tt>admin/sql/install.mysql.utf8.sql</tt>
<source lang="sql" highlight="13-17,32-35">
DROP TABLE IF EXISTS `#__helloworld`;

CREATE TABLE `#__helloworld` (
`id` INT(11) NOT NULL AUTO_INCREMENT,
`asset_id` INT(10) NOT NULL DEFAULT '0',
`created` DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
`created_by` INT(10) UNSIGNED NOT NULL DEFAULT '0',
`checked_out` INT(10) NOT NULL DEFAULT '0',
`checked_out_time` DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
`greeting` VARCHAR(25) NOT NULL,
`alias` VARCHAR(40) NOT NULL DEFAULT '',
`language` CHAR(7) NOT NULL DEFAULT '*',
`parent_id` int(10) NOT NULL DEFAULT '1',
`level` int(10) NOT NULL DEFAULT '0',
`path` VARCHAR(400) NOT NULL DEFAULT '',
`lft` int(11) NOT NULL DEFAULT '0',
`rgt` int(11) NOT NULL DEFAULT '0',
`published` tinyint(4) NOT NULL DEFAULT '1',
`catid` int(11) NOT NULL DEFAULT '0',
`params` VARCHAR(1024) NOT NULL DEFAULT '',
`image` VARCHAR(1024) NOT NULL DEFAULT '',
`latitude` DECIMAL(9,7) NOT NULL DEFAULT 0.0,
`longitude` DECIMAL(10,7) NOT NULL DEFAULT 0.0,
PRIMARY KEY (`id`)
)
ENGINE =MyISAM
AUTO_INCREMENT =0
DEFAULT CHARSET =utf8;

CREATE UNIQUE INDEX `aliasindex` ON `#__helloworld` (`alias`, `catid`);

/*We added the published column to the INTO statement in order to set the published column, in the helloworld root record, to 1 otherwise you won't be able to publish items.*/

INSERT INTO `#__helloworld` (`greeting`,`alias`,`language`, `parent_id`, `level`, `path`, `lft`, `rgt`, `published`) VALUES
('helloworld root','helloworld-root-alias','en-GB', 0, 0, '', 0, 5, 1),
('Hello World!','hello-world','en-GB', 1, 1, 'hello-world', 1, 2, 0),
('Goodbye World!','goodbye-world','en-GB', 1, 1, 'goodbye-world', 3, 4, 0);
</source>
</span>

<translate> For the upgrade we define the new database structure in the file below ...</translate>

<span id="admin/sql/updates/mysql/0.0.26.sql">
<tt>/admin/sql/updates/mysql/0.0.26.sql</tt>
<source lang="sql">
ALTER TABLE `#__helloworld` DROP COLUMN `ordering`;
ALTER TABLE `#__helloworld` ADD COLUMN `parent_id` INT(10) NOT NULL DEFAULT '1' AFTER `language`;
ALTER TABLE `#__helloworld` ADD COLUMN `level` int(10) NOT NULL DEFAULT '0' AFTER `parent_id`;
ALTER TABLE `#__helloworld` ADD COLUMN `path` varchar(400) NOT NULL DEFAULT '' AFTER `level`;
ALTER TABLE `#__helloworld` ADD COLUMN `lft` int(11) NOT NULL DEFAULT '0' AFTER `path`;
ALTER TABLE `#__helloworld` ADD COLUMN `rgt` int(11) NOT NULL DEFAULT '0' AFTER `lft`;
UPDATE `#__helloworld` SET `path` = `alias`;
</source>
</span>

<translate> But for building the tree we use an install <tt>script.php</tt> file. This code does the following:</translate>
# <translate> it checks if there's already a root record with id=1. If so, then it assumes that the tree has been built, and it exits without changing anything.</translate>
# <translate> otherwise if there's an ordinary record with id=1, then it changes its id to one bigger than the max id in the table. It then changes any associated record in the Assets table and in the Associations table. (We looked at how the key in the Associations table was created using an md5 hash in [[S:MyLanguage/J3.x:Developing an MVC Component/Adding Associations|Adding Associations]]. If the helloworld record with id=1 had had this new id originally, then the associations key formed by the md5 hash would have been different, but actually that doesn't matter. In fact, when the md5 hash is done, if the associations in the array are in a different order then it would produce a different key anyway).</translate>
# <translate> it creates the root record, with id=1, and sets the lft and rgt values for it (based on the total number of records in the table).</translate>
# <translate> it updates the lft and rgt values for all the existing helloworld records in the table.</translate>

<span id="script.php">
<tt>script.php</tt>
<source lang="php" highlight="93-248">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* Script file of HelloWorld component.
*
* The name of this class is dependent on the component being installed.
* The class name should have the component's name, directly followed by
* the text InstallerScript (ex:. com_helloWorldInstallerScript).
*
* This class will be called by Joomla!'s installer, if specified in your component's
* manifest file, and is used for custom automation actions in its installation process.
*
* In order to use this automation script, you should reference it in your component's
* manifest file as follows:
* <scriptfile>script.php</scriptfile>
*
* @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
*/
class com_helloWorldInstallerScript
{
/**
* This method is called after a component is installed.
*
* @param \stdClass $parent - Parent object calling this method.
*
* @return void
*/
public function install($parent)
{
$parent->getParent()->setRedirectURL('index.php?option=com_helloworld');
}

/**
* This method is called after a component is uninstalled.
*
* @param \stdClass $parent - Parent object calling this method.
*
* @return void
*/
public function uninstall($parent)
{
echo '<p>' . JText::_('COM_HELLOWORLD_UNINSTALL_TEXT') . '</p>';
}

/**
* This method is called after a component is updated.
*
* @param \stdClass $parent - Parent object calling object.
*
* @return void
*/
public function update($parent)
{
echo '<p>' . JText::sprintf('COM_HELLOWORLD_UPDATE_TEXT', $parent->get('manifest')->version) . '</p>';
}

/**
* Runs just before any installation action is preformed on the component.
* Verifications and pre-requisites should run in this function.
*
* @param string $type - Type of PreFlight action. Possible values are:
* - * install
* - * update
* - * discover_install
* @param \stdClass $parent - Parent object calling object.
*
* @return void
*/
public function preflight($type, $parent)
{
echo '<p>' . JText::_('COM_HELLOWORLD_PREFLIGHT_' . $type . '_TEXT') . '</p>';
}

/**
* Runs right after any installation action is preformed on the component.
*
* @param string $type - Type of PostFlight action. Possible values are:
* - * install
* - * update
* - * discover_install
* @param \stdClass $parent - Parent object calling object.
*
* @return void
*/
function postflight($type, $parent)
{
$db = JFactory::getDbo();

echo '<p>Checking if the root record is already present ...</p>';

$query = $db->getQuery(true);
$query->select('id');
$query->from('#__helloworld');
$query->where('id = 1');
$query->where('alias = "helloworld-root-alias"');
$db->setQuery($query);
$id = $db->loadResult();

if ($id == '1')
{ // assume tree structure already built
echo '<p>Root record already present, install program exiting ...</p>';
return;
}

echo '<p>Checking if there is a record with id = 1 ...</p>';

$query = $db->getQuery(true);
$query->select('id');
$query->from('#__helloworld');
$query->where('id = 1');
$db->setQuery($query);
$id = $db->loadResult();

if ($id)
{
echo '<p>Record with id = 1 found</p>';

// get new id
$query = $db->getQuery(true)
->select('max(id) + 1')
->from('#__helloworld');
$db->setQuery($query);
$newid = $db->loadResult();
echo "<p>Changing id to $newid</p>";

// update id in helloworld table
$query = $db->getQuery(true)
->update('#__helloworld')
->set("id = $newid")
->where("id = $id");
$db->setQuery($query);
$result = $db->execute();
if ($result)
{
$nrows = $db->getAffectedRows();
echo "<p>Id in helloworld table changed, records updated: $nrows</p>";
}
else
{
echo "<p>Error: Id in helloworld table not changed</p>";
var_dump($result);
}

// update id in the associations table
$query = $db->getQuery(true)
->update('#__associations')
->set("id = $newid")
->where("id = $id")
->where('context = "com_helloworld.item"');
$db->setQuery($query);
$result = $db->execute();
if ($result)
{
$nrows = $db->getAffectedRows();
echo "<p>Id in associations table changed, records updated: $nrows</p>";
}
else
{
echo "<p>Error: Id in associations table not changed</p>";
var_dump($result);
}

// update id in the assets table
$query = $db->getQuery(true)
->update('#__assets')
->set('name = "com_helloworld.helloworld.' . $newid . '"')
->where('name = "com_helloworld.helloworld.' . $id . '"');
$db->setQuery($query);
$result = $db->execute();
if ($result)
{
$nrows = $db->getAffectedRows();
echo "<p>Id in assets table changed, records updated: $nrows</p>";
}
else
{
echo "<p>Error: Id in assets table not changed</p>";
var_dump($result);
}
}
else
{
echo '<p>No record with id = 1 found</p>';
}

// find number of records in helloworld table
$query = $db->getQuery(true)
->select('count(*)')
->from('#__helloworld');
$db->setQuery($query);
$total = $db->loadResult();

// insert root record
$columns = array('id','greeting','alias','parent_id','rgt');
$values = array(1, 'helloworld root','helloworld-root-alias',0, 2 * (int)$total + 1);

$query = $db->getQuery(true)
->insert('#__helloworld')
->columns($db->quoteName($columns))
->values(implode(',', $db->quote($values)));
$db->setQuery($query);
$result = $db->execute();
if ($result)
{
$nrows = $db->getAffectedRows();
echo "<p>$nrows inserted into helloworld table</p>";
}
else
{
echo "<p>Error creating root record</p>";
var_dump($result);
}

// update lft and rgt for each of the other records (ie not root)
$query = $db->getQuery(true)
->select('id')
->from('#__helloworld')
->where('id > 1');
$db->setQuery($query);
$ids = $db->loadColumn();
for ($i = 0; $i < $total; $i++)
{
$lft = 2 * (int)$i + 1;
$rgt = 2 * (int)$i + 2;
$query = $db->getQuery(true)
->update('#__helloworld')
->set("lft = {$lft}")
->set("rgt = {$rgt}")
->where("id = {$ids[$i]}");
$db->setQuery($query);
$result = $db->execute();
if ($result)
{
$nrows = $db->getAffectedRows();
echo "<p>$nrows updated in helloworld table, for id = {$ids[$i]}</p>";
}
else
{
echo "<p>Error updating record</p>";
var_dump($result);
}
}
}
}
</source>
</span>

<translate>
== Helloworlds MVC == 
</translate>

<translate> Updated model file to include the new fields. The default ordering has been set to be based on the tree structure, as it's arguably more appropriate than being based on the greeting.</translate>

<span id="admin/models/helloworlds.php">
<tt>admin/models/helloworlds.php</tt>
<source lang="php" highlight="37,47,86-87,153-154,157">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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
{
/**
* Constructor.
*
* @param array $config An optional associative array of configuration settings.
*
* @see JController
* @since 1.6
*/
public function __construct($config = array())
{
if (empty($config['filter_fields']))
{
$config['filter_fields'] = array(
'id',
'greeting',
'author',
'created',
'language',
'lft',
'category_id',
'association',
'published'
);
}

parent::__construct($config);
}

protected function populateState($ordering = 'lft', $direction = 'asc')
{
$app = JFactory::getApplication();

// Adjust the context to support modal layouts.
if ($layout = $app->input->get('layout'))
{
$this->context .= '.' . $layout;
}

// Adjust the context to support forced languages.
$forcedLanguage = $app->input->get('forcedLanguage', '', 'CMD');
if ($forcedLanguage)
{
$this->context .= '.' . $forcedLanguage;
}

parent::populateState($ordering, $direction);

// If there's a forced language then define that filter for the query where clause
if (!empty($forcedLanguage))
{
$this->setState('filter.language', $forcedLanguage);
}
}

/**
* 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('a.id as id, a.greeting as greeting, a.published as published, a.created as created,
a.checked_out as checked_out, a.checked_out_time as checked_out_time, a.catid as catid,
a.lft as lft, a.rgt as rgt, a.parent_id as parent_id, a.level as level, a.path as path,
a.image as imageInfo, a.latitude as latitude, a.longitude as longitude, a.alias as alias, a.language as language')
->from($db->quoteName('#__helloworld', 'a'));

// Join over the categories.
$query->select($db->quoteName('c.title', 'category_title'))
->join('LEFT', $db->quoteName('#__categories', 'c') . ' ON c.id = a.catid');

// Join with users table to get the username of the author
$query->select($db->quoteName('u.username', 'author'))
->join('LEFT', $db->quoteName('#__users', 'u') . ' ON u.id = a.created_by');

// Join with users table to get the username of the person who checked the record out
$query->select($db->quoteName('u2.username', 'editor'))
->join('LEFT', $db->quoteName('#__users', 'u2') . ' ON u2.id = a.checked_out');

// Join with languages table to get the language title and image to display
// Put these into fields called language_title and language_image so that
// we can use the little com_content layout to display the map symbol
$query->select($db->quoteName('l.title', 'language_title') . "," .$db->quoteName('l.image', 'language_image'))
->join('LEFT', $db->quoteName('#__languages', 'l') . ' ON l.lang_code = a.language');

// Join over the associations - we just want to know if there are any, at this stage
if (JLanguageAssociations::isEnabled())
{
$query->select('COUNT(asso2.id)>1 as association')
->join('LEFT', '#__associations AS asso ON asso.id = a.id AND asso.context=' . $db->quote('com_helloworld.item'))
->join('LEFT', '#__associations AS asso2 ON asso2.key = asso.key')
->group('a.id');
}

// Filter: like / search
$search = $this->getState('filter.search');

if (!empty($search))
{
$like = $db->quote('%' . $search . '%');
$query->where('greeting LIKE ' . $like);
}

// Filter by published state
$published = $this->getState('filter.published');

if (is_numeric($published))
{
$query->where('a.published = ' . (int) $published);
}
elseif ($published === '')
{
$query->where('(a.published IN (0, 1))');
}

// Filter by language, if the user has set that in the filter field
$language = $this->getState('filter.language');
if ($language)
{
$query->where('a.language = ' . $db->quote($language));
}

// Filter by categories
$catid = $this->getState('filter.category_id');
if ($catid)
{
$query->where("a.catid = " . $db->quote($db->escape($catid)));
}

// exclude root helloworld record
$query->where('a.id > 1');

// Add the list ordering clause.
$orderCol = $this->state->get('list.ordering', 'lft');
$orderDirn = $this->state->get('list.direction', 'asc');

$query->order($db->escape($orderCol) . ' ' . $db->escape($orderDirn));

return $query;
}
}
</source>
</span>

<translate> In our view file we create a mapping of parent id to the ids of its children. This enables us to find more easily the successive parents of a record up the hierarchy, which we'll do in the layout file.</translate>

<span id="admin/views/helloworlds/view.html.php">
<tt>admin/views/helloworlds/view.html.php</tt>
<source lang="php" highlight="70-75">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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();

// Get data from the model
$this->items = $this->get('Items');
$this->pagination = $this->get('Pagination');
$this->state = $this->get('State');
$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('com_helloworld');

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

return false;
}

// Set the sidebar submenu and toolbar, but not on the modal window
if ($this->getLayout() !== 'modal')
{
HelloWorldHelper::addSubmenu('helloworlds');
$this->addToolBar();
}
else
{
// If it's being displayed to select a record as an association, then forcedLanguage is set
if ($forcedLanguage = $app->input->get('forcedLanguage', '', 'CMD'))
{
// Transform the language selector filter into an hidden field, so it can't be set
$languageXml = new SimpleXMLElement('<field name="language" type="hidden" default="' . $forcedLanguage . '" />');
$this->filterForm->setField($languageXml, 'filter', true);

// Also, unset the active language filter so the search tools is not open by default with this filter.
unset($this->activeFilters['language']);
}
}

// Prepare a mapping from parent id to the ids of its children
$this->ordering = array();
foreach ($this->items as $item)
{
$this->ordering[$item->parent_id][] = $item->id;
}

// 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.edit') || JFactory::getUser()->authorise('core.manage', 'com_checkin'))
{
JToolBarHelper::checkin('helloworlds.checkin');
}
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>

<translate> In our layout file we include new columns for the lft, rgt, level and parent fields (although with headings which are just the database field names rather than translated strings), and include the path in small letters below the alias under the greeting. We also change the parameters for the javascript in <tt>sortablelist.js</tt> which enables the dragging of rows to reorder the rows which have the same parent.</translate>

<translate> This javascript code hides all the descendants (not just immediate children) when dragging is being performed, so for each row there's a little work to create a list of the successive parents of that row, going up the tree hierarchy, which is then put into the parents attribute of the <tt><tr></tt> element. When a row with id=xxx is being dragged, the javascript then hides any row in which the id xxx appears in this parents attribute.</translate>

<span id="admin/views/helloworlds/tmpl/default.php">
<tt>admin/views/helloworlds/tmpl/default.php</tt>
<source lang="php" highlight="21,25-26,52,58,61,64,67-78,80,114-138,140,157,165-166,180-182,194-205">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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');

use Joomla\Registry\Registry;

JHtml::_('formbehavior.chosen', 'select');

$listOrder = $this->escape($this->state->get('list.ordering'));
$listDirn = $this->escape($this->state->get('list.direction'));
$user = JFactory::getUser();
$userId = $user->get('id');
$saveOrder = ($listOrder == 'lft' && strtolower($listDirn) == 'asc');
if ($saveOrder)
{
$saveOrderingUrl = 'index.php?option=com_helloworld&task=helloworlds.saveOrderAjax&tmpl=component';
// pass true as parameter 7 to indicate that we have a nested set
JHtml::_('sortablelist.sortable', 'helloworldList', 'adminForm', strtolower($listDirn), $saveOrderingUrl, false, true);
}
$assoc = JLanguageAssociations::isEnabled();
$authorFieldwidth = $assoc ? "10%" : "25%";
JLoader::register('JHtmlHelloworlds', JPATH_ADMINISTRATOR . '/components/com_helloworld/helpers/html/helloworlds.php');
?>
<form action="index.php?option=com_helloworld&view=helloworlds" method="post" id="adminForm" name="adminForm">
<div id="j-sidebar-container" class="span2">
<?php echo JHtmlSidebar::render(); ?>
</div>
<div id="j-main-container" class="span10">
<div class="row-fluid">
<div class="span6">
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLDS_FILTER'); ?>
<?php
echo JLayoutHelper::render(
'joomla.searchtools.default',
array('view' => $this)
);
?>
</div>
</div>
<table class="table table-striped table-hover" id="helloworldList">
<thead>
<tr>
<th width="1%">
<?php echo JHtml::_('searchtools.sort', '', 'lft', $listDirn, $listOrder, null, 'asc', 'JGRID_HEADING_ORDERING', 'icon-menu-2'); ?>
</th>
<th width="1%"><?php echo JText::_('COM_HELLOWORLD_NUM'); ?></th>
<th width="1%">
<?php echo JHtml::_('grid.checkall'); ?>
</th>
<th width="10%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_HELLOWORLDS_NAME', 'greeting', $listDirn, $listOrder); ?>
</th>
<th width="10%">
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLDS_POSITION'); ?>
</th>
<th width="10%">
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLDS_IMAGE'); ?>
</th>
<th width="5%">
<?php echo "lft"; ?>
</th>
<th width="5%">
<?php echo "rgt"; ?>
</th>
<th width="5%">
<?php echo "level"; ?>
</th>
<th width="5%">
<?php echo "parent"; ?>
</th>
<?php if ($assoc) : ?>
<th width="10%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_HELLOWORLDS_ASSOCIATIONS', 'association', $listDirn, $listOrder); ?>
</th>
<?php endif; ?>
<th width="<?php echo $authorFieldwidth; ?>">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_AUTHOR', 'author', $listDirn, $listOrder); ?>
</th>
<th width="10%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_LANGUAGE', 'language', $listDirn, $listOrder); ?>
</th>
<th width="10%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_CREATED_DATE', 'created', $listDirn, $listOrder); ?>
</th>
<th width="5%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_PUBLISHED', 'published', $listDirn, $listOrder); ?>
</th>
<th width="2%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_ID', 'id', $listDirn, $listOrder); ?>
</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) :
$link = JRoute::_('index.php?option=com_helloworld&task=helloworld.edit&id=' . $row->id);
$row->image = new Registry;
$row->image->loadString($row->imageInfo);
// create a list of the parents up the hierarchy to the root
if ($row->level > 1)
{
$parentsStr = '';
$_currentParentId = $row->parent_id;
$parentsStr = ' ' . $_currentParentId;
for ($j = 0; $j < $row->level; $j++)
{
foreach ($this->ordering as $k => $v)
{
$v = implode('-', $v);
$v = '-' . $v . '-';
if (strpos($v, '-' . $_currentParentId . '-') !== false)
{
$parentsStr .= ' ' . $k;
$_currentParentId = $k;
break;
}
}
}
}
else
{
$parentsStr = '';
}
?>
<tr class="row<?php echo $i % 2; ?>" sortable-group-id="<?php echo $row->parent_id; ?>" item-id="<?php echo $row->id; ?>" parents="<?php echo $parentsStr; ?>" level="<?php echo $row->level; ?>">
<td><?php
$iconClass = '';
$canReorder = $user->authorise('core.edit.state', 'com_helloworld.helloworld.' . $row->id);
if (!$canReorder)
{
$iconClass = ' inactive';
}
elseif (!$saveOrder)
{
$iconClass = ' inactive tip-top hasTooltip" title="' . JHtml::_('tooltipText', 'JORDERINGDISABLED');
}
?>
<span class="sortable-handler<?php echo $iconClass ?>">
<span class="icon-menu" aria-hidden="true"></span>
</span>
<?php if ($canReorder && $saveOrder) : ?>
<input type="text" style="display:none" name="order[]" size="5" value="<?php echo $row->lft; ?>" class="width-20 text-area-order" />
<?php endif; ?>
</td>
<td><?php echo $this->pagination->getRowOffset($i); ?></td>
<td>
<?php echo JHtml::_('grid.id', $i, $row->id); ?>
</td>
<td>
<?php $prefix = JLayoutHelper::render('joomla.html.treeprefix', array('level' => $row->level)); ?>
<?php echo $prefix; ?>
<?php if ($row->checked_out) : ?>
<?php $canCheckin = $user->authorise('core.manage', 'com_checkin') || $row->checked_out == $userId; ?>
<?php echo JHtml::_('jgrid.checkedout', $i, $row->editor, $row->checked_out_time, 'helloworlds.', $canCheckin); ?>
<?php endif; ?>
<a href="<?php echo $link; ?>" title="<?php echo JText::_('COM_HELLOWORLD_EDIT_HELLOWORLD'); ?>">
<?php echo $row->greeting; ?>
</a>
<span class="small break-word">
<?php echo JText::sprintf('JGLOBAL_LIST_ALIAS', $this->escape($row->alias)); ?>
</span>
<div class="small">
<?php echo JText::_('JCATEGORY') . ': ' . $this->escape($row->category_title); ?>
</div>
<div class="small">
<?php echo 'Path: ' . $this->escape($row->path); ?>
</div>
</td>
<td align="center">
<?php echo "[" . $row->latitude . ", " . $row->longitude . "]"; ?>
</td>
<td align="center">
<?php
$caption = $row->image->get('caption') ? : '' ;
$src = JURI::root() . ($row->image->get('image') ? : '' );
$html = '<p class="hasTooltip" style="display: inline-block" data-html="true" data-toggle="tooltip" data-placement="right" title="<img width=\'100px\' height=\'100px\' src=\'%s\'>">%s</p>';
echo sprintf($html, $src, $caption); ?>
</td>
<td align="center">
<?php echo $row->lft; ?>
</td>
<td align="center">
<?php echo $row->rgt; ?>
</td>
<td align="center">
<?php echo $row->level; ?>
</td>
<td align="center">
<?php echo $row->parent_id; ?>
</td>
<?php if ($assoc) : ?>
<td align="center">
<?php if ($row->association) : ?>
<?php echo JHtml::_('helloworlds.association', $row->id); ?>
<?php endif; ?>
</td>
<?php endif; ?>
<td align="center">
<?php echo $row->author; ?>
</td>
<td align="center">
<?php echo JLayoutHelper::render('joomla.content.language', $row); ?>
</td>
<td align="center">
<?php echo substr($row->created, 0, 10); ?>
</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>
<input type="hidden" name="task" value=""/>
<input type="hidden" name="boxchecked" value="0"/>
<?php echo JHtml::_('form.token'); ?>
</div>
</form>
</source>
</span>

<translate> We also need to change "ordering" option within the filter fields to use the <tt>lft</tt> database field instead of the <tt>ordering</tt> field which we had in the previous step, and make the default ordering by <tt>lft</tt>.</translate>

<span id="admin/models/forms/filter_helloworlds.xml">
<tt>admin/models/forms/filter_helloworlds.xml</tt>
<source lang="xml" highlight="48,51-52">
<?xml version="1.0" encoding="utf-8"?>
<form>
<fields name="filter">
<field
name="search"
type="text"
label="COM_BANNERS_SEARCH_IN_TITLE"
hint="JSEARCH_FILTER"
class="js-stools-search-string"
/>
<field
name="published"
type="status"
label="JOPTION_SELECT_PUBLISHED"
description="JOPTION_SELECT_PUBLISHED_DESC"
onchange="this.form.submit();"
>
<option value="">JOPTION_SELECT_PUBLISHED</option>
</field>
<field
name="language"
type="contentlanguage"
label="JOPTION_FILTER_LANGUAGE"
description="JOPTION_FILTER_LANGUAGE_DESC"
onchange="this.form.submit();"
>
<option value="">JOPTION_SELECT_LANGUAGE</option>
<option value="*">JALL</option>
</field>
<field
name="category_id"
type="category"
label="JOPTION_FILTER_CATEGORY"
extension="com_helloworld"
onchange="this.form.submit();"
published="0,1,2"
>
<option value="">JOPTION_SELECT_CATEGORY</option>
</field>
</fields>
<fields name="list">
<field
name="fullordering"
type="list"
label="COM_HELLOWORLD_LIST_FULL_ORDERING"
description="COM_HELLOWORLD_LIST_FULL_ORDERING_DESC"
onchange="this.form.submit();"
default="lft ASC"
>
<option value="">JGLOBAL_SORT_BY</option>
<option value="lft ASC">COM_HELLOWORLD_ORDERING_ASC</option>
<option value="lft DESC">COM_HELLOWORLD_ORDERING_DESC</option>
<option value="greeting ASC">COM_HELLOWORLD_GREETING_ASC</option>
<option value="greeting DESC">COM_HELLOWORLD_GREETING_DESC</option>
<option value="id ASC">JGRID_HEADING_ID_ASC</option>
<option value="id DESC">JGRID_HEADING_ID_DESC</option>
<option value="published ASC">COM_HELLOWORLD_PUBLISHED_ASC</option>
<option value="published DESC">COM_HELLOWORLD_PUBLISHED_DESC</option>
<option value="author ASC">COM_HELLOWORLD_AUTHOR_ASC</option>
<option value="author DESC">COM_HELLOWORLD_AUTHOR_DESC</option>
<option value="created ASC">COM_HELLOWORLD_CREATED_ASC</option>
<option value="created DESC">COM_HELLOWORLD_CREATED_DESC</option>
<option value="language ASC">COM_HELLOWORLD_LANGUAGE_ASC</option>
<option value="language DESC">COM_HELLOWORLD_LANGUAGE_DESC</option>
<option value="association ASC">COM_HELLOWORLD_ASSOCIATION_ASC</option>
<option value="association DESC">COM_HELLOWORLD_ASSOCIATION_DESC</option>
</field>
<field
name="limit"
type="limitbox"
class="input-mini"
default="25"
label="COM_CONTENT_LIST_LIMIT"
description="COM_HELLOWORLD_LIST_LIMIT_DESC"
onchange="this.form.submit();"
/>
</fields>
</form>
</source>
</span>

<translate>
== Helloworld Edit Form == 
</translate>

<translate> The form is updated to include the 2 new input elements for capturing the parent and the ordering.</translate>

<translate> The helloworldparent field will result in a <tt>jform['parent_id']</tt> parameter being passed in the HTTP POST from the form, and this will be mapped to the <tt>parent_id</tt> field of the record.</translate>

<translate> The helloworldordering field will result in a <tt>jform['helloworldordering']</tt> parameter containing the id of the sibling below which this record should be placed, or a special value of -1 (to set it as the first child) or -2 (to set it as the last child). This field doesn't map to a field in the database, but will be used to position the location of the edited record.</translate>

<span id="admin/models/forms/helloworld.xml">
<tt>admin/models/forms/helloworld.xml</tt>
<source lang="xml" highlight="74-89">
<?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="alias"
type="text"
label="JFIELD_ALIAS_LABEL"
description="JFIELD_ALIAS_DESC"
hint="JFIELD_ALIAS_PLACEHOLDER"
size="40"
/>
<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>
<field
name="latitude"
type="number"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_LATITUDE_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_LATITUDE_DESC"
min="-90.0"
max="90.0"
class="inputbox"
required="true"
default="0.0"
/>
<field
name="longitude"
type="number"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_LONGITUDE_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_LONGITUDE_DESC"
min="-180.0"
max="180.0"
class="inputbox"
required="true"
default="0.0"
/>
<field
name="language"
type="contentlanguage"
label="JFIELD_LANGUAGE_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_LANGUAGE_DESC"
>
<option value="*">JALL</option>
</field>
<field
name="parent_id"
type="helloworldparent"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_DESC"
default="1"
filter="int">
</field>
<field
name="helloworldordering"
type="helloworldordering"
label="JFIELD_ORDERING_LABEL"
description="JFIELD_ORDERING_DESC"
filter="int"
size="1">
</field>
</fieldset>
<fields name="imageinfo">
<fieldset
name="image-info"
label="COM_HELLOWORLD_IMAGE_FIELDS"
>
<field
name="image"
type="media"
preview="tooltip"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_IMAGE_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_IMAGE_DESC" />
<field name="alt"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_ALT_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_ALT_DESC"
size="30"/>
<field name="caption"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTION_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTION_DESC"
size="30"/>
</fieldset>
</fields>
<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> Both of the two new input elements are custom fields, so we will need to provide definitions of them in two new files within the <tt>admin/models/fields</tt> directory. Firstly the parent:</translate>

<span id="admin/models/fields/helloworldparent.php">
<tt>admin/models/fields/helloworldparent.php</tt>
<source lang="php">
<?php
/**
* Class associated with displaying an input field to capture the parent of a helloworld record
*/

defined('JPATH_BASE') or die;

JFormHelper::loadFieldClass('list');

class JFormFieldHelloworldParent extends JFormFieldList
{
protected $type = 'HelloworldParent';

/**
* Method to return the field options for the parent
*
*/
protected function getOptions()
{
$options = array();

$db = JFactory::getDbo();
$query = $db->getQuery(true)
->select('DISTINCT(a.id) AS value, a.greeting AS text, a.level, a.lft')
->from('#__helloworld AS a');

// Prevent parenting to children of this record, or to itself
// If this record has lft = x and rgt = y, then its children have lft > x and rgt < y
if ($id = $this->form->getValue('id'))
{
$query->join('LEFT', $db->quoteName('#__helloworld') . ' AS h ON h.id = ' . (int) $id)
->where('NOT(a.lft >= h.lft AND a.rgt <= h.rgt)');
}

$query->order('a.lft ASC');

$db->setQuery($query);

try
{
$options = $db->loadObjectList();
}
catch (RuntimeException $e)
{
JError::raiseWarning(500, $e->getMessage());
}

// Pad the option text with spaces using depth level as a multiplier.
for ($i = 0; $i < count($options); $i++)
{
$options[$i]->text = str_repeat('- ', $options[$i]->level) . $options[$i]->text;
}

// Merge any additional options in the XML definition.
$options = array_merge(parent::getOptions(), $options);

return $options;

}
}
</source>
</span>

<translate> And secondly, the ordering</translate>

<span id="admin/models/fields/helloworldordering.php">
<tt>admin/models/fields/helloworldordering.php</tt>
<source lang="php">
<?php
/**
* Class for displaying the Ordering field in the helloworld edit layout
*/

defined('JPATH_BASE') or die;

JFormHelper::loadFieldClass('list');

class JFormFieldHelloworldOrdering extends JFormFieldList
{
protected $type = 'HelloworldOrdering';

/**
* Method to return the options for ordering the helloworld record
* This is the list of siblings the record's siblings - ie those records with the same parent.
* The method requires that parent id be set.
*/
protected function getOptions()
{
$options = array();

// Get the parent
$parent_id = $this->form->getValue('parent_id', 0);

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

$db = JFactory::getDbo();
$query = $db->getQuery(true)
->select('a.id AS value, a.greeting AS text')
->from('#__helloworld AS a')
->where('a.parent_id =' . (int) $parent_id);

$query->order('a.lft ASC');

// Get the options.
$db->setQuery($query);

try
{
$options = $db->loadObjectList();
}
catch (RuntimeException $e)
{
JError::raiseWarning(500, $e->getMessage());
}

$options = array_merge(
array(array('value' => '-1', 'text' => JText::_('COM_HELLOWORLD_ITEM_FIELD_ORDERING_VALUE_FIRST'))),
$options,
array(array('value' => '-2', 'text' => JText::_('COM_HELLOWORLD_ITEM_FIELD_ORDERING_VALUE_LAST')))
);

// Merge any additional options in the XML definition.
$options = array_merge(parent::getOptions(), $options);

return $options;
}

/**
* Method to get the field input markup.
*
* @return string The field input markup.
*
* This method returns the input element except if a new record is being created, in which case a text string is output
*/
protected function getInput()
{
if ($this->form->getValue('id', 0) == 0)
{
return '<span class="readonly">' . JText::_('COM_HELLOWORLD_ITEM_FIELD_ORDERING_TEXT') . '</span>';
}
else
{
return parent::getInput();
}
}
}
</source>
</span>

<translate>
== Handling Admin Record Updates == 
</translate>

<translate> Our Helloworld model and Helloworld table code together handle the updates arising from admin operations on the helloworld edit form and on the helloworlds view. With reference to the two updated files below, here's how these updates are processed.</translate>

<translate> '''Dragging a row to reorder'''</translate>
<translate>
* The dragging is handled within the javascript code in sortablelist.js, and the updated order is sent to the server via an Ajax call to task=helloworlds.saveOrderAjax.
* The code within the Admin Controller saveOrderAjax() method calls our model saveorder() function.
* Our model saveorder() in turn calls the saveorder() within JTableNested
* JTableNested::saveorder() executes the database updates.</translate>

<translate> '''Deleting records'''</translate>
* <translate> Clicking the Delete button in the helloworlds view causes an HTTP POST with task=helloworlds.delete and the list of record ids to delete (from the checkboxes which have been checked)</translate>
* <translate> The Admin Controller delete() calls the delete() function in the model, passing the array of ids to be deleted.</translate>
* <translate> As we don't have a specific delete() function in our helloworld model, this results in the parent Admin Model delete() being called. This function gets the table instance from the model and for each id in the array it calls the table delete() method, passing the id as the single parameter.</translate>
* <translate> The table delete() method invoked is the delete() in our Helloworld Table class. We've overridden the JNestedTable delete() method because if just a single parameter is passed to JNestedTable::delete() then it deletes the children as well as the record. We override it so that the default is NOT to delete the children.</translate>
* <translate> JNestedTable::delete() deletes the record, and moves each of its children up the hierarchy, to be parented on the deleted record's parent.</translate>

<translate> '''Edit record to change the parent'''</translate>
* <translate> Clicking Save causes an HTTP post with task=helloworld.save which gets handled by JControllerForm::save(). This function calls the model save().</translate>
* <translate> This invokes our helloworld model save() which calls the parent::save() which is in JModelAdmin.</translate>
** <translate> JModelAdmin::save() calls table load() to load the existing values, then table bind() to bind the new values</translate>
*** <translate> This invokes our Helloworld table bind() function, which checks if the new parent is the same as the existing parent, and when it finds it isn't it calls table setLocation() to set the position as the last child of that parent</translate>
*** <translate> JTableNested::setLocation() stores the parent and the position (ie 'last child') in instance variables</translate>
** <translate> Back in JModelAdmin::save() it calls table store().</translate>
** <translate> This invokes JTableNested::store() which moves the edited record and all of its descendants under the new parent record, based on the previously stored instance variables. This fixes the lft and rgt values of all the records in the helloworld database table. However, it doesn't fix up the path field of the records which have been moved.</translate>
* <translate> Back in our helloworld model save() we call the JTableNested rebuild() method to rebuild the whole database table. This is rather a crude method for fixing up the path fields of the moved records. However, if we don't use in our code the path field then we can omit this step.</translate>

<translate> '''Edit record to change the ordering (but not the parent)'''</translate>
* <translate> Clicking Save causes an HTTP post with task=helloworld.save and jform['helloworldordering'] set to the id of the field below which we're positioning this record (or set to -1 (first child) or -2 (last child) as special cases). This POST gets handled by JControllerForm::save() which calls the model save().</translate>
* <translate> This invokes our helloworld model save() which calls the parent::save() which is in JModelAdmin.</translate>
** <translate> JModelAdmin::save() calls table load() to load the existing values, then table bind() to bind the new values</translate>
*** <translate> This invokes our Helloworld table bind() function, which checks if the new parent is the same as the existing parent, and when it finds it is then it calls table setLocation() to set the position as after the record id in the 'helloworldordering' element of the array (and handling the special cases of -1 or -2).</translate>
*** <translate> JTableNested::setLocation() stores the (unchanged) parent and the position in instance variables</translate>
** <translate> Back in JModelAdmin::save() it calls table store().</translate>
** <translate> This invokes JTableNested::store() which moves the edited record based on the new position stored in its instance variable. This fixes the lft and rgt values of all the records in the helloworld database table.</translate>
* <translate> Back in our helloworld model save() we call the JTableNested rebuild() method to rebuild the whole database table. This is very inefficient as there is no need to rebuild the paths in this case!</translate>

<translate> '''New and Save as Copy'''</translate>
* <translate> Both of these result in an HTTP POST which get handled by JControllerForm::save() which calls the model save(). In the array of data for the new record the id is either not set or set to 0.</translate>
* <translate> This invokes our helloworld model save() which calls the parent::save() which is in JModelAdmin.</translate>
** <translate> JModelAdmin::save() calls table load() to load the existing values, then table bind() to bind the new values</translate>
*** <translate> This invokes our Helloworld table bind() function, which checks the 'id' element of the array to see if it's a new record. When it finds it is then it calls table setLocation() to set the position as the last child of the record defined in the 'parent_id' array element.</translate>
*** <translate> JTableNested::setLocation() stores the parent and the (last child) position in instance variables</translate>
** <translate> Back in JModelAdmin::save() it calls table store().</translate>
** <translate> This invokes JTableNested::store() which updates the lft and rgt fields in the table to make room for the new record to be inserted at the position specified by the instance variables set in the setLocation() call. This fixes the lft and rgt values of all the records in the helloworld database table, but doesn't set the path of our new record.</translate>
* <translate> Back in our helloworld model save() we call the JTableNested rebuild() method to rebuild the whole database table. This is again very inefficient as we should really only be calling the JTableNested rebuildPath() method to set the path of the new record!</translate>

<translate> '''Addressing the rebuild problem'''</translate>
<translate> The inefficiencies associated with having to call the rebuild() method are significant, particularly because it results in the whole helloworld table being processed for all record updates, even if the update is not concerned with adjusting a record's position in the tree. There are various alternatives to address this issue:</translate>
* <translate> If you don't use the path field in your code then you can just ignore it and not bother calling rebuild() to fix it.</translate>
* <translate> As described in the video accompanying this tutorial step, you can follow the example of com_content and put the code for save() into the helloworld model, rather than calling the parent Admin Model save() to do the work.</translate>
* <translate> In the helloworld model save() for a record update you can load the existing record from the database, compare its parent id with the data from the form, and call rebuild() only if the parent id is different.</translate>

<translate> Our updated model is below. Note that the code has been removed from prepareTable() as defining the order of the records is now done in the bind() method of our helloworld table class.</translate>

<span id="admin/models/helloworld.php">
<tt>admin/models/helloworld.php</tt>
<source lang='php' highlight="214-219,235-236,238-254">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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');

use Joomla\Registry\Registry;

/**
* HelloWorld Model
*
* @since 0.0.1
*/
class HelloWorldModelHelloWorld extends JModelAdmin
{
// JModelAdmin needs to know this for storing the associations
protected $associationsContext = 'com_helloworld.item';

/**
* Method to override getItem to allow us to convert the JSON-encoded image information
* in the database record into an array for subsequent prefilling of the edit form
* We also use this method to prefill the associations
*/
public function getItem($pk = null)
{
$item = parent::getItem($pk);
if ($item AND property_exists($item, 'image'))
{
$registry = new Registry($item->image);
$item->imageinfo = $registry->toArray();
}

// Load associated items
if (JLanguageAssociations::isEnabled())
{
$item->associations = array();

if ($item->id != null)
{
$associations = JLanguageAssociations::getAssociations('com_helloworld', '#__helloworld', 'com_helloworld.item', (int)$item->id);

foreach ($associations as $tag => $association)
{
$item->associations[$tag] = $association->id;
}
}
}
return $item;
}

/**
* 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 preprocess the form to add the association fields dynamically
*
* @return none
*/
protected function preprocessForm(JForm $form, $data, $group = 'helloworld')
{
// Association content items
if (JLanguageAssociations::isEnabled())
{
$languages = JLanguageHelper::getContentLanguages(false, true, null, 'ordering', 'asc');

if (count($languages) > 1)
{
$addform = new SimpleXMLElement('<form />');
$fields = $addform->addChild('fields');
$fields->addAttribute('name', 'associations');
$fieldset = $fields->addChild('fieldset');
$fieldset->addAttribute('name', 'item_associations');

foreach ($languages as $language)
{
$field = $fieldset->addChild('field');
$field->addAttribute('name', $language->lang_code);
$field->addAttribute('type', 'modal_helloworld');
$field->addAttribute('language', $language->lang_code);
$field->addAttribute('label', $language->title);
$field->addAttribute('translate_label', 'false');
}

$form->load($addform, false);
}
}
parent::preprocessForm($form, $data, $group);
}

/**
* Method to get the script 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 override the JModelAdmin save() function to handle Save as Copy correctly
*
* @param The helloworld record data submitted from the form.
*
* @return parent::save() return value
*/
public function save($data)
{
$input = JFactory::getApplication()->input;

JLoader::register('CategoriesHelper', JPATH_ADMINISTRATOR . '/components/com_categories/helpers/categories.php');

// Validate the category id
// validateCategoryId() returns 0 if the catid can't be found
if ((int) $data['catid'] > 0)
{
$data['catid'] = CategoriesHelper::validateCategoryId($data['catid'], 'com_helloworld');
}

// Alter the greeting and alias for save as copy
if ($input->get('task') == 'save2copy')
{
$origTable = clone $this->getTable();
$origTable->load($input->getInt('id'));

if ($data['greeting'] == $origTable->greeting)
{
list($greeting, $alias) = $this->generateNewTitle($data['catid'], $data['alias'], $data['greeting']);
$data['greeting'] = $greeting;
$data['alias'] = $alias;
}
else
{
if ($data['alias'] == $origTable->alias)
{
$data['alias'] = '';
}
}
// standard Joomla practice is to set the new record as unpublished
$data['published'] = 0;
}

$result = parent::save($data);
if ($result)
{
$this->getTable()->rebuild(1);
}
return $result;
}
/**
* Method to check if it's OK to delete a message. Overrides JModelAdmin::canDelete
*/
protected function canDelete($record)
{
if( !empty( $record->id ) )
{
return JFactory::getUser()->authorise( "core.delete", "com_helloworld.helloworld." . $record->id );
}
}
/**
* Prepare a helloworld record for saving in the database
*/
protected function prepareTable($table)
{
}

/**
* Save the record reordering after a record is dragged to a new position in the helloworlds view
*/
public function saveorder($idArray = null, $lft_array = null)
{
// Get an instance of the table object.
$table = $this->getTable();

if (!$table->saveorder($idArray, $lft_array))
{
$this->setError($table->getError());

return false;
}

return true;
}
}
</source>
</span>

<span id="admin/tables/helloworld.php">
<tt>admin/tables/helloworld.php</tt>
<source lang="php" highlight="17,61-99,170-173">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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 JTableNested
{
/**
* 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;
}

if (isset($array['imageinfo']) && is_array($array['imageinfo']))
{
// Convert the imageinfo array to a string.
$parameter = new JRegistry;
$parameter->loadArray($array['imageinfo']);
$array['image'] = (string)$parameter;
}

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

if (isset($array['parent_id']))
{
if (!isset($array['id']) || $array['id'] == 0)
{ // new record
$this->setLocation($array['parent_id'], 'last-child');
}
elseif (isset($array['helloworldordering']))
{
// when saving a record load() is called before bind() so the table instance will have properties which are the existing field values
if ($this->parent_id == $array['parent_id'])
{
// If first is chosen make the item the first child of the selected parent.
if ($array['helloworldordering'] == -1)
{
$this->setLocation($array['parent_id'], 'first-child');
}
// If last is chosen make it the last child of the selected parent.
elseif ($array['helloworldordering'] == -2)
{
$this->setLocation($array['parent_id'], 'last-child');
}
// Don't try to put an item after itself. All other ones put after the selected item.
elseif ($array['helloworldordering'] && $this->id != $array['helloworldordering'])
{
$this->setLocation($array['helloworldordering'], 'after');
}
// Just leave it where it is if no change is made.
elseif ($array['helloworldordering'] && $this->id == $array['helloworldordering'])
{
unset($array['helloworldordering']);
}
}
// Set the new parent id if parent id not matched and put in last position
else
{
$this->setLocation($array['parent_id'], 'last-child');
}
}
}

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

/**
* 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.helloworld.'.(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;
}

public function check()
{
$this->alias = trim($this->alias);
if (empty($this->alias))
{
$this->alias = $this->greeting;
}
$this->alias = JFilterOutput::stringURLSafe($this->alias);
return true;
}

public function delete($pk = null, $children = false)
{
return parent::delete($pk, $children);
}
}
</source>
</span>
<translate>
== Front-end Helloworld Display == 
</translate>

<translate> To display the parent and children on the helloworld page there are 3 changes required:</translate>
<translate>
# In the view, get the data for the parent and for the children using function calls to the model
# In the model provide the data for these function calls
# In the layout output the html which includes the parent and children data.</translate>

<translate> Note that we've changed the model code to allow a parameter to <tt>getItem()</tt>. This has the side-effect of changing the <tt>this->item</tt> variable within the model instance to point to the latest item retrieved. As the functionality within <tt>getMapParams()</tt> (called from <tt>addMap()</tt>) uses <tt>this->item</tt> to get the latitude and longitude etc for the current record, we need to ensure that the call to <tt>addMap()</tt> happens before the new code we're introducing.</translate>

<translate> '''Note.''' If you had a menuitem pointing to your helloworld record which had id=1 then you'll need to edit that menuitem to point to the new id.</translate>

<span id="site/views/helloworld/view.html.php">
<tt>site/views/helloworld/view.html.php</tt>
<source lang="php" highlight="42-46">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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->item = $this->get('Item');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JLog::add(implode('<br />', $errors), JLog::WARNING, 'jerror');

return false;
}

$this->addMap();

$model = $this->getModel();
$this->parentItem = $model->getItem($this->item->parent_id);
$this->children = $model->getChildren($this->item->id);
// getChildren includes the record itself (as well as the children) so remove this record
unset($this->children[0]);

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

function addMap()
{
$document = JFactory::getDocument();

// everything's dependent upon JQuery
JHtml::_('jquery.framework');

// we need the Openlayers JS and CSS libraries
$document->addScript("https://cdnjs.cloudflare.com/ajax/libs/openlayers/4.6.4/ol.js");
$document->addStyleSheet("https://cdnjs.cloudflare.com/ajax/libs/openlayers/4.6.4/ol.css");

// ... and our own JS and CSS
$document->addScript(JURI::root() . "media/com_helloworld/js/openstreetmap.js");
$document->addStyleSheet(JURI::root() . "media/com_helloworld/css/openstreetmap.css");

// get the data to pass to our JS code
$params = $this->get("mapParams");
$document->addScriptOptions('params', $params);
}
}

</source>
</span>

<span id="site/models/helloworld.php">
<tt>site/models/helloworld.php</tt>
<source lang="php" highlight="71,73,75,78-79,184-189">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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');

JLoader::register('HelloworldHelperRoute', JPATH_ROOT . '/components/com_helloworld/helpers/route.php');

/**
* HelloWorld Model
*
* @since 0.0.1
*/
class HelloWorldModelHelloWorld extends JModelItem
{
/**
* @var object item
*/
protected $item;

/**
* Method to auto-populate the model state.
*
* This method should only be called once per instantiation and is designed
* to be called on the first call to the getState() method unless the model
* configuration flag to ignore the request is set.
*
* Note. Calling getState in this method will result in recursion.
*
* @return void
* @since 2.5
*/
protected function populateState()
{
// Get the message id
$jinput = JFactory::getApplication()->input;
$id = $jinput->get('id', 1, 'INT');
$this->setState('message.id', $id);

// Load the parameters.
$this->setState('params', JFactory::getApplication()->getParams());
parent::populateState();
}

/**
* 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);
}

/**
* Get the message
* @return object The message to be displayed to the user
*/
public function getItem($id = null)
{
if (!isset($this->item) || !is_null($id))
{
$id = is_null($id) ? $this->getState('message.id') : $id;
$db = JFactory::getDbo();
$query = $db->getQuery(true);
$query->select('h.greeting, h.params, h.image as image, c.title as category, h.latitude as latitude, h.longitude as longitude,
h.id as id, h.alias as alias, h.catid as catid, h.parent_id as parent_id, h.level as level')
->from('#__helloworld as h')
->leftJoin('#__categories as c ON h.catid=c.id')
->where('h.id=' . (int)$id);

if (JLanguageMultilang::isEnabled())
{
$lang = JFactory::getLanguage()->getTag();
$query->where('h.language IN ("*","' . $lang . '")');
}

$db->setQuery((string)$query);

if ($this->item = $db->loadObject())
{
// Load the JSON string
$params = new JRegistry;
$params->loadString($this->item->params, 'JSON');
$this->item->params = $params;

// Merge global params with item params
$params = clone $this->getState('params');
$params->merge($this->item->params);
$this->item->params = $params;

// Convert the JSON-encoded image info into an array
$image = new JRegistry;
$image->loadString($this->item->image, 'JSON');
$this->item->imageDetails = $image;
}
else
{
throw new Exception('Helloworld id not found', 404);
}
}
return $this->item;
}

public function getMapParams()
{
if ($this->item)
{
$url = HelloworldHelperRoute::getAjaxURL();
$this->mapParams = array(
'latitude' => $this->item->latitude,
'longitude' => $this->item->longitude,
'zoom' => 10,
'greeting' => $this->item->greeting,
'ajaxurl' => $url
);
return $this->mapParams;
}
else
{
throw new Exception('No helloworld details available for map', 500);
}
}

public function getMapSearchResults($mapbounds)
{
try
{
$db = JFactory::getDbo();
$query = $db->getQuery(true);
$query->select('h.id, h.alias, h.catid, h.greeting, h.latitude, h.longitude')
->from('#__helloworld as h')
->where('h.latitude > ' . $mapbounds['minlat'] .
' AND h.latitude < ' . $mapbounds['maxlat'] .
' AND h.longitude > ' . $mapbounds['minlng'] .
' AND h.longitude < ' . $mapbounds['maxlng']);

if (JLanguageMultilang::isEnabled())
{
$lang = JFactory::getLanguage()->getTag();
$query->where('h.language IN ("*","' . $lang . '")');
}

$db->setQuery($query);
$results = $db->loadObjectList();
}
catch (Exception $e)
{
$msg = $e->getMessage();
JFactory::getApplication()->enqueueMessage($msg, 'error');
$results = null;
}

if (JLanguageMultilang::isEnabled())
{
$query_lang = "&lang={$lang}";
}
else
{
$query_lang = "";
}

for ($i = 0; $i < count($results); $i++)
{
$results[$i]->url = JRoute::_('index.php?option=com_helloworld&view=helloworld&id=' . $results[$i]->id .
":" . $results[$i]->alias . '&catid=' . $results[$i]->catid . $query_lang);
}

return $results;
}

public function getChildren($id)
{
$table = $this->getTable();
$children = $table->getTree($id);
return $children;
}
}

</source>
</span>

<span id="site/views/helloworld/tmpl/default.php">
<tt>site/views/helloworld/tmpl/default.php</tt>
<source lang="php" highlight="12-20,38-59">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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');
$lang = JFactory::getLanguage()->getTag();
if (JLanguageMultilang::isEnabled() && $lang)
{
$query_lang = "&lang={$lang}";
}
else
{
$query_lang = "";
}
?>
<h1><?php echo $this->item->greeting.(($this->item->category and $this->item->params->get('show_category'))
? (' ('.$this->item->category.')') : ''); ?>
</h1>
<?php
$src = $this->item->imageDetails['image'];
if ($src)
{
$html = '<figure>
<img src="%s" alt="%s" >
<figcaption>%s</figcaption>
</figure>';
$alt = $this->item->imageDetails['alt'];
$caption = $this->item->imageDetails['caption'];
echo sprintf($html, $src, $alt, $caption);
} ?>

<?php if ($this->parentItem->id > 1) : ?>
<h1><?php echo JText::_('COM_HELLOWORLD_PARENT') ?>
</h1>
<h3>
<?php $url = JRoute::_('index.php?option=com_helloworld&view=helloworld&id=' . $this->parentItem->id . ':' . $this->parentItem->alias . '&catid=' . $this->parentItem->catid . $query_lang); ?>
<a href="<?php echo $url; ?>"><?php echo $this->parentItem->greeting; ?></a>
</h3>
<?php endif; ?>

<?php if ($this->children) :
$baseLevel = $this->item->level; ?>
<h1><?php echo JText::_('COM_HELLOWORLD_CHILDREN') ?>
</h1>
<?php foreach ($this->children as $i => $child) : ?>
<h3>
<?php $prefix = JLayoutHelper::render('joomla.html.treeprefix', array('level' => $child->level - $baseLevel)); ?>
<?php echo $prefix; ?>
<?php $url = JRoute::_('index.php?option=com_helloworld&view=helloworld&id=' . $child->id . ':' . $child->alias . '&catid=' . $child->catid . $query_lang); ?>
<a href="<?php echo $url; ?>"><?php echo $child->greeting; ?></a>
</h3>
<?php endforeach; ?>
<?php endif; ?>

<div id="map" class="map"></div>
<div class="map-callout map-callout-bottom" id="greeting-container"></div>
<div id="searchmap">
<?php echo '<input id="token" type="hidden" name="' . JSession::getFormToken() . '" value="1" />'; ?>
<button type="button" class="btn btn-primary" onclick="searchHere();">
<?php echo JText::_('COM_HELLOWORLD_SEARCH_HERE_BUTTON') ?>
</button>
<div id="searchresults">
</div>
</div>
</source>
</span>

<translate>
== Helloworld Frontend Form == 
</translate>

<translate> To support capturing the parent in the frontend form we reuse the admin custom form field in the add-form xml definition.</translate>

<translate> Note that in the functionality for creating a new helloworld record on the frontend we haven't included a table <tt>rebuild()</tt> so new records fail to get the <tt>path</tt> field written in the database. However the new record will get inserted into the tree correctly because the front end uses the admin backend table code, and so it will pick up the inheritance of the Nested Table, with its <tt>bind()</tt> override etc. This means too that we should remove the code in the model <tt>prepareTable()</tt> which previously defined the ordering of the new record.</translate>

<span id="site/models/forms/add-form.xml">
<tt>site/models/forms/add-form.xml</tt>
<source lang="xml" highlight="4,113-120">
<?xml version="1.0" encoding="utf-8"?>
<form
addrulepath="/administrator/components/com_helloworld/models/rules"
addfieldpath="/administrator/components/com_helloworld/models/fields"
>
<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"
required="true"
hint="COM_HELLOWORLD_HELLOWORLD_GREETING_HINT"
default=""
/>
<field
name="alias"
type="text"
label="JFIELD_ALIAS_LABEL"
description="JFIELD_ALIAS_DESC"
hint="JFIELD_ALIAS_PLACEHOLDER"
size="40"
/>
<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>
<fields name="imageinfo" label="COM_HELLOWORLD_HELLOWORLD_IMAGE_LABEL">
<field
name="image"
type="file"
label="COM_HELLOWORLD_HELLOWORLD_PICTURE_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_PICTURE_DESC"
accept="image/*"
>
</field>
<field
name="caption"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_CAPTION_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_CAPTION_DESC"
size="40"
class="inputbox"
>
</field>
<field
name="alt"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_ALTTEXT_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_ALTTEXT_DESC"
size="40"
class="inputbox"
>
</field>
</fields>
<field
name="language"
type="contentlanguage"
label="JFIELD_LANGUAGE_LABEL"
description="JFIELD_LANGUAGE_DESC"
class="inputbox">
</field>
<field
name="message"
type="textarea"
rows="5"
cols="80"
label="COM_HELLOWORLD_HELLOWORLD_MESSAGE_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_MESSAGE_DESC"
hint="COM_HELLOWORLD_HELLOWORLD_MESSAGE_HINT"
required="true"
>
</field>
<field
name="captcha"
type="captcha"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTCHA_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTCHA_DESC"
validate="captcha"
>
</field>
<fields name="params">
<field
name="show_category"
type="list"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_DESC"
default=""
useglobal="true"
>
<option value="0">JHIDE</option>
<option value="1">JSHOW</option>
</field>
</fields>
<field
name="parent_id"
type="helloworldparent"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_DESC"
default="1"
filter="int">
</field>
</fieldset>
</form>

</source>
</span>

<span id="site/models/form.php">
<tt>site/models/form.php</tt>
<source lang="php" highlight="104-105">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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 HelloWorldModelForm 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.form',
'add-form',
array(
'control' => 'jform',
'load_data' => $loadData
)
);

if (empty($form))
{
$errors = $this->getErrors();
throw new Exception(implode("\n", $errors), 500);
}

return $form;
}

/**
* Method to get the data that should be injected in the form.
* As this form is for add, we're not prefilling the form with an existing record
* But if the user has previously hit submit and the validation has found an error,
* then we inject what was previously entered.
*
* @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()
);

return $data;
}

/**
* Method to get the script that have to be included on the form
* This returns the script associated with helloworld field greeting validation
*
* @return string Script files
*/
public function getScript()
{
return 'administrator/components/com_helloworld/models/forms/helloworld.js';
}

/**
* Prepare a helloworld record for saving in the database
*/
protected function prepareTable($table)
{
}
}
</source>
</span>

<translate>
== Frontend Category View == 
</translate>

<translate> We just have to change the ordering to use the <tt>lft</tt> database field instead of the <tt>ordering</tt> field.</translate>

<span id="site/models/category.php">
<tt>site/models/category.php</tt>
<source lang="php" highlight="18,51">
<?php
/**
* Model for displaying the helloworld messages in a given category
*/

defined('_JEXEC') or die;

class HelloworldModelCategory extends JModelList
{
public function __construct($config = array())
{
if (empty($config['filter_fields']))
{
$config['filter_fields'] = array(
'id',
'greeting',
'alias',
'lft',
);
}

parent::__construct($config);
}

protected function populateState($ordering = null, $direction = null)
{
parent::populateState($ordering, $direction);

$app = JFactory::getApplication('site');
$catid = $app->input->getInt('id');

$this->setState('category.id', $catid);
}

protected function getListQuery()
{
$db = JFactory::getDbo();
$query = $db->getQuery(true);

$catid = $this->getState('category.id');
$query->select('id, greeting, alias, catid')
->from($db->quoteName('#__helloworld'))
->where('catid = ' . $catid);

if (JLanguageMultilang::isEnabled())
{
$lang = JFactory::getLanguage()->getTag();
$query->where('language IN ("*","' . $lang . '")');
}

$orderCol = $this->state->get('list.ordering', 'lft');
$orderDirn = $this->state->get('list.direction', 'asc');

$query->order($db->escape($orderCol) . ' ' . $db->escape($orderDirn));

return $query;
}

public function getCategoryName()
{
$catid = $this->getState('category.id');
$categories = JCategories::getInstance('Helloworld', array());
$categoryNode = $categories->get($catid);
return $categoryNode->title;
}

public function getSubcategories()
{
$catid = $this->getState('category.id');
$categories = JCategories::getInstance('Helloworld', array());
$categoryNode = $categories->get($catid);
$subcats = $categoryNode->getChildren();

$lang = JFactory::getLanguage()->getTag();
if (JLanguageMultilang::isEnabled() && $lang)
{
$query_lang = "&lang={$lang}";
}
else
{
$query_lang = '';
}

foreach ($subcats as $subcat)
{
$subcat->url = JRoute::_("index.php?view=category&id=" . $subcat->id . $query_lang);
}
return $subcats;
}
}
</source>
</span>

<span id="site/models/forms/filter_category.xml">
<tt>site/models/forms/filter_category.xml</tt>
<source lang="xml" highlight="8,11-12">
<?xml version="1.0" encoding="utf-8"?>
<form>
<fields name="list">
<field
name="fullordering"
type="list"
onchange="this.form.submit();"
default="lft ASC"
>
<option value="">COM_HELLOWORLD_SORT_BY</option>
<option value="lft ASC">COM_HELLOWORLD_ORDERING_ASC</option>
<option value="lft DESC">COM_HELLOWORLD_ORDERING_DESC</option>
<option value="greeting ASC">COM_HELLOWORLD_GREETING_ASC</option>
<option value="greeting DESC">COM_HELLOWORLD_GREETING_DESC</option>
<option value="id ASC">COM_HELLOWORLD_ID_ASC</option>
<option value="id DESC">COM_HELLOWORLD_ID_DESC</option>
<option value="alias ASC">COM_HELLOWORLD_ALIAS_ASC</option>
<option value="alias DESC">COM_HELLOWORLD_ALIAS_DESC</option>
</field>
<field
name="limit"
type="limitbox"
class="input-mini"
default="10"
onchange="this.form.submit();"
/>
</fields>
</form>
</source>
</span>
<translate>
== Updated Language Strings == 
</translate>

<span id="site/language/en-GB/en-GB.com_helloworld.ini">
<tt>site/language/en-GB/en-GB.com_helloworld.ini</tt>
<source lang="text" highlight="25-26,37-38">
; add new message form
COM_HELLOWORLD_LEGEND_DETAILS="New Helloworld Message Details"
COM_HELLOWORLD_HELLOWORLD_CREATING="Add message"
COM_HELLOWORLD_HELLOWORLD_ERROR_UNACCEPTABLE="Sorry, you have an error"
COM_HELLOWORLD_HELLOWORLD_DETAILS="Message details"
COM_HELLOWORLD_HELLOWORLD_GREETING_LABEL="Greeting"
COM_HELLOWORLD_HELLOWORLD_GREETING_DESC="Please specify the greeting to add"
COM_HELLOWORLD_HELLOWORLD_GREETING_HINT="Any characters allowed"
COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_LABEL="Category"
COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_DESC="Please select the associated category"
COM_HELLOWORLD_HELLOWORLD_MESSAGE_LABEL="Reason"
COM_HELLOWORLD_HELLOWORLD_MESSAGE_DESC="Please say why you're adding this greeting"
COM_HELLOWORLD_HELLOWORLD_MESSAGE_HINT="No HTML tags!"
COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTCHA_LABEL="Spam protection"
COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTCHA_DESC="Prove you're a real person!"
COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_LABEL="Display category or not?"
COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_DESC="Select if you want the category displayed too"
COM_HELLOWORLD_HELLOWORLD_IMAGE_LABEL="Image information"
COM_HELLOWORLD_HELLOWORLD_PICTURE_LABEL="Image file to upload"
COM_HELLOWORLD_HELLOWORLD_PICTURE_DESC="Select the file with the image to upload"
COM_HELLOWORLD_HELLOWORLD_CAPTION_LABEL="Caption"
COM_HELLOWORLD_HELLOWORLD_CAPTION_DESC="Text to use as a caption for the image"
COM_HELLOWORLD_HELLOWORLD_ALTTEXT_LABEL="Alt text"
COM_HELLOWORLD_HELLOWORLD_ALTTEXT_DESC="Text to display if image cannot be shown"
COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_LABEL="Parent"
COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_DESC="Select the record which is to be the parent"
; save and cancel confirmation messages
COM_HELLOWORLD_ADD_SUCCESSFUL="New greeting successfully saved"
COM_HELLOWORLD_ADD_CANCELLED="New greeting cancelled ok"
; file upload error conditions
COM_HELLOWORLD_ERROR_FILEUPLOAD="PHP Error %s encountered when uploading file"
COM_HELLOWORLD_ERROR_FILETOOLARGE="Upload file exceeds max size configured in Joomla"
COM_HELLOWORLD_ERROR_BADFILENAME="Upload file has an invalid filename"
COM_HELLOWORLD_ERROR_FILE_EXISTS="Upload file already exists"
COM_HELLOWORLD_ERROR_UNABLE_TO_UPLOAD_FILE="Error creating uploaded file"
; helloworld greeting page
COM_HELLOWORLD_PARENT="Parent"
COM_HELLOWORLD_CHILDREN="Children"
COM_HELLOWORLD_SEARCH_HERE_BUTTON="Search here"
; Ajax handling errors
COM_HELLOWORLD_ERROR_NO_RECORDS="Didn't get any records"
COM_HELLOWORLD_ERROR_NO_MAP_BOUNDS="Error: no map bounds"
; category view, search and ordering fields and headings
COM_HELLOWORLD_SORT_BY="Sort by ..."
COM_HELLOWORLD_ORDERING_ASC="Ordering asc"
COM_HELLOWORLD_ORDERING_DESC="Ordering desc"
COM_HELLOWORLD_GREETING_ASC="Greeting asc"
COM_HELLOWORLD_GREETING_DESC="Greeting desc"
COM_HELLOWORLD_ID_ASC="id asc"
COM_HELLOWORLD_ID_DESC="id desc"
COM_HELLOWORLD_ALIAS_ASC="alias asc"
COM_HELLOWORLD_ALIAS_DESC="alias desc"
COM_HELLOWORLD_HELLOWORLD_ALIAS_LABEL="Alias"
COM_HELLOWORLD_HELLOWORLD_FIELD_URL_LABEL="URL"
COM_HELLOWORLD_HEADER_SUBCATEGORIES="Subcategories"
</source>
</span>

<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="34-38">
; Joomla! Project
; Copyright (C) 2005 - 2018 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_AUTHOR="Author"
COM_HELLOWORLD_LANGUAGE="Language"
COM_HELLOWORLD_CREATED_DATE="Created"
COM_HELLOWORLD_PUBLISHED="Published"
COM_HELLOWORLD_HELLOWORLDS_NAME="Name"
COM_HELLOWORLD_HELLOWORLDS_POSITION="Position"
COM_HELLOWORLD_HELLOWORLDS_IMAGE="Image"
COM_HELLOWORLD_HELLOWORLDS_ASSOCIATIONS="Associations"
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_FIELD_LATITUDE_LABEL="Latitude"
COM_HELLOWORLD_HELLOWORLD_FIELD_LATITUDE_DESC="Enter the position latitude, between -90 and +90 degrees"
COM_HELLOWORLD_HELLOWORLD_FIELD_LONGITUDE_LABEL="Longitude"
COM_HELLOWORLD_HELLOWORLD_FIELD_LONGITUDE_DESC="Enter the position longitude, between -180 and +180 degrees"
COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_LABEL="Parent"
COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_DESC="Select the parent record"
COM_HELLOWORLD_ITEM_FIELD_ORDERING_VALUE_FIRST="-- First record"
COM_HELLOWORLD_ITEM_FIELD_ORDERING_VALUE_LAST="-- Last record"
COM_HELLOWORLD_ITEM_FIELD_ORDERING_TEXT="Ordering will be available after saving."
COM_HELLOWORLD_HELLOWORLD_FIELD_LANGUAGE_DESC="Select the appropriate language"
COM_HELLOWORLD_IMAGE_FIELDS="Image details"
COM_HELLOWORLD_HELLOWORLD_FIELD_IMAGE_LABEL="Select image"
COM_HELLOWORLD_HELLOWORLD_FIELD_IMAGE_DESC="Select an image from the library, or upload a new one"
COM_HELLOWORLD_HELLOWORLD_FIELD_ALT_LABEL="Alt text"
COM_HELLOWORLD_HELLOWORLD_FIELD_ALT_DESC="Alternative text (if image cannot be displayed)"
COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTION_LABEL="Caption"
COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTION_DESC="Provide a caption for the image"
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_HELLOWORLD_FIELD_CAPTCHA_LABEL="Captcha"
COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTCHA_DESC="Select Captcha to use on front end form"
COM_HELLOWORLD_HELLOWORLD_FIELD_USER_TO_EMAIL_LABEL="User to email"
COM_HELLOWORLD_HELLOWORLD_FIELD_USER_TO_EMAIL_DESC="Select user to email when a new message is entered on front end"
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?"
COM_HELLOWORLD_TAB_NEW_MESSAGE="New Message"
COM_HELLOWORLD_TAB_EDIT_MESSAGE="Message Details"
COM_HELLOWORLD_TAB_PARAMS="Parameters"
COM_HELLOWORLD_TAB_ASSOCIATIONS="Associations"
COM_HELLOWORLD_TAB_PERMISSIONS="Permissions"
COM_HELLOWORLD_TAB_IMAGE="Image"
COM_HELLOWORLD_LEGEND_DETAILS="Message Details"
COM_HELLOWORLD_LEGEND_PARAMS="Message Parameters"
COM_HELLOWORLD_LEGEND_ASSOCIATIONS="Message Associations"
COM_HELLOWORLD_LEGEND_PERMISSIONS="Message Permissions"
COM_HELLOWORLD_LEGEND_IMAGE="Image info"
; Column ordering in the Helloworlds view
COM_HELLOWORLD_ORDERING_ASC="Ordering ascending"
COM_HELLOWORLD_ORDERING_DESC="Ordering descending"
COM_HELLOWORLD_GREETING_ASC="Greeting ascending"
COM_HELLOWORLD_GREETING_DESC="Greeting descending"
COM_HELLOWORLD_AUTHOR_ASC="Author ascending"
COM_HELLOWORLD_AUTHOR_DESC="Author descending"
COM_HELLOWORLD_CREATED_ASC="Creation date ascending"
COM_HELLOWORLD_CREATED_DESC="Creation date descending"
COM_HELLOWORLD_PUBLISHED_ASC="Unpublished first"
COM_HELLOWORLD_PUBLISHED_DESC="Published first"
COM_HELLOWORLD_LANGUAGE_ASC="Language ascending"
COM_HELLOWORLD_LANGUAGE_DESC="Language descending"
COM_HELLOWORLD_ASSOCIATION_ASC="Association ascending"
COM_HELLOWORLD_ASSOCIATION_DESC="Association descending"
; Helloworld menuitem - selecting a greeting via modal
COM_HELLOWORLD_MENUITEM_SELECT_MODAL_TITLE="Select greeting"
COM_HELLOWORLD_MENUITEM_SELECT_HELLOWORLD="Select"
COM_HELLOWORLD_MENUITEM_SELECT_BUTTON_TOOLTIP="Select a helloworld greeting"
; Checking in records
COM_HELLOWORLD_N_ITEMS_CHECKED_IN_0="No records checked in."
COM_HELLOWORLD_N_ITEMS_CHECKED_IN_1="%d record successfully checked in."
COM_HELLOWORLD_N_ITEMS_CHECKED_IN_MORE="%d records successfully checked in."
</source>
</span>
<translate>
== Packaging the Component == 
</translate>

<translate> Contents of your code directory. Each file link below takes you to the step in the tutorial which has the latest version of that source code file.</translate>

* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#helloworld.xml|helloworld.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#script.php|script.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#site/router.php|site/router.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_a_view_to_the_site_part#site/helloworld.php|site/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding AJAX#site/controller.php|site/controller.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_an_Image#site/controllers/helloworld.php|site/controllers/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding AJAX#site/views/helloworld/view.json.php|site/views/helloworld/view.json.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding a Modal#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/form/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using the language filter facility#site/views/form/view.html.php|site/views/form/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/form/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_an_Image#site/views/form/tmpl/edit.php|site/views/form/tmpl/edit.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_a_front-end_form#site/views/form/tmpl/edit.xml|site/views/form/tmpl/edit.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/category/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using the language filter facility#site/views/category/view.html.php|site/views/category/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/category/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using the language filter facility#site/views/category/tmpl/default.php|site/views/category/tmpl/default.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding an alias#site/views/category/tmpl/default.xml|site/views/category/tmpl/default.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/models/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#site/models/form.php|site/models/form.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#site/models/category.php|site/models/category.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/models/forms/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#site/models/forms/add-form.xml|site/models/forms/add-form.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#site/models/forms/filter_category.xml|site/models/forms/filter_category.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/language/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/language/en-GB/index.html]]''
* ''[[S:MyLanguage/J3.x:Developing an MVC Component/Adding Levels#site/language/en-GB/en-GB.com_helloworld.ini|site/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/helpers/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using the language filter facility#site/helpers/route.php|site/helpers/route.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using the language filter facility#site/helpers/category.php|site/helpers/category.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#site/helpers/association.php|site/helpers/association.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_ACL#admin/helloworld.php|admin/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_ACL#admin/config.xml|admin/config.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Basic_backend#admin/controller.php|admin/controller.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_ACL#admin/access.xml|admin/access.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_categories#admin/helpers/helloworld.php|admin/helpers/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#admin/helpers/associations.php|admin/helpers/associations.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/helpers/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#admin/helpers/html/helloworlds.php|admin/helpers/html/helloworlds.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/helpers/html/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using_the_database#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[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]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_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_an_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_an_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_an_MVC_Component/Adding_a_front-end_form#admin/sql/updates/mysql/0.0.16.sql|admin/sql/updates/mysql/0.0.16.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_an_Image#admin/sql/updates/mysql/0.0.17.sql|admin/sql/updates/mysql/0.0.17.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding a Map#admin/sql/updates/mysql/0.0.18.sql|admin/sql/updates/mysql/0.0.18.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding an alias#admin/sql/updates/mysql/0.0.20.sql|admin/sql/updates/mysql/0.0.20.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using the language filter facility#admin/sql/updates/mysql/0.0.21.sql|admin/sql/updates/mysql/0.0.21.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Checkout#admin/sql/updates/mysql/0.0.24.sql|admin/sql/updates/mysql/0.0.24.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Ordering#admin/sql/updates/mysql/0.0.25.sql|admin/sql/updates/mysql/0.0.25.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/sql/updates/mysql/0.0.26.sql|admin/sql/updates/mysql/0.0.26.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_categories#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/models/fields/helloworldordering.php|admin/models/fields/helloworldordering.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/models/fields/helloworldparent.php|admin/models/fields/helloworldparent.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/modal/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#admin/models/fields/modal/helloworld.php|admin/models/fields/modal/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/models/helloworld.php|admin/models/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/models/forms/filter_helloworlds.xml|admin/models/forms/filter_helloworlds.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/forms/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding an alias#admin/models/forms/helloworld.js|admin/models/forms/helloworld.js]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/models/forms/helloworld.xml|admin/models/forms/helloworld.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding an alias#admin/models/rules/greeting.php|admin/models/rules/greeting.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/rules/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_ACL#admin/controllers/helloworld.php|admin/controllers/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_backend_actions#admin/controllers/helloworlds.php|admin/controllers/helloworlds.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/controllers/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworld/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_ACL#admin/views/helloworld/view.html.php|admin/views/helloworld/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworld/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#admin/views/helloworld/tmpl/edit.php|admin/views/helloworld/tmpl/edit.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_verifications#admin/views/helloworld/submitbutton.js|admin/views/helloworld/submitbutton.js]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#admin/views/helloworlds/tmpl/modal.php|admin/views/helloworlds/tmpl/modal.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/tables/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/tables/helloworld.php|admin/tables/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/language/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/language/en-GB/index.html]]''
* ''[[S:MyLanguage/J3.x:Developing an MVC Component/Adding Levels#admin.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.ini|admin/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[S:MyLanguage/J3.x:Developing an MVC Component/Adding Associations#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_an_MVC_Component/Developing_a_Basic_Component#index.html|media/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|media/images/index.html]]''
* ''[[S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_decorations_to_the_backend#Adding_some_icons|media/images/tux-16x16.png]]''
* ''[[S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_decorations_to_the_backend#Adding_some_icons|media/images/tux-48x48.png]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|media/js/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding an alias#media/js/openstreetmap.js|media/js/openstreetmap.js]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding a Modal#media/js/admin-helloworlds-modal.js|media/js/admin-helloworlds-modal.js]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|media/css/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding a Map#index.html|media/css/openstreetmap.css]]''

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

<name>COM_HELLOWORLD</name>

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

<description>COM_HELLOWORLD_DESCRIPTION</description>


<scriptfile>script.php</scriptfile>

<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>
<filename>router.php</filename>
<folder>controllers</folder>
<folder>views</folder>
<folder>models</folder>
<folder>helpers</folder>
</files>

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

<media destination="com_helloworld" folder="media">
<filename>index.html</filename>
<folder>images</folder>
<folder>js</folder>
<folder>css</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>
<language tag="fr-FR">fr-FR/fr-FR.com_helloworld.ini</language>
<language tag="fr-FR">fr-FR/fr-FR.com_helloworld.sys.ini</language>
</languages>
</administration>

</extension>
</source>
</span>
<translate>
== Contributors == 
</translate>
*[[User:Robbiej|Robbie Jackson]]

<div class="row">
<div class="large-6 columns">{{Basic button|S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding Ordering|<translate> Prev: Adding Ordering</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding Versioning|<translate> Next: Adding Versioning</translate>|class=expand}}</div>
</div>
__NOTOC__
<noinclude>
[[Category:Joomla! 3.x{{#translation:}}]]
[[Category:Joomla! 3.0{{#translation:}}]]
[[Category:Joomla! 3.1{{#translation:}}]]
[[Category:Joomla! 3.2{{#translation:}}]]
[[Category:Joomla! 3.3{{#translation:}}]]
[[Category:Joomla! 3.4{{#translation:}}]]
[[Category:Beginner Development{{#translation:}}]]
[[Category:Component Development{{#translation:}}]]
[[Category:Tutorials{{#translation:}}]]
[[Category:Tutorials in a Series{{#translation:}}]]
</noinclude>

J3.x:Developing an MVC Component/Adding Access

2020-03-20T17:37:04Z

ThiagoG: published column added since https://docs.joomla.org/J3.x:Developing_an_MVC_Component/Adding_Levels as we can't publish items without having our helloworld root record published.

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

en</translate>}}

<translate> This tutorial is part of the [[S:MyLanguage/J3.2:Developing an MVC Component | Developing an MVC Component for Joomla! 3.2]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.</translate>

<translate> In this step we add access capability to our component, which allows us to restrict the set of users who can view our helloworld data. This step really fits before [[S:MyLanguage/J3.x:Developing an MVC Component/Adding ACL|Adding ACL]], but is added belatedly for completeness here.</translate>

<translate> There is a video accompanying this step (which was originally produced at the same time as the other videos for ACL) available at [https://youtu.be/CS_Ok1t550E Access Levels].</translate>

{{#widget:YouTube|id=CS_Ok1t550E}}

<translate>
== Introduction == 
</translate>
<translate> If you're not familiar with Access within Joomla, then it's worthwhile playing around with the functionality – setting access on menuitems and articles, setting the accesslevels of user groups (and hence of users), and confirming that users can see only the items to which they have been granted access. This works on both the site front end, and the admin back end.</translate>
<translate>

The diagram shows how Joomla user access levels work.</translate>
[[File:joomla-access-levels.jpg|right|Joomla Access Levels]]

<translate> Each item – eg an article, a menuitem, or in our case a helloworld record – has an access level assigned.</translate>

<translate> Each user is assigned one or more user groups, and user groups have a hierarchical (tree) structure, so that if a user belongs to a user group which is a child of another, then that user is also a member of the parent user group.</translate>
<translate>

Each access level has one more associated user groups, who will then have view access to items which have that access level.</translate>

<translate>
When the user requests to view a particular item, then the functionality
# obtains the set of accesslevels that the user has
# checks if the accesslevel of the requested item is within the set of accesslevels of that user
# if it is, then the item is presented to the user
# if it isn't, then an HTTP response with status 403 (forbidden) is returned.</translate>

<translate>
== Approach == 
</translate>

<translate>
=== Database Changes === 
</translate>
<translate> To enable us to have an Access Level against a helloworld record, we need to specify a new field in the database, which we'll call "access". We'll set the database default value of this access field to be 0, however in the <tt>JTable</tt> constructor there is code which looks for a database field called "access" and if it finds it then it sets the default value of the <tt>access</tt> property in the <tt>JTable</tt> object to have the value specified in the global config (in configuration.php). So we use this mechanism to align with what an administrator would want to have as the default access across the Joomla website.</translate>

<translate> However, for those helloworld records already present in the database, we don't want to have the access field set to 0 (the SQL default), so after altering the table to introduce the new access field we must update those records. Ideally we should use an install script and perform a SQL UPDATE to set <tt>access</tt> to <tt>JFactory::getConfig()->get('access')</tt>, but for simplicity we just use a SQL UPDATE statement to set it to 1 (ie public access).</translate>

<translate> We also have a change to our content_types field mapping, as described below.</translate>
<translate>
=== Admin back end changes === 
</translate>
<translate> To enable the administrator to set this field, we will add an Access field within the back-end edit form, and we use the "[[S:MyLanguage/Accesslevel form field type|accesslevel]]" field type within the Joomla [[S:MyLanguage/Standard form field types|standard form field types]]. As is often the case, this field will get automatically saved to the "access" field in the database by our existing code.</translate>

<translate> On our administrator helloworlds view we'll add a column to display the Access Level assigned to that item. As this should be displayed as a string rather than the int value in the helloworld record, we have to do a SQL JOIN find the associated title of the access level from where they're stored in the viewlevels record.</translate>

<translate> We will make this column sortable, so we must include options for it in the filter fields xml file and in the helloworlds model.</translate>

<translate> We also want to restrict the administrator to only those helloworld records that he/she has access to view, so this will involve a filter within the SQL query in our model.</translate>

<translate> The key Joomla method which we use to find the accesslevels which a user has is <tt>JUser::getAuthorisedViewLevels()</tt>, and for a user to be allowed to view an item, the item's accesslevel must be within the array of accesslevels returned by <tt>getAuthorisedViewLevels()</tt>. This is true for both front end and back end.</translate>

<translate> We will also follow the pattern in Joomla, which specifies that to view an item the user must have access to both the item itself and to the category (if any) associated with the item. Joomla already allows us to set an accesslevel against a category, and where categories are being displayed (both on front end and back end) it filters them to show only those which the user is entitled to see. However, we must write the code in the case where we're displaying helloworld records, to check that the user is entitled to view the associated category as well.</translate>

<translate>
=== Frontend changes === 
</translate>

<translate> On the front end we have pages where we display a single helloworld record (our Hello World menuitem) and others where we display a list of records (Category view, our Ajax response to the Search here on the map, and functionality developed in [[S:MyLanguage/J3.x:Developing an MVC Component/Adding Levels|Adding Levels]] to output a list of children of a helloworld record). What if the visitor to the site doesn't have access to view a record? In this case we could return an error 403 (forbidden) for a single record, and avoid including an inaccessible record in a list.</translate>

<translate> However, the user may actually have access to the record and the problem is that he/she just hasn't logged in yet. So we'll make it a bit more sophisticated, and check if the user is currently logged in, and adopt the following approach (which reflects the various strategies you might consider for an actual component):</translate>

<translate> If the user is logged in then</translate>
<translate>
* for the Hello World menuitem, if the user doesn't have access then we'll provide an HTTP status 403 (forbidden) and an error message.
* for the Category list and Ajax list, if a record can't be accessed then we'll omit it from the list.
* for the list of children, we'll just output all the records anyway.</translate>

<translate> If the user isn't logged in then</translate>
<translate>
* for the Hello World menuitem, if the user doesn't have access then we'll provide a notice and a redirect to the login form.
* for the Category list, if a record can't be accessed we'll still include it in the list, but add a message to the record prompting the user to login.
* for the Ajax list we'll just display the record's link as normal – when the user clicks on it then the action above for the Hello World menuitem will be taken.
* for the list of children, we'll just output all the records anyway.</translate>

<translate> To find if the user is logged in we use <tt>JFactory::getUser()->get('guest')</tt> which returns 1 if just a guest on the site, ie not logged in, and returns 0 if the user is logged in.</translate>

<translate> The split of functionality we'll adopt is:</translate>

<translate>
Hello World menuitem:
* Model: determine if the user has access to the record
* View: if the user doesn't have access then display an error (with a redirect to login) or a notice (with a redirect to login) depending upon whether the user is logged in or not.</translate>

<translate> Category list:</translate>
<translate>
* Model: we'll post-process the items returned from the query, and for those where the user doesn't have access we'll remove them if the user is logged in, or set a "no-access" flag if the user isn't logged in
* Layout: we'll display the record differently if the no-access flag is set</translate>

<translate> Ajax list:</translate>
<translate> * If the user is logged in, then we'll change the SQL query to omit records the user doesn't have access to, but continue to return all the records if the user isn't logged in.</translate>

<translate> List of children:</translate>
<translate> * no change - all the records will be returned regardless of whether the user has access or not.</translate>

<translate> Finally, as helloworld records may be viewed (to a certain extent) via the tags functionality, we update our field mappings so that our access field is copied into the ucm_content table core_access field. This means that the same restrictions will apply to viewing both the helloworld record and its copy in the ucm_content table.</translate>

<translate> (If we didn't copy the field into ucm_content then Joomla's tag functionality would store the default of 0 in its core_access field. The JTable constructor doesn't set the global config access value here because the ucm_content field is called "core_access" rather than "access". Whenever Joomla's com_tags component displays the records having a particular tag, it always includes records with a core_access of 0, and hence would show helloworld records which the user couldn't access, so that when the user clicked on them then the user would receive the "no access" notification).</translate>

<translate> In the previous step we needed to set a published field in the front end form to get the default value of 1 carried through to the ucm_content table. However, we don't need to do the same for the access field, because of the way the JTable constructor sets the default value into the JTable object.</translate>

<translate>
== Database == 
</translate>
<translate> We add our new access field to the helloworld record, and include this in the set of fields which are mapped to the ucm_content copy.</translate>

<span id="admin/sql/updates/mysql/0.0.29.sql">
<tt>admin/sql/updates/mysql/0.0.29.sql</tt>
<source lang="sql">
ALTER TABLE `#__helloworld` ADD COLUMN `access` tinyint(4) NOT NULL DEFAULT '0' AFTER `published`;
UPDATE `#__helloworld` SET `access` = 1;

UPDATE `#__content_types` SET
`field_mappings` =
'{"common": {
"core_content_item_id": "id",
"core_title": "greeting",
"core_state": "published",
"core_alias": "alias",
"core_language":"language",
"core_created_time": "created",
"core_body": "description",
"core_access": "access",
"core_catid": "catid"
}}'
WHERE `type_alias` = 'com_helloworld.helloworld';
</source>
</span>

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

CREATE TABLE `#__helloworld` (
`id` INT(11) NOT NULL AUTO_INCREMENT,
`asset_id` INT(10) NOT NULL DEFAULT '0',
`created` DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
`created_by` INT(10) UNSIGNED NOT NULL DEFAULT '0',
`checked_out` INT(10) NOT NULL DEFAULT '0',
`checked_out_time` DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
`greeting` VARCHAR(25) NOT NULL,
`description` VARCHAR(4000) NOT NULL DEFAULT '',
`alias` VARCHAR(40) NOT NULL DEFAULT '',
`language` CHAR(7) NOT NULL DEFAULT '*',
`parent_id` int(10) NOT NULL DEFAULT '1',
`level` int(10) NOT NULL DEFAULT '0',
`path` VARCHAR(400) NOT NULL DEFAULT '',
`lft` int(11) NOT NULL DEFAULT '0',
`rgt` int(11) NOT NULL DEFAULT '0',
`published` tinyint(4) NOT NULL DEFAULT '1',
`access` tinyint(4) NOT NULL DEFAULT '0',
`catid` int(11) NOT NULL DEFAULT '0',
`params` VARCHAR(1024) NOT NULL DEFAULT '',
`image` VARCHAR(1024) NOT NULL DEFAULT '',
`latitude` DECIMAL(9,7) NOT NULL DEFAULT 0.0,
`longitude` DECIMAL(10,7) NOT NULL DEFAULT 0.0,
PRIMARY KEY (`id`)
)
ENGINE =MyISAM
AUTO_INCREMENT =0
DEFAULT CHARSET =utf8;

CREATE UNIQUE INDEX `aliasindex` ON `#__helloworld` (`alias`, `catid`);

INSERT INTO `#__helloworld` (`greeting`,`alias`,`language`, `parent_id`, `level`, `path`, `lft`, `rgt`, `published`) VALUES
('helloworld root','helloworld-root-alias','en-GB', 0, 0, '', 0, 5, 1),
('Hello World!','hello-world','en-GB', 1, 1, 'hello-world', 1, 2, 0),
('Goodbye World!','goodbye-world','en-GB', 1, 1, 'goodbye-world', 3, 4, 0);

INSERT INTO `#__content_types` (`type_title`, `type_alias`, `content_history_options`, `table`, `field_mappings`, `router`)
VALUES
('Helloworld', 'com_helloworld.helloworld',
'{"formFile":"administrator\\/components\\/com_helloworld\\/models\\/forms\\/helloworld.xml",
"hideFields":["asset_id","checked_out","checked_out_time","version","lft","rgt","level","path"],
"ignoreChanges":["checked_out", "checked_out_time", "path"],
"convertToInt":[],
"displayLookup":[
{"sourceColumn":"created_by","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},
{"sourceColumn":"parent_id","targetTable":"#__helloworld","targetColumn":"id","displayColumn":"greeting"},
{"sourceColumn":"catid","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"}]}',
'{"special":{"dbtable":"#__helloworld","key":"id","type":"Helloworld","prefix":"HelloworldTable","config":"array()"},
"common":{"dbtable":"#__ucm_content","key":"ucm_id","type":"Corecontent","prefix":"JTable","config":"array()"}}',
'{"common": {
"core_content_item_id": "id",
"core_title": "greeting",
"core_state": "published",
"core_alias": "alias",
"core_language":"language",
"core_created_time": "created",
"core_body": "description",
"core_access": "access",
"core_catid": "catid"
}}',
'HelloworldHelperRoute::getHelloworldRoute'),
('Helloworld Category', 'com_helloworld.category',
'{"formFile":"administrator\\/components\\/com_categories\\/models\\/forms\\/category.xml",
"hideFields":["asset_id","checked_out","checked_out_time","version","lft","rgt","level","path","extension"],
"ignoreChanges":["modified_user_id", "modified_time", "checked_out", "checked_out_time", "version", "hits", "path"],
"convertToInt":["publish_up", "publish_down"],
"displayLookup":[
{"sourceColumn":"created_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},
{"sourceColumn":"access","targetTable":"#__viewlevels","targetColumn":"id","displayColumn":"title"},
{"sourceColumn":"modified_user_id","targetTable":"#__users","targetColumn":"id","displayColumn":"name"},
{"sourceColumn":"parent_id","targetTable":"#__categories","targetColumn":"id","displayColumn":"title"}]}',
'{"special":{"dbtable":"#__categories","key":"id","type":"Category","prefix":"JTable","config":"array()"},
"common":{"dbtable":"#__ucm_content","key":"ucm_id","type":"Corecontent","prefix":"JTable","config":"array()"}}',
'{"common": {
"core_content_item_id":"id",
"core_title":"title",
"core_state":"published",
"core_alias":"alias",
"core_created_time":"created_time",
"core_modified_time":"modified_time",
"core_body":"description",
"core_hits":"hits",
"core_publish_up":"null",
"core_publish_down":"null",
"core_access":"access",
"core_params":"params",
"core_featured":"null",
"core_metadata":"metadata",
"core_language":"language",
"core_images":"null",
"core_urls":"null",
"core_version":"version",
"core_ordering":"null",
"core_metakey":"metakey",
"core_metadesc":"metadesc",
"core_catid":"parent_id",
"core_xreference":"null",
"asset_id":"asset_id"},
"special":{
"parent_id":"parent_id",
"lft":"lft",
"rgt":"rgt",
"level":"level",
"path":"path",
"extension":"extension",
"note":"note"}}',
'HelloworldHelperRoute::getCategoryRoute');
</source>
</span>

<translate>
== Admin Edit Form == 
</translate>

<translate> We add the access field into the form xml definition. That's all we need to do to enable the administrator to view and set that field, and to get it written to the database.</translate>

<span id="admin/models/forms/helloworld.xml">
<tt>admin/models/forms/helloworld.xml</tt>
<source lang="xml" highlight="96-102">
<?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="alias"
type="text"
label="JFIELD_ALIAS_LABEL"
description="JFIELD_ALIAS_DESC"
hint="JFIELD_ALIAS_PLACEHOLDER"
size="40"
/>
<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>
<field
name="latitude"
type="number"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_LATITUDE_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_LATITUDE_DESC"
min="-90.0"
max="90.0"
class="inputbox"
required="true"
default="0.0"
/>
<field
name="longitude"
type="number"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_LONGITUDE_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_LONGITUDE_DESC"
min="-180.0"
max="180.0"
class="inputbox"
required="true"
default="0.0"
/>
<field
name="language"
type="contentlanguage"
label="JFIELD_LANGUAGE_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_LANGUAGE_DESC"
>
<option value="*">JALL</option>
</field>
<field name="published"
type="list"
label="JSTATUS"
description="JFIELD_PUBLISHED_DESC"
class="chzn-color-state"
filter="intval"
size="1"
default="1"
>
<option value="1">
JPUBLISHED</option>
<option value="0">
JUNPUBLISHED</option>
</field>
<field
name="tags"
type="tag"
label="JTAG"
description="JTAG_DESC"
multiple="true"
>
</field>
<field
name="access"
type="accesslevel"
label="JFIELD_ACCESS_LABEL"
description="JFIELD_ACCESS_DESC"
>
</field>
<field
name="parent_id"
type="helloworldparent"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_DESC"
default="1"
filter="int">
</field>
<field
name="helloworldordering"
type="helloworldordering"
label="JFIELD_ORDERING_LABEL"
description="JFIELD_ORDERING_DESC"
filter="int"
size="1">
</field>
<field name="version_note"
type="text"
label="JGLOBAL_FIELD_VERSION_NOTE_LABEL"
description="JGLOBAL_FIELD_VERSION_NOTE_DESC"
class="inputbox"
size="45"
labelclass="control-label">
</field>
</fieldset>
<field name="description"
type="editor"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_DESCRIPTION_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_DESCRIPTION_DESC"
filter="JComponentHelper::filterText"
buttons="true"
/>
<fields name="imageinfo">
<fieldset
name="image-info"
label="COM_HELLOWORLD_IMAGE_FIELDS"
>
<field
name="image"
type="media"
preview="tooltip"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_IMAGE_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_IMAGE_DESC" />
<field name="alt"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_ALT_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_ALT_DESC"
size="30"/>
<field name="caption"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTION_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTION_DESC"
size="30"/>
</fieldset>
</fields>
<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>
== Admin Helloworlds Display == 
</translate>

<translate>
Updates to 3 files are required to implement the necessary changes:
# the layout file
# the filter fields xml definition
# the helloworlds model</translate>

<translate> In the layout file we replace the 4 columns associated with the nested table structure (lft, rgt, level, parent) with the access column, and make it a sortable column.</translate>

<span id="admin/views/helloworlds/tmpl/default.php">
<tt>admin/views/helloworlds/tmpl/default.php</tt>
<source lang="php" highlight="67-69,185-187">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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');

use Joomla\Registry\Registry;

JHtml::_('formbehavior.chosen', 'select');

$listOrder = $this->escape($this->state->get('list.ordering'));
$listDirn = $this->escape($this->state->get('list.direction'));
$user = JFactory::getUser();
$userId = $user->get('id');
$saveOrder = ($listOrder == 'lft' && strtolower($listDirn) == 'asc');
if ($saveOrder)
{
$saveOrderingUrl = 'index.php?option=com_helloworld&task=helloworlds.saveOrderAjax&tmpl=component';
// pass true as parameter 7 to indicate that we have a nested set
JHtml::_('sortablelist.sortable', 'helloworldList', 'adminForm', strtolower($listDirn), $saveOrderingUrl, false, true);
}
$assoc = JLanguageAssociations::isEnabled();
$authorFieldwidth = $assoc ? "10%" : "25%";
JLoader::register('JHtmlHelloworlds', JPATH_ADMINISTRATOR . '/components/com_helloworld/helpers/html/helloworlds.php');
?>
<form action="index.php?option=com_helloworld&view=helloworlds" method="post" id="adminForm" name="adminForm">
<div id="j-sidebar-container" class="span2">
<?php echo JHtmlSidebar::render(); ?>
</div>
<div id="j-main-container" class="span10">
<div class="row-fluid">
<div class="span6">
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLDS_FILTER'); ?>
<?php
echo JLayoutHelper::render(
'joomla.searchtools.default',
array('view' => $this)
);
?>
</div>
</div>
<table class="table table-striped table-hover" id="helloworldList">
<thead>
<tr>
<th width="1%">
<?php echo JHtml::_('searchtools.sort', '', 'lft', $listDirn, $listOrder, null, 'asc', 'JGRID_HEADING_ORDERING', 'icon-menu-2'); ?>
</th>
<th width="1%"><?php echo JText::_('COM_HELLOWORLD_NUM'); ?></th>
<th width="1%">
<?php echo JHtml::_('grid.checkall'); ?>
</th>
<th width="10%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_HELLOWORLDS_NAME', 'greeting', $listDirn, $listOrder); ?>
</th>
<th width="10%">
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLDS_POSITION'); ?>
</th>
<th width="10%">
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLDS_IMAGE'); ?>
</th>
<th width="20%">
<?php echo JHtml::_('searchtools.sort', 'JGRID_HEADING_ACCESS', 'access', $listDirn, $listOrder); ?>
</th>
<?php if ($assoc) : ?>
<th width="10%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_HELLOWORLDS_ASSOCIATIONS', 'association', $listDirn, $listOrder); ?>
</th>
<?php endif; ?>
<th width="<?php echo $authorFieldwidth; ?>">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_AUTHOR', 'author', $listDirn, $listOrder); ?>
</th>
<th width="10%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_LANGUAGE', 'language', $listDirn, $listOrder); ?>
</th>
<th width="10%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_CREATED_DATE', 'created', $listDirn, $listOrder); ?>
</th>
<th width="5%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_PUBLISHED', 'published', $listDirn, $listOrder); ?>
</th>
<th width="2%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_ID', 'id', $listDirn, $listOrder); ?>
</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) :
$link = JRoute::_('index.php?option=com_helloworld&task=helloworld.edit&id=' . $row->id);
$row->image = new Registry;
$row->image->loadString($row->imageInfo);
// create a list of the parents up the hierarchy to the root
if ($row->level > 1)
{
$parentsStr = '';
$_currentParentId = $row->parent_id;
$parentsStr = ' ' . $_currentParentId;
for ($j = 0; $j < $row->level; $j++)
{
foreach ($this->ordering as $k => $v)
{
$v = implode('-', $v);
$v = '-' . $v . '-';
if (strpos($v, '-' . $_currentParentId . '-') !== false)
{
$parentsStr .= ' ' . $k;
$_currentParentId = $k;
break;
}
}
}
}
else
{
$parentsStr = '';
}
?>
<tr class="row<?php echo $i % 2; ?>" sortable-group-id="<?php echo $row->parent_id; ?>" item-id="<?php echo $row->id; ?>" parents="<?php echo $parentsStr; ?>" level="<?php echo $row->level; ?>">
<td><?php
$iconClass = '';
$canReorder = $user->authorise('core.edit.state', 'com_helloworld.helloworld.' . $row->id);
if (!$canReorder)
{
$iconClass = ' inactive';
}
elseif (!$saveOrder)
{
$iconClass = ' inactive tip-top hasTooltip" title="' . JHtml::_('tooltipText', 'JORDERINGDISABLED');
}
?>
<span class="sortable-handler<?php echo $iconClass ?>">
<span class="icon-menu" aria-hidden="true"></span>
</span>
<?php if ($canReorder && $saveOrder) : ?>
<input type="text" style="display:none" name="order[]" size="5" value="<?php echo $row->lft; ?>" class="width-20 text-area-order" />
<?php endif; ?>
</td>
<td><?php echo $this->pagination->getRowOffset($i); ?></td>
<td>
<?php echo JHtml::_('grid.id', $i, $row->id); ?>
</td>
<td>
<?php $prefix = JLayoutHelper::render('joomla.html.treeprefix', array('level' => $row->level)); ?>
<?php echo $prefix; ?>
<?php if ($row->checked_out) : ?>
<?php $canCheckin = $user->authorise('core.manage', 'com_checkin') || $row->checked_out == $userId; ?>
<?php echo JHtml::_('jgrid.checkedout', $i, $row->editor, $row->checked_out_time, 'helloworlds.', $canCheckin); ?>
<?php endif; ?>
<a href="<?php echo $link; ?>" title="<?php echo JText::_('COM_HELLOWORLD_EDIT_HELLOWORLD'); ?>">
<?php echo $row->greeting; ?>
</a>
<span class="small break-word">
<?php echo JText::sprintf('JGLOBAL_LIST_ALIAS', $this->escape($row->alias)); ?>
</span>
<div class="small">
<?php echo JText::_('JCATEGORY') . ': ' . $this->escape($row->category_title); ?>
</div>
<div class="small">
<?php echo 'Path: ' . $this->escape($row->path); ?>
</div>
</td>
<td align="center">
<?php echo "[" . $row->latitude . ", " . $row->longitude . "]"; ?>
</td>
<td align="center">
<?php
$caption = $row->image->get('caption') ? : '' ;
$src = JURI::root() . ($row->image->get('image') ? : '' );
$html = '<p class="hasTooltip" style="display: inline-block" data-html="true" data-toggle="tooltip" data-placement="right" title="<img width=\'100px\' height=\'100px\' src=\'%s\'>">%s</p>';
echo sprintf($html, $src, $caption); ?>
</td>
<td align="center">
<?php echo $this->escape($row->access_level); ?>
</td>
<?php if ($assoc) : ?>
<td align="center">
<?php if ($row->association) : ?>
<?php echo JHtml::_('helloworlds.association', $row->id); ?>
<?php endif; ?>
</td>
<?php endif; ?>
<td align="center">
<?php echo $row->author; ?>
</td>
<td align="center">
<?php echo JLayoutHelper::render('joomla.content.language', $row); ?>
</td>
<td align="center">
<?php echo substr($row->created, 0, 10); ?>
</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>
<input type="hidden" name="task" value=""/>
<input type="hidden" name="boxchecked" value="0"/>
<?php echo JHtml::_('form.token'); ?>
</div>
</form>
</source>
</span>

<translate> Secondly, in the filter helloworlds form definition we add the 2 options for sorting by the access column.</translate>

<span id="admin/models/forms/filter_helloworlds.xml">
<tt>admin/models/forms/filter_helloworlds.xml</tt>
<source lang="xml" highlight="65-66">
<?xml version="1.0" encoding="utf-8"?>
<form>
<fields name="filter">
<field
name="search"
type="text"
label="COM_BANNERS_SEARCH_IN_TITLE"
hint="JSEARCH_FILTER"
class="js-stools-search-string"
/>
<field
name="published"
type="status"
label="JOPTION_SELECT_PUBLISHED"
description="JOPTION_SELECT_PUBLISHED_DESC"
onchange="this.form.submit();"
>
<option value="">JOPTION_SELECT_PUBLISHED</option>
</field>
<field
name="language"
type="contentlanguage"
label="JOPTION_FILTER_LANGUAGE"
description="JOPTION_FILTER_LANGUAGE_DESC"
onchange="this.form.submit();"
>
<option value="">JOPTION_SELECT_LANGUAGE</option>
<option value="*">JALL</option>
</field>
<field
name="category_id"
type="category"
label="JOPTION_FILTER_CATEGORY"
extension="com_helloworld"
onchange="this.form.submit();"
published="0,1,2"
>
<option value="">JOPTION_SELECT_CATEGORY</option>
</field>
</fields>
<fields name="list">
<field
name="fullordering"
type="list"
label="COM_HELLOWORLD_LIST_FULL_ORDERING"
description="COM_HELLOWORLD_LIST_FULL_ORDERING_DESC"
onchange="this.form.submit();"
default="greeting ASC"
>
<option value="">JGLOBAL_SORT_BY</option>
<option value="ordering ASC">COM_HELLOWORLD_ORDERING_ASC</option>
<option value="ordering DESC">COM_HELLOWORLD_ORDERING_DESC</option>
<option value="greeting ASC">COM_HELLOWORLD_GREETING_ASC</option>
<option value="greeting DESC">COM_HELLOWORLD_GREETING_DESC</option>
<option value="id ASC">JGRID_HEADING_ID_ASC</option>
<option value="id DESC">JGRID_HEADING_ID_DESC</option>
<option value="published ASC">COM_HELLOWORLD_PUBLISHED_ASC</option>
<option value="published DESC">COM_HELLOWORLD_PUBLISHED_DESC</option>
<option value="author ASC">COM_HELLOWORLD_AUTHOR_ASC</option>
<option value="author DESC">COM_HELLOWORLD_AUTHOR_DESC</option>
<option value="created ASC">COM_HELLOWORLD_CREATED_ASC</option>
<option value="created DESC">COM_HELLOWORLD_CREATED_DESC</option>
<option value="language ASC">COM_HELLOWORLD_LANGUAGE_ASC</option>
<option value="language DESC">COM_HELLOWORLD_LANGUAGE_DESC</option>
<option value="access ASC">COM_HELLOWORLD_ACCESS_ASC</option>
<option value="access DESC">COM_HELLOWORLD_ACCESS_DESC</option>
<option value="association ASC">COM_HELLOWORLD_ASSOCIATION_ASC</option>
<option value="association DESC">COM_HELLOWORLD_ASSOCIATION_DESC</option>
</field>
<field
name="limit"
type="limitbox"
class="input-mini"
default="25"
label="COM_CONTENT_LIST_LIMIT"
description="COM_HELLOWORLD_LIST_LIMIT_DESC"
onchange="this.form.submit();"
/>
</fields>
</form>
</source>
</span>

<translate> Thirdly we must change the helloworlds model</translate>
<translate> * to include the access field in the query, and translate the access value into the name of that access level,</translate>
<translate> * to include the access field within the list of sort fields (<tt>$config</tt> array),</translate>
<translate> * to restrict the record returned to those which the user has access to see, by adding an additional SQL WHERE clause.</translate>

<translate> Note that we must check specifically for the user being a Super User (<tt>$user->authorise('core.admin')</tt> returns <tt>true</tt>), as they should be able to see everything, regardless of access.</translate>

<span id="admin/models/helloworlds.php">
<tt>admin/models/helloworlds.php</tt>
<source lang="php" highlight="39,84,87,120-122,159-165">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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
{
/**
* Constructor.
*
* @param array $config An optional associative array of configuration settings.
*
* @see JController
* @since 1.6
*/
public function __construct($config = array())
{
if (empty($config['filter_fields']))
{
$config['filter_fields'] = array(
'id',
'greeting',
'author',
'created',
'language',
'lft',
'category_id',
'access',
'association',
'published'
);
}

parent::__construct($config);
}

protected function populateState($ordering = 'lft', $direction = 'asc')
{
$app = JFactory::getApplication();

// Adjust the context to support modal layouts.
if ($layout = $app->input->get('layout'))
{
$this->context .= '.' . $layout;
}

// Adjust the context to support forced languages.
$forcedLanguage = $app->input->get('forcedLanguage', '', 'CMD');
if ($forcedLanguage)
{
$this->context .= '.' . $forcedLanguage;
}

parent::populateState($ordering, $direction);

// If there's a forced language then define that filter for the query where clause
if (!empty($forcedLanguage))
{
$this->setState('filter.language', $forcedLanguage);
}
}

/**
* 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);
$user = JFactory::getUser();

// Create the base select statement.
$query->select('a.id as id, a.greeting as greeting, a.published as published, a.created as created, a.access as access,
a.checked_out as checked_out, a.checked_out_time as checked_out_time, a.catid as catid,
a.lft as lft, a.rgt as rgt, a.parent_id as parent_id, a.level as level, a.path as path,
a.image as imageInfo, a.latitude as latitude, a.longitude as longitude, a.alias as alias, a.language as language')
->from($db->quoteName('#__helloworld', 'a'));

// Join over the categories.
$query->select($db->quoteName('c.title', 'category_title'))
->join('LEFT', $db->quoteName('#__categories', 'c') . ' ON c.id = a.catid');

// Join with users table to get the username of the author
$query->select($db->quoteName('u.username', 'author'))
->join('LEFT', $db->quoteName('#__users', 'u') . ' ON u.id = a.created_by');

// Join with users table to get the username of the person who checked the record out
$query->select($db->quoteName('u2.username', 'editor'))
->join('LEFT', $db->quoteName('#__users', 'u2') . ' ON u2.id = a.checked_out');

// Join with languages table to get the language title and image to display
// Put these into fields called language_title and language_image so that
// we can use the little com_content layout to display the map symbol
$query->select($db->quoteName('l.title', 'language_title') . "," .$db->quoteName('l.image', 'language_image'))
->join('LEFT', $db->quoteName('#__languages', 'l') . ' ON l.lang_code = a.language');

// Join over the associations - we just want to know if there are any, at this stage
if (JLanguageAssociations::isEnabled())
{
$query->select('COUNT(asso2.id)>1 as association')
->join('LEFT', '#__associations AS asso ON asso.id = a.id AND asso.context=' . $db->quote('com_helloworld.item'))
->join('LEFT', '#__associations AS asso2 ON asso2.key = asso.key')
->group('a.id');
}

// Join over the access levels, to get the name of the access level
$query->select('v.title AS access_level')
->join('LEFT', '#__viewlevels AS v ON v.id = a.access');

// Filter: like / search
$search = $this->getState('filter.search');

if (!empty($search))
{
$like = $db->quote('%' . $search . '%');
$query->where('greeting LIKE ' . $like);
}

// Filter by published state
$published = $this->getState('filter.published');

if (is_numeric($published))
{
$query->where('a.published = ' . (int) $published);
}
elseif ($published === '')
{
$query->where('(a.published IN (0, 1))');
}

// Filter by language, if the user has set that in the filter field
$language = $this->getState('filter.language');
if ($language)
{
$query->where('a.language = ' . $db->quote($language));
}

// Filter by categories
$catid = $this->getState('filter.category_id');
if ($catid)
{
$query->where("a.catid = " . $db->quote($db->escape($catid)));
}

// Display only records to which the user has access
if (!$user->authorise('core.admin')) // ie if not SuperUser
{
$userAccessLevels = implode(',', $user->getAuthorisedViewLevels());
$query->where('a.access IN (' . $userAccessLevels . ')');
$query->where('c.access IN (' . $userAccessLevels . ')');
}

// exclude root helloworld record
$query->where('a.id > 1');

// Add the list ordering clause.
$orderCol = $this->state->get('list.ordering', 'lft');
$orderDirn = $this->state->get('list.direction', 'asc');

$query->order($db->escape($orderCol) . ' ' . $db->escape($orderDirn));

return $query;
}
}
</source>
</span>

<translate>
== Front End Hello World Menuitem and Ajax Display == 
</translate>

<translate> In the model for the single record display we set an item property <tt>canAccess</tt>, depending upon whether the user has access to the record or not. Also we change the SQL query for the Ajax response to exclude those records which a logged-in user can't access.</translate>

<span id="site/models/helloworld.php">
<tt>site/models/helloworld.php</tt>
<source lang="php" highlight="78-79,110-127,163,176-184">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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');

JLoader::register('HelloworldHelperRoute', JPATH_ROOT . '/components/com_helloworld/helpers/route.php');

/**
* HelloWorld Model
*
* @since 0.0.1
*/
class HelloWorldModelHelloWorld extends JModelItem
{
/**
* @var object item
*/
protected $item;

/**
* Method to auto-populate the model state.
*
* This method should only be called once per instantiation and is designed
* to be called on the first call to the getState() method unless the model
* configuration flag to ignore the request is set.
*
* Note. Calling getState in this method will result in recursion.
*
* @return void
* @since 2.5
*/
protected function populateState()
{
// Get the message id
$jinput = JFactory::getApplication()->input;
$id = $jinput->get('id', 1, 'INT');
$this->setState('message.id', $id);

// Load the parameters.
$this->setState('params', JFactory::getApplication()->getParams());
parent::populateState();
}

/**
* 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);
}

/**
* Get the message
* @return object The message to be displayed to the user
*/
public function getItem($id = null)
{
if (!isset($this->item) || !is_null($id))
{
$id = is_null($id) ? $this->getState('message.id') : $id;
$db = JFactory::getDbo();
$query = $db->getQuery(true);
$query->select('h.greeting, h.params, h.image as image, c.title as category, c.access as catAccess,
h.latitude as latitude, h.longitude as longitude, h.access as access,
h.id as id, h.alias as alias, h.catid as catid, h.parent_id as parent_id, h.level as level, h.description as description')
->from('#__helloworld as h')
->leftJoin('#__categories as c ON h.catid=c.id')
->where('h.id=' . (int)$id);

if (JLanguageMultilang::isEnabled())
{
$lang = JFactory::getLanguage()->getTag();
$query->where('h.language IN ("*","' . $lang . '")');
}

$db->setQuery((string)$query);

if ($this->item = $db->loadObject())
{
// Load the JSON string
$params = new JRegistry;
$params->loadString($this->item->params, 'JSON');
$this->item->params = $params;

// Merge global params with item params
$params = clone $this->getState('params');
$params->merge($this->item->params);
$this->item->params = $params;

// Convert the JSON-encoded image info into an array
$image = new JRegistry;
$image->loadString($this->item->image, 'JSON');
$this->item->imageDetails = $image;

// Check if the user can access this record (and category)
$user = JFactory::getUser();
$userAccessLevels = $user->getAuthorisedViewLevels();
if ($user->authorise('core.admin')) // ie superuser
{
$this->item->canAccess = true;
}
else
{
if ($this->item->catid == 0)
{
$this->item->canAccess = in_array($this->item->access, $userAccessLevels);
}
else
{
$this->item->canAccess = in_array($this->item->access, $userAccessLevels) && in_array($this->item->catAccess, $userAccessLevels);
}
}
}
else
{
throw new Exception('Helloworld id not found', 404);
}
}
return $this->item;
}

public function getMapParams()
{
if ($this->item)
{
$url = HelloworldHelperRoute::getAjaxURL();
$this->mapParams = array(
'latitude' => $this->item->latitude,
'longitude' => $this->item->longitude,
'zoom' => 10,
'greeting' => $this->item->greeting,
'ajaxurl' => $url
);
return $this->mapParams;
}
else
{
throw new Exception('No helloworld details available for map', 500);
}
}

public function getMapSearchResults($mapbounds)
{
try
{
$db = JFactory::getDbo();
$query = $db->getQuery(true);
$query->select('h.id, h.alias, h.catid, h.greeting, h.latitude, h.longitude, h.access')
->from('#__helloworld as h')
->where('h.latitude > ' . $mapbounds['minlat'] .
' AND h.latitude < ' . $mapbounds['maxlat'] .
' AND h.longitude > ' . $mapbounds['minlng'] .
' AND h.longitude < ' . $mapbounds['maxlng']);

if (JLanguageMultilang::isEnabled())
{
$lang = JFactory::getLanguage()->getTag();
$query->where('h.language IN ("*","' . $lang . '")');
}

$user = JFactory::getUser();
$loggedIn = $user->get('guest') != 1;
if ($loggedIn && !$user->authorise('core.admin'))
{
$userAccessLevels = $user->getAuthorisedViewLevels();
$query->where('h.access IN (' . implode(",", $userAccessLevels) . ')');
$query->join('LEFT', $db->quoteName('#__categories', 'c') . ' ON c.id = h.catid');
$query->where('(c.access IN (' . implode(",", $userAccessLevels) . ') OR h.catid = 0)');
}

$db->setQuery($query);
$results = $db->loadObjectList();
}
catch (Exception $e)
{
$msg = $e->getMessage();
JFactory::getApplication()->enqueueMessage($msg, 'error');
$results = null;
}

if (JLanguageMultilang::isEnabled())
{
$query_lang = "&lang={$lang}";
}
else
{
$query_lang = "";
}

for ($i = 0; $i < count($results); $i++)
{
$results[$i]->url = JRoute::_('index.php?option=com_helloworld&view=helloworld&id=' . $results[$i]->id .
":" . $results[$i]->alias . '&catid=' . $results[$i]->catid . $query_lang);
}

return $results;
}

public function getChildren($id)
{
$table = $this->getTable();
$children = $table->getTree($id);
return $children;
}
}
</source>
</span>

<translate> In the view we handle the case of <tt>canAccess</tt> being false. Note that there is a problem with Joomla's redirect functionality here. We provide a redirect to the com_users login form, and specify the url to access after logging in within the "return" parameter, as described in [[S:MyLanguage/How do you redirect users after a successful login%3f|How do you redirect users after a successful login]]. However, if the user enters the credentials into the Login Form module instead then that module encodes the return parameter based on a url which has already the return parameter set and it doesn't work. So ideally we either have to</translate>
<translate> * omit the redirect to the com_users login form, and just assume the user will enter the details in the login module box, or,</translate>
<translate> * redirect to the com_users login form, but we should find a means of removing the login module from that page (eg by redirecting to a specific hidden menuitem which displays the login form, but on which the login module is absent).</translate>

<span id="site/views/helloworld/view.html.php">
<tt>site/views/helloworld/view.html.php</tt>
<source lang="php" highlight="31-32,42-59">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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->item = $this->get('Item');
$user = JFactory::getUser();
$app = JFactory::getApplication();

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JLog::add(implode('<br />', $errors), JLog::WARNING, 'jerror');

return false;
}

// Take action based on whether the user has access to see the record or not
$loggedIn = $user->get('guest') != 1;
if (!$this->item->canAccess)
{
if ($loggedIn)
{
$app->enqueueMessage(JText::_('JERROR_ALERTNOAUTHOR'), 'error');
$app->setHeader('status', 403, true);
return;
}
else
{
$return = base64_encode(JUri::getInstance());
$login_url_with_return = JRoute::_('index.php?option=com_users&return=' . $return, false);
$app->enqueueMessage(JText::_('COM_HELLOWORLD_MUST_LOGIN'), 'notice');
$app->redirect($login_url_with_return, 403);
}
}

$this->addMap();

$tagsHelper = new JHelperTags;
$this->item->tags = $tagsHelper->getItemTags('com_helloworld.helloworld' , $this->item->id);

$model = $this->getModel();
$this->parentItem = $model->getItem($this->item->parent_id);
$this->children = $model->getChildren($this->item->id);
// getChildren includes the record itself (as well as the children) so remove this record
unset($this->children[0]);

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

function addMap()
{
$document = JFactory::getDocument();

// everything's dependent upon JQuery
JHtml::_('jquery.framework');

// we need the Openlayers JS and CSS libraries
$document->addScript("https://cdnjs.cloudflare.com/ajax/libs/openlayers/4.6.4/ol.js");
$document->addStyleSheet("https://cdnjs.cloudflare.com/ajax/libs/openlayers/4.6.4/ol.css");

// ... and our own JS and CSS
$document->addScript(JURI::root() . "media/com_helloworld/js/openstreetmap.js");
$document->addStyleSheet(JURI::root() . "media/com_helloworld/css/openstreetmap.css");

// get the data to pass to our JS code
$params = $this->get("mapParams");
$document->addScriptOptions('params', $params);
}
}

</source>
</span>

<translate>
== Frontend Category Display == 
</translate>

<translate> In the category model we post-process the helloworld records which have the specified category id, and for the records which the user can't access, we either remove them completely from the list (if the user is already logged in) or set the item <tt>canAccess</tt> property to false (if the user isn't logged in). Note that by default the <tt>JCategories</tt> methods which we use here remove records to which the user doesn't have access, so we specify in the constructor the options array set to <tt>array('access' => false)</tt> so that all records are returned, and we perform the access checks ourselves.</translate>

<span id="site/models/category.php">
<tt>site/models/category.php</tt>
<source lang="php" highlight="41,62,70,91-146">
<?php
/**
* Model for displaying the helloworld messages in a given category
*/

defined('_JEXEC') or die;

class HelloworldModelCategory extends JModelList
{
public function __construct($config = array())
{
if (empty($config['filter_fields']))
{
$config['filter_fields'] = array(
'id',
'greeting',
'alias',
'lft',
);
}

parent::__construct($config);
}

protected function populateState($ordering = null, $direction = null)
{
parent::populateState($ordering, $direction);

$app = JFactory::getApplication('site');
$catid = $app->input->getInt('id');

$this->setState('category.id', $catid);
}

protected function getListQuery()
{
$db = JFactory::getDbo();
$query = $db->getQuery(true);

$catid = $this->getState('category.id');
$query->select('id, greeting, alias, catid, access')
->from($db->quoteName('#__helloworld'))
->where('catid = ' . $catid);

if (JLanguageMultilang::isEnabled())
{
$lang = JFactory::getLanguage()->getTag();
$query->where('language IN ("*","' . $lang . '")');
}

$orderCol = $this->state->get('list.ordering', 'lft');
$orderDirn = $this->state->get('list.direction', 'asc');

$query->order($db->escape($orderCol) . ' ' . $db->escape($orderDirn));

return $query;
}

public function getCategoryName()
{
$catid = $this->getState('category.id');
$categories = JCategories::getInstance('Helloworld', array('access' => false));
$categoryNode = $categories->get($catid);
return $categoryNode->title;
}

public function getSubcategories()
{
$catid = $this->getState('category.id');
$categories = JCategories::getInstance('Helloworld', array('access' => false));
$categoryNode = $categories->get($catid);
$subcats = $categoryNode->getChildren();

$lang = JFactory::getLanguage()->getTag();
if (JLanguageMultilang::isEnabled() && $lang)
{
$query_lang = "&lang={$lang}";
}
else
{
$query_lang = '';
}

foreach ($subcats as $subcat)
{
$subcat->url = JRoute::_("index.php?view=category&id=" . $subcat->id . $query_lang);
}
return $subcats;
}

public function getCategoryAccess()
{
$catid = $this->getState('category.id');
$categories = JCategories::getInstance('Helloworld', array('access' => false));
$categoryNode = $categories->get($catid);
return $categoryNode->access;
}

public function getItems()
{
$items = parent::getItems();
$user = JFactory::getUser();
$loggedIn = $user->get('guest') != 1;

if ($user->authorise('core.admin')) // ie superuser
{
return $items;
}
else
{
$userAccessLevels = $user->getAuthorisedViewLevels();
$catAccess = $this->getCategoryAccess();

if (!in_array($catAccess, $userAccessLevels))
{ // the user hasn't access to the category
if ($loggedIn)
{
return array();
}
else
{
foreach ($items as $item)
{
$item->canAccess = false;
}
return $items;
}
}

foreach ($items as $item)
{
if (!in_array($item->access, $userAccessLevels))
{
if ($loggedIn)
{
unset($item);
}
else
{
$item->canAccess = false;
}
}
}
}
return $items;
}
}
</source>
</span>

<translate> In the category layout file we change the display if the <tt>canAccess</tt> flag is set to false.</translate>

<span id="site/views/category/tmpl/default.php">
<tt>site/views/category/tmpl/default.php</tt>
<source lang="php" highlight="63-67,77">
<?php
/**
* Layout file for displaying helloworld messages belonging to a given category
*/

defined('_JEXEC') or die;

JHtml::_('formbehavior.chosen', 'select');

$listOrder = $this->escape($this->state->get('list.ordering'));
$listDirn = $this->escape($this->state->get('list.direction'));
$lang = JFactory::getLanguage()->getTag();
if (JLanguageMultilang::isEnabled() && $lang)
{
$query_lang = "&lang={$lang}";
}
else
{
$query_lang = "";
}
?>
<form action="#" method="post" id="adminForm" name="adminForm">
<h1><?php echo $this->categoryName; ?></h1>
<div id="j-main-container" class="span10">
<div class="row-fluid">
<div class="span10">
<?php
echo JLayoutHelper::render(
'joomla.searchtools.default',
array('view' => $this, 'searchButton' => false)
);
?>
</div>
</div>
<table class="table table-striped table-hover">
<thead>
<tr>
<th width="5%"><?php echo JText::_('JGLOBAL_NUM'); ?></th>
<th width="20%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_HELLOWORLD_GREETING_LABEL', 'greeting', $listDirn, $listOrder); ?>
</th>
<th width="20%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_HELLOWORLD_ALIAS_LABEL', 'alias', $listDirn, $listOrder); ?>
</th>
<th width="20%">
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLD_FIELD_URL_LABEL'); ?>
</th>
<th width="5%">
<?php echo JHtml::_('searchtools.sort', 'JGLOBAL_FIELD_ID_LABEL', 'id', $listDirn, $listOrder); ?>
</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) :
if (isset($row->canAccess) && !$row->canAccess) : ?>
<tr>
<td align="center" colspan="5"><?php echo $row->greeting . " - " . JText::_('COM_HELLOWORLD_MUST_LOGIN'); ?></td>
</tr>
<?php else :
$url = JRoute::_('index.php?option=com_helloworld&view=helloworld&id=' . $row->id . ':' . $row->alias . '&catid=' . $row->catid . $query_lang);
?>
<tr>
<td align="center"><?php echo $this->pagination->getRowOffset($i); ?></td>
<td align="center"><?php echo $row->greeting; ?></td>
<td align="center"><?php echo $row->alias; ?></td>
<td align="center"><a href="<?php echo $url; ?>"><?php echo $url; ?></a></td>
<td align="center"><?php echo $row->id; ?></td>
</tr>
<?php endif; ?>
<?php endforeach; ?>
<?php endif; ?>
</tbody>
</table>
<h1><?php echo JText::_('COM_HELLOWORLD_HEADER_SUBCATEGORIES'); ?></h1>
<?php foreach ($this->subcategories as $subcategory) : ?>
<h3><a href="<?php echo $subcategory->url; ?>"> <?php echo $subcategory->title; ?> </a></h3>
<p><?php echo $subcategory->description; ?></p>
<?php endforeach; ?>
</div>
</form>
</source>
</span>

<translate>
== Updated Language Strings == 
</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="100-101">
; Joomla! Project
; Copyright (C) 2005 - 2018 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_AUTHOR="Author"
COM_HELLOWORLD_LANGUAGE="Language"
COM_HELLOWORLD_CREATED_DATE="Created"
COM_HELLOWORLD_PUBLISHED="Published"
COM_HELLOWORLD_HELLOWORLDS_NAME="Name"
COM_HELLOWORLD_HELLOWORLDS_POSITION="Position"
COM_HELLOWORLD_HELLOWORLDS_IMAGE="Image"
COM_HELLOWORLD_HELLOWORLDS_ASSOCIATIONS="Associations"
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_DESCRIPTION_DESC="Message description"
COM_HELLOWORLD_HELLOWORLD_FIELD_DESCRIPTION_LABEL="Description"
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_FIELD_LATITUDE_LABEL="Latitude"
COM_HELLOWORLD_HELLOWORLD_FIELD_LATITUDE_DESC="Enter the position latitude, between -90 and +90 degrees"
COM_HELLOWORLD_HELLOWORLD_FIELD_LONGITUDE_LABEL="Longitude"
COM_HELLOWORLD_HELLOWORLD_FIELD_LONGITUDE_DESC="Enter the position longitude, between -180 and +180 degrees"
COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_LABEL="Parent"
COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_DESC="Select the parent record"
COM_HELLOWORLD_ITEM_FIELD_ORDERING_VALUE_FIRST="-- First record"
COM_HELLOWORLD_ITEM_FIELD_ORDERING_VALUE_LAST="-- Last record"
COM_HELLOWORLD_ITEM_FIELD_ORDERING_TEXT="Ordering will be available after saving."
COM_HELLOWORLD_HELLOWORLD_FIELD_LANGUAGE_DESC="Select the appropriate language"
COM_HELLOWORLD_IMAGE_FIELDS="Image details"
COM_HELLOWORLD_HELLOWORLD_FIELD_IMAGE_LABEL="Select image"
COM_HELLOWORLD_HELLOWORLD_FIELD_IMAGE_DESC="Select an image from the library, or upload a new one"
COM_HELLOWORLD_HELLOWORLD_FIELD_ALT_LABEL="Alt text"
COM_HELLOWORLD_HELLOWORLD_FIELD_ALT_DESC="Alternative text (if image cannot be displayed)"
COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTION_LABEL="Caption"
COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTION_DESC="Provide a caption for the image"
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_HELLOWORLD_FIELD_CAPTCHA_LABEL="Captcha"
COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTCHA_DESC="Select Captcha to use on front end form"
COM_HELLOWORLD_HELLOWORLD_FIELD_USER_TO_EMAIL_LABEL="User to email"
COM_HELLOWORLD_HELLOWORLD_FIELD_USER_TO_EMAIL_DESC="Select user to email when a new message is entered on front end"
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?"
COM_HELLOWORLD_TAB_NEW_MESSAGE="New Message"
COM_HELLOWORLD_TAB_EDIT_MESSAGE="Message Details"
COM_HELLOWORLD_TAB_PARAMS="Parameters"
COM_HELLOWORLD_TAB_ASSOCIATIONS="Associations"
COM_HELLOWORLD_TAB_PERMISSIONS="Permissions"
COM_HELLOWORLD_TAB_IMAGE="Image"
COM_HELLOWORLD_LEGEND_DETAILS="Message Details"
COM_HELLOWORLD_LEGEND_PARAMS="Message Parameters"
COM_HELLOWORLD_LEGEND_ASSOCIATIONS="Message Associations"
COM_HELLOWORLD_LEGEND_PERMISSIONS="Message Permissions"
COM_HELLOWORLD_LEGEND_IMAGE="Image info"
; Column ordering in the Helloworlds view
COM_HELLOWORLD_ORDERING_ASC="Ordering ascending"
COM_HELLOWORLD_ORDERING_DESC="Ordering descending"
COM_HELLOWORLD_GREETING_ASC="Greeting ascending"
COM_HELLOWORLD_GREETING_DESC="Greeting descending"
COM_HELLOWORLD_AUTHOR_ASC="Author ascending"
COM_HELLOWORLD_AUTHOR_DESC="Author descending"
COM_HELLOWORLD_CREATED_ASC="Creation date ascending"
COM_HELLOWORLD_CREATED_DESC="Creation date descending"
COM_HELLOWORLD_PUBLISHED_ASC="Unpublished first"
COM_HELLOWORLD_PUBLISHED_DESC="Published first"
COM_HELLOWORLD_LANGUAGE_ASC="Language ascending"
COM_HELLOWORLD_LANGUAGE_DESC="Language descending"
COM_HELLOWORLD_ASSOCIATION_ASC="Association ascending"
COM_HELLOWORLD_ASSOCIATION_DESC="Association descending"
COM_HELLOWORLD_ACCESS_ASC="Access ascending"
COM_HELLOWORLD_ACCESS_DESC="Access descending"
; Helloworld menuitem - selecting a greeting via modal
COM_HELLOWORLD_MENUITEM_SELECT_MODAL_TITLE="Select greeting"
COM_HELLOWORLD_MENUITEM_SELECT_HELLOWORLD="Select"
COM_HELLOWORLD_MENUITEM_SELECT_BUTTON_TOOLTIP="Select a helloworld greeting"
; Checking in records
COM_HELLOWORLD_N_ITEMS_CHECKED_IN_0="No records checked in."
COM_HELLOWORLD_N_ITEMS_CHECKED_IN_1="%d record successfully checked in."
COM_HELLOWORLD_N_ITEMS_CHECKED_IN_MORE="%d records successfully checked in."
</source>
</span>

<span id="site/language/en-GB/en-GB.com_helloworld.ini">
<tt>site/language/en-GB/en-GB.com_helloworld.ini</tt>
<source lang="text" highlight="56-57">
; add new message form
COM_HELLOWORLD_LEGEND_DETAILS="New Helloworld Message Details"
COM_HELLOWORLD_HELLOWORLD_CREATING="Add message"
COM_HELLOWORLD_HELLOWORLD_ERROR_UNACCEPTABLE="Sorry, you have an error"
COM_HELLOWORLD_HELLOWORLD_DETAILS="Message details"
COM_HELLOWORLD_HELLOWORLD_GREETING_LABEL="Greeting"
COM_HELLOWORLD_HELLOWORLD_GREETING_DESC="Please specify the greeting to add"
COM_HELLOWORLD_HELLOWORLD_GREETING_HINT="Any characters allowed"
COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_LABEL="Category"
COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_DESC="Please select the associated category"
COM_HELLOWORLD_HELLOWORLD_MESSAGE_LABEL="Reason"
COM_HELLOWORLD_HELLOWORLD_MESSAGE_DESC="Please say why you're adding this greeting"
COM_HELLOWORLD_HELLOWORLD_MESSAGE_HINT="No HTML tags!"
COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTCHA_LABEL="Spam protection"
COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTCHA_DESC="Prove you're a real person!"
COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_LABEL="Display category or not?"
COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_DESC="Select if you want the category displayed too"
COM_HELLOWORLD_HELLOWORLD_IMAGE_LABEL="Image information"
COM_HELLOWORLD_HELLOWORLD_PICTURE_LABEL="Image file to upload"
COM_HELLOWORLD_HELLOWORLD_PICTURE_DESC="Select the file with the image to upload"
COM_HELLOWORLD_HELLOWORLD_CAPTION_LABEL="Caption"
COM_HELLOWORLD_HELLOWORLD_CAPTION_DESC="Text to use as a caption for the image"
COM_HELLOWORLD_HELLOWORLD_ALTTEXT_LABEL="Alt text"
COM_HELLOWORLD_HELLOWORLD_ALTTEXT_DESC="Text to display if image cannot be shown"
COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_LABEL="Parent"
COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_DESC="Select the record which is to be the parent"
; save and cancel confirmation messages
COM_HELLOWORLD_ADD_SUCCESSFUL="New greeting successfully saved"
COM_HELLOWORLD_ADD_CANCELLED="New greeting cancelled ok"
; file upload error conditions
COM_HELLOWORLD_ERROR_FILEUPLOAD="PHP Error %s encountered when uploading file"
COM_HELLOWORLD_ERROR_FILETOOLARGE="Upload file exceeds max size configured in Joomla"
COM_HELLOWORLD_ERROR_BADFILENAME="Upload file has an invalid filename"
COM_HELLOWORLD_ERROR_FILE_EXISTS="Upload file already exists"
COM_HELLOWORLD_ERROR_UNABLE_TO_UPLOAD_FILE="Error creating uploaded file"
; helloworld greeting page
COM_HELLOWORLD_PARENT="Parent"
COM_HELLOWORLD_CHILDREN="Children"
COM_HELLOWORLD_SEARCH_HERE_BUTTON="Search here"
; Ajax handling errors
COM_HELLOWORLD_ERROR_NO_RECORDS="Didn't get any records"
COM_HELLOWORLD_ERROR_NO_MAP_BOUNDS="Error: no map bounds"
; category view, search and ordering fields and headings
COM_HELLOWORLD_SORT_BY="Sort by ..."
COM_HELLOWORLD_ORDERING_ASC="Ordering asc"
COM_HELLOWORLD_ORDERING_DESC="Ordering desc"
COM_HELLOWORLD_GREETING_ASC="Greeting asc"
COM_HELLOWORLD_GREETING_DESC="Greeting desc"
COM_HELLOWORLD_ID_ASC="id asc"
COM_HELLOWORLD_ID_DESC="id desc"
COM_HELLOWORLD_ALIAS_ASC="alias asc"
COM_HELLOWORLD_ALIAS_DESC="alias desc"
COM_HELLOWORLD_HELLOWORLD_ALIAS_LABEL="Alias"
COM_HELLOWORLD_HELLOWORLD_FIELD_URL_LABEL="URL"
COM_HELLOWORLD_HEADER_SUBCATEGORIES="Subcategories"
; Access errors
COM_HELLOWORLD_MUST_LOGIN="You must login before trying to view this item"
</source>
</span>

<translate>
== Packaging the Component == 
</translate>

<translate> Contents of your code directory. Each file link below takes you to the step in the tutorial which has the latest version of that source code file.</translate>

* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Access#helloworld.xml|helloworld.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Versioning#script.php|script.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#site/router.php|site/router.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_a_view_to_the_site_part#site/helloworld.php|site/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding AJAX#site/controller.php|site/controller.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_an_Image#site/controllers/helloworld.php|site/controllers/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Access#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding AJAX#site/views/helloworld/view.json.php|site/views/helloworld/view.json.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding a Modal#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Tags#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/form/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using the language filter facility#site/views/form/view.html.php|site/views/form/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/form/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_an_Image#site/views/form/tmpl/edit.php|site/views/form/tmpl/edit.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_a_front-end_form#site/views/form/tmpl/edit.xml|site/views/form/tmpl/edit.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/category/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using the language filter facility#site/views/category/view.html.php|site/views/category/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/category/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Access#site/views/category/tmpl/default.php|site/views/category/tmpl/default.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding an alias#site/views/category/tmpl/default.xml|site/views/category/tmpl/default.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/models/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Access#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#site/models/form.php|site/models/form.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Access#site/models/category.php|site/models/category.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/models/forms/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Tags#site/models/forms/add-form.xml|site/models/forms/add-form.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#site/models/forms/filter_category.xml|site/models/forms/filter_category.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/language/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/language/en-GB/index.html]]''
* ''[[S:MyLanguage/J3.x:Developing an MVC Component/Adding Access#site/language/en-GB/en-GB.com_helloworld.ini|site/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/helpers/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Tags#site/helpers/route.php|site/helpers/route.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using the language filter facility#site/helpers/category.php|site/helpers/category.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#site/helpers/association.php|site/helpers/association.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_ACL#admin/helloworld.php|admin/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Versioning#admin/config.xml|admin/config.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Basic_backend#admin/controller.php|admin/controller.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_ACL#admin/access.xml|admin/access.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_categories#admin/helpers/helloworld.php|admin/helpers/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#admin/helpers/associations.php|admin/helpers/associations.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/helpers/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#admin/helpers/html/helloworlds.php|admin/helpers/html/helloworlds.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/helpers/html/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Access#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Tags#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[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]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_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_an_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_an_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_an_MVC_Component/Adding_a_front-end_form#admin/sql/updates/mysql/0.0.16.sql|admin/sql/updates/mysql/0.0.16.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_an_Image#admin/sql/updates/mysql/0.0.17.sql|admin/sql/updates/mysql/0.0.17.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding a Map#admin/sql/updates/mysql/0.0.18.sql|admin/sql/updates/mysql/0.0.18.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding an alias#admin/sql/updates/mysql/0.0.20.sql|admin/sql/updates/mysql/0.0.20.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using the language filter facility#admin/sql/updates/mysql/0.0.21.sql|admin/sql/updates/mysql/0.0.21.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Checkout#admin/sql/updates/mysql/0.0.24.sql|admin/sql/updates/mysql/0.0.24.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Ordering#admin/sql/updates/mysql/0.0.25.sql|admin/sql/updates/mysql/0.0.25.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/sql/updates/mysql/0.0.26.sql|admin/sql/updates/mysql/0.0.26.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Versioning#admin/sql/updates/mysql/0.0.27.sql|admin/sql/updates/mysql/0.0.27.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Tags#admin/sql/updates/mysql/0.0.28.sql|admin/sql/updates/mysql/0.0.28.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Access#admin/sql/updates/mysql/0.0.29.sql|admin/sql/updates/mysql/0.0.29.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_categories#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/models/fields/helloworldordering.php|admin/models/fields/helloworldordering.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/models/fields/helloworldparent.php|admin/models/fields/helloworldparent.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/modal/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#admin/models/fields/modal/helloworld.php|admin/models/fields/modal/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Access#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Tags#admin/models/helloworld.php|admin/models/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Access#admin/models/forms/filter_helloworlds.xml|admin/models/forms/filter_helloworlds.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/forms/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding an alias#admin/models/forms/helloworld.js|admin/models/forms/helloworld.js]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Access#admin/models/forms/helloworld.xml|admin/models/forms/helloworld.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding an alias#admin/models/rules/greeting.php|admin/models/rules/greeting.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/rules/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_ACL#admin/controllers/helloworld.php|admin/controllers/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_backend_actions#admin/controllers/helloworlds.php|admin/controllers/helloworlds.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/controllers/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworld/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Versioning#admin/views/helloworld/view.html.php|admin/views/helloworld/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworld/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Versioning#admin/views/helloworld/tmpl/edit.php|admin/views/helloworld/tmpl/edit.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_verifications#admin/views/helloworld/submitbutton.js|admin/views/helloworld/submitbutton.js]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Access#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#admin/views/helloworlds/tmpl/modal.php|admin/views/helloworlds/tmpl/modal.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/tables/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Tags#admin/tables/helloworld.php|admin/tables/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/language/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/language/en-GB/index.html]]''
* ''[[S:MyLanguage/J3.x:Developing an MVC Component/Adding Access#admin.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.ini|admin/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[S:MyLanguage/J3.x:Developing an MVC Component/Adding Associations#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_an_MVC_Component/Developing_a_Basic_Component#index.html|media/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|media/images/index.html]]''
* ''[[S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_decorations_to_the_backend#Adding_some_icons|media/images/tux-16x16.png]]''
* ''[[S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_decorations_to_the_backend#Adding_some_icons|media/images/tux-48x48.png]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|media/js/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding an alias#media/js/openstreetmap.js|media/js/openstreetmap.js]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding a Modal#media/js/admin-helloworlds-modal.js|media/js/admin-helloworlds-modal.js]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|media/css/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding a Map#index.html|media/css/openstreetmap.css]]''

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

<name>COM_HELLOWORLD</name>

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

<description>COM_HELLOWORLD_DESCRIPTION</description>


<scriptfile>script.php</scriptfile>

<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>
<filename>router.php</filename>
<folder>controllers</folder>
<folder>views</folder>
<folder>models</folder>
<folder>helpers</folder>
</files>

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

<media destination="com_helloworld" folder="media">
<filename>index.html</filename>
<folder>images</folder>
<folder>js</folder>
<folder>css</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>
<language tag="fr-FR">fr-FR/fr-FR.com_helloworld.ini</language>
<language tag="fr-FR">fr-FR/fr-FR.com_helloworld.sys.ini</language>
</languages>
</administration>

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

<translate>
== Contributors == 
</translate>

*[[User:Robbiej|Robbie Jackson]]

<div class="row">
<div class="large-6 columns">{{Basic button|S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding Tags|<translate> Prev: Adding Tags</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding a batch process|<translate> Next: Adding a batch process</translate>|class=expand}}</div>
</div>
__NOTOC__
<noinclude>
[[Category:Joomla! 3.x{{#translation:}}]]
[[Category:Joomla! 3.0{{#translation:}}]]
[[Category:Joomla! 3.1{{#translation:}}]]
[[Category:Joomla! 3.2{{#translation:}}]]
[[Category:Joomla! 3.3{{#translation:}}]]
[[Category:Joomla! 3.4{{#translation:}}]]
[[Category:Beginner Development{{#translation:}}]]
[[Category:Component Development{{#translation:}}]]
[[Category:Tutorials{{#translation:}}]]
[[Category:Tutorials in a Series{{#translation:}}]]
</noinclude>

J3.x:Developing an MVC Component/Adding Tags

2020-03-20T17:35:10Z

ThiagoG: published column added since https://docs.joomla.org/J3.x:Developing_an_MVC_Component/Adding_Levels as we can't publish items without having our helloworld root record published.

J3.x:Developing an MVC Component/Adding Versioning

2020-03-20T17:33:16Z

ThiagoG: published column added since https://docs.joomla.org/J3.x:Developing_an_MVC_Component/Adding_Levels as we can't publish items without having our helloworld root record published.

J3.x:Developing an MVC Component/Adding Levels

2020-03-20T17:31:14Z

ThiagoG: published column added as we can't publish items without having our helloworld root record published.

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

en</translate>}}

<translate> This tutorial is part of the [[S:MyLanguage/J3.2:Developing an MVC Component | Developing an MVC Component for Joomla! 3.2]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.</translate>

<translate> In this step we add levels to our helloworld component, which basically means that we're implementing a tree structure on our helloworld records.</translate>

<translate> You can view an accompanying video at [https://youtu.be/vpchQZFQlso Adding levels].</translate>

{{#widget:YouTube|id=vpchQZFQlso}}

<translate>
== Introduction == 
</translate>
<translate> Joomla implements menuitems and categories as tree structures. This means, for example, that menuitems on a menu can have submenus off them (as can be seen on the Joomla admin menu) and those submenuitems can in turn have submenus off them, and so on. The submenus are ordered, so you can define which order the submenuitems appear.</translate>
<translate> Some terminology:</translate>
<translate>
# each of our records is a node within the tree structure
# there is a root node which occupies the highest position in the hierarchy; within Joomla we define this root node as being at level 0
# the root node has a number of children, and these will be at level 1. Each of these children's parent is the root node
# these children may in turn have children of their own, at level 2, and so on.</translate>

[[File:NestedSetModel.png|right|Nested Set Model]]

{| class="wikitable"
|-
! style="text-align:left;"| Node
! Left
! Right
|-
|Clothing
|1
|22
|-
|Men's
|2
|9
|-
|Suits
|3
|8
|-
|Slacks
|4
|5
|-
|Jackets
|6
|7
|-
|Women's
|10
|21
|-
|Dresses
|11
|16
|-
|Evening Gowns
|12
|13
|-
|Sun Dresses
|14
|15
|-
|Skirts
|17
|18
|-
|Blouses
|19
|20
|}

<translate> To implement this tree structure within a relational database Joomla uses the [https://en.wikipedia.org/wiki/Nested_set_model Nested Set Model]. This involves assigning to each record a left (in Joomla lft) and a right (in Joomla rgt) field, as shown in the diagram and associated table. You should be able to see how using the lft and rgt values you can determine for any node its level in the tree, its parent, and for nodes with the same parent, the ordering of those nodes.</translate>

<translate> While having lft and rgt values may be sufficient to define a tree completely in theory, in practice adding additional fields give more opportunity for navigating the tree efficiently, and in Joomla there are 5 fields associated with a tree structure:</translate>
<translate>
* lft and rgt fields
* parent id – the id of the parent node
* level - the level in the hierarchy, level 0 (Clothing in the example above) being the highest
* path</translate>
<translate> The path is like the path in a directory structure, and is a join of the alias values going from the root node to the node in question, with a slash separating the aliases. For example, referring to the diagram above, if Clothing is the root node, then the path for Jackets would be Men-s/Suits/Jackets.</translate>

<translate> Notice how the additional fields provide us with efficient mechanisms for navigating the tree. For instance, we can do a query selecting records WHERE parent is Suits, and ORDER BY lft, and that will give us Slacks and Jackets in order. These sorts of operations are generally done on the front end, where we want the site to perform well. By contrast, admin operations can involve many updates. For example, if we move Blouses to be the first child under Men's then it will involve updating the lft and rgt values of nearly all the records in the database table.</translate>

<translate> As you might expect, Joomla provides library functions to help with positioning a new node in the tree, reparenting an item, deleting an item (and all of its children), reordering items, etc.</translate>

<translate>
== Functionality == 
</translate>
<translate> Firstly, we'll want our install of this step to build the tree structure in our helloworld table.</translate>

<translate> In our admin helloworlds view we will show the level of the record by indenting the title, as is done for categories and menuitems. We'll also display the values of our new fields – really for our own diagnostic purposes, as you wouldn't do this in a real application.</translate>

<translate> In the previous step we introduced functionality which enabled the administrator to drag the records to reorder them. We'll continue using this mechanism, but reordering will be limited to records having the same parent (ie siblings), and the records will have to be ordered in ascending order first (sorting by "Ordering descending" won't do).</translate>

<translate> If we delete an item, then all of its children will be moved up the hierarchy, to have as parent the parent of the deleted record.</translate>

<translate>
In the admin edit view we'll allow the administrator to:
* specify a new parent for the item
* specify the positioning of this item within the order of its siblings
(albeit, if we change the parent, then the new siblings will appear only after Save).</translate>

<translate> We'll also ensure that New and Save as Copy functionality works as expected.</translate>

<translate> In the frontend we'll change the page which displays a HelloWorld record to present as well the parent and the descendants of that record.</translate>

<translate> We'll also update the frontend form for creating a new helloworld record so that it prompts for the parent as well.</translate>

<translate>
== Approach == 
</translate>

<translate> Initially we'll need to set up our database as a nested set tree. We'll want record with id=1 to be the root of the tree, so if there's an existing record with id=1 we'll give it a new number, and we'll change any associated records in the Assets and Associations table. After the root record is in place, we'll set the other helloworld records as direct children of the root, and set the new fields accordingly. As this is too complex to do in SQL script, we'll code this within the install <tt>script.php</tt> file.</translate>

<translate> The code for performing operations on the nested set database fields is within <tt>JTableNested</tt>, so we change our helloworld table class to inherit from it instead of <tt>JTable</tt>. We'll use a number of methods from within this class to apply database changes arising from admin operations:</translate>
* <translate> <tt>setLocation($referenceId, $position)</tt> to define how the current record is positioned (for ordering) with respect to its siblings - we'll use this when the administrator uses the helloworld edit form and changes the parent or the ordering of the record with respect to its siblings</translate>
* <translate> <tt>saveorder($idArray, $lft_array)</tt> to store a revised order of siblings - we'll use this whenever the administrator uses the drag record functionality to move a record</translate>
* <translate> <tt>store($updateNulls)</tt> to store a new or updated record - this will be called by the <tt>save()</tt> method in <tt>JModelAdmin</tt></translate>
* <translate> <tt>delete($pk, $children)</tt> to delete a record and (optionally) all of its descendants - we'll use this whenever the administrator deletes one or more helloworld records, and we'll use the option of NOT deleting the descendants.</translate>
* <translate> <tt>rebuild(...)</tt> to recalculate the lft, rgt and path values for the helloworld records - we'll use this after we reposition a record by changing its parent or ordering in the edit form.</translate>

<translate> In our Helloworlds layout file the display of the new fields is straightforward. The other changes involve the following.</translate>
# <translate> To indent the records based on the level (as is done for menus and categories) we'll use the standard joomla layout in layouts/joomla/html/treeprefix.php</translate>
# <translate> To support dragging the rows to reorder, the javascript code in sortablelist.js which we encountered in the previous step [[S:MyLanguage/J3.x:Developing an MVC Component/Adding Ordering|Adding Ordering]] will be used again, but for handing the nested set we specify different parameters to the function, and we need to add different attributes to the <tr> elements.</translate>

<translate> In our Helloworld (edit) layout we'll display the input elements to capture</translate>
* <translate> the record's parent – this will be a list of all the helloworld records, but excluding the record itself (as a record can't have itself as its parent) and its descendants (as this would form a loop in the tree), and,</translate>
* <translate> its position with respect to the record's siblings – for outputting the siblings in order.</translate>

<translate> Because of the specific requirements of these select lists, neither can be implemented using a standard Joomla form field and XML, and we'll define a custom form field for each and define the list of possible values dynamically.</translate>

<translate> In the front end we'll use another Nested Table function <tt>getTree()</tt> to find the descendants of the record we're displaying. And in the front-end form for creating a new record we'll reuse the admin custom form field for presenting the list of records to choose a parent.</translate>

<translate> Where in the previous tutorial step we used the <tt>ordering</tt> database field for ordering, in this step we will use the <tt>lft</tt> database field. So that is a global change within both our admin and site code.</translate>

<translate>
== Database and Install == 
</translate>

<translate> Updated SQL install file:</translate>

<span id="admin/sql/install.mysql.utf8.sql">
<tt>admin/sql/install.mysql.utf8.sql</tt>
<source lang="sql" highlight="13-17,32-35">
DROP TABLE IF EXISTS `#__helloworld`;

CREATE TABLE `#__helloworld` (
`id` INT(11) NOT NULL AUTO_INCREMENT,
`asset_id` INT(10) NOT NULL DEFAULT '0',
`created` DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
`created_by` INT(10) UNSIGNED NOT NULL DEFAULT '0',
`checked_out` INT(10) NOT NULL DEFAULT '0',
`checked_out_time` DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00',
`greeting` VARCHAR(25) NOT NULL,
`alias` VARCHAR(40) NOT NULL DEFAULT '',
`language` CHAR(7) NOT NULL DEFAULT '*',
`parent_id` int(10) NOT NULL DEFAULT '1',
`level` int(10) NOT NULL DEFAULT '0',
`path` VARCHAR(400) NOT NULL DEFAULT '',
`lft` int(11) NOT NULL DEFAULT '0',
`rgt` int(11) NOT NULL DEFAULT '0',
`published` tinyint(4) NOT NULL DEFAULT '1',
`catid` int(11) NOT NULL DEFAULT '0',
`params` VARCHAR(1024) NOT NULL DEFAULT '',
`image` VARCHAR(1024) NOT NULL DEFAULT '',
`latitude` DECIMAL(9,7) NOT NULL DEFAULT 0.0,
`longitude` DECIMAL(10,7) NOT NULL DEFAULT 0.0,
PRIMARY KEY (`id`)
)
ENGINE =MyISAM
AUTO_INCREMENT =0
DEFAULT CHARSET =utf8;

CREATE UNIQUE INDEX `aliasindex` ON `#__helloworld` (`alias`, `catid`);

/*We added the publish column in order to publish the helloworld root record, otherwise you won't be able to publish items.*/

INSERT INTO `#__helloworld` (`greeting`,`alias`,`language`, `parent_id`, `level`, `path`, `lft`, `rgt`, `published`) VALUES
('helloworld root','helloworld-root-alias','en-GB', 0, 0, '', 0, 5, 1),
('Hello World!','hello-world','en-GB', 1, 1, 'hello-world', 1, 2, 0),
('Goodbye World!','goodbye-world','en-GB', 1, 1, 'goodbye-world', 3, 4, 0);
</source>
</span>

<translate> For the upgrade we define the new database structure in the file below ...</translate>

<span id="admin/sql/updates/mysql/0.0.26.sql">
<tt>/admin/sql/updates/mysql/0.0.26.sql</tt>
<source lang="sql">
ALTER TABLE `#__helloworld` DROP COLUMN `ordering`;
ALTER TABLE `#__helloworld` ADD COLUMN `parent_id` INT(10) NOT NULL DEFAULT '1' AFTER `language`;
ALTER TABLE `#__helloworld` ADD COLUMN `level` int(10) NOT NULL DEFAULT '0' AFTER `parent_id`;
ALTER TABLE `#__helloworld` ADD COLUMN `path` varchar(400) NOT NULL DEFAULT '' AFTER `level`;
ALTER TABLE `#__helloworld` ADD COLUMN `lft` int(11) NOT NULL DEFAULT '0' AFTER `path`;
ALTER TABLE `#__helloworld` ADD COLUMN `rgt` int(11) NOT NULL DEFAULT '0' AFTER `lft`;
UPDATE `#__helloworld` SET `path` = `alias`;
</source>
</span>

<translate> But for building the tree we use an install <tt>script.php</tt> file. This code does the following:</translate>
# <translate> it checks if there's already a root record with id=1. If so, then it assumes that the tree has been built, and it exits without changing anything.</translate>
# <translate> otherwise if there's an ordinary record with id=1, then it changes its id to one bigger than the max id in the table. It then changes any associated record in the Assets table and in the Associations table. (We looked at how the key in the Associations table was created using an md5 hash in [[S:MyLanguage/J3.x:Developing an MVC Component/Adding Associations|Adding Associations]]. If the helloworld record with id=1 had had this new id originally, then the associations key formed by the md5 hash would have been different, but actually that doesn't matter. In fact, when the md5 hash is done, if the associations in the array are in a different order then it would produce a different key anyway).</translate>
# <translate> it creates the root record, with id=1, and sets the lft and rgt values for it (based on the total number of records in the table).</translate>
# <translate> it updates the lft and rgt values for all the existing helloworld records in the table.</translate>

<span id="script.php">
<tt>script.php</tt>
<source lang="php" highlight="93-248">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

/**
* Script file of HelloWorld component.
*
* The name of this class is dependent on the component being installed.
* The class name should have the component's name, directly followed by
* the text InstallerScript (ex:. com_helloWorldInstallerScript).
*
* This class will be called by Joomla!'s installer, if specified in your component's
* manifest file, and is used for custom automation actions in its installation process.
*
* In order to use this automation script, you should reference it in your component's
* manifest file as follows:
* <scriptfile>script.php</scriptfile>
*
* @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
*/
class com_helloWorldInstallerScript
{
/**
* This method is called after a component is installed.
*
* @param \stdClass $parent - Parent object calling this method.
*
* @return void
*/
public function install($parent)
{
$parent->getParent()->setRedirectURL('index.php?option=com_helloworld');
}

/**
* This method is called after a component is uninstalled.
*
* @param \stdClass $parent - Parent object calling this method.
*
* @return void
*/
public function uninstall($parent)
{
echo '<p>' . JText::_('COM_HELLOWORLD_UNINSTALL_TEXT') . '</p>';
}

/**
* This method is called after a component is updated.
*
* @param \stdClass $parent - Parent object calling object.
*
* @return void
*/
public function update($parent)
{
echo '<p>' . JText::sprintf('COM_HELLOWORLD_UPDATE_TEXT', $parent->get('manifest')->version) . '</p>';
}

/**
* Runs just before any installation action is preformed on the component.
* Verifications and pre-requisites should run in this function.
*
* @param string $type - Type of PreFlight action. Possible values are:
* - * install
* - * update
* - * discover_install
* @param \stdClass $parent - Parent object calling object.
*
* @return void
*/
public function preflight($type, $parent)
{
echo '<p>' . JText::_('COM_HELLOWORLD_PREFLIGHT_' . $type . '_TEXT') . '</p>';
}

/**
* Runs right after any installation action is preformed on the component.
*
* @param string $type - Type of PostFlight action. Possible values are:
* - * install
* - * update
* - * discover_install
* @param \stdClass $parent - Parent object calling object.
*
* @return void
*/
function postflight($type, $parent)
{
$db = JFactory::getDbo();

echo '<p>Checking if the root record is already present ...</p>';

$query = $db->getQuery(true);
$query->select('id');
$query->from('#__helloworld');
$query->where('id = 1');
$query->where('alias = "helloworld-root-alias"');
$db->setQuery($query);
$id = $db->loadResult();

if ($id == '1')
{ // assume tree structure already built
echo '<p>Root record already present, install program exiting ...</p>';
return;
}

echo '<p>Checking if there is a record with id = 1 ...</p>';

$query = $db->getQuery(true);
$query->select('id');
$query->from('#__helloworld');
$query->where('id = 1');
$db->setQuery($query);
$id = $db->loadResult();

if ($id)
{
echo '<p>Record with id = 1 found</p>';

// get new id
$query = $db->getQuery(true)
->select('max(id) + 1')
->from('#__helloworld');
$db->setQuery($query);
$newid = $db->loadResult();
echo "<p>Changing id to $newid</p>";

// update id in helloworld table
$query = $db->getQuery(true)
->update('#__helloworld')
->set("id = $newid")
->where("id = $id");
$db->setQuery($query);
$result = $db->execute();
if ($result)
{
$nrows = $db->getAffectedRows();
echo "<p>Id in helloworld table changed, records updated: $nrows</p>";
}
else
{
echo "<p>Error: Id in helloworld table not changed</p>";
var_dump($result);
}

// update id in the associations table
$query = $db->getQuery(true)
->update('#__associations')
->set("id = $newid")
->where("id = $id")
->where('context = "com_helloworld.item"');
$db->setQuery($query);
$result = $db->execute();
if ($result)
{
$nrows = $db->getAffectedRows();
echo "<p>Id in associations table changed, records updated: $nrows</p>";
}
else
{
echo "<p>Error: Id in associations table not changed</p>";
var_dump($result);
}

// update id in the assets table
$query = $db->getQuery(true)
->update('#__assets')
->set('name = "com_helloworld.helloworld.' . $newid . '"')
->where('name = "com_helloworld.helloworld.' . $id . '"');
$db->setQuery($query);
$result = $db->execute();
if ($result)
{
$nrows = $db->getAffectedRows();
echo "<p>Id in assets table changed, records updated: $nrows</p>";
}
else
{
echo "<p>Error: Id in assets table not changed</p>";
var_dump($result);
}
}
else
{
echo '<p>No record with id = 1 found</p>';
}

// find number of records in helloworld table
$query = $db->getQuery(true)
->select('count(*)')
->from('#__helloworld');
$db->setQuery($query);
$total = $db->loadResult();

// insert root record
$columns = array('id','greeting','alias','parent_id','rgt');
$values = array(1, 'helloworld root','helloworld-root-alias',0, 2 * (int)$total + 1);

$query = $db->getQuery(true)
->insert('#__helloworld')
->columns($db->quoteName($columns))
->values(implode(',', $db->quote($values)));
$db->setQuery($query);
$result = $db->execute();
if ($result)
{
$nrows = $db->getAffectedRows();
echo "<p>$nrows inserted into helloworld table</p>";
}
else
{
echo "<p>Error creating root record</p>";
var_dump($result);
}

// update lft and rgt for each of the other records (ie not root)
$query = $db->getQuery(true)
->select('id')
->from('#__helloworld')
->where('id > 1');
$db->setQuery($query);
$ids = $db->loadColumn();
for ($i = 0; $i < $total; $i++)
{
$lft = 2 * (int)$i + 1;
$rgt = 2 * (int)$i + 2;
$query = $db->getQuery(true)
->update('#__helloworld')
->set("lft = {$lft}")
->set("rgt = {$rgt}")
->where("id = {$ids[$i]}");
$db->setQuery($query);
$result = $db->execute();
if ($result)
{
$nrows = $db->getAffectedRows();
echo "<p>$nrows updated in helloworld table, for id = {$ids[$i]}</p>";
}
else
{
echo "<p>Error updating record</p>";
var_dump($result);
}
}
}
}
</source>
</span>

<translate>
== Helloworlds MVC == 
</translate>

<translate> Updated model file to include the new fields. The default ordering has been set to be based on the tree structure, as it's arguably more appropriate than being based on the greeting.</translate>

<span id="admin/models/helloworlds.php">
<tt>admin/models/helloworlds.php</tt>
<source lang="php" highlight="37,47,86-87,153-154,157">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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
{
/**
* Constructor.
*
* @param array $config An optional associative array of configuration settings.
*
* @see JController
* @since 1.6
*/
public function __construct($config = array())
{
if (empty($config['filter_fields']))
{
$config['filter_fields'] = array(
'id',
'greeting',
'author',
'created',
'language',
'lft',
'category_id',
'association',
'published'
);
}

parent::__construct($config);
}

protected function populateState($ordering = 'lft', $direction = 'asc')
{
$app = JFactory::getApplication();

// Adjust the context to support modal layouts.
if ($layout = $app->input->get('layout'))
{
$this->context .= '.' . $layout;
}

// Adjust the context to support forced languages.
$forcedLanguage = $app->input->get('forcedLanguage', '', 'CMD');
if ($forcedLanguage)
{
$this->context .= '.' . $forcedLanguage;
}

parent::populateState($ordering, $direction);

// If there's a forced language then define that filter for the query where clause
if (!empty($forcedLanguage))
{
$this->setState('filter.language', $forcedLanguage);
}
}

/**
* 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('a.id as id, a.greeting as greeting, a.published as published, a.created as created,
a.checked_out as checked_out, a.checked_out_time as checked_out_time, a.catid as catid,
a.lft as lft, a.rgt as rgt, a.parent_id as parent_id, a.level as level, a.path as path,
a.image as imageInfo, a.latitude as latitude, a.longitude as longitude, a.alias as alias, a.language as language')
->from($db->quoteName('#__helloworld', 'a'));

// Join over the categories.
$query->select($db->quoteName('c.title', 'category_title'))
->join('LEFT', $db->quoteName('#__categories', 'c') . ' ON c.id = a.catid');

// Join with users table to get the username of the author
$query->select($db->quoteName('u.username', 'author'))
->join('LEFT', $db->quoteName('#__users', 'u') . ' ON u.id = a.created_by');

// Join with users table to get the username of the person who checked the record out
$query->select($db->quoteName('u2.username', 'editor'))
->join('LEFT', $db->quoteName('#__users', 'u2') . ' ON u2.id = a.checked_out');

// Join with languages table to get the language title and image to display
// Put these into fields called language_title and language_image so that
// we can use the little com_content layout to display the map symbol
$query->select($db->quoteName('l.title', 'language_title') . "," .$db->quoteName('l.image', 'language_image'))
->join('LEFT', $db->quoteName('#__languages', 'l') . ' ON l.lang_code = a.language');

// Join over the associations - we just want to know if there are any, at this stage
if (JLanguageAssociations::isEnabled())
{
$query->select('COUNT(asso2.id)>1 as association')
->join('LEFT', '#__associations AS asso ON asso.id = a.id AND asso.context=' . $db->quote('com_helloworld.item'))
->join('LEFT', '#__associations AS asso2 ON asso2.key = asso.key')
->group('a.id');
}

// Filter: like / search
$search = $this->getState('filter.search');

if (!empty($search))
{
$like = $db->quote('%' . $search . '%');
$query->where('greeting LIKE ' . $like);
}

// Filter by published state
$published = $this->getState('filter.published');

if (is_numeric($published))
{
$query->where('a.published = ' . (int) $published);
}
elseif ($published === '')
{
$query->where('(a.published IN (0, 1))');
}

// Filter by language, if the user has set that in the filter field
$language = $this->getState('filter.language');
if ($language)
{
$query->where('a.language = ' . $db->quote($language));
}

// Filter by categories
$catid = $this->getState('filter.category_id');
if ($catid)
{
$query->where("a.catid = " . $db->quote($db->escape($catid)));
}

// exclude root helloworld record
$query->where('a.id > 1');

// Add the list ordering clause.
$orderCol = $this->state->get('list.ordering', 'lft');
$orderDirn = $this->state->get('list.direction', 'asc');

$query->order($db->escape($orderCol) . ' ' . $db->escape($orderDirn));

return $query;
}
}
</source>
</span>

<translate> In our view file we create a mapping of parent id to the ids of its children. This enables us to find more easily the successive parents of a record up the hierarchy, which we'll do in the layout file.</translate>

<span id="admin/views/helloworlds/view.html.php">
<tt>admin/views/helloworlds/view.html.php</tt>
<source lang="php" highlight="70-75">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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();

// Get data from the model
$this->items = $this->get('Items');
$this->pagination = $this->get('Pagination');
$this->state = $this->get('State');
$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('com_helloworld');

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

return false;
}

// Set the sidebar submenu and toolbar, but not on the modal window
if ($this->getLayout() !== 'modal')
{
HelloWorldHelper::addSubmenu('helloworlds');
$this->addToolBar();
}
else
{
// If it's being displayed to select a record as an association, then forcedLanguage is set
if ($forcedLanguage = $app->input->get('forcedLanguage', '', 'CMD'))
{
// Transform the language selector filter into an hidden field, so it can't be set
$languageXml = new SimpleXMLElement('<field name="language" type="hidden" default="' . $forcedLanguage . '" />');
$this->filterForm->setField($languageXml, 'filter', true);

// Also, unset the active language filter so the search tools is not open by default with this filter.
unset($this->activeFilters['language']);
}
}

// Prepare a mapping from parent id to the ids of its children
$this->ordering = array();
foreach ($this->items as $item)
{
$this->ordering[$item->parent_id][] = $item->id;
}

// 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.edit') || JFactory::getUser()->authorise('core.manage', 'com_checkin'))
{
JToolBarHelper::checkin('helloworlds.checkin');
}
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>

<translate> In our layout file we include new columns for the lft, rgt, level and parent fields (although with headings which are just the database field names rather than translated strings), and include the path in small letters below the alias under the greeting. We also change the parameters for the javascript in <tt>sortablelist.js</tt> which enables the dragging of rows to reorder the rows which have the same parent.</translate>

<translate> This javascript code hides all the descendants (not just immediate children) when dragging is being performed, so for each row there's a little work to create a list of the successive parents of that row, going up the tree hierarchy, which is then put into the parents attribute of the <tt><tr></tt> element. When a row with id=xxx is being dragged, the javascript then hides any row in which the id xxx appears in this parents attribute.</translate>

<span id="admin/views/helloworlds/tmpl/default.php">
<tt>admin/views/helloworlds/tmpl/default.php</tt>
<source lang="php" highlight="21,25-26,52,58,61,64,67-78,80,114-138,140,157,165-166,180-182,194-205">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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');

use Joomla\Registry\Registry;

JHtml::_('formbehavior.chosen', 'select');

$listOrder = $this->escape($this->state->get('list.ordering'));
$listDirn = $this->escape($this->state->get('list.direction'));
$user = JFactory::getUser();
$userId = $user->get('id');
$saveOrder = ($listOrder == 'lft' && strtolower($listDirn) == 'asc');
if ($saveOrder)
{
$saveOrderingUrl = 'index.php?option=com_helloworld&task=helloworlds.saveOrderAjax&tmpl=component';
// pass true as parameter 7 to indicate that we have a nested set
JHtml::_('sortablelist.sortable', 'helloworldList', 'adminForm', strtolower($listDirn), $saveOrderingUrl, false, true);
}
$assoc = JLanguageAssociations::isEnabled();
$authorFieldwidth = $assoc ? "10%" : "25%";
JLoader::register('JHtmlHelloworlds', JPATH_ADMINISTRATOR . '/components/com_helloworld/helpers/html/helloworlds.php');
?>
<form action="index.php?option=com_helloworld&view=helloworlds" method="post" id="adminForm" name="adminForm">
<div id="j-sidebar-container" class="span2">
<?php echo JHtmlSidebar::render(); ?>
</div>
<div id="j-main-container" class="span10">
<div class="row-fluid">
<div class="span6">
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLDS_FILTER'); ?>
<?php
echo JLayoutHelper::render(
'joomla.searchtools.default',
array('view' => $this)
);
?>
</div>
</div>
<table class="table table-striped table-hover" id="helloworldList">
<thead>
<tr>
<th width="1%">
<?php echo JHtml::_('searchtools.sort', '', 'lft', $listDirn, $listOrder, null, 'asc', 'JGRID_HEADING_ORDERING', 'icon-menu-2'); ?>
</th>
<th width="1%"><?php echo JText::_('COM_HELLOWORLD_NUM'); ?></th>
<th width="1%">
<?php echo JHtml::_('grid.checkall'); ?>
</th>
<th width="10%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_HELLOWORLDS_NAME', 'greeting', $listDirn, $listOrder); ?>
</th>
<th width="10%">
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLDS_POSITION'); ?>
</th>
<th width="10%">
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLDS_IMAGE'); ?>
</th>
<th width="5%">
<?php echo "lft"; ?>
</th>
<th width="5%">
<?php echo "rgt"; ?>
</th>
<th width="5%">
<?php echo "level"; ?>
</th>
<th width="5%">
<?php echo "parent"; ?>
</th>
<?php if ($assoc) : ?>
<th width="10%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_HELLOWORLDS_ASSOCIATIONS', 'association', $listDirn, $listOrder); ?>
</th>
<?php endif; ?>
<th width="<?php echo $authorFieldwidth; ?>">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_AUTHOR', 'author', $listDirn, $listOrder); ?>
</th>
<th width="10%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_LANGUAGE', 'language', $listDirn, $listOrder); ?>
</th>
<th width="10%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_CREATED_DATE', 'created', $listDirn, $listOrder); ?>
</th>
<th width="5%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_PUBLISHED', 'published', $listDirn, $listOrder); ?>
</th>
<th width="2%">
<?php echo JHtml::_('searchtools.sort', 'COM_HELLOWORLD_ID', 'id', $listDirn, $listOrder); ?>
</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) :
$link = JRoute::_('index.php?option=com_helloworld&task=helloworld.edit&id=' . $row->id);
$row->image = new Registry;
$row->image->loadString($row->imageInfo);
// create a list of the parents up the hierarchy to the root
if ($row->level > 1)
{
$parentsStr = '';
$_currentParentId = $row->parent_id;
$parentsStr = ' ' . $_currentParentId;
for ($j = 0; $j < $row->level; $j++)
{
foreach ($this->ordering as $k => $v)
{
$v = implode('-', $v);
$v = '-' . $v . '-';
if (strpos($v, '-' . $_currentParentId . '-') !== false)
{
$parentsStr .= ' ' . $k;
$_currentParentId = $k;
break;
}
}
}
}
else
{
$parentsStr = '';
}
?>
<tr class="row<?php echo $i % 2; ?>" sortable-group-id="<?php echo $row->parent_id; ?>" item-id="<?php echo $row->id; ?>" parents="<?php echo $parentsStr; ?>" level="<?php echo $row->level; ?>">
<td><?php
$iconClass = '';
$canReorder = $user->authorise('core.edit.state', 'com_helloworld.helloworld.' . $row->id);
if (!$canReorder)
{
$iconClass = ' inactive';
}
elseif (!$saveOrder)
{
$iconClass = ' inactive tip-top hasTooltip" title="' . JHtml::_('tooltipText', 'JORDERINGDISABLED');
}
?>
<span class="sortable-handler<?php echo $iconClass ?>">
<span class="icon-menu" aria-hidden="true"></span>
</span>
<?php if ($canReorder && $saveOrder) : ?>
<input type="text" style="display:none" name="order[]" size="5" value="<?php echo $row->lft; ?>" class="width-20 text-area-order" />
<?php endif; ?>
</td>
<td><?php echo $this->pagination->getRowOffset($i); ?></td>
<td>
<?php echo JHtml::_('grid.id', $i, $row->id); ?>
</td>
<td>
<?php $prefix = JLayoutHelper::render('joomla.html.treeprefix', array('level' => $row->level)); ?>
<?php echo $prefix; ?>
<?php if ($row->checked_out) : ?>
<?php $canCheckin = $user->authorise('core.manage', 'com_checkin') || $row->checked_out == $userId; ?>
<?php echo JHtml::_('jgrid.checkedout', $i, $row->editor, $row->checked_out_time, 'helloworlds.', $canCheckin); ?>
<?php endif; ?>
<a href="<?php echo $link; ?>" title="<?php echo JText::_('COM_HELLOWORLD_EDIT_HELLOWORLD'); ?>">
<?php echo $row->greeting; ?>
</a>
<span class="small break-word">
<?php echo JText::sprintf('JGLOBAL_LIST_ALIAS', $this->escape($row->alias)); ?>
</span>
<div class="small">
<?php echo JText::_('JCATEGORY') . ': ' . $this->escape($row->category_title); ?>
</div>
<div class="small">
<?php echo 'Path: ' . $this->escape($row->path); ?>
</div>
</td>
<td align="center">
<?php echo "[" . $row->latitude . ", " . $row->longitude . "]"; ?>
</td>
<td align="center">
<?php
$caption = $row->image->get('caption') ? : '' ;
$src = JURI::root() . ($row->image->get('image') ? : '' );
$html = '<p class="hasTooltip" style="display: inline-block" data-html="true" data-toggle="tooltip" data-placement="right" title="<img width=\'100px\' height=\'100px\' src=\'%s\'>">%s</p>';
echo sprintf($html, $src, $caption); ?>
</td>
<td align="center">
<?php echo $row->lft; ?>
</td>
<td align="center">
<?php echo $row->rgt; ?>
</td>
<td align="center">
<?php echo $row->level; ?>
</td>
<td align="center">
<?php echo $row->parent_id; ?>
</td>
<?php if ($assoc) : ?>
<td align="center">
<?php if ($row->association) : ?>
<?php echo JHtml::_('helloworlds.association', $row->id); ?>
<?php endif; ?>
</td>
<?php endif; ?>
<td align="center">
<?php echo $row->author; ?>
</td>
<td align="center">
<?php echo JLayoutHelper::render('joomla.content.language', $row); ?>
</td>
<td align="center">
<?php echo substr($row->created, 0, 10); ?>
</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>
<input type="hidden" name="task" value=""/>
<input type="hidden" name="boxchecked" value="0"/>
<?php echo JHtml::_('form.token'); ?>
</div>
</form>
</source>
</span>

<translate> We also need to change "ordering" option within the filter fields to use the <tt>lft</tt> database field instead of the <tt>ordering</tt> field which we had in the previous step, and make the default ordering by <tt>lft</tt>.</translate>

<span id="admin/models/forms/filter_helloworlds.xml">
<tt>admin/models/forms/filter_helloworlds.xml</tt>
<source lang="xml" highlight="48,51-52">
<?xml version="1.0" encoding="utf-8"?>
<form>
<fields name="filter">
<field
name="search"
type="text"
label="COM_BANNERS_SEARCH_IN_TITLE"
hint="JSEARCH_FILTER"
class="js-stools-search-string"
/>
<field
name="published"
type="status"
label="JOPTION_SELECT_PUBLISHED"
description="JOPTION_SELECT_PUBLISHED_DESC"
onchange="this.form.submit();"
>
<option value="">JOPTION_SELECT_PUBLISHED</option>
</field>
<field
name="language"
type="contentlanguage"
label="JOPTION_FILTER_LANGUAGE"
description="JOPTION_FILTER_LANGUAGE_DESC"
onchange="this.form.submit();"
>
<option value="">JOPTION_SELECT_LANGUAGE</option>
<option value="*">JALL</option>
</field>
<field
name="category_id"
type="category"
label="JOPTION_FILTER_CATEGORY"
extension="com_helloworld"
onchange="this.form.submit();"
published="0,1,2"
>
<option value="">JOPTION_SELECT_CATEGORY</option>
</field>
</fields>
<fields name="list">
<field
name="fullordering"
type="list"
label="COM_HELLOWORLD_LIST_FULL_ORDERING"
description="COM_HELLOWORLD_LIST_FULL_ORDERING_DESC"
onchange="this.form.submit();"
default="lft ASC"
>
<option value="">JGLOBAL_SORT_BY</option>
<option value="lft ASC">COM_HELLOWORLD_ORDERING_ASC</option>
<option value="lft DESC">COM_HELLOWORLD_ORDERING_DESC</option>
<option value="greeting ASC">COM_HELLOWORLD_GREETING_ASC</option>
<option value="greeting DESC">COM_HELLOWORLD_GREETING_DESC</option>
<option value="id ASC">JGRID_HEADING_ID_ASC</option>
<option value="id DESC">JGRID_HEADING_ID_DESC</option>
<option value="published ASC">COM_HELLOWORLD_PUBLISHED_ASC</option>
<option value="published DESC">COM_HELLOWORLD_PUBLISHED_DESC</option>
<option value="author ASC">COM_HELLOWORLD_AUTHOR_ASC</option>
<option value="author DESC">COM_HELLOWORLD_AUTHOR_DESC</option>
<option value="created ASC">COM_HELLOWORLD_CREATED_ASC</option>
<option value="created DESC">COM_HELLOWORLD_CREATED_DESC</option>
<option value="language ASC">COM_HELLOWORLD_LANGUAGE_ASC</option>
<option value="language DESC">COM_HELLOWORLD_LANGUAGE_DESC</option>
<option value="association ASC">COM_HELLOWORLD_ASSOCIATION_ASC</option>
<option value="association DESC">COM_HELLOWORLD_ASSOCIATION_DESC</option>
</field>
<field
name="limit"
type="limitbox"
class="input-mini"
default="25"
label="COM_CONTENT_LIST_LIMIT"
description="COM_HELLOWORLD_LIST_LIMIT_DESC"
onchange="this.form.submit();"
/>
</fields>
</form>
</source>
</span>

<translate>
== Helloworld Edit Form == 
</translate>

<translate> The form is updated to include the 2 new input elements for capturing the parent and the ordering.</translate>

<translate> The helloworldparent field will result in a <tt>jform['parent_id']</tt> parameter being passed in the HTTP POST from the form, and this will be mapped to the <tt>parent_id</tt> field of the record.</translate>

<translate> The helloworldordering field will result in a <tt>jform['helloworldordering']</tt> parameter containing the id of the sibling below which this record should be placed, or a special value of -1 (to set it as the first child) or -2 (to set it as the last child). This field doesn't map to a field in the database, but will be used to position the location of the edited record.</translate>

<span id="admin/models/forms/helloworld.xml">
<tt>admin/models/forms/helloworld.xml</tt>
<source lang="xml" highlight="74-89">
<?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="alias"
type="text"
label="JFIELD_ALIAS_LABEL"
description="JFIELD_ALIAS_DESC"
hint="JFIELD_ALIAS_PLACEHOLDER"
size="40"
/>
<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>
<field
name="latitude"
type="number"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_LATITUDE_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_LATITUDE_DESC"
min="-90.0"
max="90.0"
class="inputbox"
required="true"
default="0.0"
/>
<field
name="longitude"
type="number"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_LONGITUDE_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_LONGITUDE_DESC"
min="-180.0"
max="180.0"
class="inputbox"
required="true"
default="0.0"
/>
<field
name="language"
type="contentlanguage"
label="JFIELD_LANGUAGE_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_LANGUAGE_DESC"
>
<option value="*">JALL</option>
</field>
<field
name="parent_id"
type="helloworldparent"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_DESC"
default="1"
filter="int">
</field>
<field
name="helloworldordering"
type="helloworldordering"
label="JFIELD_ORDERING_LABEL"
description="JFIELD_ORDERING_DESC"
filter="int"
size="1">
</field>
</fieldset>
<fields name="imageinfo">
<fieldset
name="image-info"
label="COM_HELLOWORLD_IMAGE_FIELDS"
>
<field
name="image"
type="media"
preview="tooltip"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_IMAGE_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_IMAGE_DESC" />
<field name="alt"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_ALT_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_ALT_DESC"
size="30"/>
<field name="caption"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTION_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTION_DESC"
size="30"/>
</fieldset>
</fields>
<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> Both of the two new input elements are custom fields, so we will need to provide definitions of them in two new files within the <tt>admin/models/fields</tt> directory. Firstly the parent:</translate>

<span id="admin/models/fields/helloworldparent.php">
<tt>admin/models/fields/helloworldparent.php</tt>
<source lang="php">
<?php
/**
* Class associated with displaying an input field to capture the parent of a helloworld record
*/

defined('JPATH_BASE') or die;

JFormHelper::loadFieldClass('list');

class JFormFieldHelloworldParent extends JFormFieldList
{
protected $type = 'HelloworldParent';

/**
* Method to return the field options for the parent
*
*/
protected function getOptions()
{
$options = array();

$db = JFactory::getDbo();
$query = $db->getQuery(true)
->select('DISTINCT(a.id) AS value, a.greeting AS text, a.level, a.lft')
->from('#__helloworld AS a');

// Prevent parenting to children of this record, or to itself
// If this record has lft = x and rgt = y, then its children have lft > x and rgt < y
if ($id = $this->form->getValue('id'))
{
$query->join('LEFT', $db->quoteName('#__helloworld') . ' AS h ON h.id = ' . (int) $id)
->where('NOT(a.lft >= h.lft AND a.rgt <= h.rgt)');
}

$query->order('a.lft ASC');

$db->setQuery($query);

try
{
$options = $db->loadObjectList();
}
catch (RuntimeException $e)
{
JError::raiseWarning(500, $e->getMessage());
}

// Pad the option text with spaces using depth level as a multiplier.
for ($i = 0; $i < count($options); $i++)
{
$options[$i]->text = str_repeat('- ', $options[$i]->level) . $options[$i]->text;
}

// Merge any additional options in the XML definition.
$options = array_merge(parent::getOptions(), $options);

return $options;

}
}
</source>
</span>

<translate> And secondly, the ordering</translate>

<span id="admin/models/fields/helloworldordering.php">
<tt>admin/models/fields/helloworldordering.php</tt>
<source lang="php">
<?php
/**
* Class for displaying the Ordering field in the helloworld edit layout
*/

defined('JPATH_BASE') or die;

JFormHelper::loadFieldClass('list');

class JFormFieldHelloworldOrdering extends JFormFieldList
{
protected $type = 'HelloworldOrdering';

/**
* Method to return the options for ordering the helloworld record
* This is the list of siblings the record's siblings - ie those records with the same parent.
* The method requires that parent id be set.
*/
protected function getOptions()
{
$options = array();

// Get the parent
$parent_id = $this->form->getValue('parent_id', 0);

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

$db = JFactory::getDbo();
$query = $db->getQuery(true)
->select('a.id AS value, a.greeting AS text')
->from('#__helloworld AS a')
->where('a.parent_id =' . (int) $parent_id);

$query->order('a.lft ASC');

// Get the options.
$db->setQuery($query);

try
{
$options = $db->loadObjectList();
}
catch (RuntimeException $e)
{
JError::raiseWarning(500, $e->getMessage());
}

$options = array_merge(
array(array('value' => '-1', 'text' => JText::_('COM_HELLOWORLD_ITEM_FIELD_ORDERING_VALUE_FIRST'))),
$options,
array(array('value' => '-2', 'text' => JText::_('COM_HELLOWORLD_ITEM_FIELD_ORDERING_VALUE_LAST')))
);

// Merge any additional options in the XML definition.
$options = array_merge(parent::getOptions(), $options);

return $options;
}

/**
* Method to get the field input markup.
*
* @return string The field input markup.
*
* This method returns the input element except if a new record is being created, in which case a text string is output
*/
protected function getInput()
{
if ($this->form->getValue('id', 0) == 0)
{
return '<span class="readonly">' . JText::_('COM_HELLOWORLD_ITEM_FIELD_ORDERING_TEXT') . '</span>';
}
else
{
return parent::getInput();
}
}
}
</source>
</span>

<translate>
== Handling Admin Record Updates == 
</translate>

<translate> Our Helloworld model and Helloworld table code together handle the updates arising from admin operations on the helloworld edit form and on the helloworlds view. With reference to the two updated files below, here's how these updates are processed.</translate>

<translate> '''Dragging a row to reorder'''</translate>
<translate>
* The dragging is handled within the javascript code in sortablelist.js, and the updated order is sent to the server via an Ajax call to task=helloworlds.saveOrderAjax.
* The code within the Admin Controller saveOrderAjax() method calls our model saveorder() function.
* Our model saveorder() in turn calls the saveorder() within JTableNested
* JTableNested::saveorder() executes the database updates.</translate>

<translate> '''Deleting records'''</translate>
* <translate> Clicking the Delete button in the helloworlds view causes an HTTP POST with task=helloworlds.delete and the list of record ids to delete (from the checkboxes which have been checked)</translate>
* <translate> The Admin Controller delete() calls the delete() function in the model, passing the array of ids to be deleted.</translate>
* <translate> As we don't have a specific delete() function in our helloworld model, this results in the parent Admin Model delete() being called. This function gets the table instance from the model and for each id in the array it calls the table delete() method, passing the id as the single parameter.</translate>
* <translate> The table delete() method invoked is the delete() in our Helloworld Table class. We've overridden the JNestedTable delete() method because if just a single parameter is passed to JNestedTable::delete() then it deletes the children as well as the record. We override it so that the default is NOT to delete the children.</translate>
* <translate> JNestedTable::delete() deletes the record, and moves each of its children up the hierarchy, to be parented on the deleted record's parent.</translate>

<translate> '''Edit record to change the parent'''</translate>
* <translate> Clicking Save causes an HTTP post with task=helloworld.save which gets handled by JControllerForm::save(). This function calls the model save().</translate>
* <translate> This invokes our helloworld model save() which calls the parent::save() which is in JModelAdmin.</translate>
** <translate> JModelAdmin::save() calls table load() to load the existing values, then table bind() to bind the new values</translate>
*** <translate> This invokes our Helloworld table bind() function, which checks if the new parent is the same as the existing parent, and when it finds it isn't it calls table setLocation() to set the position as the last child of that parent</translate>
*** <translate> JTableNested::setLocation() stores the parent and the position (ie 'last child') in instance variables</translate>
** <translate> Back in JModelAdmin::save() it calls table store().</translate>
** <translate> This invokes JTableNested::store() which moves the edited record and all of its descendants under the new parent record, based on the previously stored instance variables. This fixes the lft and rgt values of all the records in the helloworld database table. However, it doesn't fix up the path field of the records which have been moved.</translate>
* <translate> Back in our helloworld model save() we call the JTableNested rebuild() method to rebuild the whole database table. This is rather a crude method for fixing up the path fields of the moved records. However, if we don't use in our code the path field then we can omit this step.</translate>

<translate> '''Edit record to change the ordering (but not the parent)'''</translate>
* <translate> Clicking Save causes an HTTP post with task=helloworld.save and jform['helloworldordering'] set to the id of the field below which we're positioning this record (or set to -1 (first child) or -2 (last child) as special cases). This POST gets handled by JControllerForm::save() which calls the model save().</translate>
* <translate> This invokes our helloworld model save() which calls the parent::save() which is in JModelAdmin.</translate>
** <translate> JModelAdmin::save() calls table load() to load the existing values, then table bind() to bind the new values</translate>
*** <translate> This invokes our Helloworld table bind() function, which checks if the new parent is the same as the existing parent, and when it finds it is then it calls table setLocation() to set the position as after the record id in the 'helloworldordering' element of the array (and handling the special cases of -1 or -2).</translate>
*** <translate> JTableNested::setLocation() stores the (unchanged) parent and the position in instance variables</translate>
** <translate> Back in JModelAdmin::save() it calls table store().</translate>
** <translate> This invokes JTableNested::store() which moves the edited record based on the new position stored in its instance variable. This fixes the lft and rgt values of all the records in the helloworld database table.</translate>
* <translate> Back in our helloworld model save() we call the JTableNested rebuild() method to rebuild the whole database table. This is very inefficient as there is no need to rebuild the paths in this case!</translate>

<translate> '''New and Save as Copy'''</translate>
* <translate> Both of these result in an HTTP POST which get handled by JControllerForm::save() which calls the model save(). In the array of data for the new record the id is either not set or set to 0.</translate>
* <translate> This invokes our helloworld model save() which calls the parent::save() which is in JModelAdmin.</translate>
** <translate> JModelAdmin::save() calls table load() to load the existing values, then table bind() to bind the new values</translate>
*** <translate> This invokes our Helloworld table bind() function, which checks the 'id' element of the array to see if it's a new record. When it finds it is then it calls table setLocation() to set the position as the last child of the record defined in the 'parent_id' array element.</translate>
*** <translate> JTableNested::setLocation() stores the parent and the (last child) position in instance variables</translate>
** <translate> Back in JModelAdmin::save() it calls table store().</translate>
** <translate> This invokes JTableNested::store() which updates the lft and rgt fields in the table to make room for the new record to be inserted at the position specified by the instance variables set in the setLocation() call. This fixes the lft and rgt values of all the records in the helloworld database table, but doesn't set the path of our new record.</translate>
* <translate> Back in our helloworld model save() we call the JTableNested rebuild() method to rebuild the whole database table. This is again very inefficient as we should really only be calling the JTableNested rebuildPath() method to set the path of the new record!</translate>

<translate> '''Addressing the rebuild problem'''</translate>
<translate> The inefficiencies associated with having to call the rebuild() method are significant, particularly because it results in the whole helloworld table being processed for all record updates, even if the update is not concerned with adjusting a record's position in the tree. There are various alternatives to address this issue:</translate>
* <translate> If you don't use the path field in your code then you can just ignore it and not bother calling rebuild() to fix it.</translate>
* <translate> As described in the video accompanying this tutorial step, you can follow the example of com_content and put the code for save() into the helloworld model, rather than calling the parent Admin Model save() to do the work.</translate>
* <translate> In the helloworld model save() for a record update you can load the existing record from the database, compare its parent id with the data from the form, and call rebuild() only if the parent id is different.</translate>

<translate> Our updated model is below. Note that the code has been removed from prepareTable() as defining the order of the records is now done in the bind() method of our helloworld table class.</translate>

<span id="admin/models/helloworld.php">
<tt>admin/models/helloworld.php</tt>
<source lang='php' highlight="214-219,235-236,238-254">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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');

use Joomla\Registry\Registry;

/**
* HelloWorld Model
*
* @since 0.0.1
*/
class HelloWorldModelHelloWorld extends JModelAdmin
{
// JModelAdmin needs to know this for storing the associations
protected $associationsContext = 'com_helloworld.item';

/**
* Method to override getItem to allow us to convert the JSON-encoded image information
* in the database record into an array for subsequent prefilling of the edit form
* We also use this method to prefill the associations
*/
public function getItem($pk = null)
{
$item = parent::getItem($pk);
if ($item AND property_exists($item, 'image'))
{
$registry = new Registry($item->image);
$item->imageinfo = $registry->toArray();
}

// Load associated items
if (JLanguageAssociations::isEnabled())
{
$item->associations = array();

if ($item->id != null)
{
$associations = JLanguageAssociations::getAssociations('com_helloworld', '#__helloworld', 'com_helloworld.item', (int)$item->id);

foreach ($associations as $tag => $association)
{
$item->associations[$tag] = $association->id;
}
}
}
return $item;
}

/**
* 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 preprocess the form to add the association fields dynamically
*
* @return none
*/
protected function preprocessForm(JForm $form, $data, $group = 'helloworld')
{
// Association content items
if (JLanguageAssociations::isEnabled())
{
$languages = JLanguageHelper::getContentLanguages(false, true, null, 'ordering', 'asc');

if (count($languages) > 1)
{
$addform = new SimpleXMLElement('<form />');
$fields = $addform->addChild('fields');
$fields->addAttribute('name', 'associations');
$fieldset = $fields->addChild('fieldset');
$fieldset->addAttribute('name', 'item_associations');

foreach ($languages as $language)
{
$field = $fieldset->addChild('field');
$field->addAttribute('name', $language->lang_code);
$field->addAttribute('type', 'modal_helloworld');
$field->addAttribute('language', $language->lang_code);
$field->addAttribute('label', $language->title);
$field->addAttribute('translate_label', 'false');
}

$form->load($addform, false);
}
}
parent::preprocessForm($form, $data, $group);
}

/**
* Method to get the script 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 override the JModelAdmin save() function to handle Save as Copy correctly
*
* @param The helloworld record data submitted from the form.
*
* @return parent::save() return value
*/
public function save($data)
{
$input = JFactory::getApplication()->input;

JLoader::register('CategoriesHelper', JPATH_ADMINISTRATOR . '/components/com_categories/helpers/categories.php');

// Validate the category id
// validateCategoryId() returns 0 if the catid can't be found
if ((int) $data['catid'] > 0)
{
$data['catid'] = CategoriesHelper::validateCategoryId($data['catid'], 'com_helloworld');
}

// Alter the greeting and alias for save as copy
if ($input->get('task') == 'save2copy')
{
$origTable = clone $this->getTable();
$origTable->load($input->getInt('id'));

if ($data['greeting'] == $origTable->greeting)
{
list($greeting, $alias) = $this->generateNewTitle($data['catid'], $data['alias'], $data['greeting']);
$data['greeting'] = $greeting;
$data['alias'] = $alias;
}
else
{
if ($data['alias'] == $origTable->alias)
{
$data['alias'] = '';
}
}
// standard Joomla practice is to set the new record as unpublished
$data['published'] = 0;
}

$result = parent::save($data);
if ($result)
{
$this->getTable()->rebuild(1);
}
return $result;
}
/**
* Method to check if it's OK to delete a message. Overrides JModelAdmin::canDelete
*/
protected function canDelete($record)
{
if( !empty( $record->id ) )
{
return JFactory::getUser()->authorise( "core.delete", "com_helloworld.helloworld." . $record->id );
}
}
/**
* Prepare a helloworld record for saving in the database
*/
protected function prepareTable($table)
{
}

/**
* Save the record reordering after a record is dragged to a new position in the helloworlds view
*/
public function saveorder($idArray = null, $lft_array = null)
{
// Get an instance of the table object.
$table = $this->getTable();

if (!$table->saveorder($idArray, $lft_array))
{
$this->setError($table->getError());

return false;
}

return true;
}
}
</source>
</span>

<span id="admin/tables/helloworld.php">
<tt>admin/tables/helloworld.php</tt>
<source lang="php" highlight="17,61-99,170-173">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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 JTableNested
{
/**
* 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;
}

if (isset($array['imageinfo']) && is_array($array['imageinfo']))
{
// Convert the imageinfo array to a string.
$parameter = new JRegistry;
$parameter->loadArray($array['imageinfo']);
$array['image'] = (string)$parameter;
}

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

if (isset($array['parent_id']))
{
if (!isset($array['id']) || $array['id'] == 0)
{ // new record
$this->setLocation($array['parent_id'], 'last-child');
}
elseif (isset($array['helloworldordering']))
{
// when saving a record load() is called before bind() so the table instance will have properties which are the existing field values
if ($this->parent_id == $array['parent_id'])
{
// If first is chosen make the item the first child of the selected parent.
if ($array['helloworldordering'] == -1)
{
$this->setLocation($array['parent_id'], 'first-child');
}
// If last is chosen make it the last child of the selected parent.
elseif ($array['helloworldordering'] == -2)
{
$this->setLocation($array['parent_id'], 'last-child');
}
// Don't try to put an item after itself. All other ones put after the selected item.
elseif ($array['helloworldordering'] && $this->id != $array['helloworldordering'])
{
$this->setLocation($array['helloworldordering'], 'after');
}
// Just leave it where it is if no change is made.
elseif ($array['helloworldordering'] && $this->id == $array['helloworldordering'])
{
unset($array['helloworldordering']);
}
}
// Set the new parent id if parent id not matched and put in last position
else
{
$this->setLocation($array['parent_id'], 'last-child');
}
}
}

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

/**
* 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.helloworld.'.(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;
}

public function check()
{
$this->alias = trim($this->alias);
if (empty($this->alias))
{
$this->alias = $this->greeting;
}
$this->alias = JFilterOutput::stringURLSafe($this->alias);
return true;
}

public function delete($pk = null, $children = false)
{
return parent::delete($pk, $children);
}
}
</source>
</span>
<translate>
== Front-end Helloworld Display == 
</translate>

<translate> To display the parent and children on the helloworld page there are 3 changes required:</translate>
<translate>
# In the view, get the data for the parent and for the children using function calls to the model
# In the model provide the data for these function calls
# In the layout output the html which includes the parent and children data.</translate>

<translate> Note that we've changed the model code to allow a parameter to <tt>getItem()</tt>. This has the side-effect of changing the <tt>this->item</tt> variable within the model instance to point to the latest item retrieved. As the functionality within <tt>getMapParams()</tt> (called from <tt>addMap()</tt>) uses <tt>this->item</tt> to get the latitude and longitude etc for the current record, we need to ensure that the call to <tt>addMap()</tt> happens before the new code we're introducing.</translate>

<translate> '''Note.''' If you had a menuitem pointing to your helloworld record which had id=1 then you'll need to edit that menuitem to point to the new id.</translate>

<span id="site/views/helloworld/view.html.php">
<tt>site/views/helloworld/view.html.php</tt>
<source lang="php" highlight="42-46">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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->item = $this->get('Item');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JLog::add(implode('<br />', $errors), JLog::WARNING, 'jerror');

return false;
}

$this->addMap();

$model = $this->getModel();
$this->parentItem = $model->getItem($this->item->parent_id);
$this->children = $model->getChildren($this->item->id);
// getChildren includes the record itself (as well as the children) so remove this record
unset($this->children[0]);

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

function addMap()
{
$document = JFactory::getDocument();

// everything's dependent upon JQuery
JHtml::_('jquery.framework');

// we need the Openlayers JS and CSS libraries
$document->addScript("https://cdnjs.cloudflare.com/ajax/libs/openlayers/4.6.4/ol.js");
$document->addStyleSheet("https://cdnjs.cloudflare.com/ajax/libs/openlayers/4.6.4/ol.css");

// ... and our own JS and CSS
$document->addScript(JURI::root() . "media/com_helloworld/js/openstreetmap.js");
$document->addStyleSheet(JURI::root() . "media/com_helloworld/css/openstreetmap.css");

// get the data to pass to our JS code
$params = $this->get("mapParams");
$document->addScriptOptions('params', $params);
}
}

</source>
</span>

<span id="site/models/helloworld.php">
<tt>site/models/helloworld.php</tt>
<source lang="php" highlight="71,73,75,78-79,184-189">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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');

JLoader::register('HelloworldHelperRoute', JPATH_ROOT . '/components/com_helloworld/helpers/route.php');

/**
* HelloWorld Model
*
* @since 0.0.1
*/
class HelloWorldModelHelloWorld extends JModelItem
{
/**
* @var object item
*/
protected $item;

/**
* Method to auto-populate the model state.
*
* This method should only be called once per instantiation and is designed
* to be called on the first call to the getState() method unless the model
* configuration flag to ignore the request is set.
*
* Note. Calling getState in this method will result in recursion.
*
* @return void
* @since 2.5
*/
protected function populateState()
{
// Get the message id
$jinput = JFactory::getApplication()->input;
$id = $jinput->get('id', 1, 'INT');
$this->setState('message.id', $id);

// Load the parameters.
$this->setState('params', JFactory::getApplication()->getParams());
parent::populateState();
}

/**
* 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);
}

/**
* Get the message
* @return object The message to be displayed to the user
*/
public function getItem($id = null)
{
if (!isset($this->item) || !is_null($id))
{
$id = is_null($id) ? $this->getState('message.id') : $id;
$db = JFactory::getDbo();
$query = $db->getQuery(true);
$query->select('h.greeting, h.params, h.image as image, c.title as category, h.latitude as latitude, h.longitude as longitude,
h.id as id, h.alias as alias, h.catid as catid, h.parent_id as parent_id, h.level as level')
->from('#__helloworld as h')
->leftJoin('#__categories as c ON h.catid=c.id')
->where('h.id=' . (int)$id);

if (JLanguageMultilang::isEnabled())
{
$lang = JFactory::getLanguage()->getTag();
$query->where('h.language IN ("*","' . $lang . '")');
}

$db->setQuery((string)$query);

if ($this->item = $db->loadObject())
{
// Load the JSON string
$params = new JRegistry;
$params->loadString($this->item->params, 'JSON');
$this->item->params = $params;

// Merge global params with item params
$params = clone $this->getState('params');
$params->merge($this->item->params);
$this->item->params = $params;

// Convert the JSON-encoded image info into an array
$image = new JRegistry;
$image->loadString($this->item->image, 'JSON');
$this->item->imageDetails = $image;
}
else
{
throw new Exception('Helloworld id not found', 404);
}
}
return $this->item;
}

public function getMapParams()
{
if ($this->item)
{
$url = HelloworldHelperRoute::getAjaxURL();
$this->mapParams = array(
'latitude' => $this->item->latitude,
'longitude' => $this->item->longitude,
'zoom' => 10,
'greeting' => $this->item->greeting,
'ajaxurl' => $url
);
return $this->mapParams;
}
else
{
throw new Exception('No helloworld details available for map', 500);
}
}

public function getMapSearchResults($mapbounds)
{
try
{
$db = JFactory::getDbo();
$query = $db->getQuery(true);
$query->select('h.id, h.alias, h.catid, h.greeting, h.latitude, h.longitude')
->from('#__helloworld as h')
->where('h.latitude > ' . $mapbounds['minlat'] .
' AND h.latitude < ' . $mapbounds['maxlat'] .
' AND h.longitude > ' . $mapbounds['minlng'] .
' AND h.longitude < ' . $mapbounds['maxlng']);

if (JLanguageMultilang::isEnabled())
{
$lang = JFactory::getLanguage()->getTag();
$query->where('h.language IN ("*","' . $lang . '")');
}

$db->setQuery($query);
$results = $db->loadObjectList();
}
catch (Exception $e)
{
$msg = $e->getMessage();
JFactory::getApplication()->enqueueMessage($msg, 'error');
$results = null;
}

if (JLanguageMultilang::isEnabled())
{
$query_lang = "&lang={$lang}";
}
else
{
$query_lang = "";
}

for ($i = 0; $i < count($results); $i++)
{
$results[$i]->url = JRoute::_('index.php?option=com_helloworld&view=helloworld&id=' . $results[$i]->id .
":" . $results[$i]->alias . '&catid=' . $results[$i]->catid . $query_lang);
}

return $results;
}

public function getChildren($id)
{
$table = $this->getTable();
$children = $table->getTree($id);
return $children;
}
}

</source>
</span>

<span id="site/views/helloworld/tmpl/default.php">
<tt>site/views/helloworld/tmpl/default.php</tt>
<source lang="php" highlight="12-20,38-59">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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');
$lang = JFactory::getLanguage()->getTag();
if (JLanguageMultilang::isEnabled() && $lang)
{
$query_lang = "&lang={$lang}";
}
else
{
$query_lang = "";
}
?>
<h1><?php echo $this->item->greeting.(($this->item->category and $this->item->params->get('show_category'))
? (' ('.$this->item->category.')') : ''); ?>
</h1>
<?php
$src = $this->item->imageDetails['image'];
if ($src)
{
$html = '<figure>
<img src="%s" alt="%s" >
<figcaption>%s</figcaption>
</figure>';
$alt = $this->item->imageDetails['alt'];
$caption = $this->item->imageDetails['caption'];
echo sprintf($html, $src, $alt, $caption);
} ?>

<?php if ($this->parentItem->id > 1) : ?>
<h1><?php echo JText::_('COM_HELLOWORLD_PARENT') ?>
</h1>
<h3>
<?php $url = JRoute::_('index.php?option=com_helloworld&view=helloworld&id=' . $this->parentItem->id . ':' . $this->parentItem->alias . '&catid=' . $this->parentItem->catid . $query_lang); ?>
<a href="<?php echo $url; ?>"><?php echo $this->parentItem->greeting; ?></a>
</h3>
<?php endif; ?>

<?php if ($this->children) :
$baseLevel = $this->item->level; ?>
<h1><?php echo JText::_('COM_HELLOWORLD_CHILDREN') ?>
</h1>
<?php foreach ($this->children as $i => $child) : ?>
<h3>
<?php $prefix = JLayoutHelper::render('joomla.html.treeprefix', array('level' => $child->level - $baseLevel)); ?>
<?php echo $prefix; ?>
<?php $url = JRoute::_('index.php?option=com_helloworld&view=helloworld&id=' . $child->id . ':' . $child->alias . '&catid=' . $child->catid . $query_lang); ?>
<a href="<?php echo $url; ?>"><?php echo $child->greeting; ?></a>
</h3>
<?php endforeach; ?>
<?php endif; ?>

<div id="map" class="map"></div>
<div class="map-callout map-callout-bottom" id="greeting-container"></div>
<div id="searchmap">
<?php echo '<input id="token" type="hidden" name="' . JSession::getFormToken() . '" value="1" />'; ?>
<button type="button" class="btn btn-primary" onclick="searchHere();">
<?php echo JText::_('COM_HELLOWORLD_SEARCH_HERE_BUTTON') ?>
</button>
<div id="searchresults">
</div>
</div>
</source>
</span>

<translate>
== Helloworld Frontend Form == 
</translate>

<translate> To support capturing the parent in the frontend form we reuse the admin custom form field in the add-form xml definition.</translate>

<translate> Note that in the functionality for creating a new helloworld record on the frontend we haven't included a table <tt>rebuild()</tt> so new records fail to get the <tt>path</tt> field written in the database. However the new record will get inserted into the tree correctly because the front end uses the admin backend table code, and so it will pick up the inheritance of the Nested Table, with its <tt>bind()</tt> override etc. This means too that we should remove the code in the model <tt>prepareTable()</tt> which previously defined the ordering of the new record.</translate>

<span id="site/models/forms/add-form.xml">
<tt>site/models/forms/add-form.xml</tt>
<source lang="xml" highlight="4,113-120">
<?xml version="1.0" encoding="utf-8"?>
<form
addrulepath="/administrator/components/com_helloworld/models/rules"
addfieldpath="/administrator/components/com_helloworld/models/fields"
>
<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"
required="true"
hint="COM_HELLOWORLD_HELLOWORLD_GREETING_HINT"
default=""
/>
<field
name="alias"
type="text"
label="JFIELD_ALIAS_LABEL"
description="JFIELD_ALIAS_DESC"
hint="JFIELD_ALIAS_PLACEHOLDER"
size="40"
/>
<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>
<fields name="imageinfo" label="COM_HELLOWORLD_HELLOWORLD_IMAGE_LABEL">
<field
name="image"
type="file"
label="COM_HELLOWORLD_HELLOWORLD_PICTURE_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_PICTURE_DESC"
accept="image/*"
>
</field>
<field
name="caption"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_CAPTION_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_CAPTION_DESC"
size="40"
class="inputbox"
>
</field>
<field
name="alt"
type="text"
label="COM_HELLOWORLD_HELLOWORLD_ALTTEXT_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_ALTTEXT_DESC"
size="40"
class="inputbox"
>
</field>
</fields>
<field
name="language"
type="contentlanguage"
label="JFIELD_LANGUAGE_LABEL"
description="JFIELD_LANGUAGE_DESC"
class="inputbox">
</field>
<field
name="message"
type="textarea"
rows="5"
cols="80"
label="COM_HELLOWORLD_HELLOWORLD_MESSAGE_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_MESSAGE_DESC"
hint="COM_HELLOWORLD_HELLOWORLD_MESSAGE_HINT"
required="true"
>
</field>
<field
name="captcha"
type="captcha"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTCHA_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTCHA_DESC"
validate="captcha"
>
</field>
<fields name="params">
<field
name="show_category"
type="list"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_DESC"
default=""
useglobal="true"
>
<option value="0">JHIDE</option>
<option value="1">JSHOW</option>
</field>
</fields>
<field
name="parent_id"
type="helloworldparent"
label="COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_LABEL"
description="COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_DESC"
default="1"
filter="int">
</field>
</fieldset>
</form>

</source>
</span>

<span id="site/models/form.php">
<tt>site/models/form.php</tt>
<source lang="php" highlight="104-105">
<?php
/**
* @package Joomla.Administrator
* @subpackage com_helloworld
*
* @copyright Copyright (C) 2005 - 2018 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 HelloWorldModelForm 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.form',
'add-form',
array(
'control' => 'jform',
'load_data' => $loadData
)
);

if (empty($form))
{
$errors = $this->getErrors();
throw new Exception(implode("\n", $errors), 500);
}

return $form;
}

/**
* Method to get the data that should be injected in the form.
* As this form is for add, we're not prefilling the form with an existing record
* But if the user has previously hit submit and the validation has found an error,
* then we inject what was previously entered.
*
* @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()
);

return $data;
}

/**
* Method to get the script that have to be included on the form
* This returns the script associated with helloworld field greeting validation
*
* @return string Script files
*/
public function getScript()
{
return 'administrator/components/com_helloworld/models/forms/helloworld.js';
}

/**
* Prepare a helloworld record for saving in the database
*/
protected function prepareTable($table)
{
}
}
</source>
</span>

<translate>
== Frontend Category View == 
</translate>

<translate> We just have to change the ordering to use the <tt>lft</tt> database field instead of the <tt>ordering</tt> field.</translate>

<span id="site/models/category.php">
<tt>site/models/category.php</tt>
<source lang="php" highlight="18,51">
<?php
/**
* Model for displaying the helloworld messages in a given category
*/

defined('_JEXEC') or die;

class HelloworldModelCategory extends JModelList
{
public function __construct($config = array())
{
if (empty($config['filter_fields']))
{
$config['filter_fields'] = array(
'id',
'greeting',
'alias',
'lft',
);
}

parent::__construct($config);
}

protected function populateState($ordering = null, $direction = null)
{
parent::populateState($ordering, $direction);

$app = JFactory::getApplication('site');
$catid = $app->input->getInt('id');

$this->setState('category.id', $catid);
}

protected function getListQuery()
{
$db = JFactory::getDbo();
$query = $db->getQuery(true);

$catid = $this->getState('category.id');
$query->select('id, greeting, alias, catid')
->from($db->quoteName('#__helloworld'))
->where('catid = ' . $catid);

if (JLanguageMultilang::isEnabled())
{
$lang = JFactory::getLanguage()->getTag();
$query->where('language IN ("*","' . $lang . '")');
}

$orderCol = $this->state->get('list.ordering', 'lft');
$orderDirn = $this->state->get('list.direction', 'asc');

$query->order($db->escape($orderCol) . ' ' . $db->escape($orderDirn));

return $query;
}

public function getCategoryName()
{
$catid = $this->getState('category.id');
$categories = JCategories::getInstance('Helloworld', array());
$categoryNode = $categories->get($catid);
return $categoryNode->title;
}

public function getSubcategories()
{
$catid = $this->getState('category.id');
$categories = JCategories::getInstance('Helloworld', array());
$categoryNode = $categories->get($catid);
$subcats = $categoryNode->getChildren();

$lang = JFactory::getLanguage()->getTag();
if (JLanguageMultilang::isEnabled() && $lang)
{
$query_lang = "&lang={$lang}";
}
else
{
$query_lang = '';
}

foreach ($subcats as $subcat)
{
$subcat->url = JRoute::_("index.php?view=category&id=" . $subcat->id . $query_lang);
}
return $subcats;
}
}
</source>
</span>

<span id="site/models/forms/filter_category.xml">
<tt>site/models/forms/filter_category.xml</tt>
<source lang="xml" highlight="8,11-12">
<?xml version="1.0" encoding="utf-8"?>
<form>
<fields name="list">
<field
name="fullordering"
type="list"
onchange="this.form.submit();"
default="lft ASC"
>
<option value="">COM_HELLOWORLD_SORT_BY</option>
<option value="lft ASC">COM_HELLOWORLD_ORDERING_ASC</option>
<option value="lft DESC">COM_HELLOWORLD_ORDERING_DESC</option>
<option value="greeting ASC">COM_HELLOWORLD_GREETING_ASC</option>
<option value="greeting DESC">COM_HELLOWORLD_GREETING_DESC</option>
<option value="id ASC">COM_HELLOWORLD_ID_ASC</option>
<option value="id DESC">COM_HELLOWORLD_ID_DESC</option>
<option value="alias ASC">COM_HELLOWORLD_ALIAS_ASC</option>
<option value="alias DESC">COM_HELLOWORLD_ALIAS_DESC</option>
</field>
<field
name="limit"
type="limitbox"
class="input-mini"
default="10"
onchange="this.form.submit();"
/>
</fields>
</form>
</source>
</span>
<translate>
== Updated Language Strings == 
</translate>

<span id="site/language/en-GB/en-GB.com_helloworld.ini">
<tt>site/language/en-GB/en-GB.com_helloworld.ini</tt>
<source lang="text" highlight="25-26,37-38">
; add new message form
COM_HELLOWORLD_LEGEND_DETAILS="New Helloworld Message Details"
COM_HELLOWORLD_HELLOWORLD_CREATING="Add message"
COM_HELLOWORLD_HELLOWORLD_ERROR_UNACCEPTABLE="Sorry, you have an error"
COM_HELLOWORLD_HELLOWORLD_DETAILS="Message details"
COM_HELLOWORLD_HELLOWORLD_GREETING_LABEL="Greeting"
COM_HELLOWORLD_HELLOWORLD_GREETING_DESC="Please specify the greeting to add"
COM_HELLOWORLD_HELLOWORLD_GREETING_HINT="Any characters allowed"
COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_LABEL="Category"
COM_HELLOWORLD_HELLOWORLD_FIELD_CATID_DESC="Please select the associated category"
COM_HELLOWORLD_HELLOWORLD_MESSAGE_LABEL="Reason"
COM_HELLOWORLD_HELLOWORLD_MESSAGE_DESC="Please say why you're adding this greeting"
COM_HELLOWORLD_HELLOWORLD_MESSAGE_HINT="No HTML tags!"
COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTCHA_LABEL="Spam protection"
COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTCHA_DESC="Prove you're a real person!"
COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_LABEL="Display category or not?"
COM_HELLOWORLD_HELLOWORLD_FIELD_SHOW_CATEGORY_DESC="Select if you want the category displayed too"
COM_HELLOWORLD_HELLOWORLD_IMAGE_LABEL="Image information"
COM_HELLOWORLD_HELLOWORLD_PICTURE_LABEL="Image file to upload"
COM_HELLOWORLD_HELLOWORLD_PICTURE_DESC="Select the file with the image to upload"
COM_HELLOWORLD_HELLOWORLD_CAPTION_LABEL="Caption"
COM_HELLOWORLD_HELLOWORLD_CAPTION_DESC="Text to use as a caption for the image"
COM_HELLOWORLD_HELLOWORLD_ALTTEXT_LABEL="Alt text"
COM_HELLOWORLD_HELLOWORLD_ALTTEXT_DESC="Text to display if image cannot be shown"
COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_LABEL="Parent"
COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_DESC="Select the record which is to be the parent"
; save and cancel confirmation messages
COM_HELLOWORLD_ADD_SUCCESSFUL="New greeting successfully saved"
COM_HELLOWORLD_ADD_CANCELLED="New greeting cancelled ok"
; file upload error conditions
COM_HELLOWORLD_ERROR_FILEUPLOAD="PHP Error %s encountered when uploading file"
COM_HELLOWORLD_ERROR_FILETOOLARGE="Upload file exceeds max size configured in Joomla"
COM_HELLOWORLD_ERROR_BADFILENAME="Upload file has an invalid filename"
COM_HELLOWORLD_ERROR_FILE_EXISTS="Upload file already exists"
COM_HELLOWORLD_ERROR_UNABLE_TO_UPLOAD_FILE="Error creating uploaded file"
; helloworld greeting page
COM_HELLOWORLD_PARENT="Parent"
COM_HELLOWORLD_CHILDREN="Children"
COM_HELLOWORLD_SEARCH_HERE_BUTTON="Search here"
; Ajax handling errors
COM_HELLOWORLD_ERROR_NO_RECORDS="Didn't get any records"
COM_HELLOWORLD_ERROR_NO_MAP_BOUNDS="Error: no map bounds"
; category view, search and ordering fields and headings
COM_HELLOWORLD_SORT_BY="Sort by ..."
COM_HELLOWORLD_ORDERING_ASC="Ordering asc"
COM_HELLOWORLD_ORDERING_DESC="Ordering desc"
COM_HELLOWORLD_GREETING_ASC="Greeting asc"
COM_HELLOWORLD_GREETING_DESC="Greeting desc"
COM_HELLOWORLD_ID_ASC="id asc"
COM_HELLOWORLD_ID_DESC="id desc"
COM_HELLOWORLD_ALIAS_ASC="alias asc"
COM_HELLOWORLD_ALIAS_DESC="alias desc"
COM_HELLOWORLD_HELLOWORLD_ALIAS_LABEL="Alias"
COM_HELLOWORLD_HELLOWORLD_FIELD_URL_LABEL="URL"
COM_HELLOWORLD_HEADER_SUBCATEGORIES="Subcategories"
</source>
</span>

<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="34-38">
; Joomla! Project
; Copyright (C) 2005 - 2018 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_AUTHOR="Author"
COM_HELLOWORLD_LANGUAGE="Language"
COM_HELLOWORLD_CREATED_DATE="Created"
COM_HELLOWORLD_PUBLISHED="Published"
COM_HELLOWORLD_HELLOWORLDS_NAME="Name"
COM_HELLOWORLD_HELLOWORLDS_POSITION="Position"
COM_HELLOWORLD_HELLOWORLDS_IMAGE="Image"
COM_HELLOWORLD_HELLOWORLDS_ASSOCIATIONS="Associations"
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_FIELD_LATITUDE_LABEL="Latitude"
COM_HELLOWORLD_HELLOWORLD_FIELD_LATITUDE_DESC="Enter the position latitude, between -90 and +90 degrees"
COM_HELLOWORLD_HELLOWORLD_FIELD_LONGITUDE_LABEL="Longitude"
COM_HELLOWORLD_HELLOWORLD_FIELD_LONGITUDE_DESC="Enter the position longitude, between -180 and +180 degrees"
COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_LABEL="Parent"
COM_HELLOWORLD_HELLOWORLD_FIELD_PARENT_DESC="Select the parent record"
COM_HELLOWORLD_ITEM_FIELD_ORDERING_VALUE_FIRST="-- First record"
COM_HELLOWORLD_ITEM_FIELD_ORDERING_VALUE_LAST="-- Last record"
COM_HELLOWORLD_ITEM_FIELD_ORDERING_TEXT="Ordering will be available after saving."
COM_HELLOWORLD_HELLOWORLD_FIELD_LANGUAGE_DESC="Select the appropriate language"
COM_HELLOWORLD_IMAGE_FIELDS="Image details"
COM_HELLOWORLD_HELLOWORLD_FIELD_IMAGE_LABEL="Select image"
COM_HELLOWORLD_HELLOWORLD_FIELD_IMAGE_DESC="Select an image from the library, or upload a new one"
COM_HELLOWORLD_HELLOWORLD_FIELD_ALT_LABEL="Alt text"
COM_HELLOWORLD_HELLOWORLD_FIELD_ALT_DESC="Alternative text (if image cannot be displayed)"
COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTION_LABEL="Caption"
COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTION_DESC="Provide a caption for the image"
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_HELLOWORLD_FIELD_CAPTCHA_LABEL="Captcha"
COM_HELLOWORLD_HELLOWORLD_FIELD_CAPTCHA_DESC="Select Captcha to use on front end form"
COM_HELLOWORLD_HELLOWORLD_FIELD_USER_TO_EMAIL_LABEL="User to email"
COM_HELLOWORLD_HELLOWORLD_FIELD_USER_TO_EMAIL_DESC="Select user to email when a new message is entered on front end"
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?"
COM_HELLOWORLD_TAB_NEW_MESSAGE="New Message"
COM_HELLOWORLD_TAB_EDIT_MESSAGE="Message Details"
COM_HELLOWORLD_TAB_PARAMS="Parameters"
COM_HELLOWORLD_TAB_ASSOCIATIONS="Associations"
COM_HELLOWORLD_TAB_PERMISSIONS="Permissions"
COM_HELLOWORLD_TAB_IMAGE="Image"
COM_HELLOWORLD_LEGEND_DETAILS="Message Details"
COM_HELLOWORLD_LEGEND_PARAMS="Message Parameters"
COM_HELLOWORLD_LEGEND_ASSOCIATIONS="Message Associations"
COM_HELLOWORLD_LEGEND_PERMISSIONS="Message Permissions"
COM_HELLOWORLD_LEGEND_IMAGE="Image info"
; Column ordering in the Helloworlds view
COM_HELLOWORLD_ORDERING_ASC="Ordering ascending"
COM_HELLOWORLD_ORDERING_DESC="Ordering descending"
COM_HELLOWORLD_GREETING_ASC="Greeting ascending"
COM_HELLOWORLD_GREETING_DESC="Greeting descending"
COM_HELLOWORLD_AUTHOR_ASC="Author ascending"
COM_HELLOWORLD_AUTHOR_DESC="Author descending"
COM_HELLOWORLD_CREATED_ASC="Creation date ascending"
COM_HELLOWORLD_CREATED_DESC="Creation date descending"
COM_HELLOWORLD_PUBLISHED_ASC="Unpublished first"
COM_HELLOWORLD_PUBLISHED_DESC="Published first"
COM_HELLOWORLD_LANGUAGE_ASC="Language ascending"
COM_HELLOWORLD_LANGUAGE_DESC="Language descending"
COM_HELLOWORLD_ASSOCIATION_ASC="Association ascending"
COM_HELLOWORLD_ASSOCIATION_DESC="Association descending"
; Helloworld menuitem - selecting a greeting via modal
COM_HELLOWORLD_MENUITEM_SELECT_MODAL_TITLE="Select greeting"
COM_HELLOWORLD_MENUITEM_SELECT_HELLOWORLD="Select"
COM_HELLOWORLD_MENUITEM_SELECT_BUTTON_TOOLTIP="Select a helloworld greeting"
; Checking in records
COM_HELLOWORLD_N_ITEMS_CHECKED_IN_0="No records checked in."
COM_HELLOWORLD_N_ITEMS_CHECKED_IN_1="%d record successfully checked in."
COM_HELLOWORLD_N_ITEMS_CHECKED_IN_MORE="%d records successfully checked in."
</source>
</span>
<translate>
== Packaging the Component == 
</translate>

<translate> Contents of your code directory. Each file link below takes you to the step in the tutorial which has the latest version of that source code file.</translate>

* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#helloworld.xml|helloworld.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#script.php|script.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#site/router.php|site/router.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_a_view_to_the_site_part#site/helloworld.php|site/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding AJAX#site/controller.php|site/controller.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_an_Image#site/controllers/helloworld.php|site/controllers/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding AJAX#site/views/helloworld/view.json.php|site/views/helloworld/view.json.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding a Modal#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/form/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using the language filter facility#site/views/form/view.html.php|site/views/form/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/form/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_an_Image#site/views/form/tmpl/edit.php|site/views/form/tmpl/edit.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_a_front-end_form#site/views/form/tmpl/edit.xml|site/views/form/tmpl/edit.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/category/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using the language filter facility#site/views/category/view.html.php|site/views/category/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/views/category/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using the language filter facility#site/views/category/tmpl/default.php|site/views/category/tmpl/default.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding an alias#site/views/category/tmpl/default.xml|site/views/category/tmpl/default.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/models/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#site/models/form.php|site/models/form.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#site/models/category.php|site/models/category.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/models/forms/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#site/models/forms/add-form.xml|site/models/forms/add-form.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#site/models/forms/filter_category.xml|site/models/forms/filter_category.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/language/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/language/en-GB/index.html]]''
* ''[[S:MyLanguage/J3.x:Developing an MVC Component/Adding Levels#site/language/en-GB/en-GB.com_helloworld.ini|site/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|site/helpers/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using the language filter facility#site/helpers/route.php|site/helpers/route.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using the language filter facility#site/helpers/category.php|site/helpers/category.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#site/helpers/association.php|site/helpers/association.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_ACL#admin/helloworld.php|admin/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_ACL#admin/config.xml|admin/config.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Basic_backend#admin/controller.php|admin/controller.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_ACL#admin/access.xml|admin/access.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_categories#admin/helpers/helloworld.php|admin/helpers/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#admin/helpers/associations.php|admin/helpers/associations.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/helpers/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#admin/helpers/html/helloworlds.php|admin/helpers/html/helloworlds.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/helpers/html/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using_the_database#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[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]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using_the_database#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_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_an_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_an_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_an_MVC_Component/Adding_a_front-end_form#admin/sql/updates/mysql/0.0.16.sql|admin/sql/updates/mysql/0.0.16.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_an_Image#admin/sql/updates/mysql/0.0.17.sql|admin/sql/updates/mysql/0.0.17.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding a Map#admin/sql/updates/mysql/0.0.18.sql|admin/sql/updates/mysql/0.0.18.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding an alias#admin/sql/updates/mysql/0.0.20.sql|admin/sql/updates/mysql/0.0.20.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Using the language filter facility#admin/sql/updates/mysql/0.0.21.sql|admin/sql/updates/mysql/0.0.21.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Checkout#admin/sql/updates/mysql/0.0.24.sql|admin/sql/updates/mysql/0.0.24.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Ordering#admin/sql/updates/mysql/0.0.25.sql|admin/sql/updates/mysql/0.0.25.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/sql/updates/mysql/0.0.26.sql|admin/sql/updates/mysql/0.0.26.sql]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_categories#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/models/fields/helloworldordering.php|admin/models/fields/helloworldordering.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/models/fields/helloworldparent.php|admin/models/fields/helloworldparent.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/fields/modal/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#admin/models/fields/modal/helloworld.php|admin/models/fields/modal/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/models/helloworld.php|admin/models/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/models/forms/filter_helloworlds.xml|admin/models/forms/filter_helloworlds.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/forms/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding an alias#admin/models/forms/helloworld.js|admin/models/forms/helloworld.js]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/models/forms/helloworld.xml|admin/models/forms/helloworld.xml]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding an alias#admin/models/rules/greeting.php|admin/models/rules/greeting.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/models/rules/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_ACL#admin/controllers/helloworld.php|admin/controllers/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_backend_actions#admin/controllers/helloworlds.php|admin/controllers/helloworlds.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/controllers/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworld/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_ACL#admin/views/helloworld/view.html.php|admin/views/helloworld/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworld/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#admin/views/helloworld/tmpl/edit.php|admin/views/helloworld/tmpl/edit.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding_verifications#admin/views/helloworld/submitbutton.js|admin/views/helloworld/submitbutton.js]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/views/helloworlds/tmpl/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Associations#admin/views/helloworlds/tmpl/modal.php|admin/views/helloworlds/tmpl/modal.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/tables/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding Levels#admin/tables/helloworld.php|admin/tables/helloworld.php]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/language/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|admin/language/en-GB/index.html]]''
* ''[[S:MyLanguage/J3.x:Developing an MVC Component/Adding Levels#admin.2Flanguage.2Fen-GB.2Fen-GB.com_helloworld.ini|admin/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[S:MyLanguage/J3.x:Developing an MVC Component/Adding Associations#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_an_MVC_Component/Developing_a_Basic_Component#index.html|media/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|media/images/index.html]]''
* ''[[S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_decorations_to_the_backend#Adding_some_icons|media/images/tux-16x16.png]]''
* ''[[S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_decorations_to_the_backend#Adding_some_icons|media/images/tux-48x48.png]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|media/js/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding an alias#media/js/openstreetmap.js|media/js/openstreetmap.js]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding a Modal#media/js/admin-helloworlds-modal.js|media/js/admin-helloworlds-modal.js]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Developing_a_Basic_Component#index.html|media/css/index.html]]''
* ''[[S:MyLanguage/J3.2:Developing_an_MVC_Component/Adding a Map#index.html|media/css/openstreetmap.css]]''

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

<name>COM_HELLOWORLD</name>

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

<description>COM_HELLOWORLD_DESCRIPTION</description>


<scriptfile>script.php</scriptfile>

<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>
<filename>router.php</filename>
<folder>controllers</folder>
<folder>views</folder>
<folder>models</folder>
<folder>helpers</folder>
</files>

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

<media destination="com_helloworld" folder="media">
<filename>index.html</filename>
<folder>images</folder>
<folder>js</folder>
<folder>css</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>
<language tag="fr-FR">fr-FR/fr-FR.com_helloworld.ini</language>
<language tag="fr-FR">fr-FR/fr-FR.com_helloworld.sys.ini</language>
</languages>
</administration>

</extension>
</source>
</span>
<translate>
== Contributors == 
</translate>
*[[User:Robbiej|Robbie Jackson]]

<div class="row">
<div class="large-6 columns">{{Basic button|S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding Ordering|<translate> Prev: Adding Ordering</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding Versioning|<translate> Next: Adding Versioning</translate>|class=expand}}</div>
</div>
__NOTOC__
<noinclude>
[[Category:Joomla! 3.x{{#translation:}}]]
[[Category:Joomla! 3.0{{#translation:}}]]
[[Category:Joomla! 3.1{{#translation:}}]]
[[Category:Joomla! 3.2{{#translation:}}]]
[[Category:Joomla! 3.3{{#translation:}}]]
[[Category:Joomla! 3.4{{#translation:}}]]
[[Category:Beginner Development{{#translation:}}]]
[[Category:Component Development{{#translation:}}]]
[[Category:Tutorials{{#translation:}}]]
[[Category:Tutorials in a Series{{#translation:}}]]
</noinclude>

J3.x:Developing an MVC Component/Adding a batch process

2020-03-18T13:48:22Z

ThiagoG:

J3.x:Developing an MVC Component/Adding a Modal

2020-03-10T19:16:19Z

ThiagoG: