Joomla! Documentation - User contributions [en]

J3.x:Triggering content plugins in your extension

2015-03-27T17:13:35Z

JulienV:

{{version|2.5,3.x}}
A common example of [[Supporting plugins in your component|using plugins]] is to run the '''content plugins''' on some text. This is useful if you want to support plugins that usually work on Content from a custom extension. For the content prepare trigger you can simply call:

<source lang="php">
$text = JHtml::_('content.prepare', $text);
</source>

For any other content triggers you must call:

<source lang="php">
$article = new stdClass;
$article->text = $text;

// add more to parameters if needed
$params = new JObject;

// Note JDispatcher is deprecated in favour of JEventDispatcher in Joomla 3.x however still works.
JPluginHelper::importPlugin('content');
$dispatcher = JDispatcher::getInstance();
$dispatcher->trigger('onContentPrepare', array('some.context', &$article, &$params, 0));
</source>

You might want to look at core components (for example com_content) for an example. See the [[Plugin/Events|triggers page]] for the possible content plugin triggers.

Also for PHP5.3 compliance please look at the discussion page.
<noinclude>[[Category:Extension development]][[Category:Plugins]]
[[Category:Plugin Development]]
[[Category:Development Recommended Reading]]
</noinclude>

J3.x:Triggering content plugins in your extension

2015-03-27T17:09:29Z

JulienV: The example was using onPrepareContent instead of onContentPrepare

{{version|2.5,3.x}}
A common example of [[Supporting plugins in your component|using plugins]] is to run the '''content plugins''' on some text. This is useful if you want to support plugins that usually work on Content from a custom extension. For the content prepare trigger you can simply call:

<source lang="php">
$text = JHtml::_('content.prepare', $text);
</source>

For any other content triggers you must call:

<source lang="php">
// Note JDispatcher is deprecated in favour of JEventDispatcher in Joomla 3.x however still works.
$dispatcher = JDispatcher::getInstance();
$item->text = your_text_area_item;
$item->params = new JRegistry;
JPluginHelper::importPlugin('content');
$dispatcher->trigger('onContentPrepare', array ('some.context', &$item, 0));
</source>

You might want to look at core components (for example com_content) for an example. See the [[Plugin/Events|triggers page]] for the possible content plugin triggers.

Also for PHP5.3 compliance please look at the discussion page.
<noinclude>[[Category:Extension development]][[Category:Plugins]]
[[Category:Plugin Development]]
[[Category:Development Recommended Reading]]
</noinclude>

Joomla CodeSniffer

2013-07-05T22:03:08Z

JulienV: /* PHPStorm: added method to add joomla code style */

{{page|needs technical review|This page needs expanded installation instructions, especially for Windows-based systems}}

== A Nose For Joomla ==

This is a custom coding standard for the PHP CodeSniffer that attempts to codify and enforce the Joomla coding standards.

==Why?==

- Coherent and consisting coding practice makes the files look more professional. Conflicting styles in the same project (or worse, the same file) not only look sloppy, they encourage further sloppiness.

- When all code complies with the same standard, bad code is easier for everyone to spot.

- It makes it easier for someone new to a particular file in the project to find and fix errors, or extend functionality.

- If there is no consistent standard maintained, the sometimes developers will reformat the code to suit themselves. This causes a wide range of changes in the code repository, and if there is a later problem, a significant change could be lost in the chaff produced by a diff.

==Installation==

