Joomla! Documentation - User contributions [en]

Configuring Xdebug for PHP development/Mac

2014-05-01T14:55:56Z

Catanet: Created page with "== Configuring Xdebug with MAMP == === Prerequisites === These instructions are for Mac OS X (actually tested on version 10.9.2 Mavericks) with installed MAMP Application (ac..."

== Configuring Xdebug with MAMP ==

=== Prerequisites ===
These instructions are for Mac OS X (actually tested on version 10.9.2 Mavericks) with installed MAMP Application (actually tested on MAMP version 3.0.4).

=== Configuration instructions ===
*Open finder and navigate to
<tt> /Applications/MAMP/conf/<selected php version>/ </tt>
(NOTE: <selected php version> is the php version that you have selected in the MAMP configuration)
*Open the file '''php.ini''' with a text editor like e.g. TextWrangler
*Find the section [xdebug]
*Uncomment the line
<tt>
[xdebug]
;zend_extension="/Applications/MAMP/bin/php/<selected php version>/lib/php/extensions/no-debug-non-zts-20121212/xdebug.so"
</tt>
by removing the ''';''' character at the beginning of the line
*Add after the line the following text, if not already existing
<tt>
xdebug.remote_enable=on
xdebug.remote_handler=dbgp
xdebug.remote_host=localhost
xdebug.remote_port=9000
</tt>
*Save changes and close the editor
*Restart your MAMP Server
Note: You can set a different port number if you need.

J2.5:Creating Mootools accordion or simple slider/toggler

2014-01-24T11:01:20Z

Catanet: Fix: added closing ' that was missing

{{version/tutor|2.5|platform=11.1|target=from}}
{{review}}
Simple example to create a simple accordion. Can also be used to make a simple slide-toggler (just use 1 link).
In this example all the accordions (slider) are closed by default.

