Joomla! Documentation - User contributions [en]

J3.x talk:Developing an MVC Component/Adding a variable request in the menu type

2016-01-10T14:46:41Z

Robwent: Note about issues updating page

If I try and update the copyright year on this page the formatting of the first xml block gets messed up even though I haven't edited it.

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

2016-01-10T13:40:58Z

Robwent: Updating copyright year

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

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

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

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

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

<translate>
To add a menu item you will need to navigate to <tt>com_helloworld</tt>, which is the original directory we made for our component. You must use the updated directory structure from the last [[S:MyLanguage/J3.x:Developing_an_MVC_Component/Adding_a_menu_type_to_the_site_part | tutorial]]. Using your preferred file manager, create or update the following files; as you create or update the files, add the source code for each file which is found in [[#File Details|File Details]].</translate>

{| border=1
| 1
| Create: [[#site/models/helloworld.php| helloworld.php]]
| <tt><path_to_com_helloworld>/site/models/helloworld.php<tt>
|-
| 2
| Create: [[#site/models/index.html| index.html]]
| <tt><path_to_com_helloworld>/site/models/index.html</tt>
|-
| 3
| Update: [[#site/views/helloworld/view.html.php| view.html.php]]
| <tt><path_to_com_helloworld>/site/views/helloworld/view.html.php</tt>
|-
| 4
| Update: [[#helloworld.xml| helloworld.xml]]
| <tt><path_to_com_helloworld>/helloworld.xml</tt>
|}

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

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

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

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

/**
* Get the message
*
* @return string The message to be displayed to the user
*/
public function getMsg()
{
if (!isset($this->message))
{
$this->message = 'Hello World!';
}

return $this->message;
}
}
</source>

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

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

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

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

return false;
}

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

{{vanchor|site/helloworld.xml}}
<source lang="xml" highlight="13,32">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2.0" method="upgrade">

<name>Hello World!</name>

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

<version>0.0.4</version>

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

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



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

<administration>

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


<files folder="admin">

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

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

</extension>
</source>

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

=== helloworld.php ===

<source lang="php">
class HelloWorldModelHelloWorld extends JModelItem
{
</source>

<translate>
This class will be called by the class HelloWorldViewHelloWorld.</translate>

<translate>
=== view.html.php === 
</translate>

<source lang="php">
$this->msg = $this->get('Msg');
</source>

<translate>
The ''HelloWorldViewHelloWorld'' class asks the model for data using the ''get'' method of the ''JViewLegacy''.</translate>

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

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

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

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

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

2016-01-10T13:15:34Z

Robwent: Updating copyright year

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

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

<translate>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

</source>

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

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

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

{{vanchor|helloworld.xml}}
<source lang="xml" highlight="13,30,31">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="3.2.0" method="upgrade">

<name>Hello World!</name>

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

<version>0.0.2</version>

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

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



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

<administration>

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


<files folder="admin">

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

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

</extension>
</source>

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

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

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

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

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

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

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

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

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

<translate>
The main entry point, helloworld.php, essentially passes control to the controller, which handles performing the task that was specified in the request. Our component specific controller doesn't do anything more than the parent class already does, which is why our controller class is empty.</translate>

=== controller.php ===

<source lang="php">
class HelloWorldController extends JControllerLegacy
{
}
</source>
<translate>
When no task is given in the request variables, the default task will be executed. It's the display task by default. The JControllerLegacy class has such a task. In our example, it will display a view named HelloWorld.</translate>

=== view.html.php ===

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

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

<translate>
The view sets up the text to be output and then calls the base display class.
''[https://api.joomla.org/cms-3/classes/JViewLegacy.html JViewLegacy]'' is a base class for a Joomla! View. In our case, this method will display data using the tmpl/default.php file.</translate>

=== default.php ===

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

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

=== helloworld.xml ===

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

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

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

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

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

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

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

<noinclude>
<translate>

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

Manifest files

2014-11-20T12:17:56Z

Robwent: typo

{{version|2.5,3.x}}

Within Joomla there are manifest files for all of the extensions. These files include the general installation information as well as parameters for the configuration of the [[extension]] itself. Since Joomla! 2.5 {{JVer|2.5}}, there are very few differences between the manifest file formats for the different [[Extension types (technical definitions)|types of extensions]], allowing each type to access the full power of the Joomla! installer.

==Naming conventions==
The file must be named <tt>manifest.xml</tt> or <tt><extension_name>.xml</tt> and located in the root directory of the installation package.

==Syntax==

=== Root element ===
The primary tag of the installation file is:
<source lang=xml><extension></extension></source>

This starting and closing tags are now valid for all extensions. The new tag <code><extension></code> replaces the old <code><install></install></code> from Joomla {{JVer|1.5}}. The following attributes are allowed within the tag:

{|class="wikitable"
|-
! style="width: 150px" | Attribute || style="width: 150px" | Values || Applicable to || Description
|-
| type || <code>component</code><br /><code>file</code><br /><code>language</code><br /><code>library</code><br /><code>module</code><br /><code>package</code><br /><code>plugin</code><br /><code>template</code> || All extensions
| This attribute describes the type of the extension for the installer. Based on this type further requirements to sub-tags apply.
|-
| version
| <code>2.5</code><br /><code>3.0</code> || All extensions
| String that identifies the version of Joomla for which this extension is developed.
|-
| method
| <code>install</code><br /><code>upgrade</code> || All extensions
| The default value <code>install</code> will be also used if the method attribute is not used. The <code>install</code> value means the installer will gracefully stop if it finds any existing file/folder of the new extension.
|-
| client
| <code>site</code><br /><code>administrator</code> || Modules
| The client attribute allows you to specify for which application client the new module is available.
|-
| group
| ''string'' || Plugins
| The group name specifies for which group of plugins the new plugin is available. The existing groups are the folder names within the directory <tt>/plugins</tt>. The installer will create new folder names for group names that do not exist yet.
|}

=== Metadata ===

The following elements can be used to insert metadata. None of these elements are required; if they are present, they must be a child of the root element.

<pre>
<name> – raw component name (e.g. com_banners).
<author> – author's name (e.g. Joomla! Project)
<creationDate> – date of creation or release (e.g. April 2006)
<copyright> – a copyright statement (e.g. (C) 2005 - 2011 Open Source Matters. All rights reserved.)
<license> – a license statement (e.g. NU General Public License version 2 or later; see LICENSE.txt)
<authorEmail> – author's email address (e.g. admin@joomla.org)
<authorUrl> – URL to the author's website (e.g. www.joomla.org)
<version> – the version number of the extension (e.g. 1.6.0)
<description> – the description of the component. This is a translatable field. (e.g. COM_BANNERS_XML_DESCRIPTION)
</pre>

Note: The <name> and <description> tags are also translatable fields so that the name and description of the extension can be shown to the user in their native language.

=== Front-end files ===

<source lang="xml">
<files folder="from-folder">
<filename>example.php</filename>
<folder>examples</folder>
</files>
</source>

Files to copy to the front-end directory should be placed in the <code><files></code> element. You can use the optional <code>folder</code> attribute to specify a directory '''in the ZIP package''' to copy '''from'''. Each file to copy must be represented by a <code><filename></code> element. If you want to copy an entire folder at once, you can define it as a <code><folder></code>.

=== Media files ===

<source lang="xml>
<media folder="media" destination="com_example">
<filename>com_example_logo.png</filename>
<folder>css</folder>
<folder>js</folder>
</media>
</source>

This example will copy the file(s) (<tt>/media/com_example_logo.png</tt>) and folders ( <tt>/media/css/</tt> and <tt>/media/js/</tt> ) listed to <tt>/media/com_example/</tt>, creating the <tt>com_example</tt> folder if required. You can use the optional <code>folder</code> attribute to specify a directory '''in the ZIP package''' to copy '''from''' (in this case, <tt>media</tt>).

Extensions should be storing assets they need to be web accessible (JS, CSS, images etc) in <code>media</code>. Amongst other things this feature was added as step in the progression to multi-site support and the eventual move of code files (PHP) out of the web accessible areas of the server.

Ref:
* [https://groups.google.com/forum/#!msg/joomla-dev-cms/4CAASJqFY-k/PvPj14gP29EJ Google Groups - joomla-dev-cms thread]
* [https://groups.google.com/forum/#!msg/joomla-dev-cms/uNmhX98sKbE/p8p68Jke680J Google Groups - joomla-dev-cms thread]

=== Administration section ===

<source lang="xml">
<administration>

</administration>
</source>

The administration section is defined in the <code><administration></code> element. Since only [[Component|components]] apply to both the [[Site (Application)|site]] and the [[Administrator (Application)|administrator]], '''only component manifests can include this element'''.

==== Back-end files ====

Files to copy to the back-end directory should be placed in the <code><files></code> element under the <code><administration></code>. You can use the optional <code>folder</code> attribute to specify a directory '''in the ZIP package''' to copy '''from'''. See ''Front-end files'' for further rules.

==== Menu links and submenus ====

<source lang="xml">
<menu>COM_EXAMPLE</menu>
<submenu>
<menu link="anoption=avalue">COM_EXAMPLE_SUBMENU_ANOPTION</menu>
<menu view="viewname">COM_EXAMPLE_SUBMENU_VIEWNAME</menu>
</submenu>
</source>

The text for the main menu item for the component is defined in the <code><menu></code> item, a child of <code><administration></code>. A <code><submenu></code> element may also be present (also a child of <code><administration></code>), which may contain more menu items defined by <code><menu></code>.

Additionally, each <code><menu></code> item can define the following attributes:

{| class="wikitable"
! style="width: 150px" | Attribute || Description
|-
| link || A link to send the user to when the menu item is clicked
|-
| img || The (relative) path to an image (16x16 pixels) to appear beside the menu item.
<u>Must be an url compatible as a file too (e.g. no spaces) !</u>
|-
| alt ||
|-
| ''string'' || An URL parameter to add to the link. For example, <code><menu view="cpanel">COM_EXAMPLE</menu></code> in com_example's XML manifest would cause the URL of the menu item to be <tt>index.php?option=com_example&view=cpanel</tt>.
|-
|}

The value inside the tag is the menu's label. Unlike Joomla! 1.5, you can not use a natural language string. For example, if you would enter "Example Component" instead of COM_EXAMPLE, it would result in your component name appearing as example-component in the menu and you would be unable to provide a translation. In order to provide a translation you need to create a file named en-GB.com_example.sys.ini in administrator/languages/en-GB (you can use the manifest's <code><languages></code> tag to copy it during installation) or in administrator/components/com_example/language/en-GB. In the latter case, you must not include the translation file in the <code><languages></code> tag. As long as you have placed the language directory in your <code><files></code> tag, it will be copied along when the component is being installed.

The contents of that file should be:
<source>
COM_EXAMPLE="Example Component"
COM_EXAMPLE_SUBMENU_ANOPTION="Another Option"
COM_EXAMPLE_SUBMENU_VIEWNAME="Another View"

</source>

Please note that the language string must be enclosed in double quotes, as per Joomla!'s translation standards. Important note: Joomla! 1.6 and later sorts the Component menu items based on the actual translation of the key you supply in your XML manifest. This means that the sorting order is correct no matter what you call your translation key and no matter which language the site is being displayed in. Essentially, Joomla! 1.6 fixed the wrong sorting of the Components menu experienced under Joomla! 1.5 for the majority (non-English speaking!) of Joomla! users.

{{Needsinfo|In Platform 11.1 no alt attribute processed and if link provide in menu tag other provided attributes were ignore. The other tags are task, view, controller, act, layout, sub. Please confirm this, please.}}

=== Configuration ===
{{warning|Components '''do not support''' configuration definitions '''in the manifest'''. This is a way implemented in Joomla! 1.5. They can define configuration options for multiple levels using [[Component configuration metadata]].}}
The <code><config></code> element, a child of the root, describes the configuration options for the extension. If applicable, the options will be shown by the appropriate Manager (Plugin Manager, Module Manager or Template Manager). '''Configuration options can also be defined in a separate file named <code>config.xml</code>. Its root element should be <code><config></code>.'''

{{:XML JForm form definitions}}

=== SQL ===

<source lang="xml">
<install>
<sql>
<file driver="mysql" charset="utf8">sql/example.install.sql</file>
</sql>
</install>
<uninstall>
<sql>
<file driver="mysql" charset="utf8">sql/example.uninstall.sql</file>
</sql>
</uninstall>
</source>

In the above example, we put the SQL files in the <tt>admin/sql</tt> folder of the installation package. You have to include the <tt>sql</tt> folder in the administration files (as described in ''Back-end files'').

You can execute SQL during the installation and/or uninstallation using the <code><install></code> and <code><uninstall></code> elements, respectively. A <code><sql></code> element should appear as a child of these elements. <code><sql></code> can contain any number of <code><file></code> elements, each defining a single SQL file to execute. Their database driver types are described by the <code>driver</code> attribute, their character sets by the <code>charset</code> attribute.

==== Update of the SQL schema ====

<source lang="xml">
<update>
<schemas>
<schemapath type="mysql">sql/updates/mysql</schemapath>
<schemapath type="sqlsrv">sql/updates/sqlsrv</schemapath>
</schemas>
</update>
</source>

Since 1.6, there is also an <code><update></code> tag, which allows you to provide a series of SQL files to update the current schema.

=== Language files ===
In Joomla! 1.5, extension developers had to put extension language files in the Joomla! main language file, using the <languages>..</languages> tag as shown below. '''This method can still be used in''' {{rarr|2.5,3.x}}.

<source lang="xml">

<languages folder="langfiles">
<language tag="en-GB">en-GB.com_example.ini</language>
</languages>
</source>

Since Joomla! 1.6 it has been encouraged placing your extension's language files in your extension folder. Joomla! will then automatically load your extension's language files.

By storing extension language files in the extension folder, you gain the benefit of isolating and protecting your extension's language files. For example, an administrator removes a language from their Joomla! installation. Your extension's language files will not be removed. They will remain in place and will be available if the language is installed again.

The structure of the language folder for frontend and backend is the same. You put them in the language tag (e.g. '''en-GB''' ) of each language in your language folder i.e. '''language/en-GB/'''. You have to specify those folders in the front-end and back-end files too.

In your manifest you simply include the ''''language'''' folder in your files section, the sub-directories for each language automatically be copied. Inside the <files> group you simply add a <folder> element alongside the items in the '''<files>''' group as shown in this example:

<source lang="xml">
<files>
<filename plugin="alpha">alpha.php</filename>
<folder>sql</folder>
<folder>language</folder>
</files>
</source>

It is also notable that both ways can work together. Here is an example from core:
<source lang="xml">
<files>
<filename plugin="languagecode">languagecode.php</filename>
<filename>index.html</filename>
<folder>language</folder>
</files>
<languages>
<language tag="en-GB">language/en-GB/en-GB.plg_system_languagecode.ini</language>
<language tag="en-GB">language/en-GB/en-GB.plg_system_languagecode.sys.ini</language>
</languages>
</source>

The advantages of this solution are the following:

All ini files present in the core folder have precedence over the files in the extension language/ folder.
For example a sys.ini file will always be loaded from core folders in back-end if it exists, except when installing an extension which contains a sys.ini file in a language folder. In that case and only that case, the sys.ini file in the extension folder will display its translated content at install time. This is very handy as a developer can have 2 sys.ini files with different contents. A description of the successful install as well as a tutorial in back-end for example.

Also, it is much easier for a user needing an ini file for an extension that does not provide it in the language desired, to add it in the main folders. No risk for it to be deleted in case of uninstalling the extension by mistake or any other reason.

See also:
*[[J2.5:Making non-core language packs|Making non-core language packs]]
*[[Creating language packs for extensions in Joomla 2.5]]

During development you can turn on language debugging in the Joomla! global configuration. So you can investigate if a problems arises. As of 3.2, this is necessary to help debug as en-GB is '''always''' loaded first when not in debug mode to prevent displaying Constants.

=== Script file ===

<source lang="xml">
<scriptfile>example.script.php</scriptfile>
</source>

An optional '''script file''' (PHP code that is run before, during and/or after installation, uninstallation and upgrading) can be defined using a <code><scriptfile></code> element. This file should contain a class named "<element_name>InstallerScript" where <element_name> is the name of your extension (e.g. com_componentname, mod_modulename, etc.). Plugins requires to state the group (e.g. plgsystempluginname). Library packages do not support scriptfiles. The structure of the class is as follows:

<source lang="php">

class com_componentnameInstallerScript
{
/**
* Constructor
*
* @param JAdapterInstance $adapter The object responsible for running this script
*/
public function __construct(JAdapterInstance $adapter);

/**
* Called before any type of action
*
* @param string $route Which action is happening (install|uninstall|discover_install|update)
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function preflight($route, JAdapterInstance $adapter);

/**
* Called after any type of action
*
* @param string $route Which action is happening (install|uninstall|discover_install|update)
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function postflight($route, JAdapterInstance $adapter);

/**
* Called on installation
*
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function install(JAdapterInstance $adapter);

/**
* Called on update
*
* @param JAdapterInstance $adapter The object responsible for running this script
*
* @return boolean True on success
*/
public function update(JAdapterInstance $adapter);

/**
* Called on uninstallation
*
* @param JAdapterInstance $adapter The object responsible for running this script
*/
public function uninstall(JAdapterInstance $adapter);
}

</source>

=== Update servers ===

<source lang="xml">
<updateservers>
<server type="extension" priority="1" name="Extension Update Site">http://example.com/extension.xml</server>
<server type="collection" priority="2" name="Collection Update Site">http://example.com/collection.xml</server>
</updateservers>
</source>

Update servers can be defined in the <code><updateservers></code> element, a child of the root. This element may contain one or more <code><server></code> element, each describing a location to fetch updates from. Each <code><server></code> item can define the following attributes:

{| class="wikitable"
! style="width: 150px" | Attribute || style="width: 150px" | Values || Description
|-
| type || <code>extension</code><br /><code>collection</code> || The update server type
|-
| priority || ''integer'' || The priority of the update server
|-
| name || ''string'' || The name of the update server
|}

More info:
* [[J2.5:Developing a MVC Component/Adding an update server|Building a Joomla! Extension - Adding an update server]]
* [[J2.5:Managing Component Updates|Managing Component Updates in Joomla 2.5]]

== Examples ==
For a real-life example, see [https://github.com/joomla/joomla-cms/blob/2.5.x/administrator/components/com_banners/banners.xml the manifest of the Banner component in the latest version of Joomla! 2.5].

The Joomla testing process uses several extensions to test whether the installer works correctly. The latest versions of the manifests of these extensions are:

* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/com_alpha/alpha.xml com_alpha manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/mod_alpha/mod_alpha.xml mod_alpha manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/plg_system_alpha/alpha.xml plg_system_alpha manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/tpl_simple/templateDetails.xml tpl_simple manifest]
* [http://svn.joomla.org/project/cms/development/trunk/tests/_data/installer_packages/lng_xx-XX/xx-XX.xml lng_xx-XX manifest]

== Contributors ==
*[[User:akede|Alex Kempkens]]
*[[User:dperaza|Daniel Peraza]]
*[[User:nikosdion|Nicholas K. Dionysopoulos]]
*[[User:mrs.siam|Prasit Gebsaap]]
*[[User:cppl|Craig Phillips]]

[[Category:Extension development]]
[[Category:Specifications]]

Nginx

2014-09-06T19:02:14Z

Robwent: line has been copied from console and contains $ which indicates more unseen code. Stops javascipt being gzipped

[http://nginx.net/ nginx] is a lightweight Web server that powers about 13% of Web servers across all domains[http://en.wikipedia.org/wiki/Nginx#Description]. Unless you have specific requirements that demand a heavy Web server like Apache, you are much better off using nginx.

Below are instructions on how to get Joomla! running with [http://wiki.nginx.org/PHPFcgiExample nginx and PHP via FastCGI].

== Install nginx ==
For Ubuntu, run <tt>aptitude install nginx</tt>. For other distros, run the corresponding package manager, or see http://wiki.nginx.org/Install.

== Install PHP FastCGI ==
For Ubuntu, read this excellent page on how to [http://wiki.nginx.org/PHPFcgiExample configure PHP and FastCGI for nginx].

For Gentoo, PHP will run as a FastCGI service (fpm), so the nginx server will run PHP as a separated process:
<pre>
# echo "dev-lang/php gd gd2 curl simplexml tokenizer dom tidy sqlite xml fpm cgi" >> /etc/portage/package.use
# emerge php
</pre>
The default settings of php-fpm are good for most servers. For special configurations, visit the [http://php.net/manual/en/install.fpm.php PHP FPM site].

== Configure Nginx ==
nginx configuration files reside in:
* <tt>/etc/nginx/sites-available/</tt> on Ubuntu (for sites running on that nginx instance)
* <tt>/etc/nginx/nginx.conf</tt> on Gentoo and Raspbian(= Debian optimized for Raspberry Pi)

Here is an sample nginx configuration file, joomla.conf, that you can reuse over all your nginx enabled-sites.

<pre>
server {
listen 80;
server_name YOUR_DOMAIN;
server_name_in_redirect off;

access_log /var/log/nginx/localhost.access_log main;
error_log /var/log/nginx/localhost.error_log info;

root PATH_ON_SERVER;
index index.php index.html index.htm default.html default.htm;
# Support Clean (aka Search Engine Friendly) URLs
location / {
try_files $uri $uri/ /index.php?$args;
}

# deny running scripts inside writable directories
location ~* /(images|cache|media|logs|tmp)/.*\.(php|pl|py|jsp|asp|sh|cgi)$ {
return 403;
error_page 403 /403_error.html;
}

location ~ \.php$ {
fastcgi_pass 127.0.0.1:9000;
fastcgi_index index.php;
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
include /etc/nginx/fastcgi.conf;
}

# caching of files
location ~* \.(ico|pdf|flv)$ {
expires 1y;
}

location ~* \.(js|css|png|jpg|jpeg|gif|swf|xml|txt)$ {
expires 14d;
}

}
</pre>

Pay attention to a few things:
# The parameter <tt>fastcgi_pass</tt> is set to 127.0.0.1:9000, corresponding to the port that fpm is configured to listen to. This means you can run the PHP processes on separate servers. On Gentoo, you can find this configuration in <tt>/etc/php/fpm-php5.3/php-fpm.conf/</tt>
# Don't forget to replace YOUR_DOMAIN & PATH_ON_SERVER above depending on your domain and the path of Joomla on your server.

== GZip support ==
If you need GZip compression support, add the following section to the http section of the main nginx configuration file:
<pre>
gzip on;
gzip_http_version 1.1;
gzip_comp_level 6;
gzip_min_length 1100;
gzip_buffers 4 8k;
gzip_types text/plain application/xhtml+xml text/css application/xml application/xml+rss text/javascript application/javascript application/x-javascript
gzip_proxied any;
gzip_disable "MSIE [1-6]\.";
</pre>

== Sources ==
* [http://en.gentoo-wiki.com/wiki/Nginx Nginx in Gentoo]
* [http://www.kevinworthington.com/nginx-for-windows/ Nginx for Windows]
* [http://wiki.nginx.org/Install#Ubuntu_PPA Nginx in Ubuntu]
* [http://www.debianadmin.com/howto-install-nginx-webserver-in-debian.html Nginx in Debian]
* [http://php.net/manual/en/install.fpm.php PHP-FPM installation and configuration]
* [http://wiki.nginx.org/HttpGzipModule GZip in Nginx]
* [http://wiki.nginx.org/HttpRewriteModule Rewrite in Nginx]
* [http://nginx.org/en/docs/http/request_processing.html How nginx processes a request]

Help310:Site System Information

2014-03-11T13:02:22Z

Robwent: Magic quotes recommended to be off in all other documentation and J3 will not install with it on

Joomla! Core settings with information useful for management of your Joomla! website.

==Description==
This tool provides useful information about your host server environment, including operating system, database and PHP settings, and directory information. You can navigate to five different screen: System Info, PHP Settings, Configuration File, Directory Permissions, and PHP Information. Each screen provides detailed information about that aspect of your Joomla! website. This information is very helpful when you are troubleshooting setup problems.
*Note that none of these settings can be changed from these screens. This must be done in different locations throughout your Joomla! installation, depending on the specific setting.
*Many settings on the Configuration File screen can be changed from the [[Help30:Site_Global_Configuration|Global Configuration]] screen. Some settings shown here depend on your host server configuration and cannot be changed from inside Joomla!.

==How to access==
Select '''Site → System Information''' from the drop-down menu of the '''''Joomla! Administrator Panel'''''.

==Screenshot==
[[Image:Help-3x-system-system-information.png|670px]]

==Details Tabs==
*System Info
*PHP Settings
*Configuration File
*Directory Permissions
*PHP Information.

===System Info===
This screen shows information about the operating environment for your Joomla! site.

*'''PHP Built on:''' Provides details of the principle operating system which the webserver that Joomla is running on.
*'''Database Version:''' Provides the current version of the MySQL database being used by the installation of Joomla!.
*'''Database Collation:''' How the MySQL databased is structured for the information used by Joomla!.
*'''PHP Version:''' Provides the current version of PHP server side script that is being used for this installation of Joomla!.
*'''Web Server:''' Provides the current type and version of web server which the installation of Joomla! is running on.
*'''Web Server to PHP interface:''' The script that permits interaction between the web server (in most cases, Apache) and the PHP scripting language.
*'''Joomla! Version:''' Provides the current version of Joomla!. It is recommended that it is always to to day and using the current stable release.
*'''User Agent:'''The summary of the current user's local machine's operating system and browser information which is used to create an unique session ID for access and functionality within the Joomla! web site.

===PHP Settings===

These screen shows the Relevant PHP Settings information. If any of these is highlighted as incorrect should be taken care of to rectify the situation.

*'''Safe Mode:''' Recommended setting: ON
*'''Open basedir:''' Recommended setting: Site dependent
*'''Display Errors:''' Recommended setting: OFF
*'''Short Open Tags:''' Recommended setting:
*'''File Uploads:''' Recommended setting: ON
*'''Magic Quotes:''' Recommended setting: OFF
*'''Register Globals:''' Recommended setting: OFF
*'''Output Buffering:''' Recommended setting: OFF
*'''Session Save Path:''' Recommended setting: Site dependent
*'''Session Auto Start:''' Recommended setting: OFF
*'''XML Enabled:''' Recommended setting: ON
*'''Zlib Enabled:''' Recommended setting: ON
*'''Disabled Functions:''' Recommended setting: Site dependent
*'''Mbstring Enabled:''' Recommended setting: ON
*'''Iconv Available:''' Recommended setting:
*'''WYSIWYG Editor:''' Recommended setting: Depends on preference

===Configuration File===

This screen shows the contents of the current Joomla! ''configuration.php'' file which is stored under the main '''<path to joomla>/joomla_root/''' directory. This file is created for you automatically when you first install Joomla! and where most changes of the Global Configuration section of Joomla! are recorded. Please note that none of the settings can be changed from this page. Use [[Help30:Site_Global_Configuration|Global Configuration]] to see more information about these settings and to make changes.

===Directory Permissions===

This screen shows a list of the directories that the webserver should have write access to. Please note that all directories listed on this page should say <b style="color:green">Writable</b>. If not, you may need to change the permissions to be able to install and use Joomla! successfully.

===PHP Information===

This screen displays the full configuration of the PHP server side scripting language that Joomla! runs on, together with all the associated system information that goes towards the creation of the web server. It is the output of an integrated php.info script built into Joomla!.

PHP is installed, and runs on the server (hence the server side above), and therefore all the settings are made on the server. The visitor to the web site does not need to have anything special running on their local machine in order to view or use any of the extra functionality that PHP gives to the web site.

All the settings that are ever likely to be needed are displayed here. Any changes that are required would be made within the ''php.ini'' and other configuration files on the web server.

How much control a web site owner has over this information depends on whether they own the server or if the server host is flexible in their customer approach.

It is a good practice to know the limitations of a particular server installation. This screens output is used to find detailed information about how PHP is implemented on the server.

For full details on the information contained within the PHP Info screen visit: [http://php.net/phpinfo http://php.net/phpinfo].

==Toolbar==
At the top left you will see the toolbar:

[[Image:Help30-Help-toolbar.png]]

The functions are:
{{Chunk30:Help_screen_toolbar_icon_Help}}

==Quick Tips==
*If you are having problems installing extensions, uploading files, or changing configuration options, check the Directory Permissions screen to make sure you have permission to write to files on your web server. The "Status" of the directories should be "Writable". If not, you may be unable to upload or edit files in these directories.
*When you are seeking help with setup problems, for example in a Joomla! web forum, it is very helpful to post specific information about your Joomla! installation. This screen is an easy way to find all of this information in one place.

<noinclude>{{cathelp|3.0,3.1,3.2|System information|Site Maintenance Help Screens}}</noinclude>

Sending email from extensions

2013-07-17T22:55:07Z

Robwent: /* Set a sender */

{{version|2.5,3.1}}
This is an example of how to send an email from a component. You would typically put this into your components controller.

=== Fetch the mail object ===
A reference to the global mail object (JMail) is fetched through the JFactory object. This is the object creating our mail.

<source lang="php">
$mailer = JFactory::getMailer();
</source>

=== Set a sender ===
The sender of an email is set with [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#setSender setSender]. The function takes an array with an email address and a name as an argument. We fetch the sites email address and name from the global configuration. These are set in the administration back-end (Global Configuration -> Server -> Mail Settings).

<source lang="php">
$config = JFactory::getConfig();
$sender = array(
$config->getValue( 'config.mailfrom' ),
$config->getValue( 'config.fromname' ) );

$mailer->setSender($sender);
</source>

In 3.1, $config->getValue() should be changed to $config->get()

=== Recipient ===
You set the recipient of an email with the function [http://api.joomla.org/1.5/Joomla-Framework/Mail/JMail.html# addRecipient].
To set the email address to the currently logged in user, we fetch it from the user object.

<source lang="php">
$user = JFactory::getUser();
$recipient = $user->email;

$mailer->addRecipient($recipient);
</source>

If we had multiple recipients we would put each recipients email address in an array.

<source lang="php">
$recipient = array( 'person1@domain.com', 'person2@domain.com', 'person3@domain.com' );

$mailer->addRecipient($recipient);
</source>

=== Create the mail ===
We need to set a subject line and create the text body. The subject is set with [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#setSubject setSubject].

The easy way to create an email body is as a string with plain text. Use the function [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#setBody setBody] to add a message to the mail body. You can also attach a file with [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#addAttachment addAttachment]. It takes a single file name or an array of file names as argument.

<source lang="php">
$body = "Your body string\nin double quotes if you want to parse the \nnewlines etc";
$mailer->setSubject('Your subject string');
$mailer->setBody($body);
// Optional file attached
$mailer->addAttachment(JPATH_COMPONENT.DS.'assets'.DS.'document.pdf');
</source>

If you prefer to format your email in HTML, you need to tell the mailer it is HTML. This is done with [http://api.joomla.org/Unknown/PHPMailer.html#methodIsHTML IsHTML]. When sending HTML emails you should normally set the [http://api.joomla.org/Unknown/PHPMailer.html#$Encoding Encoding] to base64 in order to avoid unwanted characters in the output. The subject line and any attachments are handled as above, with the exception of images embedded in the HTML. These are taken care of with the function [http://api.joomla.org/Unknown/PHPMailer.html#AddEmbeddedImage AddEmbeddedImage].

<source lang="php">
$body = '<h2>Our mail</h2>'
. '<div>A message to our dear readers'
. '<img src="cid:logo_id" alt="logo"/></div>';
$mailer->isHTML(true);
$mailer->Encoding = 'base64';
$mailer->setBody($body);
// Optionally add embedded image
$mailer->AddEmbeddedImage( JPATH_COMPONENT.'/assets/logo128.jpg', 'logo_id', 'logo.jpg', 'base64', 'image/jpeg' );
</source>

Normally you would leave any images on your server and refer to them with an ordinary HTML image tag, to reduce size of the mail and the time sending it.

=== Sending the mail ===

The mail is sent with the function [http://api.joomla.org/Joomla-Framework/Mail/JMail.html#Send Send]. It returns '''true''' on success or a JError object.

<source lang="php">
$send = $mailer->Send();
if ( $send !== true ) {
echo 'Error sending email: ' . $send->message;
} else {
echo 'Mail sent';
}
</source>

You would probably want to write your own error handler, if there is an error sending the mail.

The JMail object is used for sending mail in Joomlas contact manager. See the file joomla/components/com_contact/controller.php

===See also===
* [http://api.joomla.org/Joomla-Platform/JFactory.html#getMailer JFactory->getMailer on api.joomla.org]

[[Category:Development]]
[[Category:Component Development]]