First of all you have to install the [http://pear.php.net/package/PHP_CodeSniffer/ PHP CodeSniffer]. This set of files is intended to work with phpcs version 1.4, so behavior with any other version is undefined. One way to do this is to start the console (cmd.exe in windows environments) and type:

<code>pear install PHP_CodeSniffer</code>

To specify a specific version of the PHP CodeSniffer, type:

<code>pear install PHP_CodeSniffer-1.4.x</code> (specify a number for x, versions 1.4.0 through 1.4.5 are available)

Pear will handle the whole installation by itself.

Then download and unzip the [https://github.com/joomla/coding-standards Joomla! CodeSniffer] and copy the contents of it into /path/to/PHP_CodeSniffer/Standards/Joomla.

In Unix systems this path is usually /usr/lib/php/PHP/PHP_CodeSniffer/Standards/Joomla but this varies from system to system. In Xubuntu 12.04, the path is /usr/share/php/PHP/CodeSniffer/Standards/Joomla.
Windows based system with XAMPP have the following path: PATH_TO_XAMMP\php\PEAR\PHP\CodeSniffer\Standards (for example: C:\xampp\php\PEAR\PHP\CodeSniffer\Standards)

Use

<code>pear config-get php_dir</code>

to find out where the PEAR directory is on your system, then add "/PHP/PHP_CodeSniffer/Standards" to it.

== Usage ==

You invoke the custom standard by

<code>phpcs --standard=Joomla file/to/sniff</code>

To test a platform file using the provided platform coding standards use

<code>phpcs --standard=build/phpcs/Joomla path/to/file/or/folder</code>

Further documentation on the use of phpcs can be found at: [http://pear.php.net/package/PHP_CodeSniffer/docs]

==IDE integration==

While everybody loves the console as it is with no doubt the most effective way to do whatever you need to do.. sometimes even linux gurus need a little bit of comfort.

Fortunately there is a plugin available for eclipse and netbeans that integrates the CodeSniffer in our favorite IDE, so any coding standard violations are shown like "normal" errors.

=== Netbeans ===

For netbeans you have to install the sniffer plugin first. You can download the plugin [http://sourceforge.net/projects/phpmdnb/files/nbm/ here].

# Start your netbeans IDE
# Open Tools => Plugins => Downloaded and press ''Add Plugin''
# Choose the loaded nbm file and confirm the installation
# Now there is a new tab in Tools => Options => PHP called "PHPCodeSniffer"
# You have to set the path to the ''phpcs.bat'' from the installed PHP_CodeSniffer PEAR package
#* for Unix based systems the path is something like /usr/bin/phpcs
#* in XAMPP (windows) you can find the file in the php root folder (e.g. C:\xampp\php\phpcs.bat)
# As "standard" type "Joomla" to use the Joomla! standard
# now you can click ''test Settings'' to check the settings and finish the installation by pressing ''Ok''
# Open he task window (Window => Tasks) to sniff your code.
# Most time it is a good idea to filter the task (show only in edited file or create an own filter which displays only sniff errors)

=== Eclipse ===
[[Image:eclipse_pti.png|left|thumb|200px|1) Eclipse PTI]]

<div style="clear: both"></div>
Installation is a breeze and follows the usual pattern:
# <tt>Help => Install new Software...</tt>
# <tt>Work with:</tt> Fill in one of the update site URLs found here: http://www.phpsrc.org/eclipse/pti/
# Select the desired tools
# Restart Eclipse.

[[Image:eclipse_pti_settings.png|right|thumb|150px|2) Eclipse PTI settings]]
You are now able to sniff for code violations against common standards like PEAR or Zend etc.

To sniff against your own standards, all you have to do is specify their location and activate them (see screen shot 2)

# <tt>Window => Preferences</tt>
# <tt>PHP Tools => PHP CodeSniffer</tt>

Happy sniffing

=== PHPStorm ===

==== PHPStorm ====
[[Image:PhpStorm4CodeSniffer.png|left|thumb|200px|1) PHPStorm 4.x CodeSniffer]]
<div style="clear: both"></div>

CodeSniffer is supported out of the box in PHPStorm, just go to settings, and under "Inspections" you will see the list of Sniff you have installed.

See: the [http://www.jetbrains.com/phpstorm/webhelp/using-php-code-sniffer-tool.html JetBrains documentation page for setting the Code Sniffer] and also [http://blog.jetbrains.com/webide/2012/03/checking-your-code-with-php-code-sniffer-in-phpstorm-4-0/ phpStorm Blog])

For users on ubuntu using phpStorm. Don't listen instructions at http://www.jetbrains.com/phpstorm/webhelp/using-php-code-sniffer-tool.html#d59626e1126 because there is no working bat (windows file) on linux system. To validate your CodeSniffer choose /usr/bin/phpcs launcher.

Under Settings->Inspections when you choose joomla profile, in the tree below, search for PHP and open it and than make sure that PHP Code Sniffer validation checkbox is checked. Otherwise PHP Code Sniffer won't sniff your code.

On ubuntu you install code standards with:
cd /usr/share/php/PHP/CodeSniffer/Standards
sudo git clone http://github.com/joomla/coding-standards.git Joomla
===== Installing Joomla Sniff =====

# get the sniffers from the [https://github.com/joomla/coding-standards coding standards repo]
# unpack Joomla CodeSniffer rules under:
## If you are using XAMPP ''\xampp\php\PEAR\PHP\CodeSniffer\Standards\Joomla''
## If not maybe you should check here: ''/usr/share/php/PHP/CodeSniffer/Standards''
# Go to Settings (CTRL-ALT-S) and search for "PHP Code Sniffer Validation", click the button Validate to force reload of rules from disk
# Joomla should be now available in the list. See following image:

[[Image:PhpStorm6CodeSniffer.png|left|thumb|200px|1) PHPStorm 6.x CodeSniffer]]
<div style="clear: both"></div>

===== Installing Joomla Code style =====

It's nice to be able to check that the standards are respected, but it's even nicer if phpstorm helps you formatting properly too as you are coding.
To add joomla code style to phpstorm
# first get the xml scheme file from here: https://github.com/betweenbrain/phpstorm-joomla-code-style
# Then save the file in phpstorm [http://www.jetbrains.com/phpstorm/webhelp/project-and-ide-settings.html#d231397e460 home directory]: <phpstorm home directory>/config/codestyles/Joomla.xml
# restart phpstorm, and you should be able to select Joomla from the Code Style > Scheme select box

==== PHP PSR-0, PSR-1 and PSR-2 ====
* https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md
* https://github.com/pmjones/fig-standards/blob/psr-1-style-guide/proposed/PSR-1-basic.md
* https://github.com/pmjones/fig-standards/blob/psr-1-style-guide/proposed/PSR-2-advanced.md

===== Installing PHP PSR-0, PSR-1 and PSR-2 Sniff =====

A CodeSniffer sniff to check against the PSR-x Coding Standard

Download files at
* https://github.com/squizlabs/PHP_CodeSniffer/tree/master/CodeSniffer/Standards

if you are using Xampp,
# unpack PSR-1 CodeSniffer rules under \xampp\php\PEAR\PHP\CodeSniffer\Standards\PSR (SPR or any directory will work)
# Go to Settings (CTRL-ALT-S) and search for "PHP Code Sniffer Validation", click the button Validate to force reload of rules from disk
# PSR is available in the list

==== PHPStorm 3.x / Alternative method ====
'''NOTE''': This method is outdated, but it might be useful if you are looking for a different integration. It also demonstrates the use of external tools in PHPStorm - so it shouldn't be deleted.

<del>There is currently no plugin available</del> The CodeSniffer can also be integrated easily as an external tool. PHPStorm will display the output in the console, including clickable links containing line and column numbers to the files that contain errors.

* Click on "Settings" and search for "External tools"
* Click "Add..."
* Choose a "name", "Group" and "Description".
* Click "Output Filters"
** Click "Add...", Choose a name and enter under "Regular expression to match output" the value: <tt>$FILE_PATH$:$LINE$:$COLUMN$</tt>
* "Program": Search for the phpcs executable on your system. You have to set the path to the ''phpcs.bat'' from the installed PHP_CodeSniffer PEAR package
** for Unix based systems the path is something like /usr/bin/phpcs
** in XAMPP (windows) you can find the file in the php root folder (e.g. C:\xampp\php\phpcs.bat)
* "Paramaters":
** <tt>--standard=<path/to/joomla-platform>/build/phpcs/Joomla</tt> The path to the Joomla! coding standards.
** <tt>--report=emacs</tt> The will generate a simple list containing links to the error files
** Optional you may want to specify <tt>-p</tt> for "progress" or <tt>-n</tt> for "errors only".
** The last parameter has to be <tt>$FilePath$</tt> specifying the file or folder you want to sniff.

A typical "Parameters" line on a Linux system might look like this:
<pre>-np --standard=/home/elkuku/libs/joomla/build/phpcs/Joomla --report=emacs $FilePath$</pre>

You may now right click any file or folder and choose the sniffer from the context menu or add a new toolbar button with a nice Joomla! logo [[File:icon-16-joomla.png]].

=== References ===
* http://www.phpsrc.org/ PTI - PHP tools integration for Eclipse
* http://sourceforge.net/projects/phpmdnb/ Netbeans plugin
* http://hakre.wordpress.com/2010/03/06/php-code-sniffer-eclipse-and-wordpress/ - Excellent article. Just change "Wordpress" for "Joomla!" ;)

[[Category:Development]][[Category:Bug Squad]]

Talk:Calendar form field type

2012-04-19T08:41:30Z

JulienV: Created page with "it seems like the 'format' uses the one from strftime, not date. Maybe it would be best to indeed change to date format anyway, but as it is, the documentation points to the wron..."

it seems like the 'format' uses the one from strftime, not date. Maybe it would be best to indeed change to date format anyway, but as it is, the documentation points to the wrong information

Archived talk:Adapting a Joomla 1.5 extension to Joomla 2.5

2011-11-02T18:35:57Z

JulienV: regular expressions for language strings

I believe that was valuable information (including the link to Andrew Eddies site)
http://docs.joomla.org/index.php?title=Upgrading_a_Joomla_1.5_extension_to_Joomla_1.6&diff=0&oldid=35451
--[[User:Elkuku|Elkuku]] 18:31, 18 January 2011 (UTC)

There are several reasons for removing external links. We don't have the resources that would be required to monitor the sites being linked to; links can easily be turned into malware distribution sites. I'm not saying that that is the case here, but such links are often added for commercial reasons, in order to drive traffic to sites that carry advertisements or products for sale or simply to increase search-engine ranking. In order that the wiki does not become a link-fest for every commercial organisation in the community hoping to grab traffic, it is only fair that no such links are allowed. Although Andrew has the highest standing within the community I'm sure he would agree that it would be unfair to allow links to his site but not to others. But perhaps most importantly, the presence of external links discourages potential contributors from improving the documentation here on the wiki. I would prefer that anyone considering adding a link to an external site instead think about how the information in the wiki can be added to or improved for the benefit of all our users. Perhaps the author of the external site can even be persuaded to donate the material; I know that Andrew has already contributed a great deal in that way so perhaps others can too. [[User:Chris Davenport|Chris Davenport]] 18:59, 18 January 2011 (UTC)

Some more useful regular expressions to adapt language files and language strings to 1.7
* to make sure all keys are properly prefixed, for example by the component name: search ^(?!COM_MYCOMP)([^\n=]+)= replace with COM_MYCOMP_$1=
* to replace spaces before the = sign replace (COM_MYCOMP[^\s\n=]*)( )([^\n=]*)= with $1_$3= (run several times...)
* find keys with illegal characters in language files: ^([\w]+([^\w=])[^\n=]*)=
* for xml files, label and descriptions prefixes, replace (label|description)="(?!COM_MYCOMP)([^"]+)" with $1="COM_MYCOMP_$2"
* for xml files, label and descriptions spaces replace (label|description)="([^\s"]*)[\s]+([^"]*)" with $1="$2_$3" (several times)
* in php files, for prefixes replace JText::_\(\s*\'(?!COM_MYCOMP)([^']*)\' with JText::_('COM_MYCOMP_$1' (same with sprintf, and you might need to run it with double quote too)
* in php files, for spaces replace JText::_\(\s*'([^'\s]*)( )([^']*)' with JText::_('$1_$3'
([[User:JulienV|JulienV]] 13:35, 2 November 2011 (CDT))

User:JulienV

2011-06-02T10:11:32Z

JulienV:

http://www.jlv-solutions.com
jlv [a] jlv-solutions.com

J1.5 talk:Creating a search plugin

2011-06-02T10:09:28Z

JulienV:

the php file presented here is written in a procedural way.

For joomla 1.5, it's better to write it using a class, as explained here: http://docs.joomla.org/Creating_a_Plugin_for_Joomla_1.5

<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' );

// Import library dependencies
jimport('joomla.plugin.plugin');

//Load the language file. Replace 'nameofplugin' with the name of your plugin.
JPlugin::loadLanguage( 'plg_search_nameofplugin' );

class plgSearchnameofplugin extends JPlugin {

/**
* plugin 'areas', i.e. it's differents search sections
* for this example, we us only one section, but you could have several (e.g: articles, categories, author...)
* @var array
*/
var $_areas = array(
'mypluginsearcha' => 'PLG_MYSEARCHPLUGIN_AREA_A'
);

/**
* Handles onSearchAreas Event
*
* @return array
*/
function onSearchAreas()
{
return $this->_areas;
}

/**
* Handles onSearchAreas event
*
* @param string $text the text to search
* @param string $phrase the type of search (exact/all/any)
* @param string $ordering ordering of the results (alpha/newest/...)
* @param array $areas areas to be search
* @return array matches
*/
function onSearch( $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( $this->_areas ) )) {
return array();
}
}

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

//Now define the parameters 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.
// in case of multiple sectionS, just repeat and adapt for each, merging each section results,
// and filtering with an if statement: if (!$areas || in_array('mypluginsearcha', $areas))) {...}
// It will look something like this, if you have only one section
$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>
[[User:JulienV|JulienV]] 05:09, 2 June 2011 (CDT)

User:JulienV

2011-06-02T10:06:23Z

JulienV: Created page with "http://www.jlv-solutions.com"

http://www.jlv-solutions.com

J1.5 talk:Creating a search plugin

2011-06-02T10:05:20Z

JulienV: proposed object oriented version of the search plugin

Client-side form validation

2008-07-25T13:51:09Z

JulienV: changed short open tag to '<?php echo'. Short open tags are deprecated in php 6.

[[Category:Development]]

== Intro ==

Joomla 1.5 contains a behavior '''JHTMLBehavior::formvalidation()''' which enables the script '''validate.js'''.
It uses '''mootools''' (I think) and allows your form and its elements to be validated.

'''Note:''' For more recent versions of Joomla (1.5.2) use '''JHTML::_('behavior.formvalidation')''' instead of '''JHTMLBehavior::formvalidation()'''

== To enable the validation ==
The only thing you have to do is set the '''classes''' of the form and elements to specified meanings.
Classes:
=== Form ===
* form-validate -> enable validation
=== Form elements ===
* required
* validate-username
* validate-password
* validate-numeric
* validate-email
* validate-[custom] -> custom handlers have to be set then!
== Style invalid elements ==
If some elements don't validate they will get the class
* invalid
If you style this to e.g. red background and white foreground, your users will be able to see which fields are wrong.

== Really only accept form after validation ==
If you don't want the form to submit anything unless the values are validated, here's a nice script:<source lang="php">
<?php JHTMLBehavior::formvalidation(); ?>
<script language="javascript">
function myValidate(f) {
if (document.formvalidator.isValid(f)) {
f.check.value='<?php echo JUtility::getToken(); ?>';//send token
return true;
}
else {
alert('Some values are not acceptable. Please retry.');
}
return false;
}
</script>
<form id="WV-form" method="post" class="form-validate" onSubmit="return myValidate(this);">
<input type="hidden" name="check" value="post"/>
...
<input type="text" name="email" size="30" class="required validate-email"/>
...
<input type="submit" value="Submit" />
</form></source>

The page that receives the value can check several things:<source lang="php">
defined( '_JEXEC' ) or die( 'Restricted access' ); //Verify Joomla enabled

$jAp=& JFactory::getApplication();
if ($_POST['check']!=JUtility::getToken()) {
//First verify if by a javascript error or other possibilities the form has not been submitted without the validation
if ($_POST['check']=='post') $jAp->enqueueMessage('Please check all the fields of the form, aub.<br/>
If your browser blocks javascript, then this form will never be succesfull. This is a security measure.','error');
//If then still the check isn't a valid token, do nothing as this might be a spoof attack or other invalid form submission
return false;
}</source>

== Custom handlers ==
If you want a custome handler, you can add one to the class, as follow example (defined AFTER the validate.js):<source lang="php">Window.onDomReady(function() {
document.formvalidator.setHandler('birth', function(value) {
regex=/^\d{4}(-\d{2}){2}$/;
return regex.test(value);
})
})</source>
You can then set any class to validate-birth to make it validate as yyyy-mm-dd. (Valid date is not checked!)

J1.5 talk:Using the core parameter types

2008-05-27T13:45:46Z

JulienV: change 'type' value first letter to lowercase ?

It seems to me that the first letter of type parameter should be lowercase: e.g. 'type="calendar"'

otherwise, it doesn't work (element not defined). Now, maybe this is for next version, I'm not sure, so i didn't edited myself !