''The php code (e.g. inside template):''<source lang="php">
//Add Slide/toggle behavior
JHTML::_('behavior.framework',true);
$this->document->addScriptDeclaration('
window.addEvent("domready", function( ){
navAcc = new Accordion( $$( ".accordion .accT" ), $$( ".accordion .accE" ), {display: -1, alwaysHide: true} );
}');
</source>
''Your html should look like this:''<source lang="html4strict">
<div class="accordion">
<a class="accT">Link 1</a>
<div class="accE">Container 1</div>
<a class="accT">Link 1</a>
<div class="accE">Container 2</div>
<a class="accT">Link 1</a>
<div class="accE">Container 3</div>
</div>
</source>

[[Category:Development‏‎]] [[Category:mootools]]
[[Category:JavaScript]]

Combo form field type

2013-11-30T11:26:10Z

Catanet:

Provides a combobox field.

* '''name''' (mandatory) is the unique name of the parameter.
* '''type''' (mandatory) must be ''combobox''.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''description''' (optional) (translatable) tooltip for the form field.
* '''class''' (optional) specify your own classes for additonal markup, defaults to "combobox"
* '''readonly''' (optional) set to "true", defaults to false, meaning editable.
* '''disabled''' (optional) set to "true", defaults to false, meaning enabled.
* '''size''' (optional) sets the input size of the field
* '''required''' (optional) sets whether input is required, defaults to no input required.

<source type="php">
<field name="myeditbox" type="combobox" label="MyEditBox" description="myeditbox_Desc" size="7" />
</source>

[[Category:Standard form field types]]

Combo form field type

2013-11-30T11:23:58Z

Catanet:

Provides a combobox field.

* '''name''' (mandatory) is the unique name of the parameter.
* '''type''' (mandatory) must be ''combobox''.
* '''label''' (mandatory) is the descriptive title of the field.
* '''description''' (optional) tooltip for the form field.
* '''class''' (optional) specify your own classes for additonal markup, defaults to "combobox"
* '''readonly''' (optiona) set to "true", defaults to false, meaning editable.
* '''disabled''' (optional) set to "true", defaults to false, meaning enabled.
* '''size''' (optional) sets the input size of the field
* '''required''' (optional) sets whether input is required, defaults to no input required.

<source type="php">
<field name="myeditbox" type="combobox" label="MyEditBox" description="myeditbox_Desc" size="7" />
</source>

[[Category:Standard form field types]]

J3.x:Using the JToolbar class in the frontend

2013-11-08T19:40:51Z

Catanet: /* Using JToolBar with Search Engine Friendly enabled (SEF) */

{{page|needs review}}{{RightTOC}}
== Using JToolBar ==

It's now simpler to use JToolBar in the front end than it was in Joomla! 1.5 as it only requires two steps.
{{clear}}
===Step 1===
Using the MVC architecture, add a function definition to view.html.php file in the view you wish to add the toolbar to.
<source lang="php>
function getToolbar() {
// add required stylesheets from admin template
$document = & JFactory::getDocument();
$document->addStyleSheet('administrator/templates/system/css/system.css');
//now we add the necessary stylesheets from the administrator template
//in this case i make reference to the bluestork default administrator template in joomla 1.6
$document->addCustomTag(
'<link href="administrator/templates/bluestork/css/template.css" rel="stylesheet" type="text/css" />'."\n\n".
''."\n".
''."\n".
'<link rel="stylesheet" href="administrator/templates/bluestork/css/rounded.css" type="text/css" />'."\n"
);
//load the JToolBar library and create a toolbar
jimport('joomla.html.toolbar');
$bar =& new JToolBar( 'toolbar' );
//and make whatever calls you require
$bar->appendButton( 'Standard', 'save', 'Save', 'savetask', false );
$bar->appendButton( 'Separator' );
$bar->appendButton( 'Standard', 'cancel', 'Cancel', 'canceltask', false );
//generate the html and return
return $bar->render();
}
</source>

===Step 2===

Now in the corresponding tmpl file, you simply need to add code like the following (added here to a default.php file in the tmpl folder of the view to which the code above was added to the view.html.php file.
Note I say "like" the following, changes may be required. I'm including the <form> declaration html (the toolbar MUST be in a form with the id of "adminForm" in order for it to work.
<source lang="php">
<form action="index.php" method="post" id="adminForm" name="adminForm">
<?php echo $this->getToolbar(); ?>
<input type = "hidden" name = "task" value = "" />
<input type = "hidden" name = "option" value = "com_yourcom" />
</form>
<div class="clr"></div>
</source>
You'll note the [div class="clr"] which you may or may not need depending on your own design requirements. If you don't add the div tag, slapping this code into an existing component front end will place the buttons to the right and level with the content on the left.
Also, and as explained above, you'll need to add functions within the controller that is called when one of the toolbar buttons is pressed, to process the request gracefully.

== Using JToolBar with Search Engine Friendly enabled (SEF)==

When using the toolbar on the frontend,the standard buttons will sometimes bug out. This is usually because Search Engine Friendly urls is defined.

What happens is that instead of going to index.php?option=com_yourcom&view=&...#, it will go to index.php/friendlyurl# . This bugs out many users.

Using these two together can be done,however. There's two tricks to it. First, make a class called JButtonFrontend and extend JButton. For this, jimport('joomla.html.toolbar') has to be done,because this includes the standard button classes.

Just copy over the content of joomla.html.toolbar.button standard.php; then, change the fetchbutton function
<source lang="php">
//Goes inside JButtonFrontend class definition.
public function fetchButton($type = 'Standard', $name = '', $text = '', $task = '', $list = true)
{
$i18n_text = JText::_($text);
$class = $this->fetchIconClass($name);
$doTask = $this->_getCommand($text, $task, $list);

$html = "<a href=\"javascript: void( $doTask);\" onclick=\"$doTask\" class=\"toolbar\">\n";
$html .= "<span class=\"$class\">\n";
$html .= "</span>\n";
$html .= "$i18n_text\n";
$html .= "</a>\n";

return $html;
}
</source>

Then, in your mainfile (site/yourcom.php), use this:
<source lang="php">
JLoader::register('JButtonFrontend', dirname(__FILE__) . '/buttons/frontend.php');
</source>

As you can see, I made a directory called 'buttons' in my /site directory. If you do so, don't forget to add it to your package xml file! (yourcom.xml).

You can now use the 'Frontend' button:
<source lang="php">
$this->bar->appendButton( 'Frontend', 'name', 'label', 'subcontroller.method', false );
</source>

[[Category:Development]]

Archived:How to add custom filters to components

2013-04-21T01:15:55Z

Catanet:

{{version/tutor|1.7,2.5}}{{RightTOC}}
== Overview ==
This is a how-to on how to add '''ordering''' and '''filtering''' (search, custom dropdown, state) to a component backend page.<br/>
This approach is almost exactly the same for the frontend.<br/>
In general, the process of adding a '''custom field filter''' breaks down into the following steps:
* Creating the class that will generate the form dropdown options
* Adapting the view to display the form dropdown input
* Adapting the model to retrieve data from DB & to set submission values in the Joomla 'state'. For a better understanding of the code samples, the db table is called 'my_company' and the fields are: id, name, state, company, somefield, someotherfieldtosearchin.

== Extend JFormFieldList (models / fields / fieldname.php) ==
Frequently your filter fields will be very basic; probably simply a dropdown list of one of the columns being displayed on the current page. Regardless, you will need to create your own field element. This really isn't a big deal - this file will probably be less than 70 lines, including comments. The code below will generate the dropdown element to filter by companies. For more information and complex examples on creating this class see [[Creating_a_custom_form_field_type]].

My 'companies' dropdown element:
<source lang="php">
<?php

defined('JPATH_BASE') or die;

jimport('joomla.html.html');
jimport('joomla.form.formfield');
jimport('joomla.form.helper');
JFormHelper::loadFieldClass('list');

/**
* Custom Field class for the Joomla Framework.
*
* @package Joomla.Administrator
* @subpackage com_my
* @since 1.6
*/
class JFormFieldMyCompany extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 1.6
*/
protected $type = 'MyCompany';

/**
* Method to get the field options.
*
* @return array The field option objects.
* @since 1.6
*/
public function getOptions()
{
// Initialize variables.
$options = array();

$db = JFactory::getDbo();
$query = $db->getQuery(true);

$query->select('id As value, name As text');
$query->from('#__my_companies AS a');
$query->order('a.name');
$query->where('state = 1');

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

$options = $db->loadObjectList();

// Check for a database error.
if ($db->getErrorNum()) {
JError::raiseWarning(500, $db->getErrorMsg());
}

return $options;
}
}
</source>

Obviously, there is only one section here that needs to be customized:

<source lang="php">
$query->select('id As value, name As text');
$query->from('#__my_companies AS a');
$query->order('a.name');
$query->where('state = 1');
</source>

Change the database name and adjust the sql as necessary. This will produce the text and values for the select element options. I highly recommend not changing the value and text names. Although I did not test this theory, it seems likely that ancestor classes are expecting these names as keys in the resulting array.

== Modify Model (models / zzz.php) ==
In your model you have to include these two functions:
<source lang="php">
//Add this handy array with database fields to search in
protected $searchInFields = array('text','a.name','someotherfieldtosearchin');

//Override construct to allow filtering and ordering on our fields
public function __construct($config = array()) {
$config['filter_fields']=array_merge($this->searchInFields,array('a.company'));
parent::__construct($config);
}

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

//CHANGE THIS QUERY AS YOU NEED...
$query->select('id As value, name As text, somefield')
->from('#__my_companies AS a')
->order( $db->escape($this->getState('list.ordering', 'pa.id')) . ' ' .
$db->escape($this->getState('list.direction', 'desc')));

// Filter search // Extra: Search more than one fields and for multiple words
$regex = str_replace(' ', '|', $this->getState('filter.search'));
if (!empty($regex)) {
$regex=' REGEXP '.$db->quote($regex);
$query->where('('.implode($regex.' OR ',$this->searchInFields).$regex.')');
}

// Filter company
$company= $db->escape($this->getState('filter.company'));
if (!empty($company)) {
$query->where('(a.company='.$company.')');
}

// Filter by state (published, trashed, etc.)
$state = $db->escape($this->getState('filter.state'));
if (is_numeric($state)) {
$query->where('a.state = ' . (int) $state);
}
elseif ($state === '') {
$query->where('(a.state = 0 OR a.state = 1)');
}

//echo $db->replacePrefix( (string) $query );//debug
return $query;
}

/**
* Method to auto-populate the model state.
*
* Note. Calling getState in this method will result in recursion.
*
* @since 1.6
*/
protected function populateState($ordering = null, $direction = null)
{
// Initialise variables.
$app = JFactory::getApplication('administrator');

// Load the filter state.
$search = $this->getUserStateFromRequest($this->context.'.filter.search', 'filter_search');
//Omit double (white-)spaces and set state
$this->setState('filter.search', preg_replace('/\s+/',' ', $search));

//Filter (dropdown) state
$state = $this->getUserStateFromRequest($this->context.'.filter.state', 'filter_state', '', 'string');
$this->setState('filter.state', $state);

//Filter (dropdown) company
$state = $this->getUserStateFromRequest($this->context.'.filter.company', 'filter_company', '', 'string');
$this->setState('filter.company', $state);

//Takes care of states: list. limit / start / ordering / direction
parent::populateState('a.name', 'asc');
}
</source>

'''For the frontend:''' your ''$app'' variable looks like this:

<source lang="php">

protected function populateState($ordering = null, $direction = null)
{
// Initialise variables.
$app = JFactory::getApplication();

</source>

== Modify View (views / zzz / view.html.php) ==
In you view class, you have to set the state, like this:
<source lang="php>
$this->items = $this->get('Items');
$this->pagination = $this->get('Pagination');
$this->state = $this->get('State');

//Following variables used more than once
$this->sortColumn = $this->state->get('list.ordering');
$this->sortDirection = $this->state->get('list.direction');
$this->searchterms = $this->state->get('filter.search');
</source>

== Modify Template (views / zzz / tmpl / default.php) ==
=== Basic ===
Top of template somewhere:<source lang="php">
//Get companie options
JFormHelper::addFieldPath(JPATH_COMPONENT . '/models/fields');
$companies = JFormHelper::loadFieldType('MyCompany', false);
$companyOptions=$companies->getOptions(); // works only if you set your field getOptions on public!!
</source>
In your template file, this fieldset reflects filter options:<source lang="php">
<fieldset id="filter-bar">
<div class="filter-search fltlft">
<input type="text" name="filter_search" id="filter_search" value="<?php echo $this->escape($this->searchterms); ?>" title="<?php echo JText::_('Search in company, etc.'); ?>" />
<button type="submit">
<?php echo JText::_('JSEARCH_FILTER_SUBMIT'); ?>
</button>
<button type="button" onclick="document.id('filter_search').value='';this.form.submit();">
<?php echo JText::_('JSEARCH_FILTER_CLEAR'); ?>
</button>
</div>
<div class="filter-select fltrt">
<select name="filter_state" class="inputbox" onchange="this.form.submit()">
<option value="">
<?php echo JText::_('JOPTION_SELECT_PUBLISHED');?>
</option>
<?php echo JHtml::_('select.options', JHtml::_('jgrid.publishedOptions', array('archived'=>false)), 'value', 'text', $this->state->get('filter.state'), true);?>
</select>

<select name="filter_type" class="inputbox" onchange="this.form.submit()">
<option value=""> - Select Company - </option>
<?php echo JHtml::_('select.options', $companyOptions, 'value', 'text', $this->state->get('filter.company'));?>
</select>

</div>
</fieldset>
</source>

'''Remark''': the name of the ''select'' tag must be the same as defined in the ''populateState'' function. In the example:

<source php>

//populateState function
$state = $this->getUserStateFromRequest($this->context.'.filter.state', 'filter_state', '', 'string');

//template
<select name="filter_state" class="inputbox" onchange="this.form.submit()">

</source>

=== Extra: highlighting search terms ===
Here is some extra to visually mark the found search terms in the results page.<br/>
==== Template ====
<u>Add this somewhere at top somehwere:</u> <source lang="php">
$searchterms = $this->state->get('filter.search');

//Highlight search terms with js (if we did a search => more performant and otherwise crash)
if (strlen($searchterms)>1) JHtml::_('behavior.highlighter', explode(' ',$searchterms));
</source>
And further in your template, enclose the specific fields with the default highlighter finder.<br/>
<u>Example:</u><source lang="php">
<span id="highlighter-start"></span>
<table class="adminlist">
...
</table>
<span id="highlighter-end"></span>
</source>
==== CSS ====
If your default admin template doesn't have required css, you should add the class in your component css.
<u>Example in controller:</u><source lang="php">
JHtml::stylesheet('com_peopleactions/admin.css', array(), true);
</source>
<u>In admin.css:</u><source lang="css">
.highlight { background: none repeat scroll 0 0 #FFFF00; }
</source>

== Contributors ==
[[User:riledhel|Javier Constanzo]]

[[User:Doub1ejack|Doub1ejack]]

[[User:E-builds|E-builds]]

[[Category:Development]]
[[Category:Component Development]]
[[Category:Tutorials]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]

Portal:Component Development/Reading list

2013-04-21T00:57:14Z

Catanet:

* [[Portal:Platform|Joomla Platform Portal]] {{JVer|platform}}
* [[File Structure and Naming Conventions]] {{JVer/multi|1.5,2.5,3.0}}
* [[Component Program Flow]]. UML sequence diagrams showing the control flow for a component. {{JVer/multi|1.5,2.5,3.0}}
* [[Developing a Model-View-Controller Component]] {{JVer/multi|1.5,2.5,3.0}}
* [[Components:xml installfile]]. An example component XML installation file. {{JVer|1.5}}
* [[Manifest files]] for the installation of extensions {{JVer/multi|1.6,1.7,2.5,3.0}}
* [[Adding sortable columns to a table in a component]]
* [[How to add custom filters to components]] {{JVer/multi|1.7,2.5}}
* [[Supporting SEF URLs in your component]]
* [[Supporting plugins in your component]] {{JVer|1.5}}
* [[Using JPagination in your component]]
* [[Using the JPane classes in a component]] {{JVer|1.5}}
* [[Using the JHtmlTabs class in a component]] {{JVer/multi|1.6,1.7,2.5,3.0}}
* [[Using the editor in a component]]
* [[Adding AJAX to your component]]
* [[Ajax using MooTools]]
* [[How to add breadcrumbs]]
* [[Sending email from extensions]]
* [[Using the JToolBar class in the frontend]]
* [[Creating a toolbar for your component]]
* [[Creating a file uploader in your component]]
* [[Adding Javascript moo.fx to your component]]
* [[Creating Mootools accordion or simple slider/toggler]]
* [[Adding view layout configuration parameters]]
* [[Using a custom image in the menu bar title]]
* [[How to implement XML-RPC in a component]]
* [[Using multiple models in an MVC component]]
* [[Adding ACL rules to your component]] {{JVer/multi|1.6,1.7,2.5,3.0}}
* [[JController and its subclass usage overview]] {{JVer/multi|1.6,1.7,2.5}}
* [[Managing Component Updates with Joomla!2.5 - Part 1]] {{JVer/multi|1.6,1.7,2.5}}
* [[Xml-rpc changes in Joomla! 1.6]] {{JVer/multi|1.6,1.7,2.5,3.0}}
* [[Creating PDF views]] {{JVer|2.5}}<noinclude>[[Category:Landing subpages|{{PAGENAME}}]]</noinclude>

Archived:How to add custom filters to components

2013-04-21T00:46:36Z

Catanet: /* Basic */

{{version/tutor|1.7,2.5}}{{RightTOC}}
== Overview ==
This is a how-to on how to add '''ordering''' and '''filtering''' (search, custom dropdown, state) to a component backend page.<br/>
This approach is almost exactly the same for the frontend.<br/>
In general, the process of adding a '''custom field filter''' breaks down into the following steps:
* Creating the class that will generate the form dropdown options
* Adapting the view to display the form dropdown input
* Adapting the model to retrieve data from DB & to set submission values in the Joomla 'state'. For a better understanding of the code samples, the db table is called 'my_company' and the fields are: id, name, state, company, somefield, someotherfieldtosearchin.

== Extend JFormFieldList (models / fields / fieldname.php) ==
Frequently your filter fields will be very basic; probably simply a dropdown list of one of the columns being displayed on the current page. Regardless, you will need to create your own field element. This really isn't a big deal - this file will probably be less than 70 lines, including comments. The code below will generate the dropdown element to filter by companies. For more information and complex examples on creating this class see [[Creating_a_custom_form_field_type]].

My 'companies' dropdown element:
<source lang="php">
<?php

defined('JPATH_BASE') or die;

jimport('joomla.html.html');
jimport('joomla.form.formfield');
jimport('joomla.form.helper');
JFormHelper::loadFieldClass('list');

/**
* Custom Field class for the Joomla Framework.
*
* @package Joomla.Administrator
* @subpackage com_my
* @since 1.6
*/
class JFormFieldMyCompany extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 1.6
*/
protected $type = 'MyCompany';

/**
* Method to get the field options.
*
* @return array The field option objects.
* @since 1.6
*/
public function getOptions()
{
// Initialize variables.
$options = array();

$db = JFactory::getDbo();
$query = $db->getQuery(true);

$query->select('id As value, name As text');
$query->from('#__my_companies AS a');
$query->order('a.name');
$query->where('state = 1');

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

$options = $db->loadObjectList();

// Check for a database error.
if ($db->getErrorNum()) {
JError::raiseWarning(500, $db->getErrorMsg());
}

return $options;
}
}
</source>

Obviously, there is only one section here that needs to be customized:

<source lang="php">
$query->select('id As value, name As text');
$query->from('#__my_companies AS a');
$query->order('a.name');
$query->where('state = 1');
</source>

Change the database name and adjust the sql as necessary. This will produce the text and values for the select element options. I highly recommend not changing the value and text names. Although I did not test this theory, it seems likely that ancestor classes are expecting these names as keys in the resulting array.

== Modify Model (models / zzz.php) ==
In your model you have to include these two functions:
<source lang="php">
//Add this handy array with database fields to search in
protected $searchInFields = array('text','a.name','someotherfieldtosearchin');

//Override construct to allow filtering and ordering on our fields
public function __construct($config = array()) {
$config['filter_fields']=array_merge($this->searchInFields,array('a.company'));
parent::__construct($config);
}

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

//CHANGE THIS QUERY AS YOU NEED...
$query->select('id As value, name As text, somefield')
->from('#__my_companies AS a')
->order( $db->escape($this->getState('list.ordering', 'pa.id')) . ' ' .
$db->escape($this->getState('list.direction', 'desc')));

// Filter search // Extra: Search more than one fields and for multiple words
$regex = str_replace(' ', '|', $this->getState('filter.search'));
if (!empty($regex)) {
$regex=' REGEXP '.$db->quote($regex);
$query->where('('.implode($regex.' OR ',$this->searchInFields).$regex.')');
}

// Filter company
$company= $db->escape($this->getState('filter.company'));
if (!empty($company)) {
$query->where('(a.company='.$company.')');
}

// Filter by state (published, trashed, etc.)
$state = $db->escape($this->getState('filter.state'));
if (is_numeric($state)) {
$query->where('a.state = ' . (int) $state);
}
elseif ($state === '') {
$query->where('(a.state = 0 OR a.state = 1)');
}

//echo $db->replacePrefix( (string) $query );//debug
return $query;
}

/**
* Method to auto-populate the model state.
*
* Note. Calling getState in this method will result in recursion.
*
* @since 1.6
*/
protected function populateState($ordering = null, $direction = null)
{
// Initialise variables.
$app = JFactory::getApplication('administrator');

// Load the filter state.
$search = $this->getUserStateFromRequest($this->context.'.filter.search', 'filter_search');
//Omit double (white-)spaces and set state
$this->setState('filter.search', preg_replace('/\s+/',' ', $search));

//Filter (dropdown) state
$state = $this->getUserStateFromRequest($this->context.'.filter.state', 'filter_state', '', 'string');
$this->setState('filter.state', $state);

//Filter (dropdown) company
$state = $this->getUserStateFromRequest($this->context.'.filter.company', 'filter_company', '', 'string');
$this->setState('filter.company', $state);

//Takes care of states: list. limit / start / ordering / direction
parent::populateState('a.name', 'asc');
}
</source>

'''FOR THE FRONTEND:''' your '''$app''' variable looks like this:

<source lang="php">

protected function populateState($ordering = null, $direction = null)
{
// Initialise variables.
$app = JFactory::getApplication();

</source>

== Modify View (views / zzz / view.html.php) ==
In you view class, you have to set the state, like this:
<source lang="php>
$this->items = $this->get('Items');
$this->pagination = $this->get('Pagination');
$this->state = $this->get('State');

//Following variables used more than once
$this->sortColumn = $this->state->get('list.ordering');
$this->sortDirection = $this->state->get('list.direction');
$this->searchterms = $this->state->get('filter.search');
</source>

== Modify Template (views / zzz / tmpl / default.php) ==
=== Basic ===
Top of template somewhere:<source lang="php">
//Get companie options
JFormHelper::addFieldPath(JPATH_COMPONENT . '/models/fields');
$companies = JFormHelper::loadFieldType('MyCompany', false);
$companyOptions=$companies->getOptions(); // works only if you set your field getOptions on public!!
</source>
In your template file, this fieldset reflects filter options:<source lang="php">
<fieldset id="filter-bar">
<div class="filter-search fltlft">
<input type="text" name="filter_search" id="filter_search" value="<?php echo $this->escape($this->searchterms); ?>" title="<?php echo JText::_('Search in company, etc.'); ?>" />
<button type="submit">
<?php echo JText::_('JSEARCH_FILTER_SUBMIT'); ?>
</button>
<button type="button" onclick="document.id('filter_search').value='';this.form.submit();">
<?php echo JText::_('JSEARCH_FILTER_CLEAR'); ?>
</button>
</div>
<div class="filter-select fltrt">
<select name="filter_state" class="inputbox" onchange="this.form.submit()">
<option value="">
<?php echo JText::_('JOPTION_SELECT_PUBLISHED');?>
</option>
<?php echo JHtml::_('select.options', JHtml::_('jgrid.publishedOptions', array('archived'=>false)), 'value', 'text', $this->state->get('filter.state'), true);?>
</select>

<select name="filter_type" class="inputbox" onchange="this.form.submit()">
<option value=""> - Select Company - </option>
<?php echo JHtml::_('select.options', $companyOptions, 'value', 'text', $this->state->get('filter.company'));?>
</select>

</div>
</fieldset>
</source>

'''REMARK''': the name of the ''select'' tag must be the same as defined in the ''populateState'' function. In the example:

<source php>

//populateState function
$state = $this->getUserStateFromRequest($this->context.'.filter.state', 'filter_state', '', 'string');

//template
<select name="filter_state" class="inputbox" onchange="this.form.submit()">

</source>

=== Extra: highlighting search terms ===
Here is some extra to visually mark the found search terms in the results page.<br/>
==== Template ====
<u>Add this somewhere at top somehwere:</u> <source lang="php">
$searchterms = $this->state->get('filter.search');

//Highlight search terms with js (if we did a search => more performant and otherwise crash)
if (strlen($searchterms)>1) JHtml::_('behavior.highlighter', explode(' ',$searchterms));
</source>
And further in your template, enclose the specific fields with the default highlighter finder.<br/>
<u>Example:</u><source lang="php">
<span id="highlighter-start"></span>
<table class="adminlist">
...
</table>
<span id="highlighter-end"></span>
</source>
==== CSS ====
If your default admin template doesn't have required css, you should add the class in your component css.
<u>Example in controller:</u><source lang="php">
JHtml::stylesheet('com_peopleactions/admin.css', array(), true);
</source>
<u>In admin.css:</u><source lang="css">
.highlight { background: none repeat scroll 0 0 #FFFF00; }
</source>

== Contributors ==
[[User:riledhel|Javier Constanzo]]

[[User:Doub1ejack|Doub1ejack]]

[[User:E-builds|E-builds]]

[[Category:Development]]
[[Category:Component Development]]
[[Category:Tutorials]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]

Archived:How to add custom filters to components

2013-04-21T00:25:38Z

Catanet: /* Modify Model (models / zzz.php) */

{{version/tutor|1.7,2.5}}{{RightTOC}}
== Overview ==
This is a how-to on how to add '''ordering''' and '''filtering''' (search, custom dropdown, state) to a component backend page.<br/>
This approach is almost exactly the same for the frontend.<br/>
{{notice|Is confirmed: it works also for the frontend. Article's title need to be changed and redirected.}}

In general, the process of adding a '''custom field filter''' breaks down into the following steps:
* Creating the class that will generate the form dropdown options
* Adapting the view to display the form dropdown input
* Adapting the model to retrieve data from DB & to set submission values in the Joomla 'state'. For a better understanding of the code samples, the db table is called 'my_company' and the fields are: id, name, state, company, somefield, someotherfieldtosearchin.

== Extend JFormFieldList (models / fields / fieldname.php) ==
Frequently your filter fields will be very basic; probably simply a dropdown list of one of the columns being displayed on the current page. Regardless, you will need to create your own field element. This really isn't a big deal - this file will probably be less than 70 lines, including comments. The code below will generate the dropdown element to filter by companies. For more information and complex examples on creating this class see [[Creating_a_custom_form_field_type]].

My 'companies' dropdown element:
<source lang="php">
<?php

defined('JPATH_BASE') or die;

jimport('joomla.html.html');
jimport('joomla.form.formfield');
jimport('joomla.form.helper');
JFormHelper::loadFieldClass('list');

/**
* Custom Field class for the Joomla Framework.
*
* @package Joomla.Administrator
* @subpackage com_my
* @since 1.6
*/
class JFormFieldMyCompany extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 1.6
*/
protected $type = 'MyCompany';

/**
* Method to get the field options.
*
* @return array The field option objects.
* @since 1.6
*/
public function getOptions()
{
// Initialize variables.
$options = array();

$db = JFactory::getDbo();
$query = $db->getQuery(true);

$query->select('id As value, name As text');
$query->from('#__my_companies AS a');
$query->order('a.name');
$query->where('state = 1');

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

$options = $db->loadObjectList();

// Check for a database error.
if ($db->getErrorNum()) {
JError::raiseWarning(500, $db->getErrorMsg());
}

return $options;
}
}
</source>

Obviously, there is only one section here that needs to be customized:

<source lang="php">
$query->select('id As value, name As text');
$query->from('#__my_companies AS a');
$query->order('a.name');
$query->where('state = 1');
</source>

Change the database name and adjust the sql as necessary. This will produce the text and values for the select element options. I highly recommend not changing the value and text names. Although I did not test this theory, it seems likely that ancestor classes are expecting these names as keys in the resulting array.

== Modify Model (models / zzz.php) ==
In your model you have to include these two functions:
<source lang="php">
//Add this handy array with database fields to search in
protected $searchInFields = array('text','a.name','someotherfieldtosearchin');

//Override construct to allow filtering and ordering on our fields
public function __construct($config = array()) {
$config['filter_fields']=array_merge($this->searchInFields,array('a.company'));
parent::__construct($config);
}

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

//CHANGE THIS QUERY AS YOU NEED...
$query->select('id As value, name As text, somefield')
->from('#__my_companies AS a')
->order( $db->escape($this->getState('list.ordering', 'pa.id')) . ' ' .
$db->escape($this->getState('list.direction', 'desc')));

// Filter search // Extra: Search more than one fields and for multiple words
$regex = str_replace(' ', '|', $this->getState('filter.search'));
if (!empty($regex)) {
$regex=' REGEXP '.$db->quote($regex);
$query->where('('.implode($regex.' OR ',$this->searchInFields).$regex.')');
}

// Filter company
$company= $db->escape($this->getState('filter.company'));
if (!empty($company)) {
$query->where('(a.company='.$company.')');
}

// Filter by state (published, trashed, etc.)
$state = $db->escape($this->getState('filter.state'));
if (is_numeric($state)) {
$query->where('a.state = ' . (int) $state);
}
elseif ($state === '') {
$query->where('(a.state = 0 OR a.state = 1)');
}

//echo $db->replacePrefix( (string) $query );//debug
return $query;
}

/**
* Method to auto-populate the model state.
*
* Note. Calling getState in this method will result in recursion.
*
* @since 1.6
*/
protected function populateState($ordering = null, $direction = null)
{
// Initialise variables.
$app = JFactory::getApplication('administrator');

// Load the filter state.
$search = $this->getUserStateFromRequest($this->context.'.filter.search', 'filter_search');
//Omit double (white-)spaces and set state
$this->setState('filter.search', preg_replace('/\s+/',' ', $search));

//Filter (dropdown) state
$state = $this->getUserStateFromRequest($this->context.'.filter.state', 'filter_state', '', 'string');
$this->setState('filter.state', $state);

//Filter (dropdown) company
$state = $this->getUserStateFromRequest($this->context.'.filter.company', 'filter_company', '', 'string');
$this->setState('filter.company', $state);

//Takes care of states: list. limit / start / ordering / direction
parent::populateState('a.name', 'asc');
}
</source>

'''FOR THE FRONTEND:''' your '''$app''' variable looks like this:

<source lang="php">

protected function populateState($ordering = null, $direction = null)
{
// Initialise variables.
$app = JFactory::getApplication();

</source>

== Modify View (views / zzz / view.html.php) ==
In you view class, you have to set the state, like this:
<source lang="php>
$this->items = $this->get('Items');
$this->pagination = $this->get('Pagination');
$this->state = $this->get('State');

//Following variables used more than once
$this->sortColumn = $this->state->get('list.ordering');
$this->sortDirection = $this->state->get('list.direction');
$this->searchterms = $this->state->get('filter.search');
</source>

== Modify Template (views / zzz / tmpl / default.php) ==
=== Basic ===
Top of template somewhere:<source lang="php">
//Get companie options
JFormHelper::addFieldPath(JPATH_COMPONENT . '/models/fields');
$companies = JFormHelper::loadFieldType('MyCompany', false);
$companyOptions=$companies->getOptions(); // works only if you set your field getOptions on public!!
</source>
In your template file, this fieldset reflects filter options:<source lang="php">
<fieldset id="filter-bar">
<div class="filter-search fltlft">
<input type="text" name="filter_search" id="filter_search" value="<?php echo $this->escape($this->searchterms); ?>" title="<?php echo JText::_('Search in company, etc.'); ?>" />
<button type="submit">
<?php echo JText::_('JSEARCH_FILTER_SUBMIT'); ?>
</button>
<button type="button" onclick="document.id('filter_search').value='';this.form.submit();">
<?php echo JText::_('JSEARCH_FILTER_CLEAR'); ?>
</button>
</div>
<div class="filter-select fltrt">
<select name="filter_state" class="inputbox" onchange="this.form.submit()">
<option value="">
<?php echo JText::_('JOPTION_SELECT_PUBLISHED');?>
</option>
<?php echo JHtml::_('select.options', JHtml::_('jgrid.publishedOptions', array('archived'=>false)), 'value', 'text', $this->state->get('filter.state'), true);?>
</select>

<select name="filter_type" class="inputbox" onchange="this.form.submit()">
<option value=""> - Select Company - </option>
<?php echo JHtml::_('select.options', $companyOptions, 'value', 'text', $this->state->get('filter.company'));?>
</select>

</div>
</fieldset>
</source>

=== Extra: highlighting search terms ===
Here is some extra to visually mark the found search terms in the results page.<br/>
==== Template ====
<u>Add this somewhere at top somehwere:</u> <source lang="php">
$searchterms = $this->state->get('filter.search');

//Highlight search terms with js (if we did a search => more performant and otherwise crash)
if (strlen($searchterms)>1) JHtml::_('behavior.highlighter', explode(' ',$searchterms));
</source>
And further in your template, enclose the specific fields with the default highlighter finder.<br/>
<u>Example:</u><source lang="php">
<span id="highlighter-start"></span>
<table class="adminlist">
...
</table>
<span id="highlighter-end"></span>
</source>
==== CSS ====
If your default admin template doesn't have required css, you should add the class in your component css.
<u>Example in controller:</u><source lang="php">
JHtml::stylesheet('com_peopleactions/admin.css', array(), true);
</source>
<u>In admin.css:</u><source lang="css">
.highlight { background: none repeat scroll 0 0 #FFFF00; }
</source>

== Contributors ==
[[User:riledhel|Javier Constanzo]]

[[User:Doub1ejack|Doub1ejack]]

[[User:E-builds|E-builds]]

[[Category:Development]]
[[Category:Component Development]]
[[Category:Tutorials]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]

Archived:How to add custom filters to components

2013-04-21T00:04:00Z

Catanet:

{{version/tutor|1.7,2.5}}{{RightTOC}}
== Overview ==
This is a how-to on how to add '''ordering''' and '''filtering''' (search, custom dropdown, state) to a component backend page.<br/>
This approach is almost exactly the same for the frontend.<br/>
{{notice|Is confirmed: it works also for the frontend. Article's title need to be changed and redirected.}}

In general, the process of adding a '''custom field filter''' breaks down into the following steps:
* Creating the class that will generate the form dropdown options
* Adapting the view to display the form dropdown input
* Adapting the model to retrieve data from DB & to set submission values in the Joomla 'state'. For a better understanding of the code samples, the db table is called 'my_company' and the fields are: id, name, state, company, somefield, someotherfieldtosearchin.

== Extend JFormFieldList (models / fields / fieldname.php) ==
Frequently your filter fields will be very basic; probably simply a dropdown list of one of the columns being displayed on the current page. Regardless, you will need to create your own field element. This really isn't a big deal - this file will probably be less than 70 lines, including comments. The code below will generate the dropdown element to filter by companies. For more information and complex examples on creating this class see [[Creating_a_custom_form_field_type]].

My 'companies' dropdown element:
<source lang="php">
<?php

defined('JPATH_BASE') or die;

jimport('joomla.html.html');
jimport('joomla.form.formfield');
jimport('joomla.form.helper');
JFormHelper::loadFieldClass('list');

/**
* Custom Field class for the Joomla Framework.
*
* @package Joomla.Administrator
* @subpackage com_my
* @since 1.6
*/
class JFormFieldMyCompany extends JFormFieldList
{
/**
* The form field type.
*
* @var string
* @since 1.6
*/
protected $type = 'MyCompany';

/**
* Method to get the field options.
*
* @return array The field option objects.
* @since 1.6
*/
public function getOptions()
{
// Initialize variables.
$options = array();

$db = JFactory::getDbo();
$query = $db->getQuery(true);

$query->select('id As value, name As text');
$query->from('#__my_companies AS a');
$query->order('a.name');
$query->where('state = 1');

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

$options = $db->loadObjectList();

// Check for a database error.
if ($db->getErrorNum()) {
JError::raiseWarning(500, $db->getErrorMsg());
}

return $options;
}
}
</source>

Obviously, there is only one section here that needs to be customized:

<source lang="php">
$query->select('id As value, name As text');
$query->from('#__my_companies AS a');
$query->order('a.name');
$query->where('state = 1');
</source>

Change the database name and adjust the sql as necessary. This will produce the text and values for the select element options. I highly recommend not changing the value and text names. Although I did not test this theory, it seems likely that ancestor classes are expecting these names as keys in the resulting array.

== Modify Model (models / zzz.php) ==
In your model you have to include these two functions:
<source lang="php">
//Add this handy array with database fields to search in
protected $searchInFields = array('text','a.name','someotherfieldtosearchin');

//Override construct to allow filtering and ordering on our fields
public function __construct($config = array()) {
$config['filter_fields']=array_merge($this->searchInFields,array('a.company'));
parent::__construct($config);
}

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

//CHANGE THIS QUERY AS YOU NEED...
$query->select('id As value, name As text, somefield')
->from('#__my_companies AS a')
->order( $db->escape($this->getState('list.ordering', 'pa.id')) . ' ' .
$db->escape($this->getState('list.direction', 'desc')));

// Filter search // Extra: Search more than one fields and for multiple words
$regex = str_replace(' ', '|', $this->getState('filter.search'));
if (!empty($regex)) {
$regex=' REGEXP '.$db->quote($regex);
$query->where('('.implode($regex.' OR ',$this->searchInFields).$regex.')');
}

// Filter company
$company= $db->escape($this->getState('filter.company'));
if (!empty($company)) {
$query->where('(a.company='.$company.')');
}

// Filter by state (published, trashed, etc.)
$state = $db->escape($this->getState('filter.state'));
if (is_numeric($state)) {
$query->where('a.state = ' . (int) $state);
}
elseif ($state === '') {
$query->where('(a.state = 0 OR a.state = 1)');
}

//echo $db->replacePrefix( (string) $query );//debug
return $query;
}

/**
* Method to auto-populate the model state.
*
* Note. Calling getState in this method will result in recursion.
*
* @since 1.6
*/
protected function populateState($ordering = null, $direction = null)
{
// Initialise variables.
$app = JFactory::getApplication('administrator');

// Load the filter state.
$search = $this->getUserStateFromRequest($this->context.'.filter.search', 'filter_search');
//Omit double (white-)spaces and set state
$this->setState('filter.search', preg_replace('/\s+/',' ', $search));

//Filter (dropdown) state
$state = $this->getUserStateFromRequest($this->context.'.filter.state', 'filter_state', '', 'string');
$this->setState('filter.state', $state);

//Filter (dropdown) company
$state = $this->getUserStateFromRequest($this->context.'.filter.company', 'filter_company', '', 'string');
$this->setState('filter.company', $state);

//Takes care of states: list. limit / start / ordering / direction
parent::populateState('a.name', 'asc');
}
</source>

== Modify View (views / zzz / view.html.php) ==
In you view class, you have to set the state, like this:
<source lang="php>
$this->items = $this->get('Items');
$this->pagination = $this->get('Pagination');
$this->state = $this->get('State');

//Following variables used more than once
$this->sortColumn = $this->state->get('list.ordering');
$this->sortDirection = $this->state->get('list.direction');
$this->searchterms = $this->state->get('filter.search');
</source>

== Modify Template (views / zzz / tmpl / default.php) ==
=== Basic ===
Top of template somewhere:<source lang="php">
//Get companie options
JFormHelper::addFieldPath(JPATH_COMPONENT . '/models/fields');
$companies = JFormHelper::loadFieldType('MyCompany', false);
$companyOptions=$companies->getOptions(); // works only if you set your field getOptions on public!!
</source>
In your template file, this fieldset reflects filter options:<source lang="php">
<fieldset id="filter-bar">
<div class="filter-search fltlft">
<input type="text" name="filter_search" id="filter_search" value="<?php echo $this->escape($this->searchterms); ?>" title="<?php echo JText::_('Search in company, etc.'); ?>" />
<button type="submit">
<?php echo JText::_('JSEARCH_FILTER_SUBMIT'); ?>
</button>
<button type="button" onclick="document.id('filter_search').value='';this.form.submit();">
<?php echo JText::_('JSEARCH_FILTER_CLEAR'); ?>
</button>
</div>
<div class="filter-select fltrt">
<select name="filter_state" class="inputbox" onchange="this.form.submit()">
<option value="">
<?php echo JText::_('JOPTION_SELECT_PUBLISHED');?>
</option>
<?php echo JHtml::_('select.options', JHtml::_('jgrid.publishedOptions', array('archived'=>false)), 'value', 'text', $this->state->get('filter.state'), true);?>
</select>

<select name="filter_type" class="inputbox" onchange="this.form.submit()">
<option value=""> - Select Company - </option>
<?php echo JHtml::_('select.options', $companyOptions, 'value', 'text', $this->state->get('filter.company'));?>
</select>

</div>
</fieldset>
</source>

=== Extra: highlighting search terms ===
Here is some extra to visually mark the found search terms in the results page.<br/>
==== Template ====
<u>Add this somewhere at top somehwere:</u> <source lang="php">
$searchterms = $this->state->get('filter.search');

//Highlight search terms with js (if we did a search => more performant and otherwise crash)
if (strlen($searchterms)>1) JHtml::_('behavior.highlighter', explode(' ',$searchterms));
</source>
And further in your template, enclose the specific fields with the default highlighter finder.<br/>
<u>Example:</u><source lang="php">
<span id="highlighter-start"></span>
<table class="adminlist">
...
</table>
<span id="highlighter-end"></span>
</source>
==== CSS ====
If your default admin template doesn't have required css, you should add the class in your component css.
<u>Example in controller:</u><source lang="php">
JHtml::stylesheet('com_peopleactions/admin.css', array(), true);
</source>
<u>In admin.css:</u><source lang="css">
.highlight { background: none repeat scroll 0 0 #FFFF00; }
</source>

== Contributors ==
[[User:riledhel|Javier Constanzo]]

[[User:Doub1ejack|Doub1ejack]]

[[User:E-builds|E-builds]]

[[Category:Development]]
[[Category:Component Development]]
[[Category:Tutorials]]
[[Category:Joomla! 1.6]]
[[Category:Joomla! 1.7]]
[[Category:Joomla! 2.5]]