Joomla! Documentation - User contributions [en]

Selecting data using JDatabase

2021-02-25T11:29:57Z

AndyGaskell: typo

Selecting data using JDatabase

2021-02-25T11:29:26Z

AndyGaskell: note on empty results being null

Make changes to an article automatically using a plugin

2020-09-01T14:25:07Z

AndyGaskell:

==Overview==
Plugins are the simplest extensions to write. A simple plugin requires only two files. Yet plugins can be extremely handy.

One common case for using plugins is doing some customized processing every time an article is saved. For example:
* Change the published state of an article.
* Add standard text to articles.
* Set the Section or Category for an article.

Let's see how you can use a simple plugin to do these types of tasks.

==First Plugin==
A simple plugin has two files. One is an XML file that tells Joomla! how to install the plugin. The other is the actual plugin PHP code.

To make it as easy as possible for people to write plugins, Joomla! includes example plugins in every installation. In our example, we are writing a "content" plugin, since we are working with articles. So the two example files we can use as guidelines are <tt>plugins/content/example.xml</tt> amd <tt>plugins/content/example.php</tt>.

The XML file for our example is called <tt>modifyarticle.xml</tt>. We just copied the file <tt>plugins/content/example.xml</tt> to <tt>modifyarticle.xml</tt> and put it in a new folder outside of the Joomla! installation. (''We will use the Joomla! install program later on to add this to our Joomla! system. So for now we want to keep this separate from Joomla!.'') Then we edited it as follows:
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install version="1.5" type="plugin" group="content">
<name>Modify Edited Articles</name>
<creationDate>January 2009</creationDate>
<author>Joomla Doc Team</author>
<authorEmail>myemail@myemail.com</authorEmail>
<authorUrl>http://joomlacode.org</authorUrl>
<copyright>Copyright (c) 2009</copyright>
<license>GPL</license>
<version>1.0.0</version>
<description>Example plugin for Joomla! wiki.</description>
<files>
<filename plugin="modifyarticle">modifyarticle.php</filename>
</files>
</install>
</source>
Next, we copy the file <tt>plugins/content/example.php</tt> to <tt>modifyarticle.php</tt> and put it in the same folder outside of the Joomla! installation. Then we edit this file so it reads as follows:
<source lang="php">
<?php
/**
* @copyright Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.
* @license GNU/GPL, see LICENSE.php
*/

// Check to ensure this file is included in Joomla!
defined( '_JEXEC' ) or die( 'Restricted access' );

jimport( 'joomla.plugin.plugin' );

class plgContentModifyArticle extends JPlugin
{

/**
* Example before save content method
*
* Method is called right before content is saved into the database.
* Article object is passed by reference, so any changes will be saved!
* NOTE: Returning false will abort the save with an error.
* You can set the error by calling $article->setError($message)
*
* @param object A JTableContent object
* @param bool If the content is just about to be created
* @return bool If false, abort the save
*/
function onContentBeforeSave( $context, &$article, $isNew )
{
$user =& JFactory::getUser(); // get the user
if ($user->usertype == 'Author') { // unpublish if user is "Author"
$article->state = 0; // from dev 11:59
}
return true;
}
}
</source>
Notice that the <tt>example.php</tt> file has six methods plus the constructor. These document the six possible events that you can use for plugins. In our example, we want to modify the article just before it is saved to the database. So we call our method (or function) "onContentBeforeSave". This method name must be exactly as shown. The name is what tells Joomla! when to run our plugin.

In standard Joomla!, when a user in the "Author" group first submits a new article, it is set to "Unpublished". However, once the article has been published, this user can edit the article and it stays published. In our example, we want to change this so that, each time an article is edited by a user in the "Author" group, it gets changed back to "Unpublished".

The code above does that. First, we get the user. Then, if the user is in the "Author" group, we change the article's "state" to zero, meaning "Unpublished". Notice that the method has <tt>$article</tt> as a parameter, so its fields and methods are all available to us.

==Install the Plugin==
Once we have the plugin coded, we need to create a zip archive so we can install it in our Joomla! site. Here are the steps:
* Use any Zip or Gzip program to make a Zip or Gzip archive of the two files created above.
* In the back end of your Joomla! site, navigate to Extensions → Install / Uninstall.
* Press Browse and find your zip archive file.
* Press Upload File and Install. You should get a message indicating that the extension was installed successfully.
* Finally, navigate to Extensions → Plugin Manager, find the new plugin (called "Modify Edited Articles" based on the name in the XML file), and enable it.
At this point, you should be able to test that it is working as expected.

==Add Standard Text==
Once we have the basic framework, changing the plugin to do other things is simple. For example, say we want to add standard text to any article submitted by a user in the "Author" group. Here is the code for the "onBeforeContentSave()" method:
<source lang="php">
function onContentBeforeSave( $context, &$article, $isNew )
{
$newText = '<p>This is my new text to add to the article.</p>';
$user =& JFactory::getUser(); // get the user
if ($user->usertype == 'Author') {
if ($article->fulltext) {
if (strpos($article->fulltext, $newText) == 0) {
$article->fulltext .= $newText;
}
}
else {
if (strpos($article->introtext, $newText) == 0) {
$article->introtext .= $newText;
}
}
}
return true;
}
</source>
In this code, we have some standard text we put in the <tt>$newText</tt> variable. Then we deal with a complication of the <tt>$article</tt> object. Joomla! articles can have an optional "Read more..." break. If they don't have one, the entire text of the article is in the <tt>introtext</tt> field. If there is a "Read more..." break, then the part of the article after the break is in the <tt>fulltext</tt> field.

So, in the code, we have to handle both cases. If there is something in <tt>fulltext</tt>, then we add the standard text there. Otherwise, we add it to <tt>introtext</tt>.

There is one other complication. We don't want to add the standard text if it already there. Otherwise, we would keep adding more copies of it each time the article is edited. So we test to see if it already part of the article's text and we only add it if it isn't already there.

Notice that the second parameter of this method is <tt>$isNew</tt>. This is a boolean that is <tt>true</tt> if this is a new article. So we could test for that if we only wanted to add the text for new article submissions.

==Set the Section or Category==
Setting the Section or Category ID of an article is very easy. For example, in the Sample Website, this code
<source lang="php">
$article->sectionid = '4';
$article->catid = '25';
</source>
would change the article's Section to "About Joomla!" and Category to "The Project". Note that you need to use the "id" fields for the Section and Category. In this example, you also might want to remove these fields from the front-end form (by using a [[How_to_override_the_output_from_the_Joomla!_core|template override]])

==Other Things We Can Do==
It is useful to understand that any of the article's fields are available here. Below is a partial list:
* title: article's title
* alias: article's alias
* state: 0 for unpublished, 1 for published, -1 for archived
* created: date created
* created_by: user id of author
* created_by_alias: author alias field
* modified: date last modified
* modified_by: user id of last author to modify
* metakey: Metadata Information / Keywords
* metadesc: Metadata Information / Description
* access: 0 for public, 1 for registered, 2 for special

