Joomla! Documentation - User contributions [en]

J2.5:Developing a MVC Component/Adding backend actions

2012-01-20T15:08:37Z

Batch1211: /* Adding a toolbar */

This tutorial is for {{JVer|1.7}}

== Articles in this series ==
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!1.7 - Contents}}

== Introduction ==
This tutorial is part of the [[Developing a Model-View-Controller (MVC) Component for Joomla!1.7]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

== Adding a toolbar ==
In Joomla!1.7, the administrator interacts generally with components through the use of a toolbar. In the file ''admin/views/helloworlds/view.html.php'' put this content. It will create a basic toolbar and a title for the component.

<span id ="admin/views/helloworlds/view.html.php">
''admin/views/helloworlds/view.html.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HelloWorlds View
*/
class HelloWorldViewHelloWorlds extends JView
{
/**
* HelloWorlds view display method
* @return void
*/
function display($tpl = null)
{
// Get data from the model
$items = $this->get('Items');
$pagination = $this->get('Pagination');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JError::raiseError(500, implode('<br />', $errors));
return false;
}
// Assign data to the view
$this->items = $items;
$this->pagination = $pagination;

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

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

/**
* Setting the toolbar
*/
protected function addToolBar()
{
JToolBarHelper::title(JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLDS'));
JToolBarHelper::deleteList('', 'helloworlds.delete');
JToolBarHelper::editList('helloworld.edit');
JToolBarHelper::addNew('helloworld.add');
}
}
</source>
</span>

You can find other classic backend actions in the ''administrator/includes/toolbar.php'' file of your Joomla!1.7 installation.

Since the view can perform some actions, we have to add some input data. With your favorite file manager and editor, put in the file ''admin/views/helloworlds/tmpl/default.php''

<span id="admin/views/helloworlds/tmpl/default.php">
''admin/views/helloworlds/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
// load tooltip behavior
JHtml::_('behavior.tooltip');
?>
<form action="<?php echo JRoute::_('index.php?option=com_helloworld'); ?>" method="post" name="adminForm" id="adminForm">
<table class="adminlist">
<thead><?php echo $this->loadTemplate('head');?></thead>
<tfoot><?php echo $this->loadTemplate('foot');?></tfoot>
<tbody><?php echo $this->loadTemplate('body');?></tbody>
</table>
<div>
<input type="hidden" name="task" value="" />
<input type="hidden" name="boxchecked" value="0" />
<?php echo JHtml::_('form.token'); ?>
</div>
</form>
</source>
</span>

== Adding specific controllers ==
Three actions have been added:
* ''helloworlds.delete''
* ''helloworld.edit''
* ''helloworld.add''
read more about [[JController_and_its_subclass_usage_overview|subcontrollers...]]

These are compound tasks (''controller''.''task''). So two new controllers ''HelloWorldControllerHelloWorlds'' and ''HelloWorldControllerHelloWorld'' have to be coded.

<span id="admin/controllers/helloworlds.php">
''admin/controllers/helloworlds.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla controlleradmin library
jimport('joomla.application.component.controlleradmin');

/**
* HelloWorlds Controller
*/
class HelloWorldControllerHelloWorlds extends JControllerAdmin
{
/**
* Proxy for getModel.
* @since 1.7
*/
public function getModel($name = 'HelloWorld', $prefix = 'HelloWorldModel')
{
$model = parent::getModel($name, $prefix, array('ignore_request' => true));
return $model;
}
}
</source>
</span>

<span id="admin/controllers/helloworld.php">
''admin/controllers/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla controllerform library
jimport('joomla.application.component.controllerform');

/**
* HelloWorld Controller
*/
class HelloWorldControllerHelloWorld extends JControllerForm
{
}
</source>
</span>

== Adding an editing view ==
With your favorite file manager and editor, put a file ''admin/views/helloworld/view.html.php'' containing:

<span id="admin/views/helloworld/view.html.php">
''admin/views/helloworld/view.html.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HelloWorld View
*/
class HelloWorldViewHelloWorld extends JView
{
/**
* display method of Hello view
* @return void
*/
public function display($tpl = null)
{
// get the Data
$form = $this->get('Form');
$item = $this->get('Item');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JError::raiseError(500, implode('<br />', $errors));
return false;
}
// Assign the Data
$this->form = $form;
$this->item = $item;

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

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

/**
* Setting the toolbar
*/
protected function addToolBar()
{
JRequest::setVar('hidemainmenu', true);
$isNew = ($this->item->id == 0);
JToolBarHelper::title($isNew ? JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_NEW')
: JText::_('COM_HELLOWORLD_MANAGER_HELLOWORLD_EDIT'));
JToolBarHelper::save('helloworld.save');
JToolBarHelper::cancel('helloworld.cancel', $isNew ? 'JTOOLBAR_CANCEL'
: 'JTOOLBAR_CLOSE');
}
}
</source>
</span>

This view will display data using a layout.

Put a file ''admin/views/helloworld/tmpl/edit.php'' containing

<span id="admin/views/helloworld/tmpl/edit.php">
''admin/views/helloworld/tmpl/edit.php''
<source lang="php">
<?php
// No direct access
defined('_JEXEC') or die('Restricted access');
JHtml::_('behavior.tooltip');
?>
<form action="<?php echo JRoute::_('index.php?option=com_helloworld&layout=edit&id='.(int) $this->item->id); ?>"
method="post" name="adminForm" id="helloworld-form">
<fieldset class="adminform">
<legend><?php echo JText::_( 'COM_HELLOWORLD_HELLOWORLD_DETAILS' ); ?></legend>
<ul class="adminformlist">
<?php foreach($this->form->getFieldset() as $field): ?>
<li><?php echo $field->label;echo $field->input;?></li>
<?php endforeach; ?>
</ul>
</fieldset>
<div>
<input type="hidden" name="task" value="helloworld.edit" />
<?php echo JHtml::_('form.token'); ?>
</div>
</form>
</source>
</span>

== Adding a model and modifying the existing one ==

The ''HelloWorldViewHelloWorld'' view asks form and data from a model. This model has to provide a ''getTable'', a ''getForm'' method and a ''loadData'' method (called from the ''JModelAdmin'' controller)

<span id="admin/models/helloworld.php">
''admin/models/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla modelform library
jimport('joomla.application.component.modeladmin');

/**
* HelloWorld Model
*/
class HelloWorldModelHelloWorld extends JModelAdmin
{
/**
* Returns a reference to the a Table object, always creating it.
*
* @param type The table type to instantiate
* @param string A prefix for the table class name. Optional.
* @param array Configuration array for model. Optional.
* @return JTable A database object
* @since 1.7
*/
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.7
*/
public function getForm($data = array(), $loadData = true)
{
// Get the form.
$form = $this->loadForm('com_helloworld.helloworld', 'helloworld',
array('control' => 'jform', 'load_data' => $loadData));
if (empty($form))
{
return false;
}
return $form;
}
/**
* Method to get the data that should be injected in the form.
*
* @return mixed The data for the form.
* @since 1.7
*/
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;
}
}
</source>
</span>

This model inherits from the ''JModelAdmin'' class and uses its ''loadForm'' method. This method searches for forms in the ''forms'' folder. With your favorite file manager and editor, put a file ''admin/models/forms/helloworld.xml'' containing:

<span id="admin/models/forms/helloworld.xml">
''admin/models/forms/helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<form>
<fieldset>
<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"
default=""
/>
</fieldset>
</form>
</source>
</span>

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|site/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_02#site/helloworld.php|site/helloworld.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_02#site/controller.php|site/controller.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|site/views/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|site/views/helloworld/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_04#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_06#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_02#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|site/models/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_06#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|site/language/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|site/language/en-GB/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_08#site/language/en-GB/en-GB.com_helloworld.ini|site/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_07#admin/helloworld.php|admin/helloworld.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_07#admin/controller.php|admin/controller.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/sql/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_06#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_06#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/sql/updates/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_06#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/models/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/models/fields/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_06#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/models/forms/index.html]]''
* ''[[#admin/models/forms/helloworld.xml|admin/models/forms/helloworld.xml]]''
* ''[[#admin/models/helloworld.php|admin/models/helloworld.php]]''
* ''[[#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/views/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/views/helloworlds/index.html]]''
* ''[[#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/views/helloworlds/tmpl/index.html]]''
* ''[[#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_07#admin/views/helloworlds/tmpl/default_head.php|admin/views/helloworlds/tmpl/default_head.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_07#admin/views/helloworlds/tmpl/default_body.php|admin/views/helloworlds/tmpl/default_body.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_07#admin/views/helloworlds/tmpl/default_foot.php|admin/views/helloworlds/tmpl/default_foot.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/views/helloworld/index.html]]''
* ''[[#admin/views/helloworld/view.html.php|admin/views/helloworld/view.html.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/views/helloworld/tmpl/index.html]]''
* ''[[#admin/views/helloworld/tmpl/edit.php|admin/views/helloworld/tmpl/edit.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/tables/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_06#admin/tables/helloworld.php|admin/tables/helloworld.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_08#admin/language/en-GB/en-GB.com_helloworld.ini|admin/language/en-GB/en-GB.com_helloworld.ini]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_08#admin/language/en-GB/en-GB.com_helloworld.sys.ini|admin/language/en-GB/en-GB.com_helloworld.sys.ini]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/controllers/index.html]]''
* ''[[#admin/controllers/helloworld.php|admin/controllers/helloworld.php]]''
* ''[[#admin/controllers/helloworlds.php|admin/controllers/helloworlds.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_08#language/en-GB/en-GB.ini|language/en-GB/en-GB.ini]]''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58407/com_helloworld-1.6-part09.zip archive], modify the code in /admin/models/helloworld.php and install it using the extension manager of Joomla!1.7. You can add a menu item of this component using the menu manager in the backend.

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

<name>Hello World!</name>

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

<version>0.0.9</version>

<description>COM_HELLOWORLD_DESCRIPTION</description>

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



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

<administration>

<menu>COM_HELLOWORLD_MENU</menu>


<files folder="admin">

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

<folder>sql</folder>

<folder>tables</folder>

<folder>models</folder>

<folder>views</folder>

<folder>controllers</folder>
</files>

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

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

== Zips ==
Download the zip file for this Part:
[http://www.leyar.com/joomlaorg/part09.zip]

== Navigate ==

[[Developing a Model-View-Controller (MVC) Component for Joomla!1.7 - Part 08|Prev: Adding language management]]
[[Developing a Model-View-Controller (MVC) Component for Joomla!1.7 - Part 10|Next: Adding decorations to the backend]]

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Development]]
[[category:Joomla! 1.6]]
[[category:Joomla! 1.7]]
[[category:Manual]]

J2.5:Developing a MVC Component/Basic backend

2012-01-20T15:07:20Z

Batch1211: /* Create the view */

This tutorial is for {{JVer|1.7}}

== Articles in this series ==
{{Chunk:Developing a Model-View-Controller (MVC) Component for Joomla!1.7 - Contents}}

== Introduction ==
This tutorial is part of the [[Developing a Model-View-Controller (MVC) Component for Joomla!1.7]] tutorial. You are encouraged to read the previous parts of the tutorial before reading this.

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

<span id="admin/helloworld.php">
''admin/helloworld.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import joomla controller library
jimport('joomla.application.component.controller');

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

// Perform the Request task
$controller->execute(JRequest::getCmd('task'));

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

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

<span id="admin/controller.php">
''admin/controller.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla controller library
jimport('joomla.application.component.controller');

/**
* General Controller of HelloWorld component
*/
class HelloWorldController extends JController
{
/**
* display task
*
* @return void
*/
function display($cachable = false)
{
// set default view if not set
JRequest::setVar('view', JRequest::getCmd('view', 'HelloWorlds'));

// call parent behavior
parent::display($cachable);
}
}
</source>
</span>

This controller will display the 'HelloWorlds'' view by default.

== Create the view ==

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

<span id="admin/views/helloworlds/view.html.php">
''admin/views/helloworlds/view.html.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');

// import Joomla view library
jimport('joomla.application.component.view');

/**
* HelloWorlds View
*/
class HelloWorldViewHelloWorlds extends JView
{
/**
* HelloWorlds view display method
* @return void
*/
function display($tpl = null)
{
// Get data from the model
$items = $this->get('Items');
$pagination = $this->get('Pagination');

// Check for errors.
if (count($errors = $this->get('Errors')))
{
JError::raiseError(500, implode('<br />', $errors));
return false;
}
// Assign data to the view
$this->items = $items;
$this->pagination = $pagination;

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

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

<span id="admin/views/helloworlds/tmpl/default.php">
''admin/views/helloworlds/tmpl/default.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');

// load tooltip behavior
JHtml::_('behavior.tooltip');
?>
<form action="<?php echo JRoute::_('index.php?option=com_helloworld'); ?>" method="post" name="adminForm" id="adminForm">
<table class="adminlist">
<thead><?php echo $this->loadTemplate('head');?></thead>
<tfoot><?php echo $this->loadTemplate('foot');?></tfoot>
<tbody><?php echo $this->loadTemplate('body');?></tbody>
</table>
</form>
</source>
</span>

This layout calls several sub-layout (''head'', ''foot'' and ''body''). Each sub-layout corresponds to a file prefixed by the name of the main layout (''default''), and an underscore.

Put a file ''admin/views/helloworlds/tmpl/default_head.php'' containing

<span id="admin/views/helloworlds/tmpl/default_head.php">
''admin/views/helloworlds/tmpl/default_head.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<tr>
<th width="5">
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLD_HEADING_ID'); ?>
</th>
<th width="20">
<input type="checkbox" name="toggle" value="" onclick="checkAll(<?php echo count($this->items); ?>);" />
</th>
<th>
<?php echo JText::_('COM_HELLOWORLD_HELLOWORLD_HEADING_GREETING'); ?>
</th>
</tr>
</source>
</span>

''checkAll'' is a javascript function defined in the Joomla core able to check all items.

Put a file ''admin/views/helloworlds/tmpl/default_body.php'' containing

<span id="admin/views/helloworlds/tmpl/default_body.php">
''admin/views/helloworlds/tmpl/default_body.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<?php foreach($this->items as $i => $item): ?>
<tr class="row<?php echo $i % 2; ?>">
<td>
<?php echo $item->id; ?>
</td>
<td>
<?php echo JHtml::_('grid.id', $i, $item->id); ?>
</td>
<td>
<?php echo $item->greeting; ?>
</td>
</tr>
<?php endforeach; ?>
</source>
</span>

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

Put a file ''admin/views/helloworlds/tmpl/default_foot.php'' containing

<span id="admin/views/helloworlds/tmpl/default_foot.php">
''admin/views/helloworlds/tmpl/default_foot.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted Access');
?>
<tr>
<td colspan="3"><?php echo $this->pagination->getListFooter(); ?></td>
</tr>
</source>
</span>

''JPagination'' is a Joomla class able to manage and display pagination object.

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

and two states:
* ''list.start'' for determining the list offset
* ''list.limit'' for determining the list length

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

<span id="admin/models/helloworlds.php">
''admin/models/helloworlds.php''
<source lang="php">
<?php
// No direct access to this file
defined('_JEXEC') or die('Restricted access');
// import the Joomla modellist library
jimport('joomla.application.component.modellist');
/**
* HelloWorldList Model
*/
class HelloWorldModelHelloWorlds extends JModelList
{
/**
* Method to build an SQL query to load the list data.
*
* @return string An SQL query
*/
protected function getListQuery()
{
// Create a new query object.
$db = JFactory::getDBO();
$query = $db->getQuery(true);
// Select some fields
$query->select('id,greeting');
// From the hello table
$query->from('#__helloworld');
return $query;
}
}
</source>
</span>

The ''_populateState'' method is, by default, automatically called when a state is read by the ''getState'' method.

== Packaging the component ==

Content of your code directory
* ''[[#helloworld.xml|helloworld.xml]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|site/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_02#site/helloworld.php|site/helloworld.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_02#site/controller.php|site/controller.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|site/views/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|site/views/helloworld/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_04#site/views/helloworld/view.html.php|site/views/helloworld/view.html.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|site/views/helloworld/tmpl/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_06#site/views/helloworld/tmpl/default.xml|site/views/helloworld/tmpl/default.xml]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_02#site/views/helloworld/tmpl/default.php|site/views/helloworld/tmpl/default.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|site/models/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_06#site/models/helloworld.php|site/models/helloworld.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/index.html]]''
* ''[[#admin/helloworld.php|admin/helloworld.php]]''
* ''[[#admin/controller.php|admin/controller.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/sql/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_06#admin/sql/install.mysql.utf8.sql|admin/sql/install.mysql.utf8.sql]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_06#admin/sql/uninstall.mysql.utf8.sql|admin/sql/uninstall.mysql.utf8.sql]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/sql/updates/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/sql/updates/mysql/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#admin/sql/updates/mysql/0.0.1.sql|admin/sql/updates/mysql/0.0.1.sql]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_06#admin/sql/install.mysql.utf8.sql|admin/sql/updates/mysql/0.0.6.sql]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/models/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/models/fields/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_06#admin/models/fields/helloworld.php|admin/models/fields/helloworld.php]]''
* ''[[#admin/models/helloworlds.php|admin/models/helloworlds.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/views/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/views/helloworlds/index.html]]''
* ''[[#admin/views/helloworlds/view.html.php|admin/views/helloworlds/view.html.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/views/helloworlds/tmpl/index.html]]''
* ''[[#admin/views/helloworlds/tmpl/default.php|admin/views/helloworlds/tmpl/default.php]]''
* ''[[#admin/views/helloworlds/tmpl/default_head.php|admin/views/helloworlds/tmpl/default_head.php]]''
* ''[[#admin/views/helloworlds/tmpl/default_body.php|admin/views/helloworlds/tmpl/default_body.php]]''
* ''[[#admin/views/helloworlds/tmpl/default_foot.php|admin/views/helloworlds/tmpl/default_foot.php]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_01#index.html|admin/tables/index.html]]''
* ''[[Developing_a_Model-View-Controller_(MVC)_Component_for_Joomla!1.7_-_Part_06#admin/tables/helloworld.php|admin/tables/helloworld.php]]''

Create a compressed file of this directory or directly download the [http://joomlacode.org/gf/download/frsrelease/11394/58397/com_helloworld-1.6-part07.zip archive] and install it using the extension manager of Joomla!1.7. You can add a menu item of this component using the menu manager in the backend.

<span id="helloworld.xml">
''helloworld.xml''
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<extension type="component" version="1.7.0" method="upgrade">
<name>Hello World!</name>
<creationDate>November 2009</creationDate>
<author>John Doe</author>
<authorEmail>john.doe@example.org</authorEmail>
<authorUrl>http://www.example.org</authorUrl>
<copyright>Copyright Info</copyright>
<license>License Info</license>
<version>0.0.7</version>
<description>Description of the Hello World component ...</description>

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

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

<administration>
<menu>Hello World!</menu>
<files folder="admin">
<filename>index.html</filename>
<filename>helloworld.php</filename>
<filename>controller.php</filename>
<folder>sql</folder>
<folder>tables</folder>
<folder>models</folder>

<folder>views</folder>
</files>
</administration>
</extension>
</source>
</span>

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

== Zips ==
Download the zip file for this Part:
[http://www.leyar.com/joomlaorg/part07.zip]

== Navigate ==

[[Developing a Model-View-Controller (MVC) Component for Joomla!1.7 - Part 06|Prev: Using the database]]
[[Developing a Model-View-Controller (MVC) Component for Joomla!1.7 - Part 08|Next: Adding language management]]

== Contributors ==
*[[User:cdemko|Christophe Demko]]
*[[User:oaksu|Ozgur Aksu]]

[[Category:Development]]
[[category:Joomla! 1.6]]
[[category:Joomla! 1.7]]
[[category:Manual]]

J2.5 talk:Developing a MVC Component/Basic backend

2012-01-20T15:06:01Z

Batch1211: /* Admin Forms in J2.5 */ new section

Items to be adding/changed on this page:

Note that if using core J! javascript in a form, id="adminForm" must also be included.

Shouldn't references to $db->getDBO() be changed to $db->getDbo() ?

And what is this comment referring to? "The _populateState method is, by default, automatically called when a state is read by the getState method."

[[User:Radiant tech|Radiant tech]] 06:37, 1 September 2011 (CDT)

== Admin Forms in J2.5 ==

Aparently, for the JToolbar Icons to work properly in J2.5, the form elements need the id "adminForm" to be assigned to them. I changed this in ''admin/views/helloworlds/tmpl/default.php''. However, it also needs to be changed in the packages...

User talk:Batch1211

2011-09-08T14:59:26Z

Batch1211:

=== Change permission of content ===
Hi.
I would ask permission to move pages from the template namespace which are actually in course descriptions and pages that have links pointing to them.
I have as main objective the wiki organization and redesign the landing pages.

Thanks

Hey there. I didn't fully understand your query. What is it, what you're planning to do?

J2.5:Adapting a Joomla 1.5 extension to Joomla 2.5

2011-01-29T09:42:57Z

Batch1211:

{{incomplete}}

This article is written to help developers upgrade their extensions from Joomla 1.5 to Joomla 1.6. If you have any further tips, feel free to add them onto this wiki article.

== System setup ==
This document assumes that you are running the program eclipse for your development. This will allow you to automate most of the Joomla conversion process. For more instructions on how to setup eclipse, see [[Setting up your workstation for Joomla! development]].

== Background reading ==
[[What's new in Joomla 1.6#Developers]] describes most changes of Joomla 1.6 and how this affect developers.

== Updating your Joomla 1.5 language files to work on Joomla 1.6 ==
Using the native php ini parser for language files has many benefits including much faster performace. Converting your exisiting Joomla 1.5 into the new format is very easy if you use a coding platform like eclipse. Search your file for *.ini in your project of choice. Then use the following search/replace values to automatically, replace exisiting quotes, add quotes to string values and update your comments.

'''''Double quotes are NOT allowed inside the string value''', except when using "_QQ_" to represent them. In case of js use, better use html entities or single quotes.''

#Single quotes are allowed.
#Put a closing double quote at end of line if not empty or a comment. Find ^((?!#).+)\R replace with $1"\R
#Put an opening double quote at start of translated string if not empty or comment. Find ^((?!#).+?\=)(.+)\R replace with $1"$2\R
#Now replace the hash comments with the new semi colon. Find ^# and replace with ;
#Remove any illegal strings that can prevent files loading. Find ^(null|yes|no|true|false|on|off|none)=(.+)\R and replace with nothing.

Enabling Debug System in Global configuration will display the parsing errors per file and lines.

If you do not remove the illegal strings, then your language file will load until one of them is reached. The now "illegal" strings in the language file like NO, are handled by adding a 'J' in-front of them. Just make sure you change these language strings in your XML files as well. You can include in your language file:
<source lang="ini">
;forbidden words
JNULL="Null"
JYES="Yes"
JNO="No"
JTRUE="True"
JFALSE="False"
JON="On"
JOFF="Off"
JNONE="None"
</source>

== Changing Javascript function overrides ==
Joomla now has some of its Javascript functions prefixed with "Joomla". This means the functions are always unique and won't clash with other javascript functions on your server/webpage. However, you now need a different method to override the default Joomla Javascript. The Joomla 1.5 method was:
<source lang="javascript">
function submitbutton(pressbutton) {
var form = document.adminForm;
if (pressbutton == 'applyconfig') {
//do something unique
form.action.value = 'apply'
submitform('saveconfig');
return;
}

submitform(pressbutton);
return;
}
</source>
For Joomla 1.6 you need to copy your exisiting function but modify your top line to:
<source lang="javascript">
Joomla.submitbutton = function(pressbutton) {
var form = document.adminForm;
if (pressbutton == 'applyconfig') {
//do something unique
form.action.value = 'apply'
submitform('saveconfig');
return;
}

submitform(pressbutton);
return;
}
</source>

== Changing removed functions ==
Some functions were removed for various reasons. You can find a list of them on [[What's new in Joomla_1.6#Removed_features]].

Note that the ADODB compatibility methods included function like $db->Execute($query) which now need a separate $db->setQuery($query);$db->Query();

== Renamed events ==

A large number of the Joomla 1.5 events have been renamed. Here is the list of renamed events.
*onContentAfterSave
*onContentAfterTitle
*onContentAfterDisplay
*onContentBeforeDisplay
*onContentBeforeSave
*onContentSearch
*onContentSearchAreas
*onUserAuthenticate
*onUserAfterDelete
*onUserAfterSave
*onUserBeforeDelete
*onUserBeforeSave
*onUserLogin
*onUserLogout
*All content events (except for search and search areas) now pass a 'context' as the first argument to alert the plugin as to what type of content is being passed. The plugin event may or may not heed this context.

This means that if you use Joomla events you have two options:<br/>
1) rename the event and your extension can only be used on Joomla 1.6<br/>
2) create your own "legacy layer" and add the new event function name to your plugin. Here is an example of the user plugin:<br/>

<source lang="php">
//joomla 1.6 compatibility code
public function onUserLogin($user, $options){
$result = $this->onLoginUser($user, $options);
return $result;
}
public function onUserLogout($user) {
$result = $this->onLogoutUser($user);
return $result;
}
public function onUserAfterDelete($user, $succes, $msg) {
$result = $this->onAfterDeleteUser($user, $succes, $msg);
return $result;
}
public function onUserBeforeSave($user, $isnew, $new){
$result = $this->onBeforeStoreUser($user, $isnew, $new);
return $result;
}
public function onUserAfterSave($user, $isnew, $success, $msg){
$result = $this->onAfterStoreUser($user, $isnew, $success, $msg);
return $result;
}
</source>

== Changing name="adminForm" to id="adminForm" ==
To create your own admin forms in joomla you now need to use id="adminForm". This is because the use of the tag "name" is not valid HTML strict and has compatibility issues when used in XHTML served as XML.\. Although there is build in compatibility check to look for the old name="adminForm" tag, it is best to add the new id tag. Depending on the features you want to use you may need to include both, name="adminForm" and id="adminForm" because not all core functionality has been updated to use id's. An example of the new form code is:
<source lang="html4strict"><form method="post" action="index.php" name="adminForm" id="adminForm"></form></source>

== Removing references to index2.php and index3.php ==
Joomla 1.0 had different index files to serve admin content in different manners. Joomla 1.6 has now got better way to handle this and you need to search your codebase for "index2.php" and "index3.php" to ensure you don't have any Joomla 1.0 style links. If you need to display your component without any of the other Joomla 1.6 admin content (menus, etc) then add the following to the url: "&tmpl=component"

== Upgrading core table and field name usage ==
Many of the core Joomla tables have been simplified, combined or renamed. This was needed to get rid of some limitation dating back to Joomla 1.0. This means however that if you have code that directly manipulates Joomla tables, that you need to add a function that detects Joomla 1.6 and had different SQL queries based on the joomla version. Plase note that both tables and field names have been renamed or removed. An example is the following function that can find if a plugin is published on both Joomla 1.5 and 1.6:

<source lang="php">
function getPluginStatus($element, $folder) {
//get joomla specs
$db = & JFactory::getDBO();
$version = new JVersion;
$joomla = $version->getShortVersion();
if(substr($joomla,0,3) == '1.6'){
//Joomla 1.6 code
$query = 'SELECT published FROM #__extensions WHERE element=' . $db->Quote($element) . ' AND folder=' . $db->Quote($folder);
} else {
//Joomla 1.0/1.5 code
$query = 'SELECT published FROM #__plugins WHERE element=' . $db->Quote($element) . ' AND folder=' . $db->Quote($folder);
}
$db->setQuery($query);
$result = $db->loadResult();
return $result;
}
</source>

== Changing in the XML installer manifest file ==
Joomla 1.6 now uses a more streamlined approach to the XML file inside the ZIP file that installs Joomla extentions.

== New mootools version ==
Most important is that the Ajax class has been depreciated and replaced by the Request class. That means that if you use ajax calls you need to have a version switcher (below a sample code)

<source lang="php">
$version = new JVersion;
$joomla = $version->getShortVersion();

..... (your code) ....

/* our ajax istance for starting the sync */
<?php if(substr($joomla,0,3) == '1.6'){
echo 'var ajax = new Request.HTML({
url: url,';
} else {
echo 'var ajax = new Ajax(url, {';
}?>

.... your code .....

<?php if(substr($joomla,0,3) == '1.6'){
echo 'var ajaxsync = new Request.HTML({
url: url, ';
} else {
echo 'var ajaxsync = new Ajax(url, {';
}?>

.... your code .....

</source>

Also another common usuage of mootools in Joomla is the popup box. The Joomla 1.5 javascript code to close this box is:
<source lang="javascript">document.getElementById('sbox-window').close();</source>
in Joomla 1.6 you need to use:
<source lang="javascript">window.parent.SqueezeBox.close();</source>

== Converting your JParameters to JForms ==
Joomla 1.6 now uses the JForms class to handle parameters and it has also changed the way parameters are defined in your XML files. To make menu/component/module/plugin parameters work, first you need to update the XML file. Here is an automated way to handle the bulk of the conversion. (added "" to the examples below so you can see spaces in the search query as well). Use eclipse to search and replace parameters in *.xml files

replace "<param " with "<field "<br>
replace "</param>" with </field>"<br>
replace "<params> with "<config><fields name="params"><fieldset name="basic">"<br>
replace "<params*?> with "<config><fields name="params"><fieldset name="basic">"<br>
replace "</params>" with "</fieldset></fields></config>"<br>
replace "<install " with "<extension "<br>
replace "</install>" with "</extension>"

Change the "extension" node to add the following attributes:
* Keep the existing "type" attribute
* version="1.6.0"
* client="site"
* method="upgrade"

Example for a module:
<source lang="xml">
<extension type="module" version="1.6.0" client="site" method="upgrade">
</source>

Now if you want to use your joomla extension on both Joomla 1.5 and 1.6 you will need to go to your "team synchronising" view in eclipse. Double click on your changed xml file, which will open the compare editor. Then simply copy-paste back your old Joomla 1.5 params into your new Joomla 1.6 xml file and save.

If you have custom parameter types, you will need to do some additional work. In Joomla 1.5 you would use the following code:

<source lang="php"><params addpath="/administrator/components/com_yourname/elements"></source>
In joomla 1.6 JParameter classes won't work and you will need to convert your jparameter fields into JForm fields. Create a new directory and copy your "old elements" into them. Then you need to load these new fields with the individual parameter

<source lang="php"><field name="sample" type="sampleField" size="5" default="" label="sampleField" description="sampleField" addfieldpath="/administrator/components/com_yourname/fields"/></source>

Use eclipse to search and replace files in your newly created fields directory.
replace "JElement" with "JFormField"<br>
replace "var $_name =" with "public $type ="<br>
replace "function fetchElement($name, $value, &$node, $control_name)" with "protected function getInput()"<br>

Then you still need to replace the references to $control_name and others in your new JForm field, but at least the bulk of the work has been done automatically

== renamed core component names and login form parameters ==
A login module for Joomla 1.5 will not work without modifications on Joomla 1.6. Here is a part of the logout module that will work on both Joomla 1.5 and Joomla 1.6. You can compare the two to see the difference in input names.

<source lang="php">
$version = new JVersion;
$joomla = $version->getShortVersion();
if(substr($joomla,0,3) == '1.6'){
//joomla 1.6 format
$output .= '<input type="hidden" name="task" value="user.logout" />';
$output .= '<input type="hidden" name="option" value="com_users" />';
} else {
//joomla 1.5 format
$output .= '<input type="hidden" name="task" value="logout" />';
$output .= '<input type="hidden" name="option" value="com_user" />';
}
</source>

here is the code for the login module

<source lang="php">
$version = new JVersion;
$joomla = $version->getShortVersion();
if(substr($joomla,0,3) == '1.6'){
//joomla 1.6 format
$output .= '<input type="hidden" name="task" value="user.login" />';
$output .= '<input type="hidden" name="option" value="com_users" />';
$output .= '<input id="modlgn_passwd" type="password" name="password" class="inputbox" size="18" alt="password" /> ';
} else {
//joomla 1.5 format
$output .= '<input type="hidden" name="task" value="login" />';
$output .= '<input type="hidden" name="option" value="com_user" />';
$output .= '<input id="modlgn_passwd" type="password" name="passwd" class="inputbox" size="18" alt="password" /> ';
}
</source>

These changes might also apply to front-end forms of other Joomla core components (more information needed)

== ACL changes ==
Joomla 1.6 now has an advanced ACL system. It is unknown how this affects people that have previously used the ACL API in their extension. Please add some information here if you know more.

== Plugin files now in different locations ==
Joomla 1.6 now creates a different hierarchy structure for plugins. Files are no longer placed where they used to be, so if your other parts of your application (comp, mods, etc.) expects them to be in a certain position, it won't work. The change has been that now plugins are in an additional subdirectory. If you only load your plugins via the 1.5 API you should be fine.
* Joomla 1.5 example location
<source lang="php">JPATH_SITE . DS . 'plugins' . DS . 'authentication' . DS . 'example'. DS . 'example.php';</source>
* Joomla 1.6 example location
<source lang="php">JPATH_SITE . DS . 'plugins' . DS . 'authentication' . DS . 'example.php';</source>

== Changes to view parameters ==
J!1.6 has a strict new way of specifying parameters for views. J!1.5 allowed a bit of freedom where the parameters could be defined at the view.html.php level but now ithas to be at the tmpl level. AE believes the view paramters were removed.

== Installation process - preflight, postflight, etc ==
These are new events that can screw up an existing installlation process. -1 on me for not documenting the process while stepping through xdebug.
They should be totally optional access points to the installation process. But if your 1.5 install process is tricky for some reason, then these can be used to do clean up activities.

== Admin template changes ==
Admin functions that depended on certain functions, naming conventions etc no longer work. Khepri has been removed. Other admin functions/libraries may have changed.

== ACL ==
gid and aid have been removed. Significant changes to ACL archtecture. Bricking refers to totally locking your self and everyone else out - Last chance backdoor involves adding a emergency pw to the config file.

==sys.ini language translation file==
This file has 3 purposes:

1. It is used for installation process translations, when a folder language is included in the pack.

pack/language/en-gb/en-gb.extension.ini

pack/language/en-gb/en-gb.extension.sys.ini

2. It is used to replace the former .menu.ini

3. It is used to display the translated extension name in many managers.

== removed include folders ==
Most of the 3rd party libraries (Archive, domit, js, PEAR, etc) in the include folder have been removed in J!1.6.

== Use paths defined in defines.php. ==
(Note they are different for the site and the administration)

[[Category:Joomla! 1.6]]
[[Category:Tutorials]]
[[Category:Development]]
[[Category:Module Development]]
[[Category:Component Development]]
[[Category:Plugin Development]]

Security

2010-12-28T17:26:08Z

Batch1211:

== Recommended Reading ==
* [[Security and Performance FAQs]]

# [[Security Checklist 1 - Getting Started]]
# [[Security Checklist 2 - Hosting and Server Setup]]
# [[Security Checklist 3 - Testing and Development]]
# [[Security Checklist 4 - Joomla Setup]]
# [[Security Checklist 5 - Site Administration]]
# [[Security Checklist 6 - Site Recovery]]
# [[Security Checklist 7 | Security Checklist 7 - You have been Hacked]]

== More Information ==
<small>List of articles that belong to the category "Security"</small>
<DPL>
noresultsheader=\n
category=Security
</DPL>

== REMEMBER ==

#'''There's no one right way!''' Due to the variety and complexity of modern web servers, security issues can't be resolved with simple, one-size-fits-all solutions. You, or someone you trust, must learn enough about your web server infrastructure to make valid security decisions.
#'''There's no substitute for experience!''' To secure your web site, you must gain real experience , or get experienced help from others.
#'''It's not as hard as it looks:''' The following checklist may seem intimidating, but you don't have to deal with all of it at once. As you become more familiar with GNU/Linux, Apache, MySQL, PHP, HTTP, and Joomla, you'll add refinements to your combination of security tactics. Security is a moving target, so today's expert might be tomorrow's victim. Good luck!...

Please read [[Joomla%21 Administrators Security Checklist]] for more information.

See all documents in the [[:category:Security|Security Category]].

CodeExample:4ca07516bb7f7

2010-10-24T08:30:19Z

Batch1211:

<div class='example'>
<div class='example-title'><h4>JPagination on Frontpage</h4></div>
<div class='commentBlock'>

Mariska wrote:

if you want to '''Jpagination work on front page''' change Jpagination.php

on this code function _buildDataObject
bicause this method use to generate link on front end
// add "&limit=".$this->limit to $data->[]->link
function _buildDataObject() {
// Initialize variables
$data = new stdClass();
$data->all = new JPaginationObject(JText::_('View All'));
if (!$this->_viewall) {
$data->all->base = '0';

$data->all->link = JRoute::_("&limit=".$this->limit."&limitstart="); // <== this

}
// Set the start and previous data objects
$data->start = new JPaginationObject(JText::_('Start'));
$data->previous = new JPaginationObject(JText::_('Prev'));
if ($this->get('pages.current') > 1) {
$page = ($this->get('pages.current') - 2) * $this->limit;
$page = $page == 0 ? '' : $page; //set the empty for removal from route
$data->start->base = '0';

$data->start->link = JRoute::_("&limit=".$this->limit."&limitstart="); //<== this

$data->previous->base = $page;

$data->previous->link = JRoute::_("&limit=".$this->limit."&limitstart=" . $page); //<== this

}
// Set the next and end data objects
$data->next = new JPaginationObject(JText::_('Next'));
$data->end = new JPaginationObject(JText::_('End'));
if ($this->get('pages.current') < $this->get('pages.total')) {
$next = $this->get('pages.current') * $this->limit;
$end = ($this->get('pages.total') - 1) * $this->limit;
$data->next->base = $next;

$data->next->link = JRoute::_("&limit=".$this->limit."&limitstart=" . $next); // <== this

$data->end->base = $end;

$data->end->link = JRoute::_("&limit=".$this->limit."&limitstart=" . $end); // <== this

}
$data->pages = array();
$stop = $this->get('pages.stop');
for ($i = $this->get('pages.start'); $i <= $stop; $i++) {
$offset = ($i - 1) * $this->limit
$offset = $offset == 0 ? '' : $offset; //set the empty for removal from route
$data->pages[$i] = new JPaginationObject($i);
if ($i != $this->get('pages.current') || $this->_viewall) {
$data->pages[$i]->base = $offset;

$data->pages[$i]->link = JRoute::_("&limit=".$this->limit."&limitstart=" . $offset); //<== this

}
}
return $data;
}

<div class='comment-signature'>[[User:Batch1211|Batch1211]] 05:42, 27 September 2010 (CDT) [[CodeExample:4ca07516bb7f7 |Edit comment]]</div></div></div>

[[Category:JPagination]] [[Category:CodeExample]] [[Category:ClassExample]]

CodeExample:4ca07516bb7f7

2010-10-24T08:29:54Z

Batch1211:

<div class='example'>
<div class='example-title'><h4>JPagination on Frontpage</h4></div>
<div class='commentBlock'>

Mariska wrote:

if you want to '''Jpagination work on front page''' change Jpagination.php

on this code function _buildDataObject
bicause this method use to generate link on front end
// add "&limit=".$this->limit to $data->[]->link
function _buildDataObject() {
// Initialize variables
$data = new stdClass();
$data->all = new JPaginationObject(JText::_('View All'));
if (!$this->_viewall) {
$data->all->base = '0';

$data->all->link = JRoute::_("&limit=".$this->limit."&limitstart="); // <== this

}
// Set the start and previous data objects
$data->start = new JPaginationObject(JText::_('Start'));
$data->previous = new JPaginationObject(JText::_('Prev'));
if ($this->get('pages.current') > 1) {
$page = ($this->get('pages.current') - 2) * $this->limit;
$page = $page == 0 ? '' : $page; //set the empty for removal from route
$data->start->base = '0';

$data->start->link = JRoute::_("&limit=".$this->limit."&limitstart="); //<== this

$data->previous->base = $page;

$data->previous->link = JRoute::_("&limit=".$this->limit."&limitstart=" . $page); //<== this

}
// Set the next and end data objects
$data->next = new JPaginationObject(JText::_('Next'));
$data->end = new JPaginationObject(JText::_('End'));
if ($this->get('pages.current') < $this->get('pages.total')) {
$next = $this->get('pages.current') * $this->limit;
$end = ($this->get('pages.total') - 1) * $this->limit;
$data->next->base = $next;

$data->next->link = JRoute::_("&limit=".$this->limit."&limitstart=" . $next); // <== this

$data->end->base = $end;

$data->end->link = JRoute::_("&limit=".$this->limit."&limitstart=" . $end); // <== this

}
$data->pages = array();
$stop = $this->get('pages.stop');
for ($i = $this->get('pages.start'); $i <= $stop; $i++) {
$offset = ($i - 1) * $this->limit
$offset = $offset == 0 ? '' : $offset; //set the empty for removal from route
$data->pages[$i] = new JPaginationObject($i);
if ($i != $this->get('pages.current') || $this->_viewall) {
$data->pages[$i]->base = $offset;

$data->pages[$i]->link = JRoute::_("&limit=".$this->limit."&limitstart=" . $offset); //<== this

}
}
return $data;
}

<div class='comment-signature'>[[User:Batch1211|Batch1211]] 05:42, 27 September 2010 (CDT) [[CodeExample:4ca07516bb7f7 |Edit comment]]</div></div></div>

<nowiki>[[Category:JPagination]] [[Category:CodeExample]] [[Category:ClassExample]]</nowiki>

API16:JPagination

2010-10-24T08:29:11Z

Batch1211:

===Examples===
<CodeExamplesForm />
<dpl>
category=JPagination
category=CodeExample
category=ClassExample
</dpl>

API16:JPagination

2010-10-24T08:27:57Z

Batch1211: Replacing page with ' ===Examples=== <CodeExamplesForm /> <dpl> noresultsheader=\n category=JPagination category=CodeExample category=ClassExample include=* format= ,,, </dpl>'

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JPagination
category=CodeExample
category=ClassExample
include=*
format= ,,,
</dpl>

API16:JPagination

2010-10-24T08:25:46Z

Batch1211: Reverted edits by Batch1211 (Talk) to last version by Doxiki

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

===Defined in===
libraries/joomla/html/pagination.php
===Methods===
{| class="wikitable sortable"
|-
!Method name
!Description
|-
|[[API16:JPagination/__construct|__construct]]
|Constructor.
|-
|[[API16:JPagination/setAdditionalUrlParam|setAdditionalUrlParam]]
|Method to set an additional URL parameter to be added to all pagination class generated links.
|-
|[[API16:JPagination/getAdditionalUrlParam|getAdditionalUrlParam]]
|Method to get an additional URL parameter to be added to all pagination class generated links if it exists.
|-
|[[API16:JPagination/getRowOffset|getRowOffset]]
|Return the rationalised offset for a row with a given index.
|-
|[[API16:JPagination/getData|getData]]
|Return the pagination data object, only creating it if it doesn't already exist.
|-
|[[API16:JPagination/getPagesCounter|getPagesCounter]]
|Create and return the pagination pages counter string, ie. Page 2 of 4.
|-
|[[API16:JPagination/getResultsCounter|getResultsCounter]]
|Create and return the pagination result set counter string, ie. Results 1-10 of 42
|-
|[[API16:JPagination/getPagesLinks|getPagesLinks]]
|Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x.
|-
|[[API16:JPagination/getListFooter|getListFooter]]
|Return the pagination footer.
|-
|[[API16:JPagination/getLimitBox|getLimitBox]]
|Creates a dropdown box for selecting how many records to show per page.
|-
|[[API16:JPagination/orderUpIcon|orderUpIcon]]
|Return the icon to move an item UP.
|-
|[[API16:JPagination/orderDownIcon|orderDownIcon]]
|Return the icon to move an item DOWN.
|}

===Importing===
<source lang="php">jimport( 'joomla.html.pagination' );</source>

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

===Examples===
<CodeExamplesForm />
<dpl>
noresultsheader=\n
category=JPagination
category=CodeExample
category=ClassExample
include=*
format= ,,,
</dpl>

API15:JPagination

2010-10-24T08:23:08Z

Batch1211:

<span class="editsection"

style="font-size:76%;">
<nowiki>[</nowiki>

[[Description:JPagination|Edit

Descripton]]<nowiki>]</nowiki>
</span>
{{Description:JPagination}}

===Defined in===
libraries/joomla/html/pagination.php
===Methods===
{| class="wikitable sortable"
|-
!Method name
!Description
|-
|[[API15:JPagination/__construct|__construct]]
|Constructor
|-
|[[API15:JPagination/getRowOffset|getRowOffset]]
|Return the rationalised offset for a row with a given index.
|-
|[[API15:JPagination/getData|getData]]
|Return the pagination data object, only creating it if it doesn't already exist
|-
|[[API15:JPagination/getPagesCounter|getPagesCounter]]
|Create and return the pagination pages counter string, ie. Page 2 of 4
|-
|[[API15:JPagination/getResultsCounter|getResultsCounter]]
|Create and return the pagination result set counter string, ie. Results 1-10 of 42
|-
|[[API15:JPagination/getPagesLinks|getPagesLinks]]
|Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x
|-
|[[API15:JPagination/getListFooter|getListFooter]]
|Return the pagination footer
|-
|[[API15:JPagination/getLimitBox|getLimitBox]]
|Creates a dropdown box for selecting how many records to show per page
|-
|[[API15:JPagination/orderUpIcon|orderUpIcon]]
|Return the icon to move an item UP
|-
|[[API15:JPagination/orderDownIcon|orderDownIcon]]
|Return the icon to move an item DOWN
|}

===Importing===
<source lang="php">jimport( 'joomla.html.pagination' );</source>

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

===Examples===
<CodeExamplesForm />
´<dpl>
noresultsheader=\n
category=JPagination
category=CodeExample
category=ClassExample
include=*
format= ,,,
</dpl>

API15:JPagination

2010-10-24T08:21:22Z

Batch1211:

<span class="editsection"

style="font-size:76%;">
<nowiki>[</nowiki>

[[Description:JPagination|Edit

Descripton]]<nowiki>]</nowiki>
</span>
{{Description:JPagination}}

===Defined in===
libraries/joomla/html/pagination.php
===Methods===
{| class="wikitable sortable"
|-
!Method name
!Description
|-
|[[API15:JPagination/__construct|__construct]]
|Constructor
|-
|[[API15:JPagination/getRowOffset|getRowOffset]]
|Return the rationalised offset for a row with a given index.
|-
|[[API15:JPagination/getData|getData]]
|Return the pagination data object, only creating it if it doesn't already exist
|-
|[[API15:JPagination/getPagesCounter|getPagesCounter]]
|Create and return the pagination pages counter string, ie. Page 2 of 4
|-
|[[API15:JPagination/getResultsCounter|getResultsCounter]]
|Create and return the pagination result set counter string, ie. Results 1-10 of 42
|-
|[[API15:JPagination/getPagesLinks|getPagesLinks]]
|Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x
|-
|[[API15:JPagination/getListFooter|getListFooter]]
|Return the pagination footer
|-
|[[API15:JPagination/getLimitBox|getLimitBox]]
|Creates a dropdown box for selecting how many records to show per page
|-
|[[API15:JPagination/orderUpIcon|orderUpIcon]]
|Return the icon to move an item UP
|-
|[[API15:JPagination/orderDownIcon|orderDownIcon]]
|Return the icon to move an item DOWN
|}

===Importing===
<source lang="php">jimport( 'joomla.html.pagination' );</source>

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

===Examples===
<CodeExamplesForm />
<dpl>
category=JPagination
category=CodeExample
category=ClassExample
</dpl>

API15:JPagination

2010-10-24T08:20:45Z

Batch1211:

<span class="editsection"

style="font-size:76%;">
<nowiki>[</nowiki>

[[Description:JPagination|Edit

Descripton]]<nowiki>]</nowiki>
</span>
{{Description:JPagination}}

===Defined in===
libraries/joomla/html/pagination.php
===Methods===
{| class="wikitable sortable"
|-
!Method name
!Description
|-
|[[API15:JPagination/__construct|__construct]]
|Constructor
|-
|[[API15:JPagination/getRowOffset|getRowOffset]]
|Return the rationalised offset for a row with a given index.
|-
|[[API15:JPagination/getData|getData]]
|Return the pagination data object, only creating it if it doesn't already exist
|-
|[[API15:JPagination/getPagesCounter|getPagesCounter]]
|Create and return the pagination pages counter string, ie. Page 2 of 4
|-
|[[API15:JPagination/getResultsCounter|getResultsCounter]]
|Create and return the pagination result set counter string, ie. Results 1-10 of 42
|-
|[[API15:JPagination/getPagesLinks|getPagesLinks]]
|Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x
|-
|[[API15:JPagination/getListFooter|getListFooter]]
|Return the pagination footer
|-
|[[API15:JPagination/getLimitBox|getLimitBox]]
|Creates a dropdown box for selecting how many records to show per page
|-
|[[API15:JPagination/orderUpIcon|orderUpIcon]]
|Return the icon to move an item UP
|-
|[[API15:JPagination/orderDownIcon|orderDownIcon]]
|Return the icon to move an item DOWN
|}

===Importing===
<source lang="php">jimport( 'joomla.html.pagination' );</source>

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

===Examples===
<CodeExamplesForm />
<dpl>
category=JPagination
category=CodeExample
category=ClassExample
</dpl>

API15:JPagination

2010-10-24T08:17:38Z

Batch1211:

<span class="editsection"

style="font-size:76%;">
<nowiki>[</nowiki>

[[Description:JPagination|Edit

Descripton]]<nowiki>]</nowiki>
</span>
{{Description:JPagination}}

===Defined in===
libraries/joomla/html/pagination.php
===Methods===
{| class="wikitable sortable"
|-
!Method name
!Description
|-
|[[API15:JPagination/__construct|

__construct]]
|Constructor
|-
|[[API15:JPagination/getRowOffset|

getRowOffset]]
|Return the rationalised offset for

a row with a given index.
|-
|[[API15:JPagination/getData|

getData]]
|Return the pagination data object,

only creating it if it doesn't

already exist
|-
|

[[API15:JPagination/getPagesCounter|

getPagesCounter]]
|Create and return the pagination

pages counter string, ie. Page 2 of

4
|-
|

[[API15:JPagination/getResultsCounte

r|getResultsCounter]]
|Create and return the pagination

result set counter string, ie.

Results 1-10 of 42
|-
|[[API15:JPagination/getPagesLinks|

getPagesLinks]]
|Create and return the pagination

page list string, ie. Previous,

Next, 1 2 3 ... x
|-
|[[API15:JPagination/getListFooter|

getListFooter]]
|Return the pagination footer
|-
|[[API15:JPagination/getLimitBox|

getLimitBox]]
|Creates a dropdown box for

selecting how many records to show

per page
|-
|[[API15:JPagination/orderUpIcon|

orderUpIcon]]
|Return the icon to move an item UP
|-
|[[API15:JPagination/orderDownIcon|

orderDownIcon]]
|Return the icon to move an item

DOWN
|}

===Importing===
<source lang="php">jimport(

'joomla.html.pagination' );</source>

<span class="editsection"

style="font-size:76%;">
<nowiki>[</nowiki>

[[SeeAlso:JPagination|Edit See

Also]]<nowiki>]</nowiki>
</span>
{{SeeAlso:JPagination}}

===Examples===
<CodeExamplesForm />
<dpl>
category=JPagination
category=CodeExample
category=ClassExample
</dpl>

API16:JPagination

2010-10-24T08:17:02Z

Batch1211: Replacing page with ' <dpl> category=JPagination category=CodeExample category=ClassExample </dpl>'

<dpl>
category=JPagination
category=CodeExample
category=ClassExample
</dpl>

API15:JPagination

2010-10-24T08:13:11Z

Batch1211:

<dpl>
category=JPagination
category=CodeExample
category=ClassExample
</dpl>

API15:JPagination

2010-10-24T08:09:11Z

Batch1211: Replacing page with ' <dpl> noresultsheader=\n category=JPagination category=CodeExample category=ClassExample include=* format= ,,, </dpl>'

<dpl>
noresultsheader=\n
category=JPagination
category=CodeExample
category=ClassExample
include=*
format= ,,,
</dpl>

Joomla installation

2010-10-05T11:02:46Z

Batch1211:

==Joomla! 1.5.x==
* [http://help.joomla.org/content/view/1938/310/ Minimum System Requirements for Joomla! 1.5.x].
* [http://help.joomla.org/content/category/48/268/302/ Installation Manual for Joomla! 1.5.x].
* [http://help.joomla.org/content/view/1933/294/ Migration Guide for Joomla! 1.5.x].
==Joomla! 1.0.x==
* [http://help.joomla.org/content/view/34/279/ System Requirements for Joomla! 1.0.x].
* [http://help.joomla.org/content/category/15/99/132/ Installation Manual for Joomla! 1.0.x].
[[Category:Landing Pages]]
[[Category:Tutorials]][[Category:Installation]]

How to implement XML-RPC in a component

2010-10-05T11:02:14Z

Batch1211:

== Overview ==
XML-RPC is a specification and set of implementations which allow software running on different software platforms and written in different languages to make procedural calls over the internet using standard [http://en-wikipedia.org/xml eXtensible Markup Language].

There are two ways to implement XML-RPC in a component:
* Implement it using an XML-RPC plugin or
* Implement it in the component itself using raw views

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

How to distribute languages for native Joomla! 1.5 extensions

2010-10-05T11:00:56Z

Batch1211:

When you create a translation for a 3PD extension, usually it is included in the package, but sometimes it is distributed separately. In the 2nd case, it may be difficult to tell the user where to upload the language file(s), though it is even more simplier now than was in Joomla! 1.0.x.

To avoid this, by the analogy of the Joomla! 1.5 core languages you can create an installable language pack for a native Joomla! 1.5 extension. You will need to compress the .ini files and an install.xml file for them into a supported archive type with the following code like this for the back-end:

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install version="1.5" client="administrator" type="language" method="upgrade">
<tag>xx-XX</tag>
<version>1.0</version>
<creationDate>YYYY-MM-DD</creationDate>
<author>Your Name</author>
<name>YourLanguage</name>
<authorEmail>yourmail@example.com</authorEmail>
<authorUrl>http://www.example.com/</authorUrl>
<copyright>Copyright (C) YYYY Copyright Owner. All rights reserved.</copyright>
<license>LicenseType</license>
<description>[Language name] translation for [extension_name]</description>
<files>
<filename>xx-XX.[extension_name].ini</filename>
</files>
<params />
</install>
</source>

It is recommended to add the method="upgrade" parameter in order to be able to easily install a new version of the language pack. It this parameter is not specified, the installer cannot overwrite the old language file(s) and it results an error.

When an extension has language file(s) for the front-end as well, an additional package should be created. In this case please change the following line of the install.xml file:

<source lang="xml">
<install version="1.5" client="administrator" type="language" method="upgrade">
</source>

to this:

<source lang="xml">
<install version="1.5" client="site" type="language" method="upgrade">
</source>

In Joomla! 1.5.4 was implemented the single installation of both admin and site language packs what makes the language packs management even more easier for the site administrators. You can create such language pack installer using the following template:

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install version="1.5" type="language" client="both" method="upgrade">
<name>YourLanguage</name>
<tag>xx-XX</tag>
<version>1.0</version>
<creationDate>YYYY-MM-DD</creationDate>
<author>Your Name</author>
<authorEmail>youremail@example.com</authorEmail>
<authorUrl>http://www.yoursite.com/</authorUrl>
<copyright>Copyright (C) YYYY Copyright Owner. All rights reserved.</copyright>
<license>License Type</license>
<description>[Language name] translation for [extension_name]</description>
<administration>
<files folder="admin">
<filename>xx-XX.[extension_name].ini</filename>
</files>
</administration>
<site>
<files folder="site">
<filename>xx-XX.[extension_name].ini</filename>
</files>
</site>
<params />
</install>
</source>

For such kind of language pack installers, you should create an "admin" folder and a "site" folder with the appropriate language files included and an install.xml file added up one level.

Due to the critical vulnerability fixed in Joomla! 1.5.6 it was mandatory to update a web site to this version, so the creation of a single installation pack should be preferred.

Such kind of language packs can be created for the native Joomla! 1.5 extensions developed using the MVC pattern only.

Such a language pack can be installed via the Install tab of the Extension Manager screen opened by the Extensions -> Install/Uninstall menu item. The included language file(s) will be uploaded to the appropriate folder.

For a translator, this method allows him/her to specify the authoring details what are rarely added to the header of a language file. This way the end user will know who to contact for occasional proof-reading or just for a thank you.

For a developer, there is no need to add a language installation feature for their extensions that was a feature for some 1.0.x extensions.

[[Category:Tips and tricks]]
[[Category:Tips and tricks 1.5]]
[[Category:FAQ]][[Category:Language Development]]

How to determine your database prefix

2010-10-05T11:00:22Z

Batch1211:

The database prefix can be found in the file configuration.php or in the admin panel under the menu "Site - Configuration File - Global Configuration - Server"

[[Category:Database]]
{{stub}}
[[Category:Stubs]]

How to determine browser capabilities

2010-10-05T10:59:39Z

Batch1211:

Different web browsers sometimes show differences in the way that they render a page. For this reason you may wish to find out which particular browser a visitor is using, in order to use some browser-specific CSS.

The following JavaScript defines a simple browser detection object which determines the browser's name and version by decoding the <code>navigator.userAgent</code> string.

<source lang="javascript">
function browserDetect()
{
var browserNames=new Array("Opera", "MSIE","Netscape","Firefox");
this.name="NK";
this.mainVersion="NK";
this.minorVersion="NK";

for (var i=0; i< browserNames.length; i++)
{
var pattern='('+browserNames[i]+')'+'.([0-9]+)\.([0-9]+)';
var myRegExp=new RegExp(pattern);
if (myRegExp.test(navigator.userAgent))
{
var results=myRegExp.exec(navigator.userAgent);
this.name=results[1];
this.mainVersion=results[2];
this.minorVersion=results[3];
break;
}
}
}
</source>

In order to use this in a script, you then create an instance of this object:

<source lang="javascript">
var browser = new browserDetect();
</source>

The property <code>browser.name</code> will then give you then name of the browser (MSIE, Opera, Netscape or Firefox), <code>browser.mainVersion</code> will give you the main version number and <code>browser.minorVersion</code> will give you the minor version number.

However you should be aware that this is not foolproof, and it is generally better (in this writer's opinion) to avoid writing browser-specific code as far as possible.

[[Category:Tips and tricks]]
[[Category:FAQ]][[Category:Component Development]][[Category:JavaScript]]

How to create an article from the front end

2010-10-05T10:56:50Z

Batch1211:

* Login
* Click on “Submit an Article” in the user menu.
* Title your article in the text field labeled title.
* Add images to your document. You can select previously uploaded pictures, give a direct URL to an image or upload your own image. (optional)
* Add pagebreaks to your article. Pagebreaks make a table of contents for your article. (optional)
* Add a readmore tag to your article. Anything past the readmore tag can only be seen if the article is viewed individually. (optional)
* Type your article in the large text field.
* Return to the top of the page and click on the save button to create the article. Clicking on cancel will take you back to the homepage without saving.

Reference:
http://help.joomla.org/ghop/feb2008/task056/
[[Category:Tutorials]][[Category:Article Management]]

Creating a search plugin

2010-10-05T10:55:52Z

Batch1211:

{{review}}
[[Category:Development]]
[[Category:Plugins]]
==Description==
This document is about how to create a Search Plugin. You can use a Search Plugin to search through the database of your Joomla! site. To create a plugin, you will at least need two files; an XML file and a PHP file. For internationalization it is good to create an INI file as well.

==XML file==
The XML file is named the same as the PHP file, and is one of the two required files.
Always start off with the XML tag and define that it is written in a UTF-8 format.
<source lang="xml"><?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE install PUBLIC
"-//Joomla! 1.5//DTD plugin 1.0//EN" "http://www.joomla.org/xml/dtd/1.5/plugin-install.dtd">
To define that the plugin has to be a search plugin, add this line:
<source lang="xml"><install version="1.5" type="plugin" group="search"></source>
The type will define it is a plugin, the group defines the Plugin is in the group of search plugins.

After that, add some information about yourself and the plugin, like this:
<source lang="xml">
<name>Name of your search plugin</name>
<creationDate>Creation date</creationDate>
<author>Your name</author>
<authorEmail>Your e-mail address</authorEmail>
<authorUrl>Your website</authorUrl>
<copyright>Copyright information</copyright>
<license>License, for example GNU/GPL</license>
<version>Version of the plugin</version>
<description>Description of the plugin; showed during installation and when editing
the plugin in the Plugin Manager</description></source>
And now, include your PHP file to the Search Plugin. The name of this file should be the same as the name of this XML file. Put this name also behind the plugin="" part.

You could also add more files for your plugin, for example an image. Just add another row between <files> and </file>, and then place the file between <filename> tags.
<source lang="xml">
<files>
<filename plugin="nameofplugin">nameofplugin.php</filename>
</files></source>

For the internationalization, we will use language files. This is not required, but people from other countries will love it they can easily translate your plugin to their own language.
The language tags can be found here: [http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes] (use the ISO 639-1 column) and here: [http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements]
<source lang="xml">
<languages>
<language tag="en-GB">language/en-GB/en-GB.plg_search_nameofplugin.ini</language>
</languages></source>
Optionally, you could add some parameters to the plugin. These will look like this:
<source lang="xml">
<params>
<param name="paramname" type="typeofparameter" default="defaultsetting" label="title" description="description"/>
</params></source>
*'''Param name:''' The name of the parameter. You will need this when creating the PHP file.
*'''Param type:''' You could choose between several types of parameters. Look at this document to learn something about the different types: [http://docs.joomla.org/Using_the_core_parameter_types]
*'''Param default:''' The default setting for this parameter.
*'''Param label:''' The name of this parameter displayed in the edit screen of this plugin in the Plugin Manager.
*'''Param description:''' The text which appears as a tool tip for this parameter.

And do not forget to end your XML file with the following tag:
<source lang="xml"></install></source>

==PHP file==
The PHP file of your plugin is probably the most important file of the plugin. This is an example PHP file of a search plugin. The comments are included.

<source lang="PHP"><?php
//First start with information about the Plugin and yourself. For example:
/**
* @version $Id: nameofplugin.php versionnumber date author
* @copyright Copyright
* @license License, for example GNU/GPL
* All other information you would like to add
*/

//To prevent accessing the document directly, enter this code:
// no direct access
defined( '_JEXEC' ) or die( 'Restricted access' );

//Now define the registerEvent and the language file. Replace 'nameofplugin' with the name of your plugin.
$mainframe->registerEvent( 'onSearch', 'plgSearchnameofplugin' );
$mainframe->registerEvent( 'onSearchAreas', 'plgSearchnameofpluginAreas' );

JPlugin::loadLanguage( 'plg_search_nameofplugin' );

//Then define a function to return an array of search areas. Replace 'nameofplugin' with the name of your plugin.
function &plgSearchnameofpluginAreas()
{
static $areas = array(
'nameofplugin' => 'Nameofplugin'
);
return $areas;
}

//Then the real function has to be created. The database connection should be made.
//The function will be closed with an } at the end of the file.
function plgSearchnameofplugin( $text, $phrase='', $ordering='', $areas=null )
{
$db =& JFactory::getDBO();
$user =& JFactory::getUser();

//If the array is not correct, return it:
if (is_array( $areas )) {
if (!array_intersect( $areas, array_keys( plgSearchnameofpluginAreas() ) )) {
return array();
}
}

//It is time to define the parameters! First get the right plugin; 'search' (the group), 'nameofplugin'.
$plugin =& JPluginHelper::getPlugin('search', 'nameofplugin');

//Then load the parameters of the plugin..
$pluginParams = new JParameter( $plugin->params );

//And define the parameters. For example like this..
$limit = $pluginParams->def( 'nameofparameter', defaultsetting );

//Use the function trim to delete spaces in front of or at the back of the searching terms
$text = trim( $text );

//Return Array when nothing was filled in
if ($text == '') {
return array();
}

//After this, you have to add the database part. This will be the most difficult part, because this changes per situation.
//In the coding examples later on you will find some of the examples used by Joomla! 1.5 core Search Plugins.
//It will look something like this.
$wheres = array();
switch ($phrase) {

//search exact
case 'exact':
$text = $db->Quote( '%'.$db->getEscaped( $text, true ).'%', false );
$wheres2 = array();
$wheres2[] = 'LOWER(a.name) LIKE '.$text;
$where = '(' . implode( ') OR (', $wheres2 ) . ')';
break;

//search all or any
case 'all':
case 'any':

//set default
default:
$words = explode( ' ', $text );
$wheres = array();
foreach ($words as $word)
{
$word = $db->Quote( '%'.$db->getEscaped( $word, true ).'%', false );
$wheres2 = array();
$wheres2[] = 'LOWER(a.name) LIKE '.$word;
$wheres[] = implode( ' OR ', $wheres2 );
}
$where = '(' . implode( ($phrase == 'all' ? ') AND (' : ') OR ('), $wheres ) . ')';
break;
}

//ordering of the results
switch ( $ordering ) {

//alphabetic, ascending
case 'alpha':
$order = 'a.name ASC';
break;

//oldest first
case 'oldest':

//popular first
case 'popular':

//newest first
case 'newest':

//default setting: alphabetic, ascending
default:
$order = 'a.name ASC';
}

//replace nameofplugin
$searchNameofplugin = JText::_( 'Nameofplugin' );

//the database query; differs per situation! It will look something like this:
$query = 'SELECT a.name AS title,'
. ' CONCAT_WS( " / ", '. $db->Quote($searchNameofplugin) .', b.title )AS section,'
. ' "1" AS browsernav'
. ' FROM #__nameofplugin AS a'
. ' INNER JOIN #__categories AS b ON b.id = a.catid'
. ' WHERE ( '. $where .' )'
. ' AND a.published = 1'
. ' AND b.access <= '. (int) $user->get( 'aid' )
. ' ORDER BY '. $order
;

//Set query
$db->setQuery( $query, 0, $limit );
$rows = $db->loadObjectList();

//The 'output' of the displayed link
foreach($rows as $key => $row) {
$rows[$key]->href = 'index.php?option=com_newsfeeds&view=newsfeed&catid='.$row->catslug.'&id='.$row->slug;
}

//Return the search results in an array
return $rows;
}</source>

There are 4 variables that get passed in, which are evident by their names and use in the above code.
What's not obvious is what the function should return. An array of objects that the search tool uses to display the results. The results could alternatively have been assembled something like this.
<source lang="PHP">
$rows[] = (object) array(
'href' => 'index.php?option=com_newsfeeds&view=newsfeed&catid='.$row->catslug.'&id='.$row->slug,
'title' => $row['name'],
'section' => $searchnameofplugin,
'created' => $row['date'],
'text' => $row['name'],
'browsernav' => '1'
);
</source>

==INI file(s)==
For internationalization it is good to use the INI files. You can add everything to the language file that outputs text to the user, in this order:
*XML description tag
*XML label and description attributes from parameters
*JText::_( 'string' ) used by the plugin

Start your INI file with something like this:
<source lang="INI"># $Id: en-GB.plg_search_nameofplugin.ini
# Joomla! Project
# Copyright (C) 2005 - 2007 Open Source Matters. All rights reserved.
# License http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL, see LICENSE.php
# Note : All ini files need to be saved as UTF-8 - No BOM</source>
Of course, you could also add other information, like the author.

For example, this parameter:
<source lang="XML"><param name="search_limit" type="text" size="5" default="50" label="Search Limit"
description="Number of Search items to return"/></source>
Will cause the following output in the INI file:
<source lang="INI">
SEARCH LIMIT=Search Limit
NUMBER OF SEARCH ITEMS TO RETURN=Number of Search items to return</source>
The file looks repetitive, but will be very useful for translaters.

When you want to make your search plugin available in more languages, first add them to the <languages> tag in the XML file. Then create the same INI file, and change the part after the =, for example the dutch version would be:
<source lang="INI">
SEARCH LIMIT=Zoek limiet
NUMBER OF SEARCH ITEMS TO RETURN=Aantal weer te geven zoekresultaten</source>

==Coding examples==
There are six Joomla! Core Search Plugins. If you look at them you can learn a lot, especially about the query part.
You can see them 'working' when you go to the back-end of your Joomla! 1.5 installation, then go to the menu 'Extensions' and select the 'Plugin Manager'. Click on the name of the plugin to edit it; and see it working.
*Plugin Search - Categories
**\plugins\search\categories.XML
**\plugins\search\categories.PHP
**\language\en-GB\en-GB.plg_search_categories.INI
*Plugin Search - Contacts
**\plugins\search\contacts.XML
**\plugins\search\contacts.PHP
**\language\en-GB\en-GB.plg_search_contacts.INI
*Plugin Search - Content
**\plugins\search\content.XML
**\plugins\search\content.PHP
**\language\en-GB\en-GB.plg_search_content.INI
*Plugin Search - Newsfeeds
**\plugins\search\newsfeeds.XML
**\plugins\search\newsfeeds.PHP
**\language\en-GB\en-GB.plg_search_newsfeeds.INI
*Plugin Search - Sections
**\plugins\search\sections.XML
**\plugins\search\sections.PHP
**\language\en-GB\en-GB.plg_search_sections.INI
*Plugin Search - Weblinks
**\plugins\search\weblinks.XML
**\plugins\search\weblinks.PHP
**\language\en-GB\en-GB.plg_search_weblinks.INI

==Quick tips==
*In the PHP file, people often forget to place an semicolon (;) at the end of a row. This causes errors. Check this before you test your plugin.
*Make sure the parameters in the XML file are closed correctly. When you add options, for example, you need to close it with </param>.
*It is easy to test on a localhost when you are still busy with editing your plugin.
*When making a zip-file to test it, do not forget to make the directories for the language files. A typical zip will contain the following:
**nameofplugin.XML
**nameofplugin.PHP
**language\en-GB\en-GB.plg_search_nameofplugin.INI
[[Category:Tutorials]][[Category:Plugin Development]]

J1.5:How to create a language pack

2010-10-05T10:54:27Z

Batch1211:

{{review}}

Joomla! uses three language packages, one for the front end, one for the administrator and one for installation. Ideally you will create all three.

A translation pack consists of an xml file, a blank index file and a set of *.ini files containing the language strings for your language. The easiest way to understand this structure is to look at the files in the language/en-GB folder of your Joomla! installation.

This is an excerpt from en-GB.mod_login.ini

<code>

BUTTON_LOGIN=Login
BUTTON_LOGOUT=Logout
DESCLOGINFORM=This Module displays a username and password Login form. It also displays a link to retrieve a forgotten password. If User registration is enabled, (refer to the Global Configuration settings), then another link will be shown to invite Users to self-register.
ENCRYPT LOGIN FORM=Encrypt Login Form
FORGOT_YOUR_PASSWORD=Forgot your password?
FORGOT_YOUR_USERNAME=Forgot your username?
GREETING=Greeting
</code>

To create a package for your language you change the strings to the right of the =.

Many people find it helpful to use the [http://joomlacode.org/gf/project/trans_mngr/frs/ Translation manager extension]. This helps by automating the creation of the files.

Language naming convention in Joomla are
language and ISO code. Use 2 letters when available. [http://www.loc.gov/standards/iso639-2/php/code_list.php The list is available here.]

[http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm This reference concerns country codes]

Because language strings may change it is best to create your packages using either [http://developer.joomla.org/code.html the nightly build or subversion].

Name of package should be: xx-XX //using your language's ISO code.

Locale:
[http://forum.joomla.org/viewtopic.php?t=25077 Information on available locales may be found here.]

If, for any reason, ini or xml language files are edited manually with a text editor, they have to be saved with the encoding UTF8 NO BOM.

For practical information on the way to make core Translation files for Joomla 1.0, please see forum: http://forum.joomla.org/viewtopic.php?f=11&t=254709.

And for Joomla 1.5 see the forum:
[http://forum.joomla.org/viewtopic.php?f=11&t=88326&start=0 Building Extension's Language Pack for J1.5]

Guidelines for developers to facilitate translation: [[Language Guidelines for 3rd Party Extensions]]

<noinclude>
[[Category:Languages]][[Category:Tutorials]][[Category:Language Development]]
</noinclude>

How to create a continuous integration

2010-10-05T10:53:57Z

Batch1211:

You want to know how to develop a continuous integration?
This tutorial aims to guide you to achieve a functional result.
If you need advice feel free to contact me: [mailto:rudy.bruneau@hop-cube.com Rudy BRUNEAU].

==Introduction==

[http://en.wikipedia.org/wiki/Continuous_integration Continuous integration] is a way to check the daily functioning of an application.

==Tools and Environment==

* [http://en.wikipedia.org/wiki/PHP Php] 5.2.11
* [http://en.wikipedia.org/wiki/Doctrine_%28PHP%29 Doctrine] 1.2.2
* [http://en.wikipedia.org/wiki/CruiseControl Cruise Control] and PhpUnderControl an extension for Cruise Control
* [http://en.wikipedia.org/wiki/LAMP_%28software_bundle%29 LAMP]
* [[Joomla]] 1.5.x
* [http://en.wikipedia.org/wiki/Selenium_%28software%29 Selenium] Server 1.0.2 and Selenium Remote Control 1.3
* Server : [http://en.wikipedia.org/wiki/Linux Linux] [http://en.wikipedia.org/wiki/Ubuntu_%28operating_system%29 Ubuntu]
* PhpUnit
* Extension for Php : phpZip
* [http://phing.info/trac/ Phing] : a Php equivalent to 'make'

==Purpose of this operation==
===Continuous integration===
Formalization by Martin Fowler and Kent Beck, 2000
« [http://en.wikipedia.org/wiki/Continuous_integration Continuous Integration] is a software development practice where members of a team integrate their work frequently, usually each person integrates at least daily - leading to multiple integrations per day. »

« Each integration is verified by an automated build (including test) to detect integration errors as quickly as possible. »

Indeed the continuous integration process will help to automate any changes made but also run unit tests. This process must be executed as frequently as possible in order to detect problems to solve them faster.

===Unit Tests===
The purpose of unit testing is to automate regression testing. When developing software, you can easily make modifications without realizing that they introduce bugs in some cases. This is called regression bugs, in that it introduces new bugs as a result of a functional outcome. Since it is not humanly possible to systematically test all possible use cases, these bugs can be found deployed in production, with all the problems that entails.

===Web Tests===
The tests are part of the web unit tests, but they do not check the non-regression of the code. They will check any changes directly on the web pages during the execution of continuous integration.
Using [http://en.wikipedia.org/wiki/Selenium_%28software%29 Selenium] IDE ([[Mozilla Firefox]] add-on) we can create and launch our web tests.

==HOW ?==
Before start, read this documentation. Using this material that I could build my continuous integration.<br />
[http://phing.info/docs/guide/stable/ Phing docs]

Now start the xml file :
* define property (variable) to simplify notation after

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<project name="hopscore_website" default="joomla" basedir="../">
<property name="report.dir" value="${basedir}/source/ic"/>
<property name="utils" value="${basedir}/source/utils"/>
<property name="Jinstall" value="${report.dir}/JoomlaInstall"/>
<property name="Jtest" value="${report.dir}/JoomlaTest"/>
<property name="sql_file" value="${Jinstall}/dump.sql"/>
<taskdef resource="net/sf/antcontrib/antcontrib.properties"/>
</source>
* Define all targets which will be executed during continuous integration
<source lang="xml">
<target name="joomla" depends="uninstall,update, zip, install, data, extension, build" />
<target name="extension" depends="unzip, all" />

<target name="build" depends="clear,clean,phpunit,stopseleniumrc" />
</source>

All Targets will run in the order defined by the target parent.
The first task is : Joomla defined in Project.
Then all targets in 'depends' attributs will be executed.

===Step 1: Install a blank Joomla 1.5.x===
Copy the files inside the archive Joomla except the Setup folder that is deleted from the end of an manual installation.

* Create a folder with your Blank [[Joomla]].
* Copy all directories and files into a new folder except Installation directory.
'''xml file :'''
<source lang="xml">
<target name="uninstall">
<delete dir="${Jtest}"/>
<exec executable="php">
<arg line="${Jinstall}/drop_db.php"/>
</exec>
</target>

<target name="install">
<mkdir dir="${Jtest}"/>
<copy todir="${Jtest}">
<fileset dir="${Jinstall}">
<exclude name="dump.sql"/>
<exclude name="install_extensions.php"/>
<exclude name="install_extensions.xml"/>
<exclude name="create_db.php"/>
<exclude name="autoloadeditadd.php"/>
<exclude name="autoloadeditremove.php"/>
<exclude name="zip_com_products.php"/>
<exclude name="unzip.php"/>
<exclude name="drop_db.php"/>
<exclude name="add_sql.php"/>
</fileset>
</copy>
</source>

===Step 2: Automatically install the database Joomla tables===
To install the database I chose to run php scripts for several things:
* Creation of the database with [[mysql]] language
* Adding Joomla tables and data
<br />
'''Xml File:'''
<source lang="xml">
<target name="install">

<exec command="php ${Jinstall}/create_db.php" />
<exec command="php ${Jinstall}/add_sql.php" />
</target>
</source>

'''Php Files:'''<br />
* Create database
<source lang="php">
$link = mysql_connect("localhost","name","password");
$mydb="db_name";
mysql_query("CREATE DATABASE IF NOT EXISTS $mydb",$link) or die (mysql_error());
mysql_close();
</source>

* Import data
<source lang="php">
$file = file_get_contents(dirname(__FILE__)."/dump.sql");

if($file === false){
die('Fichier erroné : '.$url);
}

$requetes = explode(';', $file);

$link = mysql_connect("localhost","name","password");
$mydb="db_name";
mysql_select_db($mydb) or die (mysql_error());
foreach($requetes as $requete){
mysql_query($requete.';', $link) or die(mysql_error());
}
mysql_close();
</source>

===Step 3: Automatically install components / modules / plugins in blank Joomla===
Reproduce a component installation as in Joomla administration.
* Get the last versionned file from [http://en.wikipedia.org/wiki/Apache_Subversion SVN]
'''Xml File:'''
<source lang="xml">
<target name="zip">
<exec executable="php" dir="${Jinstall}">
<arg line="zip_com_products.php
${basedir}/source/products/components/com_products
${JoomlaInstall}/Joomla/utils/components/" />
</exec>
</target>
</source>

''' Php File:'''<br />
* zip_com_products.php contains two methods which Zip a not empty folder.
<source lang="php">
/*
go trough the path of the file to zip
*/
Recurs_zip($src,&$zip,$path_lenght)
/*
add all files and directories in an archive
*/
compress($src,$dir)
</source>

* Provide a file .zip input
'''Xml File:''' <br />
<source lang="xml">
<target name="unzip">
<echo taskname="Unzip" message="Unzip all components/modules/plugins" />
<exec command="php ${Jinstall}/unzip.php"/>
<echo taskname="Unzip" message="End of Unzip Task" />
</target>
</source>

'''Php File:''' <br />
<source lang="php">
if (!defined('DS')) {
define('DS', DIRECTORY_SEPARATOR);
}
$path = dirname(__FILE__).DS.'Joomla'.DS.'utils';

function ScanDirectory($Directory) {

$MyDirectory = opendir($Directory) or die('Erreur');
while($Entry = @readdir($MyDirectory)) {
if (is_dir($Directory.DS.$Entry) && $Entry != '.' && $Entry != '..') {
ScanDirectory($Directory.'/'.$Entry);
} else {
$zip = new ZipArchive;
if ($zip->open($Directory.DS.$Entry) === TRUE) {
$name = str_replace(".zip", "", $Entry);
$zip->extractTo($Directory.DS);
$zip->close();
}
}

}
closedir($MyDirectory);
}

ScanDirectory($path);
</source>
* Run the installation file component / modules / plugins
'''Xml File:''' <br />
<source lang="xml">
<target name="all">
<echo taskname="Install extensions" message="Start of Install all Joomla extensions" />
<exec command="php ${Jinstall}/install_extensions.php" dir="${Jinstall}"/>
<echo taskname="Install extensions" message="End of Install Extensions" />
</target>
</source>

'''Php File:'''
<source lang="php">
under construction...
</source>

===Step 4: How to run Unit Tests===
To write and run UnitTest it is easier to look at this documentation.<br />
[http://www.phpunit.de/ PhpUnit docs]

Go to the "build" Target in xml file :
<source lang="xml">
<target name="build" depends="clear,clean,phpunit,stopseleniumrc" />
</source>
* clear : Delete all report files.
<source lang="xml">

<target name="clear">
<delete file="${report.dir}/phpunit.xml"/>
<delete file="${report.dir}/phpunit2-noframes.html"/>
</target>
</source>
* clean : Clean old project build artifacts.
<source lang="xml">

<target name="clean">

<delete>
<fileset dir="${basedir}/build/logs" includes="**.*" />
</delete>

<delete>
<fileset dir="${basedir}/build/doc" includes="**.*" />
</delete>

<delete>
<fileset dir="${basedir}/build/coverage" includes="**.*" />
</delete>
</target>
</source>
* phpunit : start UnitTests, webTests, and make all report
<source lang="xml">
<target name="phpunit">
<antcall target="startseleniumrc"></antcall>
<exec executable="phpunit" dir="${basedir}/source" failonerror="on" resultproperty="test-failed">
<arg line="--log-xml ${basedir}/build/logs/phpunit.xml
--log-pmd ${basedir}/build/logs/phpunit.pmd.xml
--log-metrics ${basedir}/build/logs/phpunit.metrics.xml
--coverage-xml ${basedir}/build/logs/phpunit.coverage.xml
--coverage-html ${basedir}/build/coverage
hopscorecomAllTests AllTests.php" />
</exec>
<antcall target="stopseleniumrc"></antcall>
</target>
</source>
* stopseleniumrc : kill processus selenium
<source lang="xml">
<target name="stopseleniumrc">
<get taskname="selenium-shutdown"
src="http://localhost:4444/selenium-server/driver/?cmd=shutDown"
dest="result.txt" ignoreerrors="true" />
<echo taskname="selenium-shutdown" message="DGF Errors during shutdown are expected" />
</target>
</source>
===Step 5: How to run Web Tests===
Web tests will be run using a php file called during Unit Tests.

===Step 6: Make a report===
The report is a xml file which be created after all tests to show errors, failures, and success.
With [http://en.wikipedia.org/wiki/CruiseControl Cruise Control] and PhpUnderControl you will see all details of your continuous integration.

=== Php files to execute testSuite ===
'''AllTest.php'''<br />
called UnitTests file & WebTests file
<source lang="php">

if (defined('PHPUnit_MAIN_METHOD') === false) {
define('PHPUnit_MAIN_METHOD', 'hopscorecomAllTests::main');
}

require_once 'PHPUnit/Framework/TestSuite.php';
require_once 'PHPUnit/TextUI/TestRunner.php';

require_once dirname(__FILE__) . '/AllWebTests.php';
require_once dirname(__FILE__) . '/ProductsAllTests.php';
/**
* Main test suite for phpUnderControl.
*/
class hopscorecomAllTests
{
/**
* Test suite main method.
*
* @return void
*/
public static function main()
{
PHPUnit_TextUI_TestRunner::run(self::suite());
}

/**
* Creates the phpunit test suite for this package.
*
* @return PHPUnit_Framework_TestSuite
*/
public static function suite()
{
$suite = new PHPUnit_Framework_TestSuite('HopScore.com - AllTests ');
// Unit Test
$suite->addTestSuite('hopscorecomProductsAllTests');
// WebTest : include WebTest to display all in report
$suite->addTestSuite('hopscorecomAllWebTests');
return $suite;
}
}

if (PHPUnit_MAIN_METHOD === 'hopscorecomAllTests::main') {
phpucAllTests::main();
}
</source>

'''ProductsAllTest.php'''<br />
<source lang="php">

....

require_once dirname(__FILE__) . '/UnitTests/bashtest.php';
require_once dirname(__FILE__) . '/UnitTests/fusiontest.php';
require_once dirname(__FILE__) . '/UnitTests/transformtest.php';

/**
* Main test suite for HopScore API package.
*/
class hopscorecomProductsAllTests
{
/* same main() */

/**
* Creates the phpunit test suite for this package.
* @return PHPUnit_Framework_TestSuite
*/
public static function suite()
{
$suite = new PHPUnit_Framework_TestSuite('HopScore.com - ProductsAllTests');
$suite->addTestSuite('BashTest');
$suite->addTestSuite('FusionTest');
$suite->addTestSuite('TransformTest');
return $suite;
}
}

if (PHPUnit_MAIN_METHOD === 'hopscorecomProductsAllTests::main') {
hopscoreProductsAllTests::main();
}
</source>

'''AllWebTests.php''' <br />
<source lang="php">
....
/* require .php file from Selenium */
require_once dirname(__FILE__) . '/WebTests/*****.php';

/**
* Main test suite for HopScore.Com Web Tests
*/
class hopscorecomAllWebTests
{
/* Same Main() */
/**
* Creates the phpunit test suite for this package.
* @return PHPUnit_Framework_TestSuite
*/
public static function suite()
{
$suite = new PHPUnit_Framework_TestSuite('HopScorecom - AllWebTests');
// Name of class of php webTest file
$suite->addTestSuite('name_of_class');
return $suite;
}
}

if (PHPUnit_MAIN_METHOD === 'hopscorecomAllWebTests::main') {
hopscoreAPIAllTests::main();
}
</source>

==See Also==
[http://www.geek-directeur-technique.com/post/2009/03/18/Tests-unitaires-et-integration-continue Continuous Integration]

[[Category:Development]]
[[Category:Working Groups]]

J1.5:Creating a content plugin

2010-10-05T10:51:37Z

Batch1211:

[[Category:Development]]
[[Category:Plugins]]
==Description==
There are lots of abilities of the use of a Content Plugin. They all have to do with the display of your content and so your articles. You will need at least two files for this Plugin. An XML file and a PHP file. Because there are so many differences between two Content Plugins in the PHP file, two examples of them will be explained in this document. Also a part about internationalization (with INI files) is added. And last but not least: the Joomla! Core Content Plugin coding examples and the quick tips.

==XML file==
The XML file is named the same as the PHP file, and is one of the two required files.
Always start off with the XML tag and define that it is written in a UTF-8 format.
<source lang="xml"><?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE install
PUBLIC "-//Joomla! 1.5//DTD plugin 1.0//EN" "http://www.joomla.org/xml/dtd/1.5/plugin-install.dtd">
To define that the plugin has to be a content plugin, add this line:
<source lang="xml"><install version="1.5" type="plugin" group="content"></source>
The type will define it is a Plugin, the group defines the Plugin is in the group of Content Plugins.

After that, add some information about yourself and the Plugin, like this:
<source lang="xml">
<name>Name of your Content Plugin</name>
<creationDate>Created Date</creationDate>
<author>Your name</author>
<authorEmail>Your e-mail address</authorEmail>
<authorUrl>Your website</authorUrl>
<copyright>Copyright</copyright>
<license>License, for example GNU/GPL</license>
<version>Version of the plugin</version>
<description>Description of the Plugin; showed with installation and when editing
the Plugin in the Plugin Manager</description></source>
And now include your PHP file to the Content Plugin. The name of this file should be the same as the name of this XML file. Put this name also behind the plugin="" part.

You could also add more files for your plugin, for example an image. Just add another row between <files> and </files>, and then place the file between <filename> tags.
<source lang="xml">
<files>
<filename plugin="nameofplugin">nameofplugin.php</filename>
</files></source>

For the internationalization, we will use language files. This is not required, but people from other countries will love it if they can easily translate your plugin to their own language. Plugin language files are always installed in administrator/languages/xx-XX/ where xx-XX is the code for a language already installed in Joomla.
The language tags can be found here: [http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes] (use the ISO 639-1 column) and here: [http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements]
<source lang="xml">
<languages>
<language tag="en-GB">en-GB.plg_content_nameofplugin.ini</language>
</languages></source>
Optionally, you could add some parameters to the Plugin. These will look like this:
<source lang="xml">
<params>
<param name="paramname" type="typeofparameter" default="defaultsetting" label="title" description="description"/>
</params></source>
*'''Param name:''' The name of the parameter. You will need this when creating the PHP file.
*'''Param type:''' You could choose between several types of parameters. Look at this document to learn something about the different types: [http://docs.joomla.org/Using_the_core_parameter_types]
*'''Param default:''' The default setting for this parameter.
*'''Param label:''' The name of this parameter displayed in the edit screen of this Plugin in the Plugin Manager.
*'''Param description:''' The text which appears as a tool tip for this parameter.
When you do not want to use parameters, add the following tag:
<source lang="xml"><params/></source>

And do not forget to end your XML file with the following tag:
<source lang="xml"></install></source>

==PHP file==
Start your PHP file with the general licensing and author information about your content plugin.

<source lang="PHP"><?php
/**
* @version $Id: nameofplugin.php revision date lasteditedby $
* @package Joomla
* @subpackage Content
* @copyright Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.
* @license GNU/GPL, see LICENSE.php
* Joomla! is free software. This version may have been modified pursuant
* to the GNU General Public License, and as distributed it includes or
* is derivative of works licensed under the GNU General Public License or
* other free or open source software licenses.
* See COPYRIGHT.php for copyright notices and details.
*/ </source>

Next, always put the following code in any PHP file:
<source lang="PHP">
// no direct access
defined( '_JEXEC' ) or die( 'Restricted access' );</source>
This prevents people from directly accessing this PHP file.

After that, you should import the general plugin file of Joomla!'s library
<source lang="PHP">jimport( 'joomla.plugin.plugin' );</source>

To indicate that you're writing a Content plugin, add the following code.
<source lang="PHP">class plgContentNameofplugin extends JPlugin {</source>
Please note the use of capital letters. You should replace Nameofplugin by the name of your own plugin.

Now, it's time to construct the plugin:
<source lang="PHP">/**
* Constructor
*
* For php4 compatability we must not use the __constructor as a constructor for plugins
* because func_get_args ( void ) returns a copy of all passed arguments NOT references.
* This causes problems with cross-referencing necessary for the observer design pattern.
*
* @param object $subject The object to observe
* @param object $params The object that holds the plugin parameters
* @since 1.5
*/
function plgContentNameofplugin( &$subject, $params )
{
parent::__construct( $subject, $params );
}</source>

You should choose now at which moment the plugin should be rendered. You can choose from the following:

* onBeforeContentSave : This is an event that is called right before the content is saved into the database.
* onAfterContentSave : This is an event that is called after the content is saved into the database.
* onPrepareContent : This is the first stage in preparing content for output and is the most common point for content orientated plugins to do their work.
* onAfterDisplayTitle : This is a request for information that should be placed between the content title and the content body.
* onBeforeDisplayContent : This is a request for information that should be placed immediately before the generated content.
* onAfterDisplayContent : This is a request for information that should be placed immediately after the generated content.

More information on which type you should use for your plugin, including several examples, can be found here: [[Reference:Content_Events_for_Plugin_System]]

===onBeforeContentSave===
Use the following code:
<source lang="PHP"> function onBeforeContentSave( &$article, $isNew )
{
global $mainframe;
//add your plugin codes here
return true;
}</source>
The parameters article and isNew should contain the following:
* article : A reference to the JTableContent object that is being saved which holds the article data.
* isNew : A boolean which is set to true if the content is about to be created.

===onAfterContentSave===
Use the following code:
<source lang="PHP"> function onAfterContentSave( &$article, $isNew )
{
global $mainframe;
//add your plugin codes here
return true;
}</source>
The parameters article and isNew should contain the following:
* article : A reference to the JTableContent object that was saved which holds the article data.
* isNew : A boolean which is set to true if the content was created.

===onPrepareContent===
Use the following code:
<source lang="PHP"> function onPrepareContent( &$article, &$params, $limitstart )
{
global $mainframe;
//add your plugin codes here
//no return value
}</source>
The parameters article, params and limitstart should contain the following:
* article : A reference to the article that is being rendered by the view.
* params : A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.
* limitstart : An integer that determines the "page" of the content that is to be generated. Note that in the context of views that might not generate HTML output, a page is a reasonably abstract concept that depends on the context.

===onAfterDisplayTitle===
Use the following code:
<source lang="PHP"> function onAfterDisplayTitle( &$article, &$params, $limitstart )
{
global $mainframe;
//add your plugin codes here
return '';
//return a string value. Returned value from this event will be displayed in a placeholder.
// Most templates display this placeholder after the article separator.
}</source>
The parameters article, params and limitstart should contain the following:
* article : A reference to the article that is being rendered by the view.
* params : A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.
* limitstart : An integer that determines the "page" of the content that is to be generated. Note that in the context of views that might not generate HTML output, a page is a reasonably abstract concept that depends on the context.

===onBeforeDisplayContent===
Use the following code:
<source lang="PHP"> function onBeforeDisplayContent( &$article, &$params, $limitstart )
{
global $mainframe;
//add your plugin codes here
return '';
//return a string value. Returned value from this event will be displayed in a placeholder.
// Most templates display this placeholder after the article separator.
}</source>

The parameters article, params and limitstart should contain the following:
* article : A reference to the article that is being rendered by the view.
* params : A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.
* limitstart : An integer that determines the "page" of the content that is to be generated. Note that in the context of views that might not generate HTML output, a page is a reasonably abstract concept that depends on the context.

===onAfterDisplayContent===
Use the following code:
<source lang="PHP"> function onAfterDisplayContent( &$article, &$params, $limitstart )
{
global $mainframe;
//add your plugin codes here
return '';
//return a string value. Returned value from this event will be displayed in a placeholder.
// Most templates display this placeholder after the article separator.
}</source>

The parameters article, params and limitstart should contain the following:
* article : A reference to the article that is being rendered by the view.
* params : A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.
* limitstart : An integer that determines the "page" of the content that is to be generated. Note that in the context of views that might not generate HTML output, a page is a reasonably abstract concept that depends on the context.

==PHP file - Example==
This example PHP file is about the Content Plugin load module. It is a plugin made for displaying modules within the articles.
The commented PHP file used in this example is the file which will be included in Joomla! 1.6. This has been done because the content plugin files in Joomla! 1.5 are not refactored yet to the new standards.
<source lang="PHP">
<?php
// The general information at the top of each file
/**
* @version $Id$
* @package Joomla
* @copyright Copyright (C) 2005 - 2009 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License, see LICENSE.php
*/

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

// Import Joomla! Plugin library file
jimport('joomla.plugin.plugin');

//The Content plugin Loadmodule
class plgContentLoadmodule extends JPlugin
{
/**
* Plugin that loads module positions within content
*/
// onPrepareContent, meaning the plugin is rendered at the first stage in preparing content for output
public function onPrepareContent( &$row, &$params, $page=0 )
{
// A database connection is created
$db = JFactory::getDBO();
// simple performance check to determine whether bot should process further
if ( JString::strpos( $row->text, 'loadposition' ) === false ) {
return true;
}

// expression to search for
$regex = '/{loadposition\s*.*?}/i';

// check whether plugin has been unpublished
if ( !$this->params->get( 'enabled', 1 ) ) {
$row->text = preg_replace( $regex, '', $row->text );
return true;
}

// find all instances of plugin and put in $matches
preg_match_all( $regex, $row->text, $matches );

// Number of plugins
$count = count( $matches[0] );

// plugin only processes if there are any instances of the plugin in the text
if ( $count ) {
// Get plugin parameters
$style = $this->params->def( 'style', -2 );
$this->_process( $row, $matches, $count, $regex, $style );
}
// No return value
}
// The proccessing function
protected function _process( &$row, &$matches, $count, $regex, $style )
{
for ( $i=0; $i < $count; $i++ )
{
$load = str_replace( 'loadposition', '', $matches[0][$i] );
$load = str_replace( '{', '', $load );
$load = str_replace( '}', '', $load );
$load = trim( $load );

$modules = $this->_load( $load, $style );
$row->text = preg_replace( '{'. $matches[0][$i] .'}', $modules, $row->text );
}

// removes tags without matching module positions
$row->text = preg_replace( $regex, '', $row->text );
}
// The function who takes care for the 'completing' of the plugins' actions : loading the module(s)
protected function _load( $position, $style=-2 )
{
$document = &JFactory::getDocument();
$renderer = $document->loadRenderer('module');
$params = array('style'=>$style);

$contents = '';
foreach (JModuleHelper::getModules($position) as $mod) {
$contents .= $renderer->render($mod, $params);
}
return $contents;
}
}
</source>

==INI file(s)==
For internationalization it is good to use the INI files. You can add to the language file everyting which outputs text to the user, in this order:
*XML description tag
*XML label and description attributes from parameters
*JText::_( 'string' ) used by the plugin
Start your INI file with something like this:
<source lang="INI"># $Id: en-GB.plg_content_nameofplugin.ini
# Joomla! Project
# Copyright (C) 2005 - 2007 Open Source Matters. All rights reserved.
# License http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL, see LICENSE.php
# Note : All ini files need to be saved as UTF-8 - No BOM</source>
Of course, you could also add other information, like the author.

For example, this parameter:
<source lang="XML">
<param name="mode" type="list" default="1" label="Mode" description="Select how the emails will be displayed">
<option value="0">Nonlinkable Text</option>
<option value="1">As linkable mailto address</option>
</param></source>
Will cause the following in the INI file:
<source lang="INI">
MODE=Mode
SELECT HOW THE EMAILS WILL BE DISPLAYED=Select how the e-mails will be displayed
NONLINKABLE TEXT=Nonlinkable text
AS LINKABLE MAILTO ADDRESS=As linkable mailto address
</source>
The file looks repetitive, but will be very useful for translaters.

When you want to make your Content Plugin available in more languages, first add them to the <languages> tag in the XML file. Then create the same INI file, and change the part after the =, for example the dutch version would be:
<source lang="INI">
MODE=Modus
SELECT HOW THE EMAILS WILL BE DISPLAYED=Selecteer hoe de e-mails worden weergegeven
NONLINKABLE TEXT=Niet-linkbare tekst
AS LINKABLE MAILTO ADDRESS=Als een linkbaar mailto adres
</source>

==Coding examples==
There are seven Joomla! Core Content Plugins. These are all not yet refactored to the new standards. For learning how to write good plugins, its better to look at the (refactored) files of Joomla! 1.6.
You can see them 'working' when you go to the Back-end of your Joomla! 1.5 installation, then go to the menu 'Extensions' and select the 'Plugin Manager'. Click on the name of the Plugin to edit it; and see it working. Also watch the content and see what happens when you insert a pagebreak for example.

==Quick tips==
*In the PHP file you often forget to place an semicolon (;) at the end of a row, which causes errors. Check this before you test your Plugin and you will eliminate many errors.
*Take care of the fact that the parameters in the XML file are closed correctly. When you add options for example, you need to close it with </param>.
*It is easy to test on a localhost when you are still busy with editing your Plugin.
*A typical zip will contain the following:
**nameofplugin.XML
**nameofplugin.PHP
**en-GB.plg_content_nameofplugin.ini
[[Category:Articles that require a review]]
[[Category:Tutorials]][[Category:Plugin Development]]

Connecting to an external database

2010-10-05T10:50:25Z

Batch1211:

If you need to access tables within the same database as your Joomla! installation then you can simply use the [[JFactory/getDBO|JFactory->getDBO]] method. This uses the already established connection that Joomla! uses to connect to the database. For example:

<source lang="php">
<?php
$db = JFactory::getDBO();
?>
</source>

$db is now an object of type [[JDatabase]] and you can perform database operations on it using the usual methods.

But what if you want to connect to a completely different database from the one used by Joomla!?. This might be a different database on the same machine as your Joomla! site or it might be on a different host and perhaps even require a different database driver. Well, you can do this using the [[JDatabase/getInstance|JDatabase->getInstance]] method.

<source lang="php">
<?php
$option = array(); //prevent problems

$option['driver'] = 'mysql'; // Database driver name
$option['host'] = 'db.myhost.com'; // Database host name
$option['user'] = 'fredbloggs'; // User for database authentication
$option['password'] = 's9(39s£h[%dkFd'; // Password for database authentication
$option['database'] = 'bigdatabase'; // Database name
$option['prefix'] = 'abc_'; // Database prefix (may be empty)

$db = & JDatabase::getInstance( $option );
?>
</source>

$db is now an object of type [[JDatabase]] and you can perform database operations on it using the usual methods.

Note that if the database uses a non-standard port number then this can be specified by adding it to the end of the host name. For example, you might have your MySQL database running on port 3307 (the default is port 3306), in which case your host name might be 'db.myhost.com:3307'.

One feature of using [[JDatabase/getInstance|JDatabase->getInstance]] is that if another call is made with the same parameters it will return the previously created object rather than creating a fresh one.

Note, however, that the parameters must match exactly for this to happen. For example, if two calls were made to a MySQL database using [[JDatabase/getInstance|JDatabase->getInstance]], with the first using a host name of 'db.myhost.com' and the second using 'db.myhost.com:3306', then two separate connections would be made, even though port 3306 is the default port for MySQL and so the parameters are logically the same.
<noinclude>[[Category:Development]] [[Category:Database]]</noinclude>
[[Category:FAQ]][[Category:Module Development]]
[[Category:Plugin Development]]
[[Category:Component Development]]

How to check if mod rewrite is enabled on your server

2010-10-05T10:49:46Z

Batch1211:

Many problems with SEO arise from the fact that a host has not enabled mod_rewrite (Apache setting) on the servers. They often tell they have (while they don't have) and you can verify if this is correct or not and if this is causing you Error 500 etc.

Here is how to check if mod-rewrite is realy enabled!

'''1. Enable SEO in your administrator:'''

In Joomla 1.0: Site -> Global Configuration -> SEO: Search Engine Friendly URLs to Yes.

In Joomla 1.5: Site -> Global Configuration -> Site: Search Engine Friendly URLs to Yes, Use Apache mod_rewrite to Yes. (Setting Add suffix to URLs is optional).

'''2. Rename your htaccess.txt to .htaccess:'''

Next place ONLY the following lines in your .htaccess:

<source lang="apache">
Options +FollowSymLinks
Redirect /joomla.html http://www.joomla.org
</source>

'''3. Now point your browser to:''' http://www.example.com/joomla.html

(Replace www.example.com with your own domain name in the URL above.)

If it redirects you to joomla.org - mod_rewrite is working.
If it gives you an error - mod_rewrite is not working.

Note: if your site is located in subdomain example "test" you need to insert in .htaccess as:

<source lang="apache">
Options +FollowSymLinks
Redirect /test/joomla.html http://www.joomla.org
</source>

[[Category:Tips and tricks]]
[[Category:Tips and tricks 1.0]]
[[Category:Tips and tricks 1.5]]
[[Category:FAQ]][[Category:Installation]]

Converting an existing website to a Joomla! website

2010-10-05T10:49:00Z

Batch1211:

Many first-time Joomla! users already have a website, often written using HTML with CSS style sheets. In this case, you may wish to keep the existing website structure and just convert it to Joomla!. This section provides instructions for doing this.

= Converting Basic Static Content =

Static content is content that doesn't change frequently. In simple HTML-based websites, each menu choice simply displays a page of content.

== Page Content Conversion ==
The basic steps for converting this type of content are as follows:
# Using the Article Manager, add one article for each page of static content. Each article will contain the contents of one of your existing static pages. Give your articles descriptive names so you can find them again. Select No for Front Page, as shown below.[[Image:Screenshot_article_new.png|frame|center]]
# If you have a relatively small number of pages (e.g., 20 or fewer), you can leave the Section and Category set to "Uncategorized". If you have a large number of static pages, you should create one or more Sections, each containing one or more Categories, and then assign each Article to a Section and Category. This will make it easier to work on articles from one group. For example, when viewing your articles, you can filter or sort articles using Sections and Categories, which is convenient when you have a large number of articles.
# For each article, you can often just copy and paste the content from your existing site (using your browser) into the edit area of Joomla!. Note: In some cases, depending on the amount of custom HTML in the source page, you may need to copy the page to a plain text editor first (such as Notepad) and then copy from there into Joomla!. By content this means the actual page as shown in the browser window not the View Source code.
# At this point, you have the articles created in Joomla!. Now we need to attach them to menus.
# Determine the menu structure you need. If your existing site just has a single main menu, you will just use the Joomla! "mainmenu" module. If your existing site has a two-level menu structure, you will use "mainmenu" for the top level and then add one new menu for each existing submenu. Add the submenus using the Menu Manager / New option.
# Using the Menu Manager, press the Menu Items icon and New to add one Menu Item for each article created above.
# Each Menu Item should have the type "Article Layout", as shown below.[[Image:Screenshot_menu_article_layout.png|frame|center]]
# Note: Even if you installed Joomla! with no sample data, you will already have a Main Menu with a Home menu item that has a Front Page type. Depending on whether you want a Front Page, you may either keep this and add new menu items or change this menu item to an Article Layout.
# Enter the Title for the Menu Item. The title can be the same as the article title, so you know which article goes with which menu item.
# In the Parameters - Basic section, select the article for this menu item.
# Add a Menu Item for each article you created earlier. If needed, add one or more submenus and then add Menu Items for these in the same manner.
# At this point, each article should be associated with one menu choice. Now we need to tell Joomla! on which pages and which location on the page to put each menu.
# First, go to the Extensions / Modules selection. Even if you started with no sample data, you will already have a Main Menu module. Open this for editing to display the Module:[Edit] form, shown below. [[Image:Screenshot_mod_mainmenu.png|frame|center]]
# The Position tells Joomla! where on each page to display the menu module. This may vary depending on the template you are using. Typical menu locations include "top",. "left", and "user3". A trick in Joomla! for seeing the available positions is to add the letters "?tp=1" to the end of a Joomla! URL. For example, if you are working on a localhost site called "joomla15", typing in the URL "//localhost/joomla15/?tp=1" will display a screen showing the positions for your current template, similar to the one below.[[Image:Screenshot_joomla_positions.png|frame|center]]
# The Menu Assignment area is where you tell Joomla! which menu choices will display the current menu. Typically, your main menu will display in all menu selections. If you have submenus, each submenu would typically display in the one main menu item that calls this submenu and in all of this submenu's items. An example is shown below, where the People Menu displays on the "people" selection of the main menu and on all of the selections of the People Menu. [[Image:Screenshot_submenu_selection.png|frame|center]]
# Next, select the Menu Name for this module from the pull-down list. This will be the name of the Menu in the Menu Manager.
# Next, select the Menu Style. The available styles will vary depending on the template you use. The default template has four available styles. Some menu styles display the menu items in a vertical list (e.g., suitable for the left position), others in a horizontal list. (e.g., suitable for the top or "user3" position).
# If you like, press the Preview link in the upper right corner to display the home page so far. The article you chose for the first item on your main menu should display, along with the main menu, something like the example below. [[Image:Screenshot_home_page_example.png|frame|center]]
# If you have submenus, repeat this process for each submenu, checking as you go by previewing the website.
# Congratulations! At this point, your static content should be available. Now, you can think about adding new modules, adding a front page, or taking advantage of other Joomla! functionality.

=== Graphics Conversion ===
Converting existing graphics from a static website can be very easy or somewhat difficult, depending on several factors. These include:
* how closely your existing layout is to one of the available Joomla! templates.
* how exactly you want the Joomla! site to resemble the existing site.

If you have some knowledge of HTML and CSS, you can adjust a lot in the template by looking at the template.css file in the templates directory for the template you are using. You set the template in Joomla! from the Extensions / Template Manager option. Two templates are included with Joomla! 1.5 and many others are available, either for free or for a charge. See [[Absolute Beginners Guide to Joomla!#Learn the Basics for Joomla! Templating |Learn the Basics for Joomla! Templating ]] below for more information on modifying templates.

Return to the [[beginners | Absolute Beginner's Guide to Joomla!]]
[[Category:FAQ]][[Category:Installation]]

How does FastCGI affect Joomla?

2010-10-05T10:44:22Z

Batch1211:

When PHP runs from FastCGI, your server runs the PHP interpreter like an Apache module, but with the rights of your user account. Usually, the PHP interpreter is either running as the user of the webserver (which is fast, but insecure, since everyone's scripts run with the same rights), or as a CGI program, which is slow. Thus, FastCGI is a good solution for shared hosting.

Since the PHP interpreter runs as a single instance, it does (AFAIK) not parse the .htaccess or php.ini files per directory. To change php.ini settings, your host must offer you a method to set up or modify your own php.ini, or at least parts of it. Here is how one of host does this: it parses one php.ini file (which the user can modify) once an hour, and puts some well-defined settings into the web server's main php.ini file. Thus, users are able to change some settings for their site only, such as turning register_globals off, switching between PHP4 and PHP5.

If your server uses FastCGI, you can ask them to enable a method such as the above example, or you may be able to ask them adjust some settings for you.

[[Category:FAQ]]
[[Category:Administration FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:Installation]]

How do you upgrade a site to Joomla! 1.5?

2010-10-05T10:44:00Z

Batch1211:

You can [[Migration|migrate]] a Joomla! 1.0.x site or a Mambo 4.5.x to Joomla! 1.5.

Joomla 1.5 does not provide an upgrade path from earlier versions. Converting an older site to a Joomla 1.5 site requires creation of a new empty site using Joomla 1.5 and then populating the new site with the content from the old site. This migration of content is not a one-to-one process and involves conversions and modifications to the content dump.

There are two ways to perform the migration:

* An automated method of [[Migration|migration]] has been provided which uses a migrator component to create the migration dump out of the old site (Mambo 4.5.x up to Joomla 1.0.x) and a smart import facility in the Joomla 1.5 Installation that performs required conversions and modifications during the installation process.
* Migration can be performed manually. This involves exporting the required tables, manually performing required conversions and modifications and then importing the content to the new site after it is installed.

====Automated migration====

This is a two phased process using two tools. The first tool is a [[Migration|migrator component]] named 'com_migrator'. This component has been contributed by Harald Baer and is based on his 'eBackup' component. The migrator needs to be installed on the old site and when activated it prepares the required export dump of the old site's data. The second tool is built into the Joomla 1.5 installation process. The exported content dump is loaded to the new site and all conversions and modification are performed 'on-the-fly'.

[[Category:FAQ]]
[[Category:Upgrading and Migrating FAQ]]
[[Category:Version 1.0 FAQ]]
[[Category:Upgrade Instructions]]

How do you tune for speed with PHP5 and MySQL5?

2010-10-05T10:41:29Z

Batch1211:

This is just a point by point summary of how I've been tuning and tweaking our Joomla sites to get them running as quickly as possible. For reference, we run all our sites off a Rackspace dedicated server, with 1Gb RAM, a 2Ghz dual core Athlon, running Apache 2.0.x (current revision), PHP 5.0.x (current revision) and MySQL 5.0.18.

These are listed in terms of apparent speed increase - that is, not the sheer speed for the full page, but the speed before the page is usable to view content, even if not all features are loaded.

# PHP caching. I had been running eAccelerator, but switched to APC today, and it has made the system even faster than before, and eAccelerator was a big boost over uncached PHP. Joomla is a big complex system, so using precompiled code is a big time saver. I use a 128Mb in-memory cache, which is plenty for our needs.
# MySQL Query Caching. This one will vary depending on how dynamic your site is, and you can really kill the benefits by using the wrong extensions (any date/time based will need checking), but if you are serving pretty much the same queries each page load, it will drop the load times noticably.
# Template Image optimisation - template images really slow down the initial page load for first time visitors, so optimising the hell out of them makes sense. Remember that your template is probably not going to change as often as your story content, so you can afford to spend more time on optimising the images for it that you would otherwise. I recommend Irfanview, with the pngout plugin active for PNG images, and it isn't bad for JPG and GIF images either. Don't forget to ramp up the compression level of PNGs, and, if possible, reducing them to indexed pallettes.
# CSS compression. Easy one this - put a little script to output a gzipped version of your CSS file(s) and point your index.php at it. Example script below - I didn't write it, but it's short, to the point, and works.
<source lang="php">
ob_start ("ob_gzhandler");
header("Content-type: text/css");
header("Cache-Control: must-revalidate");
$offset = 60 * 60 ;
$ExpStr = "Expires: " .
gmdate("D, d M Y H:i:s",
time() + $offset) . " GMT";
header($ExpStr);
</source>
# Strip unneeded modules, components, mambots from Joomla. If you haven't used them, the impact on your loading time is minimal, but with more components/modules active, there are more points of failure, and Apache errors are slow!
# Scrutinise the Apache error log. It is amazing how many errors can crop up even with a fairly minimal Joomla install, and they don't necessarily affect the appearance of the page. Check your error log, especially if you are using custom components/modules, or any non-standard config settings. Once you've noticed any problems, it's time to fix the code creating them, and test thoroughly before uploading the fixed versions.
# Keep rechecking as you add/remove features, redesign or change any server configuration options. Even things like adding virtual servers in Apache can affect speed of the server, as a missed config setting can cause general Apache delays.

[[Category:FAQ]]
[[Category:Administration FAQ]]
[[Category:Installation FAQ]]
[[Category:Upgrading and Migrating FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:Installation]]

How do you setup a powerful password scheme?

2010-10-05T10:40:19Z

Batch1211:

'''Overview'''

: Most users may not need more than 3 levels of passwords and webmasters no more than 5. Each level must be completely unrelated to the others in terms of which ids and passwords are used.

'''Directions'''

* '''Level 5 (Public)''' - is the password you use on public sites. It is not imperative that you use a different password on every site. In fact it's more effective to use a different username on every site than it is to use a different password truth be told! Knowing the username allows easy hacking...half the work is done! knowing the password is useless unless you know what account it goes to!

* '''Level 4 (Webmaster)''' - Reserved for SQL Only. this is a password that would only be used by SQL and limited to a specific database in SQL. The best way to protect SQL is by limiting each account to just being able to do the minimum that DB requires. In some cases it is even wise to have a read only account for display and a separate write account that the backend write functions use. But that doesn't apply to J! at all... for J! the best practice is to set up an individual account (not root for sure) that only has read and write access to the J! DB nothing else.

* '''Level 3 (Webmaster)''' - FTP and Server Access. these can be the same user:pass combo since both if compromised can do the most damage. doesn't matter if the backend or Cpanel is safe if the FTP is not and the same goes the other way!

* '''Level 2 (Personal Data Access)''' - This password should be used for any sites or locations that contain personal data with the exception of Banking (see level 1). these sites are often used for social engineering data such as medical records, service accounts and any financial records not directly related to banking! You want these to be secure but also different from the real threat of security...your money!

* '''Level 1 (Banking!)''' - this needs to be the most secure in fact if you have two different banks it actually pays to have a different user:pass for each just to be sure!

[[Category:FAQ]]
[[Category:Administration FAQ]]
[[Category:Installation FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:Security]]

How do you set parameters for articles and other content items?

2010-10-05T10:39:50Z

Batch1211:

In Joomla! 1.5, many Article parameters, such as Show Title, Show Author, and so on, can be set in three places:
#the individual article (the Article:[Edit] screen)
#the menu item (Menu Item:[Edit] screen)
#global parameters (Article Manager / Parameters)

Typically, parameters at the individual article and menu item levels can be set to a specific value or to a value of "Use Global". If the individual article's parameter is set, then that value controls the setting. If this is set to "Use Global" then the menu item parameter is checked. If the menu item is set to a specific value, that value is used. If the menu item is set to "Use Global", then the global parameter setting is used.

A similar hierarchy is used for other content items, such as Banners, Contacts, News Feeds, and Web Links.
<noinclude>[[Category:FAQ]][[Category:Administration FAQ]][[Category:Getting Started FAQ]][[Category:Version 1.5 FAQ]][[Category:Parameters]]</noinclude>
[[Category:Article Management]]

How do you set global preferences for content?

2010-10-05T10:39:20Z

Batch1211:

Global preferences in content are set in the article manager.

In the backend, go to Content>Article manager.

On the tool bar, second from the right, there is the preferences icon.

Click that and set your global preferences.

[[Category:FAQ]]
[[Category:Administration FAQ]]
[[Category:Getting Started FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:Article Management]]

How do you restrict directory access by IP address using htaccess?

2010-10-05T10:38:55Z

Batch1211:

'''Overview'''

This can be a very effective way to protect your Joomla! administrator directory. Any other directory in public_html can be protected in the same way. This method only works if you have a static IP address assigned to you. Anyone attempting to browse such directories using a different IP Address will get a 403 Forbidden error.

'''Directions'''
# In the directory you wish to protect, open (or create) a file called, .htaccess. (Note the dot at the beginning of the file name.)
# Add the following code to this file, replacing 100.100.100.100 in this example with the static IP address you plan to allow:

Order Deny,Allow
Deny from all
Allow from 100.100.100.100

* Optional: You can enter partial IP Addresses, such as, 100.100.100. This allows access to a range of addresses.

* Optional: You can add multiple addresses by separating them with comma's.

100.100.100.101, 100.100.100.102

[[Category:FAQ]]
[[Category:Administration FAQ]]
[[Category:Getting Started FAQ]]
[[Category:Installation FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:Security]]

How do you request a feature?

2010-10-05T10:38:28Z

Batch1211:

You can request a feature here:

http://forum.joomla.org/index.php/board,38.0.html

or here:

http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=20

You will need to register at joomlacode.org to submit a feature request.

[[Category:FAQ]]
[[Category:Getting Started FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:Joomla! CMS Project FAQ]]
[[Category:Working Groups]]
[[Category:Contributors]]

How do you redirect users after a successful login?

2010-10-05T10:37:20Z

Batch1211:

Select the redirection page from the list of menu links offered. Make sure that the link is to a published item.

Note: The same procedure is used for redirecting users on successful logout except you enter the page where you want to redirect successful logouts to where it says "Logout Redirection URL."

If you would like to override the default login specified in your Administration back end from your custom code you can do so with the following:
* Take the url that you would like to redirect the user to after they have successfully logged in and apply the 'base64_encode' function to it. For example,
<source lang="php">
$redirectUrl = '''base64_encode'''($redirectUrl);
// a base64_encode of index.php?option=com_pizzapie' yeilds: 'aW5kZXgucGhwP29wdGlvbj1jb21fcGl6emFwaWU=' </source>
* Prepend the '&return=' query string to your newly encoded $redirectUrl. For example,
<source lang="php"> $redirectUrl = ''''&return=''''.$redirectUrl; </source>
* Append that $redirecturl to the Joomla Login Url. For example,
<source lang="php">
$joomlaLoginUrl = 'index.php?option=com_user&view=login';
$finalUrl = $joomlaLoginUrl . $redirecturl; </source>

When you display that $finalUrl, it should look something like this:
'index.php?option=com_user&view=login'''&return=aW5kZXgucGhwP29wdGlvbj1jb21fcGl6emFwaWU=''''

The '''controller.php''' file in the '''com_user''' checks the contents of the 'return' in the JRequest object (the Joomla query access object). If it is set and in the base64 format, it base64_decode(s) it and applies that redirection.

[[Category:FAQ]]
[[Category:Administration FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:User Management]]

How do you recover or reset your admin password?

2010-10-05T10:36:55Z

Batch1211:

Normally, you can add, edit and delete users and passwords from the back-end User Manager. To do this, you must be logged in as a member of the Super Administrator group.

In some situations, this may not be possible. For example, your site may have been "hacked" and had the passwords or users changed. Or perhaps the person who knew the passwords is no longer available. Or maybe you have forgotten the password that was used.

In these cases, it is still possible to fix up the Joomla! database so you can log back in as a Super Administrator. There are three possible methods discussed below.

===Use the Lost Password Feature===
If you have access to the email address that was used for the admin user, and you have made the "lost password" feature available on the front end, the simplest thing is to do is to use the "lost password" Front-end function. The site will send an e-mail to the user's e-mail address and allow you to change the password.

If this method will not work, you have two other options, both of which require working with the MySQL database directly.

===Change the Password in the Database===
If the admin user is still defined, the simplest option is to change the password in the database to a known value. This requires that you have access to the MySQL database using phpMyAdmin.

# Navigate to phpMyAdmin and select the database for the Joomla! site in the left-hand drop-down list box. This will show the database tables on the left side of the screen.
# Click on the table "jos_users" in the list of tables.
# Click on the "Browse" button in the top toolbar. This will show all of the users that are set up for this site.
# Find the user whose password you want to change and press the Edit icon for this row.
# A form will display that allows you to edit the password field. Copy the value <source lang="sql">d2064d358136996bd22421584a7cb33e:trd7TvKHx6dMeoMmBVxYmg0vuXEA4199</source> into the password field and press the ''Go'' button. phpMyAdmin should display the message "Affected rows: 1". At this point, the password should be changed to "secret".
# Log in with this user and password and change the password of this user to a secure value. Check all of the users using the User Manager to make sure they are legitimate. If you have been hacked, you may want to change all of the passwords on the site.

===Add a New Super Administrator User===
If changing the password won't work, or you aren't sure which user is a member of the Super Administrator group, you can use this method to create a new user.

# Navigate to phpMyAdmin and select the database for the Joomla! site in the left-hand drop-down list box. This will show the database tables on the left side of the screen.
# Press the "SQL" button in the toolbar to run a SQL query on the selected database. This will display a field called "Run SQL query/queries on database <your database>".
# Delete any text in this field and paste in the following and press the ''Go'' button.
<source lang="sql">INSERT INTO `jos_users`
(`id`, `name`, `username`, `email`, `password`, `usertype`, `block`, `sendEmail`,
`gid`, `registerDate`, `lastvisitDate`)
VALUES (null, 'Administrator2', 'admin2', 'your-email@yourdomain.com',
'd2064d358136996bd22421584a7cb33e:trd7TvKHx6dMeoMmBVxYmg0vuXEA4199',
'Super Administrator', 0, 1, 25, '0000-00-00 00:00:00', '0000-00-00 00:00:00');
INSERT INTO `jos_core_acl_aro` VALUES (NULL, 'users', LAST_INSERT_ID(), 0, 'Administrator', 0);
INSERT INTO `jos_core_acl_groups_aro_map` VALUES (25, '', LAST_INSERT_ID());
</source>

At this point, you should be able to log into the back end of Joomla! with the username of "admin2" and password of "secret". After logging in, go to the User Manager and change the password to a secure value and the e-mail to a valid e-mail address. If there is a chance you have been "hacked", be sure to check that all users are legitimate, especially any members of the Super Administrator group.

The examples above change the password to "secret". Two other possible values are shown below:
<pre>
- password = "this is the MD5 and salted hashed password"
------------------------------------------------------
- admin = 433903e0a9d6a712e00251e44d29bf87:UJ0b9J5fufL3FKfCc0TLsYJBh2PFULvT
- secret = d2064d358136996bd22421584a7cb33e:trd7TvKHx6dMeoMmBVxYmg0vuXEA4199
- OU812 = 5e3128b27a2c1f8eb53689f511c4ca9e:J584KAEv9d8VKwRGhb8ve7GdKoG7isMm
</pre>

[[Category:FAQ]][[Category:Administration FAQ]][[Category:Getting Started FAQ]][[Category:Version 1.5 FAQ]]
[[Category:User Management]]

How do you password protect directories using htaccess?

2010-10-05T10:36:19Z

Batch1211:

'''Overview'''

This FAQ explains how to protect the Joomla! /administrator/ directory on Apache servers using the htpasswd utility. You can easily adapt these instructions to protect other directories. If you need help finding or creating your .htaccess file, start here.

'''Caveat (From Apache.org)'''

Basic authentication should not be considered secure for any particularly rigorous definition of secure.
Although the password is stored on the server in encrypted format, it is passed from the client to the server in plain text across the network. Anyone listening with any variety of packet sniffer will be able to read the username and password in the clear as it goes across.

Not only that, but remember that the username and password are passed with every request, not just when the user first types them in. So the packet sniffer need not be listening at a particularly strategic time, but just for long enough to see any single request come across the wire.

And, in addition to that, the content itself is also going across the network in the clear, and so if the web site contains sensitive information, the same packet sniffer would have access to that information as it went past, even if the username and password were not used to gain direct access to the web site.

Don't use basic authentication for anything that requires real security. It is a detriment for most users, since very few people will take the trouble, or have the necessary software and/or equipment, to find out passwords. However, if someone had a desire to get in, it would take very little for them to do so.

Basic authentication across an SSL connection, however, will be secure, since everything is going to be encrypted, including the username and password.

'''Directions'''

1. If you are unfamiliar with the Apache htpasswd utility, you may want to read the following link first.
Apache Authentication, Authorization, and Access Control

2. Check to be sure your site is configured to use .htaccess files. If not sure, ask your host.

3. Decide where to put your .htaccess file. Because Apache recursively searches all directories in a path for .htaccess files, the higher in your directory structure you place this file, the more directories it will control. If there is already an .htaccess file in the directory you choose, it's probably best to add the new code to it.

4. Decide where to store your.htpasswd and .htgroups files. These files should NEVER be publicly accessable through the Web. Below is an example directory structure showing good locations for each file. Note that the /auth/ directory in this example is NOT accessible from the Web.

/home/mysite/public_html/.htaccess
/home/mysite/auth/.htpasswd/
/home/mysite/auth/.htgroups/

5. Create the .htpasswd and .htgroups files as explained in the official Apache HowTo, referenced above. (Since you've read the always current and official documentation at Apache.org, we'll spare you the trouble of displaying it again here.)

6. If a .htaccess file already exists in the directory you have chosen, make a backup copy. If the file does not exist, create a new file with that name now. (Don't forget the dot at the beginning of the name.)

7. Add the following code to the .htaccess file. Adjust the example paths (marked in red) as needed for your server. Adjust the group name that you created in step 5 if it differs from the below example.

AuthUserFile /home/auth/.htpasswd
AuthGroupFile /home/auth/.htgroups
AuthType Basic
AuthName "LWS"
require group admins

8. Test carefully.

9. Remove all backup .htaccess files from public_http directories.

10. If you can not use the Apache htpasswd utility, here's a free, online script that creates the necessary files for you. You'll need to know the user name, password, and path. The script does the rest for you. Note that for more advanced configuration, such as the use of groups, you'll need to edit the resulting files.

'''.htaccess Generator:''' http://www.webmaster-toolkit.com/htaccess-generator.shtml

[[Category:FAQ]]
[[Category:Administration FAQ]]
[[Category:Getting Started FAQ]]
[[Category:Installation FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:Security]]

How do you organize the front page with the right columns and layout?

2010-10-05T10:36:00Z

Batch1211:

If you're just getting started, take a look at the [[Absolute Beginners Guide to Joomla!]]. There are a great many conceptual ideas there that you need to understand.

There are five parts to setting up your frontpage.

# Choose a desirable template for your site. Install it, and get it basically working. The template determines the column layout for your site.
# Choose and configure your modules, so your frontpage displays the right menus, etc. Modules are those things like menus, login forms, banner-ad positions, "Breaking News" boxes, etc., that show up on the pages of your site.
#*Use Extensions/Module Manager in your backend menu to do this. Edit each module in turn to place it in the correct spot on your template (for example, right, left, breadcrumb, etc.)
#*You can disable the modules you don't want to see, enable the ones you do, position them within your template, and control their order from the Module Manager. When you're doing this, make sure you have not enabled caching.
#*If caching is enabled, it may look like your changes are not taking effect, which can drive you crazy.
#*Use the Preview button on the backend (upper right), and Shift-Reload on your browser, liberally to make sure you have things right. Change one thing in the backend, then view the frontpage again.
#*Note well: all modules in 1.5 are controlled from Extensions / Module Manager, even the ones that aren't really extensions.
#Make sure your frontpage is configured so that the front page manager can control the order of articles in your front page. You need to [[Setting_Front_Page_Advanced_Parameters|set certain advanced parameters correctly]].
#Use the Content Manager to enable certain articles to be published on the frontpage. Only enable the ones you want on the frontpage.
#Use the Front Page manager to set the order of articles on your frontpage.

[[Category:FAQ]]
[[Category:Administration FAQ]]
[[Category:Getting Started FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:Article Management]]

How do you modify a template?

2010-10-05T10:35:26Z

Batch1211:

Templates are just a series of xml, php, html and image files that are stored in the templates directory of your site.
You can edit these files or you can use the editing interface available in the [[Template Manager]].

In the [[Back-end]], select Site>>[[Extension]]s>>Templates.
Select the template you wish to modify.
Click the edit icon.

'''both'''
You are given the choice of editing "html" and "css."

[[CSS]] stands for cascading style sheets. This controls many elements of the look and feel of your site.
[[HTML]] is the file that controls where positions are defined and positioned. Other than that, it should be noted that, with a few exceptions, what is in the .css and what is in the HTML files largely depends on the approach of the tempate designer.

One common change is to use your own graphic/image. Graphics are linked to in the HTML file. Simply change the reference to the image of your choice. Keep in mind that it if it is a different size than the original image this may change the appearance of the site in unexpected ways.

[[Category:FAQ]]
[[Category:Administration FAQ]]
[[Category:Getting Started FAQ]]
[[Category:Installation FAQ]]
[[Category:Upgrading and Migrating FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:Template Management]]

How do you list your extension in the extensions site?

2010-10-05T10:32:25Z

Batch1211:

Information on how to list extensions in the extensions site is available here:
http://extensions.joomla.org/help2

Before submitting an extension to JED you should read the 4 steps checklist process
* [[JED_Entries_Submission_Checklist|Submission Checklist]]

[[Category:FAQ]]
[[Category:Getting Started FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:JED]]
[[Category:Template Development]]
[[Category:Module Development]]
[[Category:Plugin Development]]
[[Category:Component Development]]
[[Category:Language Development]]

How do you link from inside content to another content item?

2010-10-05T10:32:05Z

Batch1211:

The simple answer is that you get the page URL you want to link to and then make a link using whatever text editor you are using or (if you have no wysiwyg) with html.

The more complicated answer is that some text editors have fancier links managers. A number of these editors are available in the Joomla! Extensions Directory.

See the Tips and Tricks article [[How_to_control_module_display_when_linking_to_an_article_with_no_menu_item]] for more detailed information.

[[Category:FAQ]]
[[Category:Getting Started FAQ]]
[[Category:Administration FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:Article Management]]

How do you install a new template?

2010-10-05T10:31:34Z

Batch1211:

In the [[Back-end]] of the site, go to [[Extension]]s>>[[Installing_an_extension|Install/Uninstall]].

[[Image:Extension_install_1_5.png]]

Browse for the template zip file and click Upload File and Install.

Alternatively, you can install from a directory or URL.

To make the new template the default template for your site, select it and click the default icon (star).

[[Category:FAQ]]
[[Category:Getting Started FAQ]]
[[Category:Installation FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:Template Management]]

Enabling Search Engine Friendly (SEF) URLs on Apache

2010-10-05T10:31:00Z

Batch1211:

This article addresses SEF URLs under the popular, open-source Apache webserver.

SEF URL implementation is possible under Microsoft's IIS webserver as well, please see [[IIS and Joomla]].

==Apache Instructions==
:1. Rename htaccess.txt to .htaccess.
::* If Joomla is installed in its own folder, uncomment "RewriteBase <nowiki>/</nowiki>" and enter the Joomla folder name after the backslash. Example: <nowiki>RewriteBase /joomla</nowiki>
:2. Make sure that Mod_rewrite is working. Check that the line shown below in the file "apache/conf/httpd.conf" is uncommented. If necessary, uncomment the line and re-start the Apache web server.
::<code>LoadModule rewrite_module modules/mod_rewrite.so</code>
:3. In Global configuration, select yes to all three SEF options. The action of the three parameters is as follows:
::* '''Search Engine Friendly URLs.''' Converts the URLs from the native Joomla! format to the SEF format.
::* '''Use Apache mod_rewrite. ''' Uses the Apache "mod_rewrite" function to eliminate the "index.php" portion of the URL. If you don't want to use mod_rewrite, set this to "No" and don't rename the htaccess.txt. The SEF URLs feature will still work. The only difference is that you will see "index.php" in the URL, for example, <code><nowiki>http://www.yoursite.org/index.php/faq.html</nowiki></code>.
::* '''Add suffix to URLs.''' Adds ".html" to the end of URLs.

[[Category:FAQ]]
[[Category:Administration FAQ]]
[[Category:Getting Started FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:Category Management]]

How do you get rid of the breadcrumbs?

2010-10-05T10:30:16Z

Batch1211:

Breadcrumbs are a core module in Joomla! 1.5 and can be enabled or disabled for all pages directly through the Module Manager in the Back-end. Just navigate to the Module Manager, find the Breadcrumbs Module, and disable it.

To prevent the breadcrumb pathway from displaying on the Frontpage only, change the code of the index.php file of your template as follows:
: Replace
<source lang="php"><jdoc:include type="module" name="breadcrumbs" /></source>

: with
<source lang="php">
<?php if( JRequest::getVar( 'view' ) == 'frontpage' ) { ?>
<p> </p>
<?php } else { ?>
<p>You are here: <jdoc:include type="module" name="breadcrumbs" /></p>
<?php } ?>
</source>

[[Category:FAQ]]
[[Category:Administration FAQ]]
[[Category:Getting Started FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:Module Management]]

How do you find exploits using the *NIX shell?

2010-10-05T10:29:08Z

Batch1211:

'''Check the active processes'''

Use the "ps" command to look for odd or unknown processes, if you aren't sure what to look for there, user "netstat -ae | grep irc" and/or "netstat -ea | grep 666" and look for ports 6666, 6667, 6668, 6669, these are common ports used for running IRC bots, they may have the name "irc" listed against them, or may have "httpd" or sometimes other regular services names.

'''Check crontab'''

Check your crontab and see if there is a strange entry, these are used in many exploits to restart IRC bots, even when admins or automated process monitors are used to kill a rogue process.

'''Check for hidden files or directories'''

Check for hidden files or directories you dont expect to see, those starting with "." (dots) and also look for ". " (dot, space) often favored to try and catch searches for hidden directories.

Other examples of searches that may help pin down exploits and/or unexpected files and folders:

find /home -type f | xargs grep -l MultiViews
find . -type f | xargs grep -l base64_encode <<< this can produce false positives, it is valid in many mail/graphics scripts
find . -type f | xargs grep -l error_reporting
find / -name "[Bb]itch[xX]"
find / -name "psy*"
ls -lR | grep rwxrwxrwx > listing.txt

[[Category:FAQ]]
[[Category:Administration FAQ]]
[[Category:Installation FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:Security]]

How do you find a Joomla! extension?

2010-10-05T10:28:26Z

Batch1211:

The official Joomla! extensions site: http://extensions.joomla.org/ is the main source for extensions. If you cannot find what you need there, you should also search the Joomla! Extensions Directory Forum.

If you still cannot find the right component then you should post a request or question in the Extensions Directory forum.
*[http://forum.joomla.org/index.php/board,470.0.html 1.5]:
*[http://forum.joomla.org/index.php/board,465.0.html 1.0]:

[[Category:FAQ]]
[[Category:Administration FAQ]]
[[Category:Getting Started FAQ]]
[[Category:Version 1.5 FAQ]]
[[Category:Version 1.0 FAQ]]
[[Category:Module Management]]
[[Category:Component Management]]
[[Category:Plugin Management]]
[[Category:Language Management]]
[[Category:Template Management]]