Also, there are other built-in events we can use for plugins, see [https://docs.joomla.org/Plugin/Events/Content Plugin Events Content docs] for more info. These are documented in the <tt>plugins/content/example.php</tt> file. In addition, there are other plugin types. See the [[Developers#Plugins|plugins section of the Wiki]] for more information.

[[Category:Tips and tricks]]
[[Category:Tips and tricks 1.5]]

Make changes to an article automatically using a plugin

2020-09-01T14:23:42Z

AndyGaskell:

==Overview==
Plugins are the simplest extensions to write. A simple plugin requires only two files. Yet plugins can be extremely handy.

One common case for using plugins is doing some customized processing every time an article is saved. For example:
* Change the published state of an article.
* Add standard text to articles.
* Set the Section or Category for an article.

Let's see how you can use a simple plugin to do these types of tasks.

==First Plugin==
A simple plugin has two files. One is an XML file that tells Joomla! how to install the plugin. The other is the actual plugin PHP code.

To make it as easy as possible for people to write plugins, Joomla! includes example plugins in every installation. In our example, we are writing a "content" plugin, since we are working with articles. So the two example files we can use as guidelines are <tt>plugins/content/example.xml</tt> amd <tt>plugins/content/example.php</tt>.

The XML file for our example is called <tt>modifyarticle.xml</tt>. We just copied the file <tt>plugins/content/example.xml</tt> to <tt>modifyarticle.xml</tt> and put it in a new folder outside of the Joomla! installation. (''We will use the Joomla! install program later on to add this to our Joomla! system. So for now we want to keep this separate from Joomla!.'') Then we edited it as follows:
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install version="1.5" type="plugin" group="content">
<name>Modify Edited Articles</name>
<creationDate>January 2009</creationDate>
<author>Joomla Doc Team</author>
<authorEmail>myemail@myemail.com</authorEmail>
<authorUrl>http://joomlacode.org</authorUrl>
<copyright>Copyright (c) 2009</copyright>
<license>GPL</license>
<version>1.0.0</version>
<description>Example plugin for Joomla! wiki.</description>
<files>
<filename plugin="modifyarticle">modifyarticle.php</filename>
</files>
</install>
</source>
Next, we copy the file <tt>plugins/content/example.php</tt> to <tt>modifyarticle.php</tt> and put it in the same folder outside of the Joomla! installation. Then we edit this file so it reads as follows:
<source lang="php">
<?php
/**
* @copyright Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.
* @license GNU/GPL, see LICENSE.php
*/

// Check to ensure this file is included in Joomla!
defined( '_JEXEC' ) or die( 'Restricted access' );

jimport( 'joomla.plugin.plugin' );

class plgContentModifyArticle extends JPlugin
{

/**
* Example before save content method
*
* Method is called right before content is saved into the database.
* Article object is passed by reference, so any changes will be saved!
* NOTE: Returning false will abort the save with an error.
* You can set the error by calling $article->setError($message)
*
* @param object A JTableContent object
* @param bool If the content is just about to be created
* @return bool If false, abort the save
*/
function onContentBeforeSave( $context, &$article, $isNew )
{
$user =& JFactory::getUser(); // get the user
if ($user->usertype == 'Author') { // unpublish if user is "Author"
$article->state = 0; // from dev 11:59
}
return true;
}
}
</source>
Notice that the <tt>example.php</tt> file has six methods plus the constructor. These document the six possible events that you can use for plugins. In our example, we want to modify the article just before it is saved to the database. So we call our method (or function) "onContentBeforeSave". This method name must be exactly as shown. The name is what tells Joomla! when to run our plugin.

In standard Joomla!, when a user in the "Author" group first submits a new article, it is set to "Unpublished". However, once the article has been published, this user can edit the article and it stays published. In our example, we want to change this so that, each time an article is edited by a user in the "Author" group, it gets changed back to "Unpublished".

The code above does that. First, we get the user. Then, if the user is in the "Author" group, we change the article's "state" to zero, meaning "Unpublished". Notice that the method has <tt>$article</tt> as a parameter, so its fields and methods are all available to us.

==Install the Plugin==
Once we have the plugin coded, we need to create a zip archive so we can install it in our Joomla! site. Here are the steps:
* Use any Zip or Gzip program to make a Zip or Gzip archive of the two files created above.
* In the back end of your Joomla! site, navigate to Extensions → Install / Uninstall.
* Press Browse and find your zip archive file.
* Press Upload File and Install. You should get a message indicating that the extension was installed successfully.
* Finally, navigate to Extensions → Plugin Manager, find the new plugin (called "Modify Edited Articles" based on the name in the XML file), and enable it.
At this point, you should be able to test that it is working as expected.

==Add Standard Text==
Once we have the basic framework, changing the plugin to do other things is simple. For example, say we want to add standard text to any article submitted by a user in the "Author" group. Here is the code for the "onBeforeContentSave()" method:
<source lang="php">
function onContentBeforeSave( $context, &$article, $isNew )
{
$newText = '<p>This is my new text to add to the article.</p>';
$user =& JFactory::getUser(); // get the user
if ($user->usertype == 'Author') {
if ($article->fulltext) {
if (strpos($article->fulltext, $newText) == 0) {
$article->fulltext .= $newText;
}
}
else {
if (strpos($article->introtext, $newText) == 0) {
$article->introtext .= $newText;
}
}
}
return true;
}
</source>
In this code, we have some standard text we put in the <tt>$newText</tt> variable. Then we deal with a complication of the <tt>$article</tt> object. Joomla! articles can have an optional "Read more..." break. If they don't have one, the entire text of the article is in the <tt>introtext</tt> field. If there is a "Read more..." break, then the part of the article after the break is in the <tt>fulltext</tt> field.

So, in the code, we have to handle both cases. If there is something in <tt>fulltext</tt>, then we add the standard text there. Otherwise, we add it to <tt>introtext</tt>.

There is one other complication. We don't want to add the standard text if it already there. Otherwise, we would keep adding more copies of it each time the article is edited. So we test to see if it already part of the article's text and we only add it if it isn't already there.

Notice that the second parameter of this method is <tt>$isNew</tt>. This is a boolean that is <tt>true</tt> if this is a new article. So we could test for that if we only wanted to add the text for new article submissions.

==Set the Section or Category==
Setting the Section or Category ID of an article is very easy. For example, in the Sample Website, this code
<source lang="php">
$article->sectionid = '4';
$article->catid = '25';
</source>
would change the article's Section to "About Joomla!" and Category to "The Project". Note that you need to use the "id" fields for the Section and Category. In this example, you also might want to remove these fields from the front-end form (by using a [[How_to_override_the_output_from_the_Joomla!_core|template override]])

==Other Things We Can Do==
It is useful to understand that any of the article's fields are available here. Below is a partial list:
* title: article's title
* alias: article's alias
* state: 0 for unpublished, 1 for published, -1 for archived
* created: date created
* created_by: user id of author
* created_by_alias: author alias field
* modified: date last modified
* modified_by: user id of last author to modify
* metakey: Metadata Information / Keywords
* metadesc: Metadata Information / Description
* access: 0 for public, 1 for registered, 2 for special

Also, there are other built-in events we can use for plugins, see [https://docs.joomla.org/Plugin/Events/Content|Plugin Events Content docs] for more info. These are documented in the <tt>plugins/content/example.php</tt> file. In addition, there are other plugin types. See the [[Developers#Plugins|plugins section of the Wiki]] for more information.

[[Category:Tips and tricks]]
[[Category:Tips and tricks 1.5]]

Make changes to an article automatically using a plugin

2020-09-01T14:23:12Z

AndyGaskell:

==Overview==
Plugins are the simplest extensions to write. A simple plugin requires only two files. Yet plugins can be extremely handy.

One common case for using plugins is doing some customized processing every time an article is saved. For example:
* Change the published state of an article.
* Add standard text to articles.
* Set the Section or Category for an article.

Let's see how you can use a simple plugin to do these types of tasks.

==First Plugin==
A simple plugin has two files. One is an XML file that tells Joomla! how to install the plugin. The other is the actual plugin PHP code.

To make it as easy as possible for people to write plugins, Joomla! includes example plugins in every installation. In our example, we are writing a "content" plugin, since we are working with articles. So the two example files we can use as guidelines are <tt>plugins/content/example.xml</tt> amd <tt>plugins/content/example.php</tt>.

The XML file for our example is called <tt>modifyarticle.xml</tt>. We just copied the file <tt>plugins/content/example.xml</tt> to <tt>modifyarticle.xml</tt> and put it in a new folder outside of the Joomla! installation. (''We will use the Joomla! install program later on to add this to our Joomla! system. So for now we want to keep this separate from Joomla!.'') Then we edited it as follows:
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install version="1.5" type="plugin" group="content">
<name>Modify Edited Articles</name>
<creationDate>January 2009</creationDate>
<author>Joomla Doc Team</author>
<authorEmail>myemail@myemail.com</authorEmail>
<authorUrl>http://joomlacode.org</authorUrl>
<copyright>Copyright (c) 2009</copyright>
<license>GPL</license>
<version>1.0.0</version>
<description>Example plugin for Joomla! wiki.</description>
<files>
<filename plugin="modifyarticle">modifyarticle.php</filename>
</files>
</install>
</source>
Next, we copy the file <tt>plugins/content/example.php</tt> to <tt>modifyarticle.php</tt> and put it in the same folder outside of the Joomla! installation. Then we edit this file so it reads as follows:
<source lang="php">
<?php
/**
* @copyright Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.
* @license GNU/GPL, see LICENSE.php
*/

// Check to ensure this file is included in Joomla!
defined( '_JEXEC' ) or die( 'Restricted access' );

jimport( 'joomla.plugin.plugin' );

class plgContentModifyArticle extends JPlugin
{

/**
* Example before save content method
*
* Method is called right before content is saved into the database.
* Article object is passed by reference, so any changes will be saved!
* NOTE: Returning false will abort the save with an error.
* You can set the error by calling $article->setError($message)
*
* @param object A JTableContent object
* @param bool If the content is just about to be created
* @return bool If false, abort the save
*/
function onContentBeforeSave( $context, &$article, $isNew )
{
$user =& JFactory::getUser(); // get the user
if ($user->usertype == 'Author') { // unpublish if user is "Author"
$article->state = 0; // from dev 11:59
}
return true;
}
}
</source>
Notice that the <tt>example.php</tt> file has six methods plus the constructor. These document the six possible events that you can use for plugins. In our example, we want to modify the article just before it is saved to the database. So we call our method (or function) "onContentBeforeSave". This method name must be exactly as shown. The name is what tells Joomla! when to run our plugin.

In standard Joomla!, when a user in the "Author" group first submits a new article, it is set to "Unpublished". However, once the article has been published, this user can edit the article and it stays published. In our example, we want to change this so that, each time an article is edited by a user in the "Author" group, it gets changed back to "Unpublished".

The code above does that. First, we get the user. Then, if the user is in the "Author" group, we change the article's "state" to zero, meaning "Unpublished". Notice that the method has <tt>$article</tt> as a parameter, so its fields and methods are all available to us.

==Install the Plugin==
Once we have the plugin coded, we need to create a zip archive so we can install it in our Joomla! site. Here are the steps:
* Use any Zip or Gzip program to make a Zip or Gzip archive of the two files created above.
* In the back end of your Joomla! site, navigate to Extensions → Install / Uninstall.
* Press Browse and find your zip archive file.
* Press Upload File and Install. You should get a message indicating that the extension was installed successfully.
* Finally, navigate to Extensions → Plugin Manager, find the new plugin (called "Modify Edited Articles" based on the name in the XML file), and enable it.
At this point, you should be able to test that it is working as expected.

==Add Standard Text==
Once we have the basic framework, changing the plugin to do other things is simple. For example, say we want to add standard text to any article submitted by a user in the "Author" group. Here is the code for the "onBeforeContentSave()" method:
<source lang="php">
function onContentBeforeSave( $context, &$article, $isNew )
{
$newText = '<p>This is my new text to add to the article.</p>';
$user =& JFactory::getUser(); // get the user
if ($user->usertype == 'Author') {
if ($article->fulltext) {
if (strpos($article->fulltext, $newText) == 0) {
$article->fulltext .= $newText;
}
}
else {
if (strpos($article->introtext, $newText) == 0) {
$article->introtext .= $newText;
}
}
}
return true;
}
</source>
In this code, we have some standard text we put in the <tt>$newText</tt> variable. Then we deal with a complication of the <tt>$article</tt> object. Joomla! articles can have an optional "Read more..." break. If they don't have one, the entire text of the article is in the <tt>introtext</tt> field. If there is a "Read more..." break, then the part of the article after the break is in the <tt>fulltext</tt> field.

So, in the code, we have to handle both cases. If there is something in <tt>fulltext</tt>, then we add the standard text there. Otherwise, we add it to <tt>introtext</tt>.

There is one other complication. We don't want to add the standard text if it already there. Otherwise, we would keep adding more copies of it each time the article is edited. So we test to see if it already part of the article's text and we only add it if it isn't already there.

Notice that the second parameter of this method is <tt>$isNew</tt>. This is a boolean that is <tt>true</tt> if this is a new article. So we could test for that if we only wanted to add the text for new article submissions.

==Set the Section or Category==
Setting the Section or Category ID of an article is very easy. For example, in the Sample Website, this code
<source lang="php">
$article->sectionid = '4';
$article->catid = '25';
</source>
would change the article's Section to "About Joomla!" and Category to "The Project". Note that you need to use the "id" fields for the Section and Category. In this example, you also might want to remove these fields from the front-end form (by using a [[How_to_override_the_output_from_the_Joomla!_core|template override]])

==Other Things We Can Do==
It is useful to understand that any of the article's fields are available here. Below is a partial list:
* title: article's title
* alias: article's alias
* state: 0 for unpublished, 1 for published, -1 for archived
* created: date created
* created_by: user id of author
* created_by_alias: author alias field
* modified: date last modified
* modified_by: user id of last author to modify
* metakey: Metadata Information / Keywords
* metadesc: Metadata Information / Description
* access: 0 for public, 1 for registered, 2 for special

Also, there are other built-in events we can use for plugins, see [[https://docs.joomla.org/Plugin/Events/Content|Plugin Events Content docs]] for more info. These are documented in the <tt>plugins/content/example.php</tt> file. In addition, there are other plugin types. See the [[Developers#Plugins|plugins section of the Wiki]] for more information.

[[Category:Tips and tricks]]
[[Category:Tips and tricks 1.5]]

Make changes to an article automatically using a plugin

2020-09-01T14:22:37Z

AndyGaskell:

==Overview==
Plugins are the simplest extensions to write. A simple plugin requires only two files. Yet plugins can be extremely handy.

One common case for using plugins is doing some customized processing every time an article is saved. For example:
* Change the published state of an article.
* Add standard text to articles.
* Set the Section or Category for an article.

Let's see how you can use a simple plugin to do these types of tasks.

==First Plugin==
A simple plugin has two files. One is an XML file that tells Joomla! how to install the plugin. The other is the actual plugin PHP code.

To make it as easy as possible for people to write plugins, Joomla! includes example plugins in every installation. In our example, we are writing a "content" plugin, since we are working with articles. So the two example files we can use as guidelines are <tt>plugins/content/example.xml</tt> amd <tt>plugins/content/example.php</tt>.

The XML file for our example is called <tt>modifyarticle.xml</tt>. We just copied the file <tt>plugins/content/example.xml</tt> to <tt>modifyarticle.xml</tt> and put it in a new folder outside of the Joomla! installation. (''We will use the Joomla! install program later on to add this to our Joomla! system. So for now we want to keep this separate from Joomla!.'') Then we edited it as follows:
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install version="1.5" type="plugin" group="content">
<name>Modify Edited Articles</name>
<creationDate>January 2009</creationDate>
<author>Joomla Doc Team</author>
<authorEmail>myemail@myemail.com</authorEmail>
<authorUrl>http://joomlacode.org</authorUrl>
<copyright>Copyright (c) 2009</copyright>
<license>GPL</license>
<version>1.0.0</version>
<description>Example plugin for Joomla! wiki.</description>
<files>
<filename plugin="modifyarticle">modifyarticle.php</filename>
</files>
</install>
</source>
Next, we copy the file <tt>plugins/content/example.php</tt> to <tt>modifyarticle.php</tt> and put it in the same folder outside of the Joomla! installation. Then we edit this file so it reads as follows:
<source lang="php">
<?php
/**
* @copyright Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.
* @license GNU/GPL, see LICENSE.php
*/

// Check to ensure this file is included in Joomla!
defined( '_JEXEC' ) or die( 'Restricted access' );

jimport( 'joomla.plugin.plugin' );

class plgContentModifyArticle extends JPlugin
{

/**
* Example before save content method
*
* Method is called right before content is saved into the database.
* Article object is passed by reference, so any changes will be saved!
* NOTE: Returning false will abort the save with an error.
* You can set the error by calling $article->setError($message)
*
* @param object A JTableContent object
* @param bool If the content is just about to be created
* @return bool If false, abort the save
*/
function onContentBeforeSave( $context, &$article, $isNew )
{
$user =& JFactory::getUser(); // get the user
if ($user->usertype == 'Author') { // unpublish if user is "Author"
$article->state = 0; // from dev 11:59
}
return true;
}
}
</source>
Notice that the <tt>example.php</tt> file has six methods plus the constructor. These document the six possible events that you can use for plugins. In our example, we want to modify the article just before it is saved to the database. So we call our method (or function) "onContentBeforeSave". This method name must be exactly as shown. The name is what tells Joomla! when to run our plugin.

In standard Joomla!, when a user in the "Author" group first submits a new article, it is set to "Unpublished". However, once the article has been published, this user can edit the article and it stays published. In our example, we want to change this so that, each time an article is edited by a user in the "Author" group, it gets changed back to "Unpublished".

The code above does that. First, we get the user. Then, if the user is in the "Author" group, we change the article's "state" to zero, meaning "Unpublished". Notice that the method has <tt>$article</tt> as a parameter, so its fields and methods are all available to us.

==Install the Plugin==
Once we have the plugin coded, we need to create a zip archive so we can install it in our Joomla! site. Here are the steps:
* Use any Zip or Gzip program to make a Zip or Gzip archive of the two files created above.
* In the back end of your Joomla! site, navigate to Extensions → Install / Uninstall.
* Press Browse and find your zip archive file.
* Press Upload File and Install. You should get a message indicating that the extension was installed successfully.
* Finally, navigate to Extensions → Plugin Manager, find the new plugin (called "Modify Edited Articles" based on the name in the XML file), and enable it.
At this point, you should be able to test that it is working as expected.

==Add Standard Text==
Once we have the basic framework, changing the plugin to do other things is simple. For example, say we want to add standard text to any article submitted by a user in the "Author" group. Here is the code for the "onBeforeContentSave()" method:
<source lang="php">
function onContentBeforeSave( $context, &$article, $isNew )
{
$newText = '<p>This is my new text to add to the article.</p>';
$user =& JFactory::getUser(); // get the user
if ($user->usertype == 'Author') {
if ($article->fulltext) {
if (strpos($article->fulltext, $newText) == 0) {
$article->fulltext .= $newText;
}
}
else {
if (strpos($article->introtext, $newText) == 0) {
$article->introtext .= $newText;
}
}
}
return true;
}
</source>
In this code, we have some standard text we put in the <tt>$newText</tt> variable. Then we deal with a complication of the <tt>$article</tt> object. Joomla! articles can have an optional "Read more..." break. If they don't have one, the entire text of the article is in the <tt>introtext</tt> field. If there is a "Read more..." break, then the part of the article after the break is in the <tt>fulltext</tt> field.

So, in the code, we have to handle both cases. If there is something in <tt>fulltext</tt>, then we add the standard text there. Otherwise, we add it to <tt>introtext</tt>.

There is one other complication. We don't want to add the standard text if it already there. Otherwise, we would keep adding more copies of it each time the article is edited. So we test to see if it already part of the article's text and we only add it if it isn't already there.

Notice that the second parameter of this method is <tt>$isNew</tt>. This is a boolean that is <tt>true</tt> if this is a new article. So we could test for that if we only wanted to add the text for new article submissions.

==Set the Section or Category==
Setting the Section or Category ID of an article is very easy. For example, in the Sample Website, this code
<source lang="php">
$article->sectionid = '4';
$article->catid = '25';
</source>
would change the article's Section to "About Joomla!" and Category to "The Project". Note that you need to use the "id" fields for the Section and Category. In this example, you also might want to remove these fields from the front-end form (by using a [[How_to_override_the_output_from_the_Joomla!_core|template override]])

==Other Things We Can Do==
It is useful to understand that any of the article's fields are available here. Below is a partial list:
* title: article's title
* alias: article's alias
* state: 0 for unpublished, 1 for published, -1 for archived
* created: date created
* created_by: user id of author
* created_by_alias: author alias field
* modified: date last modified
* modified_by: user id of last author to modify
* metakey: Metadata Information / Keywords
* metadesc: Metadata Information / Description
* access: 0 for public, 1 for registered, 2 for special

Also, there are other built-in events we can use for plugins, see [[https://docs.joomla.org/Plugin/Events/Content|Plugin/Events/Content docs]] for more info. These are documented in the <tt>plugins/content/example.php</tt> file. In addition, there are other plugin types. See the [[Developers#Plugins|plugins section of the Wiki]] for more information.

[[Category:Tips and tricks]]
[[Category:Tips and tricks 1.5]]

Make changes to an article automatically using a plugin

2020-09-01T14:21:54Z

AndyGaskell:

==Overview==
Plugins are the simplest extensions to write. A simple plugin requires only two files. Yet plugins can be extremely handy.

One common case for using plugins is doing some customized processing every time an article is saved. For example:
* Change the published state of an article.
* Add standard text to articles.
* Set the Section or Category for an article.

Let's see how you can use a simple plugin to do these types of tasks.

==First Plugin==
A simple plugin has two files. One is an XML file that tells Joomla! how to install the plugin. The other is the actual plugin PHP code.

To make it as easy as possible for people to write plugins, Joomla! includes example plugins in every installation. In our example, we are writing a "content" plugin, since we are working with articles. So the two example files we can use as guidelines are <tt>plugins/content/example.xml</tt> amd <tt>plugins/content/example.php</tt>.

The XML file for our example is called <tt>modifyarticle.xml</tt>. We just copied the file <tt>plugins/content/example.xml</tt> to <tt>modifyarticle.xml</tt> and put it in a new folder outside of the Joomla! installation. (''We will use the Joomla! install program later on to add this to our Joomla! system. So for now we want to keep this separate from Joomla!.'') Then we edited it as follows:
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install version="1.5" type="plugin" group="content">
<name>Modify Edited Articles</name>
<creationDate>January 2009</creationDate>
<author>Joomla Doc Team</author>
<authorEmail>myemail@myemail.com</authorEmail>
<authorUrl>http://joomlacode.org</authorUrl>
<copyright>Copyright (c) 2009</copyright>
<license>GPL</license>
<version>1.0.0</version>
<description>Example plugin for Joomla! wiki.</description>
<files>
<filename plugin="modifyarticle">modifyarticle.php</filename>
</files>
</install>
</source>
Next, we copy the file <tt>plugins/content/example.php</tt> to <tt>modifyarticle.php</tt> and put it in the same folder outside of the Joomla! installation. Then we edit this file so it reads as follows:
<source lang="php">
<?php
/**
* @copyright Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.
* @license GNU/GPL, see LICENSE.php
*/

// Check to ensure this file is included in Joomla!
defined( '_JEXEC' ) or die( 'Restricted access' );

jimport( 'joomla.plugin.plugin' );

class plgContentModifyArticle extends JPlugin
{

/**
* Example before save content method
*
* Method is called right before content is saved into the database.
* Article object is passed by reference, so any changes will be saved!
* NOTE: Returning false will abort the save with an error.
* You can set the error by calling $article->setError($message)
*
* @param object A JTableContent object
* @param bool If the content is just about to be created
* @return bool If false, abort the save
*/
function onContentBeforeSave( $context, &$article, $isNew )
{
$user =& JFactory::getUser(); // get the user
if ($user->usertype == 'Author') { // unpublish if user is "Author"
$article->state = 0; // from dev 11:59
}
return true;
}
}
</source>
Notice that the <tt>example.php</tt> file has six methods plus the constructor. These document the six possible events that you can use for plugins. In our example, we want to modify the article just before it is saved to the database. So we call our method (or function) "onContentBeforeSave". This method name must be exactly as shown. The name is what tells Joomla! when to run our plugin.

In standard Joomla!, when a user in the "Author" group first submits a new article, it is set to "Unpublished". However, once the article has been published, this user can edit the article and it stays published. In our example, we want to change this so that, each time an article is edited by a user in the "Author" group, it gets changed back to "Unpublished".

The code above does that. First, we get the user. Then, if the user is in the "Author" group, we change the article's "state" to zero, meaning "Unpublished". Notice that the method has <tt>$article</tt> as a parameter, so its fields and methods are all available to us.

==Install the Plugin==
Once we have the plugin coded, we need to create a zip archive so we can install it in our Joomla! site. Here are the steps:
* Use any Zip or Gzip program to make a Zip or Gzip archive of the two files created above.
* In the back end of your Joomla! site, navigate to Extensions → Install / Uninstall.
* Press Browse and find your zip archive file.
* Press Upload File and Install. You should get a message indicating that the extension was installed successfully.
* Finally, navigate to Extensions → Plugin Manager, find the new plugin (called "Modify Edited Articles" based on the name in the XML file), and enable it.
At this point, you should be able to test that it is working as expected.

==Add Standard Text==
Once we have the basic framework, changing the plugin to do other things is simple. For example, say we want to add standard text to any article submitted by a user in the "Author" group. Here is the code for the "onBeforeContentSave()" method:
<source lang="php">
function onContentBeforeSave( $context, &$article, $isNew )
{
$newText = '<p>This is my new text to add to the article.</p>';
$user =& JFactory::getUser(); // get the user
if ($user->usertype == 'Author') {
if ($article->fulltext) {
if (strpos($article->fulltext, $newText) == 0) {
$article->fulltext .= $newText;
}
}
else {
if (strpos($article->introtext, $newText) == 0) {
$article->introtext .= $newText;
}
}
}
return true;
}
</source>
In this code, we have some standard text we put in the <tt>$newText</tt> variable. Then we deal with a complication of the <tt>$article</tt> object. Joomla! articles can have an optional "Read more..." break. If they don't have one, the entire text of the article is in the <tt>introtext</tt> field. If there is a "Read more..." break, then the part of the article after the break is in the <tt>fulltext</tt> field.

So, in the code, we have to handle both cases. If there is something in <tt>fulltext</tt>, then we add the standard text there. Otherwise, we add it to <tt>introtext</tt>.

There is one other complication. We don't want to add the standard text if it already there. Otherwise, we would keep adding more copies of it each time the article is edited. So we test to see if it already part of the article's text and we only add it if it isn't already there.

Notice that the second parameter of this method is <tt>$isNew</tt>. This is a boolean that is <tt>true</tt> if this is a new article. So we could test for that if we only wanted to add the text for new article submissions.

==Set the Section or Category==
Setting the Section or Category ID of an article is very easy. For example, in the Sample Website, this code
<source lang="php">
$article->sectionid = '4';
$article->catid = '25';
</source>
would change the article's Section to "About Joomla!" and Category to "The Project". Note that you need to use the "id" fields for the Section and Category. In this example, you also might want to remove these fields from the front-end form (by using a [[How_to_override_the_output_from_the_Joomla!_core|template override]])

==Other Things We Can Do==
It is useful to understand that any of the article's fields are available here. Below is a partial list:
* title: article's title
* alias: article's alias
* state: 0 for unpublished, 1 for published, -1 for archived
* created: date created
* created_by: user id of author
* created_by_alias: author alias field
* modified: date last modified
* modified_by: user id of last author to modify
* metakey: Metadata Information / Keywords
* metadesc: Metadata Information / Description
* access: 0 for public, 1 for registered, 2 for special

Also, there are other built-in events we can use for plugins, see [[https://docs.joomla.org/Plugin/Events/Content]] for more info. These are documented in the <tt>plugins/content/example.php</tt> file. In addition, there are other plugin types. See the [[Developers#Plugins|plugins section of the Wiki]] for more information.

[[Category:Tips and tricks]]
[[Category:Tips and tricks 1.5]]

Make changes to an article automatically using a plugin

2020-09-01T14:12:47Z

AndyGaskell: updating from onBeforeContentSave to onContentBeforeSave and removing support for php4

==Overview==
Plugins are the simplest extensions to write. A simple plugin requires only two files. Yet plugins can be extremely handy.

One common case for using plugins is doing some customized processing every time an article is saved. For example:
* Change the published state of an article.
* Add standard text to articles.
* Set the Section or Category for an article.

Let's see how you can use a simple plugin to do these types of tasks.

==First Plugin==
A simple plugin has two files. One is an XML file that tells Joomla! how to install the plugin. The other is the actual plugin PHP code.

To make it as easy as possible for people to write plugins, Joomla! includes example plugins in every installation. In our example, we are writing a "content" plugin, since we are working with articles. So the two example files we can use as guidelines are <tt>plugins/content/example.xml</tt> amd <tt>plugins/content/example.php</tt>.

The XML file for our example is called <tt>modifyarticle.xml</tt>. We just copied the file <tt>plugins/content/example.xml</tt> to <tt>modifyarticle.xml</tt> and put it in a new folder outside of the Joomla! installation. (''We will use the Joomla! install program later on to add this to our Joomla! system. So for now we want to keep this separate from Joomla!.'') Then we edited it as follows:
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install version="1.5" type="plugin" group="content">
<name>Modify Edited Articles</name>
<creationDate>January 2009</creationDate>
<author>Joomla Doc Team</author>
<authorEmail>myemail@myemail.com</authorEmail>
<authorUrl>http://joomlacode.org</authorUrl>
<copyright>Copyright (c) 2009</copyright>
<license>GPL</license>
<version>1.0.0</version>
<description>Example plugin for Joomla! wiki.</description>
<files>
<filename plugin="modifyarticle">modifyarticle.php</filename>
</files>
</install>
</source>
Next, we copy the file <tt>plugins/content/example.php</tt> to <tt>modifyarticle.php</tt> and put it in the same folder outside of the Joomla! installation. Then we edit this file so it reads as follows:
<source lang="php">
<?php
/**
* @copyright Copyright (C) 2005 - 2008 Open Source Matters. All rights reserved.
* @license GNU/GPL, see LICENSE.php
*/

// Check to ensure this file is included in Joomla!
defined( '_JEXEC' ) or die( 'Restricted access' );

jimport( 'joomla.plugin.plugin' );

class plgContentModifyArticle extends JPlugin
{

/**
* Example before save content method
*
* Method is called right before content is saved into the database.
* Article object is passed by reference, so any changes will be saved!
* NOTE: Returning false will abort the save with an error.
* You can set the error by calling $article->setError($message)
*
* @param object A JTableContent object
* @param bool If the content is just about to be created
* @return bool If false, abort the save
*/
function onContentBeforeSave( $context, &$article, $isNew )
{
$user =& JFactory::getUser(); // get the user
if ($user->usertype == 'Author') { // unpublish if user is "Author"
$article->state = 0; // from dev 11:59
}
return true;
}
}
</source>
Notice that the <tt>example.php</tt> file has six methods plus the constructor. These document the six possible events that you can use for plugins. In our example, we want to modify the article just before it is saved to the database. So we call our method (or function) "onContentBeforeSave". This method name must be exactly as shown. The name is what tells Joomla! when to run our plugin.

In standard Joomla!, when a user in the "Author" group first submits a new article, it is set to "Unpublished". However, once the article has been published, this user can edit the article and it stays published. In our example, we want to change this so that, each time an article is edited by a user in the "Author" group, it gets changed back to "Unpublished".

The code above does that. First, we get the user. Then, if the user is in the "Author" group, we change the article's "state" to zero, meaning "Unpublished". Notice that the method has <tt>$article</tt> as a parameter, so its fields and methods are all available to us.

==Install the Plugin==
Once we have the plugin coded, we need to create a zip archive so we can install it in our Joomla! site. Here are the steps:
* Use any Zip or Gzip program to make a Zip or Gzip archive of the two files created above.
* In the back end of your Joomla! site, navigate to Extensions → Install / Uninstall.
* Press Browse and find your zip archive file.
* Press Upload File and Install. You should get a message indicating that the extension was installed successfully.
* Finally, navigate to Extensions → Plugin Manager, find the new plugin (called "Modify Edited Articles" based on the name in the XML file), and enable it.
At this point, you should be able to test that it is working as expected.

==Add Standard Text==
Once we have the basic framework, changing the plugin to do other things is simple. For example, say we want to add standard text to any article submitted by a user in the "Author" group. Here is the code for the "onBeforeContentSave()" method:
<source lang="php">
function onContentBeforeSave( $context, &$article, $isNew )
{
$newText = '<p>This is my new text to add to the article.</p>';
$user =& JFactory::getUser(); // get the user
if ($user->usertype == 'Author') {
if ($article->fulltext) {
if (strpos($article->fulltext, $newText) == 0) {
$article->fulltext .= $newText;
}
}
else {
if (strpos($article->introtext, $newText) == 0) {
$article->introtext .= $newText;
}
}
}
return true;
}
</source>
In this code, we have some standard text we put in the <tt>$newText</tt> variable. Then we deal with a complication of the <tt>$article</tt> object. Joomla! articles can have an optional "Read more..." break. If they don't have one, the entire text of the article is in the <tt>introtext</tt> field. If there is a "Read more..." break, then the part of the article after the break is in the <tt>fulltext</tt> field.

So, in the code, we have to handle both cases. If there is something in <tt>fulltext</tt>, then we add the standard text there. Otherwise, we add it to <tt>introtext</tt>.

There is one other complication. We don't want to add the standard text if it already there. Otherwise, we would keep adding more copies of it each time the article is edited. So we test to see if it already part of the article's text and we only add it if it isn't already there.

Notice that the second parameter of this method is <tt>$isNew</tt>. This is a boolean that is <tt>true</tt> if this is a new article. So we could test for that if we only wanted to add the text for new article submissions.

==Set the Section or Category==
Setting the Section or Category ID of an article is very easy. For example, in the Sample Website, this code
<source lang="php">
$article->sectionid = '4';
$article->catid = '25';
</source>
would change the article's Section to "About Joomla!" and Category to "The Project". Note that you need to use the "id" fields for the Section and Category. In this example, you also might want to remove these fields from the front-end form (by using a [[How_to_override_the_output_from_the_Joomla!_core|template override]])

==Other Things We Can Do==
It is useful to understand that any of the article's fields are available here. Below is a partial list:
* title: article's title
* alias: article's alias
* state: 0 for unpublished, 1 for published, -1 for archived
* created: date created
* created_by: user id of author
* created_by_alias: author alias field
* modified: date last modified
* modified_by: user id of last author to modify
* metakey: Metadata Information / Keywords
* metadesc: Metadata Information / Description
* access: 0 for public, 1 for registered, 2 for special

Also, there are other built-in events we can use for plugins. These are documented in the <tt>plugins/content/example.php</tt> file. In addition, there are other plugin types. See the [[Developers#Plugins|plugins section of the Wiki]] for more information.

[[Category:Tips and tricks]]
[[Category:Tips and tricks 1.5]]

Inserting, Updating and Removing data using JDatabase

2020-06-08T10:21:10Z

AndyGaskell: insertid

J3.x:Duplicate usernames cause update issue

2020-04-11T16:45:54Z

AndyGaskell: note on how to remove all users who have never visited the site

<noinclude><languages /></noinclude>
<translate> In some websites, updating to Joomla 3.9.16 results in a database error due to duplicated usernames. If this happens do not panic - the upgrade has been mostly completed without issue and is operating as usual, the remaining database change can be applied after following the instructions below.</translate>

<translate>
==Errors reported== 
</translate>
<translate> Users receive an update error regarding a failed database query due to a duplicated key in their site's</translate> <source lang="sql" inline>#__users</source> <translate> table when upgrading from Joomla 3.9.15 or older.</translate>
[[File:76331128-c6389180-62ff-11ea-81d6-14cd3e5ab28d.png|thumb|Joomla 3.9.16 Upgrade Error]]

<translate>
==Versions affected== 
</translate>
{{tip|<translate> This pertains only to Joomla! version(s):</translate> '''3.9.16'''|title=<translate> General Information</translate>}}

<translate>
==What is the cause== 
</translate>
<translate> Your website has more than one user in the</translate> <source lang="sql" inline>#__users</source> <translate> table with the same username, which is a security concern in that the incorrect account may be accessed by the wrong account owner.</translate>

<translate>
==How to fix== 
</translate>
<translate> You will need to review your</translate> <source lang="sql" inline>#__users</source> <translate> table in your database and fix any duplicated usernames by either removing old user accounts or changing the username until all usernames are unique. Once this is finished, if you have already upgraded to 3.9.16 run the database schema fixer tool to finish the upgrade (this step is not required if you do this review prior to upgrading).</translate>

<translate> Joomla is unable to automatically determine the correct action to take and as a result is unable to perform this step for you - it has to be fixed by you as the site owner.</translate>

<translate> The following SQL Query can be run on your database to view which usernames are duplicated. Replace the placeholder <code>#__</code> with the table prefix of your Joomla database before you run it:</translate>

<source lang="sql" inline>SELECT username FROM #__users GROUP BY username HAVING COUNT(*) > 1</source>

<translate>One possible way to make resolving this simpler might be to remove all users who have never visited the site. Though this should be done with care, and ensure to backup the table first. After running this query, you can check again how many duplicate users you have.</translate>

<source lang="sql" inline>DELETE FROM #__users WHERE lastvisitDate = "0000-00-00 00:00:00"</source>

__NOTOC__

<noinclude>
[[Category:Version 3.9 FAQ{{#translation:}}]]
[[Category:Version 3.9.16 FAQ{{#translation:}}]]
[[Category:FAQ{{#translation:}}]]
[[Category:Joomla! 3.9{{#translation:}}]]
</noinclude>

Selecting data using JDatabase

2020-02-27T12:20:22Z

AndyGaskell: typo in example

Selecting data using JDatabase

2020-02-27T12:18:38Z

AndyGaskell: adding OR clause info

File form field type

2020-01-21T15:07:09Z

AndyGaskell: mozilla link rather than w3 schools, better docs

<noinclude><languages /></noinclude>
<translate>
Provides an input field for files</translate>
<translate>
* '''type''' (mandatory) must be ''file''.</translate>
<translate>
* '''name''' (mandatory) is the unique name of the field.</translate>
<translate>
* '''label''' (mandatory) (translatable) is the descriptive title of the field.</translate>
<translate>
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.</translate>
<translate>
* '''default''' (optional) (not translatable) is the default value, but doesn't mean much for a file.</translate>
<translate>
* '''size''' (optional) is the width of the file box in characters.</translate>
<translate>
* [https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file '''accept'''] (optional) Tells the browser what MIME types your form will allow to be uploaded.</translate>
<translate>
* '''class''' (optional) is a CSS class name for the HTML form field.</translate>
<translate>
* '''labelclass''' (optional) adds a CSS class for form field's label; for Joomla 2.5.4+</translate>
<translate>
* '''disabled''' (optional) HTML equivalent attribute</translate>
<translate>
* '''onchange''' (optional) HTML equivalent attribute (javascript use)</translate>
<translate>
* '''required''' Cannot be used with this field type. If the field is marked as required it will '''always''' fail validation regardless of whether a file has been uploaded or not. The suggested workaround is to add a '''filerequired''' attribute which can be tested in your own file handling code.</translate>
<translate>
* '''validate''' (optional) Whether to Joomla validate the field according to rules</translate>
<translate>
* '''showon''' (optional) Allows you to hide the field based on the value(s) of another field; for Joomla 3.2.4+</translate>
* <translate> '''multiple''' (optional) Allows you to upload multiple files at once when set to multiple="true"</translate>

<translate>
'''Note:'''
When using the file input type you should always add the attribute enctype="multipart/form-data" to your form tag. Otherwise, the uploaded files will not be attached correctly.</translate>
<translate>
'''Note 2:'''
You can put a soft limit file size by adding a hidden field with name="MAX_FILE_SIZE" and value the maximum allowed bytes which is handled by php, but you must also handle it in your code with or without it.</translate>

<translate>
Example XML field definition:</translate>

<source lang="xml">
<field name="myfilevalue" type="file" label="Enter some text" description="Choose an image from your computer with maximum 100KB" size="10" accept="image/*" />
</source>

<translate>=== See also === </translate>
<translate>
* [[S:MyLanguage/Standard form field types|List of standard form field types]]
* [[S:MyLanguage/How_to_use_the_filesystem_package|How to use the filesystem package]]
</translate>

<noinclude>
<translate>

[[Category:Standard form field types]]
[[Category:Form fields]]
[[Category:Development]]
</translate>
</noinclude>

Accessing the current user object

2019-07-14T13:05:06Z

AndyGaskell: /* Determining Status */

{{version/tutor|2.5,3.x}}
== Basics ==

For every request in Joomla!, there is one user. Information about this user is readily available through the Joomla! framework in the form of an object. To get this object for the current user, use the following member function of JFactory:

<source lang="php">
$user = JFactory::getUser();
</source>

Or, to get information about any other registered user you can call the function with a user 'id', e.g. for user '99';

<source lang="php">
$user = JFactory::getUser(99);
</source>

Getting a reference through getUser() ensures that only one user object is created during any one Joomla! request, saving on memory and processing time. Most of the information about the user is available through public member variables of the user object. This code displays the current user's name, email, user name and user type:

<source lang="php">
echo "<p>Your name is {$user->name}, your email is {$user->email}, and your username is {$user->username}</p>";
</source>
'''Note:''' Since version 1.6 Joomla has a flexible ACL system, which makes $user->usertype deprecated!

The usertype field in #__users will only contain values for users that have been migrated from Joomla 1.5, but for new created users the field will be empty.

Use $user->groups to retrieve an array with all the IDs that refer to the groups (from #__usergroups table) of a user.

== Object Member Variables and Parameters ==

These are the relevant member variables automatically generated on a call to getUser():
* id - The unique, numerical user id. Use this when referencing the user record in other database tables.
* name - The name of the user. (e.g. Vint Cerf)
* username - The login/screen name of the user. (e.g. shmuffin1979)
* email - The email address of the user. (e.g. crashoverride@hackers.com)
* password - The encrypted version of the user's password
* password_clear - Set to the user's password only when it is being changed. Otherwise, remains blank.
* usertype - <strike>The role of the user within Joomla!. (Super Administrator, Editor, etc...)</strike> Has been deprecated since Joomla 1.6. Use $user->groups to retrieve an array with all the roles of a user.
* groups - Set to the user's group ids.
* block - Set to '1' when the user is set to 'blocked' in Joomla!.
* registerDate - Set to the date when the user was first registered.
* lastvisitDate - Set to the date the user last visited the site.
* guest - If the user is not logged in, this variable will be set to '1'. The other variables will be unset or default values.
* lastResetTime - Set to the last time the password was reset.
* resetCount - Counts the number of password resets.

In addition to the member variables (which are stored in the database in columns), there are parameters for the user that hold preferences. To get one of these parameters, call the getParam() member function of the user object, passing in the name of the parameter you want along with a default value in case it is blank.

<source lang="php">
$user = JFactory::getUser();
$language = $user->getParam('language', 'the default');

echo "<p>Your language is set to {$language}.</p>";
</source>

== Determining Status ==

Frequently, you will just want to make sure the user is logged in before continuing. The 'guest' property will be set to '1' when the current user is not logged in. When the user is authenticated, 'guest' will be set to '0'.

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

if ($user->guest) {
echo "<p>You must login to see the content. I want your email address.</p>";
} else {
echo "<p>You are logged in, you can see the content.</p>";
}
</source>

== Privileges ==
Not all users are given equal rights. For instance, a Super Administrator may be able to edit anyone's content, while a Publisher may only be able to edit their own. The authorise() member function can be used to determine if the current user has permission to do a certain task. The first parameter is used to identify which task we wish to check being allowed. The second represents the component we wish to retrieve the ACL information from.

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

if ($user->authorise('core.edit', 'com_content'))
{
echo "<p>You may edit all content.</p>";
}
else
{
echo "<p>You may not edit all content.</p>";
}

if ($user->authorise('core.edit.own', 'com_content'))
{
echo "<p>You may edit your own content.</p>";
}
else
{
echo "<p>You may not edit your own content.</p>";
}
</source>

== Summary ==

Information about the current user is readily available in any part of your Joomla! extension. You need only fetch the object and access the member variables. You can authorise the user against the core permissions set, or create your own to suit your needs.

== External Links ==

[https://api.joomla.org/cms-3/classes/Joomla.CMS.Factory.html#method_getUser Joomla 3.9 API reference]
[[Category:Development]]
[[Category:Tutorials]][[Category:Framework]]
[[Category:Module Development]]
[[Category:Plugin Development]][[Category:Component Development]]

Accessing the current user object

2019-07-14T13:04:33Z

AndyGaskell: /* Determining Status */

Accessing the current user object

2019-07-14T13:03:25Z

AndyGaskell: /* Determining Status */

{{version/tutor|2.5,3.x}}
== Basics ==

For every request in Joomla!, there is one user. Information about this user is readily available through the Joomla! framework in the form of an object. To get this object for the current user, use the following member function of JFactory:

<source lang="php">
$user = JFactory::getUser();
</source>

Or, to get information about any other registered user you can call the function with a user 'id', e.g. for user '99';

<source lang="php">
$user = JFactory::getUser(99);
</source>

Getting a reference through getUser() ensures that only one user object is created during any one Joomla! request, saving on memory and processing time. Most of the information about the user is available through public member variables of the user object. This code displays the current user's name, email, user name and user type:

<source lang="php">
echo "<p>Your name is {$user->name}, your email is {$user->email}, and your username is {$user->username}</p>";
</source>
'''Note:''' Since version 1.6 Joomla has a flexible ACL system, which makes $user->usertype deprecated!

The usertype field in #__users will only contain values for users that have been migrated from Joomla 1.5, but for new created users the field will be empty.

Use $user->groups to retrieve an array with all the IDs that refer to the groups (from #__usergroups table) of a user.

== Object Member Variables and Parameters ==

These are the relevant member variables automatically generated on a call to getUser():
* id - The unique, numerical user id. Use this when referencing the user record in other database tables.
* name - The name of the user. (e.g. Vint Cerf)
* username - The login/screen name of the user. (e.g. shmuffin1979)
* email - The email address of the user. (e.g. crashoverride@hackers.com)
* password - The encrypted version of the user's password
* password_clear - Set to the user's password only when it is being changed. Otherwise, remains blank.
* usertype - <strike>The role of the user within Joomla!. (Super Administrator, Editor, etc...)</strike> Has been deprecated since Joomla 1.6. Use $user->groups to retrieve an array with all the roles of a user.
* groups - Set to the user's group ids.
* block - Set to '1' when the user is set to 'blocked' in Joomla!.
* registerDate - Set to the date when the user was first registered.
* lastvisitDate - Set to the date the user last visited the site.
* guest - If the user is not logged in, this variable will be set to '1'. The other variables will be unset or default values.
* lastResetTime - Set to the last time the password was reset.
* resetCount - Counts the number of password resets.

In addition to the member variables (which are stored in the database in columns), there are parameters for the user that hold preferences. To get one of these parameters, call the getParam() member function of the user object, passing in the name of the parameter you want along with a default value in case it is blank.

<source lang="php">
$user = JFactory::getUser();
$language = $user->getParam('language', 'the default');

echo "<p>Your language is set to {$language}.</p>";
</source>

== Determining Status ==

Frequently, you will just want to make sure the user is logged in before continuing. The 'guest' property will be set to '1' when the current user is not logged in. When the user is authenticated, 'guest' will be set to '0'.

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

if ($user->guest) {
echo "<p>You must login to see the content. I want your email address.</p>";
} else {
?>
<h1>Impromptu leftovers salad that goes well with fish</h1>
<ul>
<li>1/2 cup chopped celery</li>
<li>1/4 cup raisins</li>
<li>1 teaspoon Extra Virgin Olive Oil</li>
<li>2 tablespoons of faux Thai lemongrass marinade</li>
<li>1/4 cup shredded fresh basil</li>
<li>Sprinkling of dill weed</li>
<li>Big pinch of kosher salt</li>
<li>Several lettuce leaves</li>
</ul>

<p>Wash the lettuce and basil and place in a salad bowl.
Get out a much smaller bowl and swish around all of the remaining ingredients.
Pour this over the greens and toss.
Serves two.</p>
<?php
}
</source>

== Privileges ==
Not all users are given equal rights. For instance, a Super Administrator may be able to edit anyone's content, while a Publisher may only be able to edit their own. The authorise() member function can be used to determine if the current user has permission to do a certain task. The first parameter is used to identify which task we wish to check being allowed. The second represents the component we wish to retrieve the ACL information from.

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

if ($user->authorise('core.edit', 'com_content'))
{
echo "<p>You may edit all content.</p>";
}
else
{
echo "<p>You may not edit all content.</p>";
}

if ($user->authorise('core.edit.own', 'com_content'))
{
echo "<p>You may edit your own content.</p>";
}
else
{
echo "<p>You may not edit your own content.</p>";
}
</source>

== Summary ==

Information about the current user is readily available in any part of your Joomla! extension. You need only fetch the object and access the member variables. You can authorise the user against the core permissions set, or create your own to suit your needs.

== External Links ==

[https://api.joomla.org/cms-3/classes/Joomla.CMS.Factory.html#method_getUser Joomla 3.9 API reference]
[[Category:Development]]
[[Category:Tutorials]][[Category:Framework]]
[[Category:Module Development]]
[[Category:Plugin Development]][[Category:Component Development]]

How can you view a live site while developing, but hide it from others?

2018-09-20T10:54:00Z

AndyGaskell:

{{version|2.5,3.x}}=== Introduction ===

The method described below should be used for relatively minor modifications, such as adjusting menus or quickly reorganizing content sections. More complex tasks, such as installing new components or adjusting complex configuration settings should be performed and tested on a development server first. Not only does this keep your public site up and running, but it also lets you test at your leisure, thus reducing errors. One way to do it is to create a sub-domain (i. e., dev.yourdomain.com) and install Joomla! there just as it is installed on your public site.

See also [[Taking the website temporarily offline]].

=== Directions ===

# Log in to the [[Back-end]], and choose: Site > Global Configuration.
# The first option you'll see is is to set the site offline. Choose "Yes" and press the Save button. This will prevent display of all site pages and replace them with the following message:
#: <pre>This site is down for maintenance. Please check back again soon.</pre>
# While you are logged into the Back-end administrator system, you can still view the Front-end, by
#* {{JVer|3.x}}: clicking the site name in the top left corner
#* {{JVer|2.5}}: clicking the Preview link in the top right corner
#: This will display the site as it would appear to users along with a warning at the top that the site is down for maintenance.

<noinclude>[[Category:FAQ]]
[[Category:Administration FAQ]]
[[Category:Getting Started FAQ]]
[[Category:Version 2.5 FAQ]]
[[Category:Version 3.0 FAQ]]
[[Category:Version 3.1 FAQ]]
[[Category:Component Development]]</noinclude>

How can you view a live site while developing, but hide it from others?

2018-09-20T10:52:46Z

AndyGaskell:

{{version|2.5,3.x}}=== Introduction ===

The method described below should be used for relatively minor modifications, such as adjusting menus or quickly reorganizing content sections. More complex tasks, such as installing new components or adjusting complex configuration settings should be performed and tested on a development server first. Not only does this keep your public site up and running, but it also lets you test at your leisure, thus reducing errors. One way to do it is to create a sub-domain (i. e., dev.yourdomain.com) and install Joomla! there just as it is installed on your public site.

See also [[Taking_the_website_temporarily_offline]].

=== Directions ===

# Log in to the [[Back-end]], and choose: Site > Global Configuration.
# The first option you'll see is is to set the site offline. Choose "Yes" and press the Save button. This will prevent display of all site pages and replace them with the following message:
#: <pre>This site is down for maintenance. Please check back again soon.</pre>
# While you are logged into the Back-end administrator system, you can still view the Front-end, by
#* {{JVer|3.x}}: clicking the site name in the top left corner
#* {{JVer|2.5}}: clicking the Preview link in the top right corner
#: This will display the site as it would appear to users along with a warning at the top that the site is down for maintenance.

<noinclude>[[Category:FAQ]]
[[Category:Administration FAQ]]
[[Category:Getting Started FAQ]]
[[Category:Version 2.5 FAQ]]
[[Category:Version 3.0 FAQ]]
[[Category:Version 3.1 FAQ]]
[[Category:Component Development]]</noinclude>

File form field type

2018-04-30T11:29:31Z

AndyGaskell: adding link to file-system docs

<noinclude><languages /></noinclude>
<translate>
Provides an input field for files</translate>
<translate>
* '''type''' (mandatory) must be ''file''.</translate>
<translate>
* '''name''' (mandatory) is the unique name of the field.</translate>
<translate>
* '''label''' (mandatory) (translatable) is the descriptive title of the field.</translate>
<translate>
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.</translate>
<translate>
* '''default''' (optional) (not translatable) is the default value, but doesn't mean much for a file.</translate>
<translate>
* '''size''' (optional) is the width of the file box in characters.</translate>
<translate>
* [http://www.w3schools.com/tags/att_input_accept.asp '''accept'''] (optional) Tells the browser what MIME types your form will allow to be uploaded.</translate>
<translate>
* '''class''' (optional) is a CSS class name for the HTML form field.</translate>
<translate>
* '''labelclass''' (optional) adds a CSS class for form field's label; for Joomla 2.5.4+</translate>
<translate>
* '''disabled''' (optional) HTML equivalent attribute</translate>
<translate>
* '''onchange''' (optional) HTML equivalent attribute (javascript use)</translate>
<translate>
* '''required''' Cannot be used with this field type. If the field is marked as required it will '''always''' fail validation regardless of whether a file has been uploaded or not. The suggested workaround is to add a '''filerequired''' attribute which can be tested in your own file handling code.</translate>
<translate>
* '''validate''' (optional) Whether to Joomla validate the field according to rules</translate>
<translate>
* '''showon''' (optional) Allows you to hide the field based on the value(s) of another field; for Joomla 3.2.4+</translate>

<translate>
'''Note:'''
When using the file input type you should always add the attribute enctype="multipart/form-data" to your form tag. Otherwise, the uploaded files will not be attached correctly.</translate>
<translate>
'''Note 2:'''
You can put a soft limit file size by adding a hidden field with name="MAX_FILE_SIZE" and value the maximum allowed bytes which is handled by php, but you must also handle it in your code with or without it.</translate>

<translate>
Example XML field definition:</translate>

<source lang="xml">
<field name="myfilevalue" type="file" label="Enter some text" description="Choose an image from your computer with maximum 100KB" size="10" accept="image/*" />
</source>

<translate>=== See also === </translate>
<translate>
* [[S:MyLanguage/Standard form field types|List of standard form field types]]
* [[S:MyLanguage/How_to_use_the_filesystem_package|How to use the filesystem package]]
</translate>

<noinclude>
<translate>

[[Category:Standard form field types]]
[[Category:Form fields]]
[[Category:Development]]
</translate>
</noinclude>

Talk:Radio form field type

2017-05-16T12:54:05Z

AndyGaskell: Created page with "Not sure if the values have to be numeric, they are in the three examples, be good to explain here."

Not sure if the values have to be numeric, they are in the three examples, be good to explain here.

J3.x:Adding JavaScript and CSS to the page

2017-03-23T10:43:22Z

AndyGaskell: removing deprecated jhtml notes, as this was removed in joomla 3 in 2012, so is now not relevant

<noinclude><languages /></noinclude>

<translate>
== Inserting from a File == 
</translate>
<translate>
To have a well-formed HTML document, you must put all references to Javascript and CSS files within the <code><head></code> portion. Since Joomla! generates all the HTML that makes up a page before output, it is possible to add these references within the <head> tags from your extension. The simplest way to do this is to make use of the functionality built in to Joomla.</translate>

<translate>
===JDocument=== 
</translate>

<translate>
First, get a reference to the current document object:</translate>

<source lang="php">
$document = JFactory::getDocument();
</source>

<translate>
Then for a stylesheet, use this code:</translate>

<source lang="php">
$document->addStyleSheet($url);
</source>

<translate>
To add a Javascript file, use this code:</translate>

<source lang="php">
$document->addScript($url);
</source>

<translate>
where <code>$url</code> is the variable containing the full path to the javascript or CSS file for example:</translate>
<code>JUri::base() . 'templates/custom/js/sample.js'</code>

<translate>
Note this will **NOT** include Mootools or jQuery. If your script requires Mootools or jQuery see [[S:MyLanguage/Javascript_Frameworks|Javascript Frameworks]] for full details on how to include them (note jQuery can only be included natively on Joomla! 3.0+).</translate>

<translate>
It used to be possible to do this with JHTML, however, this was deprecated in Joomla 2.5 and removed in Joomla 3.x.
</translate>

<translate>
== Adding the options to your JavaScript code == 
</translate>
{{Joomla version|version=3.7|time=and after|comment=<translate>
Only available in Joomla! 3.7 and higher</translate>|align=left}}
<translate>
Beside adding inline scripts, Joomla! provide mechanism to store the options in the "optionsStorage".
This is allowed to nicely manage an existing options on the server side and on the client side. And allow to place all JavaScript logic to the JavaScript file, that will be cached by browser.</translate>

<translate>
Joomla! use special mechanism for "lazy loading" the options on the client side. It do not use inline JavaScript, that is good for page rendering speed, and make your site more friendly for the Speed Tester (eg Google).</translate>

<translate>
Thus use "optionsStorage" preferred, than use inline JavaScript to add the script options.</translate>

<translate>
'''Example of use'''</translate>

<translate>
Add the script options to your module:</translate>
<source lang="php">
$document = JFactory::getDocument();
$document->addScriptOptions('mod_example',
'colors' => array('selector' => 'body', 'color' => 'orange'),
'sliderOptions' => array('selector' => '.my-slider', 'timeout' => 300, 'fx' => 'fade'),
));
</source>

<translate>
Access to your options on the client side:</translate>
<source lang="javascript">
var myOptions = Joomla.getOptions('mod_example');
console.log(myOptions.colors); // Print in the browser console your options
console.log(myOptions.sliderOptions);
</source>

<translate>
Override the options on server side (possible until the head rendering):</translate>
<source lang="php">
$document = JFactory::getDocument();
// Get existing options
$myOptions = $document->getScriptOptions('mod_example');
// Change the value
$myOptions['colors'] = array('selector' => 'body', 'color' => 'green');
// Set new options
$document->addScriptOptions('mod_example', $myOptions);
</source>

<translate>
== Inserting inline scripts from within a PHP file == 
</translate>
<translate>
If your Javascript or CSS are generated using PHP, you can add the script or stylesheet directly into the head of your document:</translate>

<source lang="php">
$document = JFactory::getDocument();

// Add Javascript
$document->addScriptDeclaration('
window.event("domready", function() {
alert("An inline JavaScript Declaration");
});
');

// Add styles
$style = 'body {'
. 'background: #00ff00;'
. 'color: rgb(0,0,255);'
. '}';
$document->addStyleDeclaration($style);
</source>

<translate>
=== Javascript Example === 
For example, the following code is used to define a custom tool tip that takes advantage of mootools.</translate>

<source lang="php">
function getToolTipJS($toolTipVarName, $toolTipClassName){
$javascript = 'window.addEvent(\"domready\", function(){' ."\n";
$javascript .= "\t" .'var $toolTipVarName = new Tips($$("' . $toolTipVarName .'"), {' ."\n";
$javascript .= "\t\t" .'className: "' .$toolTipClassName .'",' ."\n";
$javascript .= "\t\t" .'initialize: function(){' ."\n";
$javascript .= "\t\t\t" .'this.fx = new Fx.Style(this.toolTip, "opacity", {duration: 500, wait: false}).set(0);' ."\n";
$javascript .= "\t\t" .'},' ."\n";
$javascript .= "\t\t" .'onShow: function(toolTip){' ."\n";
$javascript .= "\t\t\t" .'this.fx.start(1);' ."\n";
$javascript .= "\t\t" .'},' ."\n";
$javascript .= "\t\t" .'onHide: function(toolTip) {' ."\n";
$javascript .= "\t\t\t" .'this.fx.start(0);' ."\n";
$javascript .= "\t\t" .'}' ."\n";
$javascript .= "\t" .'});' ."\n";
$javascript .= '});' ."\n\n";
return $javascript;
}

$document = JFactory::getDocument();
$document->addStyleSheet("/joomla/components/com_mycustomcomponent/css/mytooltip.css",'text/css',"screen");
$document->addScriptDeclaration(getToolTipJS("mytool","MyToolTip"));
</source>

<translate>
Note that in order for this Javascript to be functionally useful, it would be necessary to include the appropriate class name in the HTML, as well as providing the <code>mytooltip.css</code> file. Both are outside the scope of this article.</translate>

<translate>
=== CSS Examples === 
</translate>
<translate>
This is also useful if your inserting a form field of CSS into your code. For example in a module, you might want a user to choose to call the colour of the border. After calling the form fields value and assigning it a variable $bordercolor in mod_example.php. Then in tmpl/default.php you can include the following:</translate>

<source lang="php">
$document = JFactory::getDocument();
$document->addStyleSheet('mod_example/mod_example.css', array(), true);
$style = '#example {
border-color:#' . $bordercolor . ';
}';
$document->addStyleDeclaration( $style );
</source>

<translate>
Here mod_example.css contains the CSS file of any non-parameter based styles. Then the bordercolor parameter/form field is added in separately.</translate>

<translate>
==Add Custom Tag== 
</translate>
<translate>
There will be some occasions where even these functions are not flexible enough, as they are limited to writing the contents of <code><script /></code> or <code><style /></code> tags, and cannot add anything outside those tags. One example would be the inclusion of a stylesheet link within conditional comments, so that it is picked up only by Internet Explorer 6 and earlier. To do this, use <code>$document->addCustomTag</code>:</translate>

<source lang="php">
$stylelink = '' ."\n";

$document = JFactory::getDocument();
$document->addCustomTag($stylelink);
</source>

<noinclude>
<translate>

[[Category:Development]]
[[Category:Tutorials]]
[[Category:Component Development]]
[[Category:Module Development]]
[[Category:JavaScript]]
[[Category:CSS]]
</translate>
</noinclude>

Textarea form field type

2017-02-17T10:05:22Z

AndyGaskell: adding hint / placeholder

<noinclude><languages /></noinclude>
<translate>
The '''textarea''' form field type provides a text area for entry of multi-line text. If the field has a value saved, this value is displayed when the page is first loaded. If not, the default value (if any) is selected.</translate>
[[Image:Params.textarea.jpg|right]]
<translate>
* '''type''' (mandatory) must be ''textarea''.</translate>
<translate>
* '''name''' (mandatory) is the unique name of the field.</translate>
<translate>
* '''label''' (mandatory) (translatable) is the descriptive title of the field.</translate>
<translate>
* '''rows''' (mandatory) is the height of the visible text area in lines. If omitted the height is determined by the browser. The value of rows does not limit the number of lines that may be entered.</translate>
<translate>
* '''cols''' (mandatory) is the width of the visible text area in characters. If omitted the width is determined by the browser. The value of cols does not limit the number of characters that may be entered.</translate>
<translate>
* '''default''' (optional) (not translatable) is the default value.</translate>
<translate>
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.</translate>
<translate>
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'text_area'.</translate>
<translate>
* '''filter''' (optional) allow the system to save certain html tags or raw data.</translate>
<translate>
* '''hint''' (optional) The text displayed in the html placeholder element, usually a lighter coloured hint displayed inside an blank field.</translate>

<translate>
Example XML field definition:</translate>
<source lang="xml"><field name="mytextarea" type="textarea" default="default" label="Enter some text" description="" rows="10" cols="5" /></source>
<translate>
Use the raw filter to ensure that html code is preserved when the form is processed:</translate>
<source lang="xml"><field name="mytextarea" type="textarea" default="default" label="Enter some html" description="" rows="10" cols="5" filter="raw"/></source>
<translate>=== Tips === </translate>
<translate>
* If you need to line break just encode <code><br /></code> in the XML config file like this:</translate> <code>&lt;br /&gt;</code>
<translate>
* If you need a new line character in your default value, add <code>&#13;&#10;</code> to the default parameter.</translate>
<translate>=== See also === </translate>
<translate>
* [[S:MyLanguage/Text form field type|Text form field type]]
* [[S:MyLanguage/Standard form field types|List of standard form field types]]</translate>

<noinclude>
<translate>

[[Category:Standard form field types]]
</translate>
</noinclude>

Text form field type

2017-02-17T10:04:40Z

AndyGaskell: adding hint / placeholder

<noinclude><languages /></noinclude>

<translate>
The '''text''' form field type provides a text box for data entry. If the field has a value saved, this value is displayed when the page is first loaded. If not, the default value (if any) is selected.</translate>
[[Image:Params.text.jpg|right]]
<translate>
* '''type''' (mandatory) must be ''text''.</translate>
<translate>
* '''name''' (mandatory) is the unique name of the field.</translate>
<translate>
* '''label''' (mandatory) (translatable) is the descriptive title of the field.</translate>
<translate>
* '''size''' (optional) is the width of the text box in characters. If omitted the width is determined by the browser. The value of size does not limit the number of characters that may be entered.</translate>
<translate>
* '''maxlength''' (optional) limits the number of characters that may be entered.</translate>
<translate>
* '''default''' (optional) (not translatable) is the default value.</translate>
<translate>
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.</translate>
<translate>
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'text_area'.</translate>
<translate>
* '''readonly''' (optional) The field cannot be changed and will automatically inherit the default value</translate>
<translate>
* '''disabled''' (optional) The field cannot be changed and will automatically inherit the default value - it will also not submit</translate>
<translate>
* '''required''' (optional) The field must be filled before submitting the form.</translate>
<translate>
* '''filter''' (optional) allow the system to save certain html tags or raw data.</translate>
<translate>
* '''message''' (optional) The error message that will be displayed instead of the default message.</translate>
<translate>
* '''hint''' (optional) The text displayed in the html placeholder element, usually a lighter coloured hint displayed inside an blank field.</translate>

<translate>
Example XML field definition:</translate>
<source lang="xml"><field name="mytextvalue" type="text" default="Some text" label="Enter some text" description="" size="10" /></source>

<translate>
Use the integer filter to ensure that letters types get stripped when the form is processed.</translate>
<source lang="xml"><field name="myintvalue" type="text" default="8" label="Enter some text" description="Enter some description" filter="integer" /></source>

<translate>
Use the raw filter to ensure that html code is preserved when the form is processed.</translate>
<source lang="xml"><field name="myhtmlvalue" type="text" default="" label="Enter some text" description="Enter some description" filter="raw" /></source>

<translate>=== See also === </translate>
<translate>

* [[S:MyLanguage/Textarea form field type|Textarea form field type]]
* [[S:MyLanguage/Standard form field types|List of standard form field types]]
</translate>

<noinclude>
<translate>

[[Category:Standard form field types]]
</translate>
</noinclude>

Portal:Learn More

2017-02-17T01:10:22Z

AndyGaskell: adding a link, seemed a useful example

<languages/>
<translate>

Joomla! is an [[S:MyLanguage/Joomla! Awards|award-winning content management system (CMS)]], which enables you to build Web sites and powerful online applications. Many aspects, including its ease-of-use and extensibility, have made Joomla! the most popular Web site software available. Best of all, Joomla! is an open source solution that is freely available to everyone, this also means that you can modify the source code according to your needs and gain maximum advantage.

==What's a content management system (CMS)?== 


A content management system is software that keeps track of every piece of content on your Web site, much like your local public library keeps track of books and stores them. Content can be simple text, photos, music, video, documents, or just about anything you can think of. A major advantage of using a CMS is that it requires almost no technical skill or knowledge to manage. The CMS manages all your content, so you don't have to. CMS also helps you track your content easily and help you develop and manage your content in the best possible way.

==What are some real world examples of what Joomla! can do?== 


Joomla is used all over the world to power Web sites of all shapes and sizes. For example:

*Corporate Web sites or portals
*Corporate intranets and extranets
*Online magazines, newspapers, and publications
*E-commerce and online reservations
*Government applications
*Small business Web sites
*Non-profit and organizational Web sites
*Community-based portals
*School and church Web sites
*Personal or family homepages

==Who uses Joomla?== 


Here are just a few examples of Web sites that use Joomla:


*Salon sukni ślubnych (Bridal Fashion - Polish) - http://www.mlodaimoda.pl/
*Alliance for Catholic Education - https://ace.nd.edu/
*Alain Milliat (Juices and Marmelades - France) - http://www.alain-milliat.com/
*Citibank (Financial institution intranet) - Not publicly accessible
*La Folie Douce - http://www.lafoliedouce.com/
*United Nations Regional Information Centre (UNRIC) - http://www.unric.org/
*FUNX (Radiostation - Netherlands) - http://www.funx.nl/
*PlayShakespeare.com (Cultural) - http://www.playshakespeare.com
*Cheap Wine Band (Music - German) - http://www.cheapwineband.de/
*Royal Dornoch Golf Club, est 1621 (Sport - Golf) - http://royaldornoch.com/


More examples of companies using Joomla! can be found in the [http://community.joomla.org/showcase/ Joomla! Community Site Showcase].
For Government sites using Joomla, view http://joomlagov.info.

==I need to build a site for a client. How will Joomla! help me?== 

</translate>[[File:Help30-Content-Article-Manager-screen.png|400px|right|link=]]<translate>

Joomla! is designed to be easy to install and set up even if you're not an advanced user. Many Web hosting services offer a single-click install or auto installers, getting your new site up and running in just a few minutes.


Since Joomla is so easy to use, as a [[S:MyLanguage/Web designers|Web designer]] or [[S:MyLanguage/Portal:Developers|Developer]], you can quickly build sites for your clients. Then, with a minimal amount of instruction, you can empower your clients to easily manage their own sites themselves.


If your clients need specialized functionality, Joomla! is highly extensible and thousands of extensions (most for free under the GPL license) are available in the [http://extensions.joomla.org/ Joomla! Extensions Directory].
</translate>{{-}}<translate>

==How can I be sure there will be Joomla! support in the future?== 

</translate>[[File:Winner - Best CMS.png|right|80px|link=]]<translate>

Joomla! is the most popular open source CMS currently available as evidenced by a vibrant and growing community of friendly users and talented developers. Joomla's roots go back to 2000 and, with over 200,000 community users and contributors, the future looks bright for the award-winning Joomla! Project.
</translate>{{-}}<translate>

==I'm a developer. What are some advanced ways I can use Joomla?== 

</translate>[[File:MVC Diagram.png|right|350px|link=]]<translate>

Many companies and organizations have requirements that go beyond what is available in the basic Joomla! package. In those cases, Joomla's powerful application framework makes it easy for developers to create sophisticated add-ons that extend the power of Joomla! into virtually unlimited directions.


The core Joomla framework enables developers to quickly and easily build:


*Inventory control systems
*Data reporting tools
*Application bridges
*Custom product catalogs
*Integrated e-commerce systems
*Complex business directories
*Reservation systems
*Communication tools


Since Joomla! is based on PHP and MySQL, you're building powerful applications on an open platform anyone can use, share, and support. To find out more information on leveraging the Joomla! framework, visit the [http://developer.joomla.org/ Joomla! Developer Network].

==Joomla! seems the right solution for me. How do I get started?== 


Joomla! is free, open, and available to anyone under the [http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GPL license]. Read [http://www.joomla.org/about-joomla/getting-started.html Getting Started with Joomla!] to find out the basics then [http://demo.joomla.org/ try out our online demo] and you'll quickly discover how simple Joomla! is. If you're ready to install Joomla, download the latest version [http://www.joomla.org/download.html here]. You'll be up and running in no time by following the [[S:MyLanguage/J3.x:Installing_Joomla|Installing Joomla!]] instructions.
</translate>
<div class="large-6 column" style="text-align:center">[[File:Test Drive Joomla.png|link=http://demo.joomla.org/]]</div>
<div class="large-6 column" style="text-align:center">[[File:Download Joomla.png|link=http://www.joomla.org/download.html]]</div>
{{-}}
<translate>
== Credits and Thanks == 


Producing world class Open Source software takes a lot of active support from community members and partnering businesses.


* [http://developer.joomla.org/tracker/volunteer-activity.html Volunteer Activity] for Joomla! project.
* [[S:MyLanguage/Joomla! Credits and Thanks|Partnering Businesses]]
</translate>

<translate>

[[Category:Landing Pages]]
[[Category:Learn More Pages|Learn More Pages]]
</translate>

Custom error pages

2016-08-22T10:06:07Z

AndyGaskell: adding info on including modules in error pages

<noinclude><languages /></noinclude>
<noinclude>{{JSplit}}</noinclude>
<translate>

Joomla! uses the <tt>templates/system/error.php</tt> file to handle several HTTP Status errors, including "403 Forbidden", "404 Not Found", and "500 Internal Server" errors. You can style the error results, if desired.
</translate>

<translate>

It is important to understand that ''error.php'' is an independent file from the Joomla! CMS but dependent on the Joomla! Platform. Plugins do not run on the file. You cannot include modules or use <tt><jdoc:include></tt> statements.
</translate>

<translate>
====Overriding the System Error Results==== 
To override the system error results, copy the <tt>templates/system/error.php</tt> file into your <tt>templates/<template-name></tt> directory.
</translate>

<translate>

If it finds one, Joomla! will use the <tt>error.php</tt> file from the current template, in place of the system file.
</translate>

<translate>
You can format the page, as desired, to match your template.</translate>

<translate>
====Overriding the System Styling==== 
If you want to change the styling, copy the <tt>templates/system/css/error.css</tt> file into your <tt>templates/<template-name>/css</tt> directory.
</translate>
<translate>

Next, update your <tt>templates/<template-name>/error.php</tt> file to reference the new location of the stylesheet by changing this line, accordingly:
</translate>

<source lang="css"><link rel="stylesheet" href="<?php echo $this->baseurl; ?>/templates/system/css/error.css" type="text/css" /></source>

<translate>
Then, simply change the <tt>error.css</tt>, as desired, for your styling requirements.</translate>

<translate>
====Customizing Error Messages==== 
You can add conditional logic to vary the message returned, dependent upon the specific error code.
</translate>

<translate>

Here is an example of how to trap a 404 error and provide a custom message.
</translate>

<source lang="php">
<?php if ($this->error->getCode() == '404') { ?>
<div id="errorboxheader">Page not found</div>
<div id="errorboxbody"><p>Sorry! That page cannot be found.</p>
</div>
</div>
<?php } ?>
</source>

<translate>
====HTTP Status Code==== 
When a request is made for a page on your site, the server returns an HTTP status code in response to the request. Joomla! returns a '200 - the server successfully returned the page' for error pages. This is problematic for those working with Google Webmaster Services and trying to get a sitemap resolved.
</translate>

<translate>

If you want Joomla! to return a status code for the error, you can do so by adding logic before the DOCTYPE line, as follows:
</translate>

<source lang="php">
<?php
if ($this->error->getCode() == '404') {
header("HTTP/1.0 404 Not Found");
} ?>
</source>

<translate>
====More HTTP Status Code Information==== 
</translate>

<translate>

* [[S:MyLanguage/Create_a_Custom_404_Error_Page|Create a Custom 404 Error Page]]
* [http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html HTTP/1.1 Status Code Definitions]
* [[wikipedia:List_of_HTTP_status_codes|List of HTTP status codes]]
</translate>

<translate>
====Using Theme Header and Footer on Standard Error Page==== 
</translate>
{{JVer|1.5}}
<translate>

If you want to see the error page in theme design and don't like redirecting to error page URL or duplicating HTML in the error page template, here is a way to apply your theme template to the error page.
</translate>

<translate>

First, put the following code in <tt>templates/<template-name>/error.php</tt>:
</translate>

<source lang="php">
<?php
// no direct access
defined( '_JEXEC' ) or die( 'Restricted access' );

include dirname(__FILE__) . "/index.php";
?>

</source>

<translate>

Then make the following edits to <tt>templates/<template-name>/index.php</tt>:
</translate>

<translate>

1. Find the following code in <tt>index.php</tt>
</translate>

<source lang="php">
<jdoc:include type="head" />
</source>

<translate>

and replace it with the following
</translate>

<source lang="php">
<?php if (!$this->error->getCode()) : ?>
<jdoc:include type="head" />
<?php else : ?>
<title><?php echo $this->error->getCode() ?> - <?php echo $this->title; ?></title>
<?php endif; ?>
</source>

<translate>

2. Find the following code in <tt>index.php</tt>
</translate>

<source lang="php">
<jdoc:include type="component" />
</source>

<translate>

and replace it with the following
</translate>

<source lang="php">
<?php if ($this->error->getCode()) : /* check if we are on error page, if yes - display error message */ ?>
<p><strong><?php echo $this->error->getCode() ?> - <?php echo $this->error->message ?></strong></p>
<p><strong><?php echo JText::_('JERROR_LAYOUT_NOT_ABLE_TO_VISIT'); ?></strong></p>
<ol>
<li><?php echo JText::_('JERROR_LAYOUT_AN_OUT_OF_DATE_BOOKMARK_FAVOURITE'); ?></li>
<li><?php echo JText::_('JERROR_LAYOUT_SEARCH_ENGINE_OUT_OF_DATE_LISTING'); ?></li>
<li><?php echo JText::_('JERROR_LAYOUT_MIS_TYPED_ADDRESS'); ?></li>
<li><?php echo JText::_('JERROR_LAYOUT_YOU_HAVE_NO_ACCESS_TO_THIS_PAGE'); ?></li>
<li><?php echo JText::_('JERROR_LAYOUT_REQUESTED_RESOURCE_WAS_NOT_FOUND'); ?></li>
<li><?php echo JText::_('JERROR_LAYOUT_ERROR_HAS_OCCURRED_WHILE_PROCESSING_YOUR_REQUEST'); ?></li>
</ol>
<p><strong><?php echo JText::_('JERROR_LAYOUT_PLEASE_TRY_ONE_OF_THE_FOLLOWING_PAGES'); ?></strong></p>

<ul>
<li><a href="<?php echo $this->baseurl; ?>/index.php" title="<?php echo JText::_('JERROR_LAYOUT_GO_TO_THE_HOME_PAGE'); ?>"><?php echo JText::_('JERROR_LAYOUT_HOME_PAGE'); ?></a></li>
</ul>

<p><?php echo JText::_('JERROR_LAYOUT_PLEASE_CONTACT_THE_SYSTEM_ADMINISTRATOR'); ?>.</p>
<?php else : ?>
<jdoc:include type="component" />
<?php endif; ?>
</source>

<translate>

Now your theme template is applied to error pages too.
</translate>

<translate>

'''Note:''' Module includes in template will not work on error page created by this method (but will work on other pages).
</translate>

<translate>
====Using modules in error pages==== 
Modules cannot be included in error pages in the same way as the template's index.php because you cannot use <tt><jdoc:include></tt> statements. There is an alternative way using <tt>JModuleHelper</tt>.
</translate>

<translate>

To include a single module by title, you can use:
</translate>
<source lang="php">
if (JModuleHelper::getModule('menu')) {
echo $doc->getBuffer('module', 'menu');
}
</source>

<translate>

To include a multiple modules by position, you can use:
</translate>
<source lang="php">
$modules = JModuleHelper::getModules( 'footer_3' );
$attribs['style'] = 'xhtml';
foreach ($modules AS $module ) {
echo JModuleHelper::renderModule( $module, $attribs );
}
</source>

<noinclude>
<translate>

[[Category:Tutorials]]
[[Category:Template Development]]
</translate>
</noinclude>

J1.5:User Group Access levels explained in simple terms

2015-08-25T09:32:45Z

AndyGaskell: changed "bots" to "plugins"

{{JVer|1.5}}
== Foreword ==

''Note that this article only applies to Joomla! version 1.5. For version 1.6 and later, please see [[ACL Tutorial for Joomla 1.6]].''

I've never been able to locate a "Plain Talk" version of how Joomla's access groups work, so I thought I'd attempt to create one myself. I created this in the process of doing training documentation for a client. I hope this helps out those of you who have had a hard time finding resources to explain the concept, and I'd appreciate comments and corrections. Note: I am NOT a core dev, just a developer who wants to give something back to the community.

== Audience ==

This document is targeted at new users who have successfully completed a Joomla install and have accessed the Admin Backend, and upon creating their first, users wondered what the heck those Group levels mean!

== Access Levels ==

Joomla controls access to certain areas and features of a site through use of a basic ACL, or Access Control Level mechanism called Groups. Certain groups have certain access level features and they are directly related to the creation, editing and publishing of content (through the Frontend and Backend interfaces) as well as to access to the Administrative (Backend) interface.

Each group has different levels of access control and once a user is made a member of that group, they inherit those rights. Note that the 'Public Front-end' and 'Public Back-end' groups are merely placeholders at this point in time. They are not valid group selections at this time, but in the future, they will define the default access levels for anonymous users in the Front-end and Back-end systems.

The Joomla ACL has been completely reworked in Joomla 1.6 (released in Jan 2011) further information on the new ACL mechanis can be read here [http://docs.joomla.org/ACL_Tutorial_for_Joomla_1.6] and in many other places on-line.

There are four (4) Front-end groups available:

'''Registered''' - This group allows the user to login to the Frontend interface. Registered users can't contribute content, but this may allow them access to other areas, like a forum or download section if your site has one.

'''Author''' - This group allows a user to post content, usually via a link in the User Menu. They can submit new content, select options to show the item on the front page and select dates for publishing but they cannot directly publish any content. When content is submitted by an Author level user, they receive the message, “Thanks for your submission. Your submission will now be reviewed before being posted to the site.” They can edit only their own articles but only when that article has been published and is visible.

'''Editor''' - This group allows a user to post and edit any (not just their own) content item from the Frontend. They can also edit content that has not been published. If your site uses the default installation’s menu option “News”, which is a Table List – Content Section type, Editors will see unpublished articles in the list that they can select for editing, where as an Author or Public (unregistered) user will not even see the unpublished items in the list. Still, Editor users cannot, publish or change the publishing status of any articles, even their own.

'''Publisher''' - This group allows a user to post, edit and publish any (not just their own) content item from the Front-end. Publishers can review all articles, edit and change publishing options but the can also determine when an article is ready for publication, making it visible to Registered, Author and the Unregistered Public (depending on what visibility was chosen in the article, of course!)

There are three (3) Administration section groups that allow access to Joomla:

'''Manager''' - This group allows access to content creation and other system information from the Backend. Think of Manager users as Publishers, with Backend access. They can log in through the Administrator interface, but their rights and access are generally restricted to content management. They can create or edit any content, access to some Backend only features like adding, deleting and editing Sections and Categories, editing the Front Page and Menus, but they don’t have any access to the “Mechanics” of Joomla, like user management or the ability to install components or modules. Note that if a Manager logs in through the Frontend interface, they’re treated just like a Publisher, with the same rights and access.

'''Administrator''' - This group allows access to most administration functions. An Administrator user has all the privileges on the back end of a Manager, but they also have access to set options on, and install/delete components, modules and plugins, User Manager access and can view the site statistics. What they cannot do however is change, edit or install Site Templates or make any changes to the sites Global configuration options. On login through the Frontend, they are treated as Publishers, just like the Manger users. Interesting to note; when an Administrator accesses the User Manager list, they will see all users at their access level or below; in other words they can modify any user EXCEPT a Super Administrator – in fact, they will not even see Super Administrator accounts in the list! Also, they cannot create additional Super Administrator level accounts, only a Super Admin can do that.

'''Super Administrator''' - This group allows access to all administration functions. Only another Super Administrator can create or edit a Super Administrator user account. Full access to ALL AREAS is given to Super Administrators, and once created they cannot be as easily deleted. It might not be obvious, but you have to change the user's group to something other than Super Administrator first. Then you can delete them.

Because of this, give a bit of thought to who you need to grant this highest level of access to. Super Admins can block the user from logging in or change the password on another SA account. Like the other Backend user accounts, SA’s are treated as Publishers when they login through the Frontend interface.

== Summary ==

As mentioned previously, the Joomla ACL has been completely re-written for Joomla! 1.6 to provide new features and greater control.

Many third-party extensions exist to extend the Joomla ACL, but due diligence should be exercised with ANY ACL extension – not only in how it affects currently available extensions for Joomla, but also how it may or may not cooperate with future releases of Joomla.

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

Sending email from extensions

2015-03-31T05:24:18Z

AndyGaskell: /* Set a Sender */ joomla 3 tweak

{{version|2.5,3.1}}
This is an example of how to send an email from a component. You would typically put this into your component's controller.
=== Fetch the Mail Object ===
A reference to the global mail object (JMail) is fetched through the JFactory object. This is the object creating our mail.

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

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

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

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

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

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

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

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

If we had multiple recipients, we would put each recipient's email address in an array.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Talk:Git for Coders

2015-02-11T11:36:40Z

AndyGaskell:

sovainfo: When you clone from your fork should you not remote add upstream joomla instead of joomla-developer?

@sovainfo: yes, you are correct! I fixed it. [[User:Dextercowley|Mark Dexter]] ([[User talk:Dextercowley|talk]]) 21:43, 19 October 2012 (CDT)

AndyGaskell: maybe this would be better split into two articles, one for command line and one for eclipse. I found it a bit hard to follow with the two interleaved. Just an idea, great content, thanks.

Selecting data using JDatabase

2014-12-16T13:32:36Z

AndyGaskell: fix of previous edit

Selecting data using JDatabase

2014-12-16T13:31:50Z

AndyGaskell: added info on limit

Archived talk:Adding custom fields to the article component

2014-01-06T20:10:58Z

AndyGaskell:

Great tutorial, will the patch be soon integrated to Joomla! packages ?
I had to install the patch in a Joomla 2.5.8 site in order to make the plugin work and I wonder if I will have to install the patch again after each update.

Thanks for your job anyway.

Thierry

----

Really useful tutorial, thanks. I just tried it on Joomla 3.1 and it doesn't work. I'll see if I can figure out what the issues are.

Andy G

User:AndyGaskell

2013-12-06T13:34:44Z

AndyGaskell: adding blurb

My name is AndyGaskell and if you want to get in touch with me, post on my '''[[User_talk:{{PAGENAME}}|talk page]]'''.

I'm a web developer, LAMP, AJAX etc. I've worked in design and IT too. Been writing code for 20 years :)

I work at SSOFB in Aberdeen Scotland. I've also live in London, Edinburgh, Sydney and Glasgow.

There are more Linux devices in our house than Windows, (5 v 2). I built our TV, it runs Linux. My kids know what a PCB is and try to fix their broken toys.

I support Crystal Palace FC, as I grew up in South London.

==My testing subpages==
<splist/>

User:AndyGaskell

2013-12-06T13:32:58Z

AndyGaskell: Created page with "{{subst:Newuser}}"

My name is AndyGaskell and if you want to get in touch with me, post on my '''[[User_talk:{{PAGENAME}}|talk page]]'''.

==My testing subpages==
<splist/>

Selecting data using JDatabase

2013-12-06T13:32:22Z

AndyGaskell: /* Selecting Records from a Single Table */ wording tweak from previous edit

Selecting data using JDatabase

2013-12-06T13:31:31Z

AndyGaskell: added not and code re grouping