Joomla! Documentation - User contributions [en]

Pizza Bugs and Fun 2011

2011-12-10T12:48:13Z

Littlejohn: /* FAQ */

[[Category:Bug Squad]]
[[Category:Development]]
[[Image:pbf.png|right]]
{{RightTOC}}

We are announcing a Joomla! Pizza, Bugs and Fun 2011 event scheduled for Saturday, December 10, 2011. The event is global for virtual participants with local venues where ever they are organized. The official start time is 9am in each time zone. Help us prepare Joomla! 2.5 for release early in January 2012!

See the section [http://docs.joomla.org/Pizza_Bugs_and_Fun_2011#General_Instructions General Instructions] below for instructions.

This wiki will be used as the central resource for coordinating efforts and accumulating results from this event.

The '''twitter''' hash tag is #jpbf11 and there is a Facebook page at http://www.facebook.com/events/208015399276419/

For '''Google+''' posts you can also use #JPBF11 in your posts. https://plus.google.com/u/0/s/%23JPBF11

== Goals ==

* '''Bugs''' : We will be working through the [http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=8103 CMS Issue Tracker] where there are bug reports needing patches and/or testing.

* '''Features''' : There are features that need some coding and/or testing before they will be ready for 2.5. Finder and the multi-database are two such features. The [http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=8549 CMS Feature Tracker] has feature requests that need testing and coding that needs to be done.

* '''Documentation''' : We still have documentation that needs to be done. If you want to help out writing documentation, you're also more than welcome.

== Organization, logistics and communications ==

=== Communication ===
We have set up a Skype chat for all attendees of the PBF. Skype is invitation only and you are all invited. To get an invitation, email your Skype name to Andy Tarr (andrea.tarr@joomla.org). To make sure you can get in, get your invitation and log in before the day of the PBF. For languages other than English, some of the organizations listed below have set up chats in their language.

=== General Instructions ===
==== If you want to code bug fixes ====
* Look for issues with a status of Confirmed
* Before you start coding, find the issue in the [https://docs.google.com/spreadsheet/ccc?key=0AuHNF8-wsi3tdGtOU0lqSThaLXB4NDJCUTBMNkxzcXc#gid=0 CMS Issues Google doc] or [https://docs.google.com/spreadsheet/ccc?key=0AuHNF8-wsi3tdEdoVUUwV1hpa1ZaN0pYVG1wWkRoSGc&authkey=CPKJ6cUD CMS Features Google doc] and put your name on the issue so people know someone is working on it. You can sign things out to a group if a group is working on any issue. Remember that everyone is seeing the same document, so please don't hide rows.
* Use the [http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=8103 CMS Issue Tracker] and [http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=8549 CMS Feature Tracker] as usual, which means you download the patch from the tracker and apply it to a current SVN copy of Joomla.
* When you have a patch, add it to the tracker and change the status to Pending if you are able to.
* Go back into the Google doc and change the status there to Pending as well and remove your name and add a comment with your name that you added a patch. If the tracker still needs to be changed to pending, you can mention it there.
* In addition to the two trackers, special coding projects can be found here: [https://docs.google.com/document/d/1D2Ui-93a9Rvm16a_pNeWwJrKydX9CoEZfWx0CGLtBH4/edit?hl=en_US special items]. These include both challenging projects and easy ones.
Helpful documentation:
* [[Setting up your workstation for Joomla! development]]. A step-by-step guide to installing the Eclipse IDE on your local workstation for Joomla! development.
* [http://community.joomla.org/blogs/community/828-webinar-using-eclipse-for-joomla-development.html Using Eclipse for Joomla! Development] Video webinar demonstrating overview of Eclipse features for Joomla! development
* [[Tortoise SVN]]
* [[Secure coding guidelines]]
* [[Development Best Practices]]

==== If you want to test and you have or can set up SVN and XAMPP/MAMP ====
* Look for issues with a status of Pending. We want at least 2 testers and more on complex issues, so you can test what others have tested already.
* Before you start testing, find the issue in the [https://docs.google.com/spreadsheet/ccc?key=0AuHNF8-wsi3tdGtOU0lqSThaLXB4NDJCUTBMNkxzcXc#gid=0 CMS Issues Google doc] or [https://docs.google.com/spreadsheet/ccc?key=0AuHNF8-wsi3tdEdoVUUwV1hpa1ZaN0pYVG1wWkRoSGc&authkey=CPKJ6cUD CMS Features Google doc] and put your name on the issue so people know someone is testing it. You can sign things out to a group if a group is working on any issue. Remember that everyone is seeing the same document, so please don't hide rows.
* Use the [http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=8103 CMS Issue Tracker] and [http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=8549 CMS Feature Tracker] as usual, which means you download the patch from the tracker and apply it to a current SVN copy of Joomla.
* Most of the issues should have test instructions with them.
* Once you have tested, add comments to the tracker on your results. Start your comment with @test so you will get counted in the stats as a tester.
* Go back into the Google doc and remove your name and add a comment with your name that you tested. If you weren’t able to put a comment in the tracker, add your results there.
* In addition to the two trackers, special testing projects can be found here: [https://docs.google.com/document/d/1D2Ui-93a9Rvm16a_pNeWwJrKydX9CoEZfWx0CGLtBH4/edit?hl=en_US special items].
Helpful Documentation:
* [[Tortoise SVN]] Freestanding Windows based SVN. This may be all you need, if you have a Windows PC
* [http://www.adobe.com/devnet/dreamweaver/articles/using_subversion_pt1.html Dreamweaver CS5 with SVN] Start of tutorials on how to use SVN in Dreamweaver
* [[Setting up your workstation for Joomla! development]]. A step-by-step guide to installing the Eclipse IDE on your local workstation for Joomla! development. This also guides you through installing XAMPP/MAMP on your computer.
* [http://community.joomla.org/blogs/community/828-webinar-using-eclipse-for-joomla-development.html Using Eclipse for Joomla! Development] Video webinar demonstrating overview of Eclipse features for Joomla! development

==== If you want to test but don’t have SVN ====
* Download the pre-patched copy (testing build) of Joomla at https://github.com/elinw/joomla-cms/tree/pbf2011. This copy has a number of patches applied to it and can be used to test those trackers. You can install it either locally (if you have XAMPP/MAMP) or online. It may be updated throughout the day.
* Look for issues with a status of Pending and are in the Pre-patched Joomla. The Google docs have a column that says which are in this download. Most of them are in the Feature tracker. We want at least 2 testers and more on complex issues, so you can test what others have tested already.
* You’ll find the issues in the [https://docs.google.com/spreadsheet/ccc?key=0AuHNF8-wsi3tdGtOU0lqSThaLXB4NDJCUTBMNkxzcXc#gid=0 CMS Issues Google doc] or [https://docs.google.com/spreadsheet/ccc?key=0AuHNF8-wsi3tdEdoVUUwV1hpa1ZaN0pYVG1wWkRoSGc&authkey=CPKJ6cUD CMS Features Google doc]. Remember that everyone is seeing the same document, so please don't hide rows.
* Put your name on the issue so people know someone is testing it. You can sign things out to a group if a group is working on an issue.
* Most of the issues should have test instructions with them.
* Once you have tested, go back into the Google doc and remove your name and add a comment with your name that you tested and your results.

==== Special Coding or Testing Projects ====

* There is a sheet outlining [https://docs.google.com/document/d/1D2Ui-93a9Rvm16a_pNeWwJrKydX9CoEZfWx0CGLtBH4/edit?hl=en_US special items] at various skill levels that are not normal bugs or features.

==== If you want to work on Documentation ====
* To edit this Documentation Wiki, you will need a user accunt. If you don't already have one, you may register on [[Special:UserLogin]]. While a brand new user account won't give you all the permissions you'd get with a confirmed and "elevated" account, you will be able to edit most pages.
* If you'd like something to be edited, but you're not sure what to write exactly, use talk pages to add comments to pages.
* During the PBF, several experienced Wiki editors will be available in the Skype chat to help you.
{{:Documentation wiki}}

===== Help Screens =====
* There are help screens that still need to be made for 1.7 [[Help17:Help screens]]

=== Pizza ===
OSM is offering pizza and soda for pre-registered groups. We aren’t setting a specific maximum, but please don’t go crazy with it. Get enough so there’s plenty for everyone, but not a week’s worth of pizza and soda leftovers for everyone. Contact Andrea Tarr (andrea.tarr@joomla.org) before the event to register and get details.

== Locations ==

If you want to get people together and have a venue to share, please add it below. Share as much as possible details like exact location, url for more information about the venue, ways to register, date and time the venue is available etc.

If you set up a location please send contact information to Andy Tarr (andrea.tarr@joomla.org). Feel free to contact her with any questions.

=== Europe ===
Lancaster UK
Hosted by Dean Marshall Consultancy Ltd
CityLab, Dalton Square, Lancaster, Lancashire, LA1 1PP
Tel: 01524 63492 or use our [http://www.deanmarshall.co.uk/contact-us.html | Online contact form]
RSVP: [http://www.meetup.com/LancasterJUG/ Lancaster JUG Meetup page]

Ringsted, Denmark
Hosted by Janich Rasmussen
Egevej 8, 4100 Ringsted
Tel: +45 3113 6101 or use our [http://dkjug.dk/details/23-Joomla-Pizza-Bugs-and-Fun-2011/Ringsted/2011-12-10/09-00.html | Online contact form]
RSVP: [http://dkjug.dk/userlist/JUG-Ringsted.html DKJUG Ringsted]

France
Hosted by Marc STUDER (AFUJ Member, French JUG)
Online contact form http://www.afuj.fr/Nous-contacter/Marc-Studer.html
Event RSVP: http://tinyurl.com/bujotbk

=== North America ===

Charlotte, NC
[http://joomlacharlotte.org/index.php/events/pizza-bugs-fun-2011 Charlotte Joomla! User Group]
Meetup Information posted shortly on event page

New England JUG
Marlboro College Graduate Center
28 Vernon Street
Brattleboro, VT 05301
http://www.joomlanewengland.org
Contact: Andy Tarr (andrea.tarr@joomla.org)

Portland, OR
[http://joomlapdx.com/events/pizza-bugs-and-fun-2011.html Portland Joomla! User Group]
Location to be posted on the page after Thursday meeting

Texas
HubAustin
4930 S. Congress Ave, Ste 307
Austin, TX 78745
http://www.meetup.com/joomlaaustin/events/41979952/

Washington, DC
PICnet
1605 Connecticut Ave, NW 3FL
Washington, DC 20009
Signup at http://www.picnet.net/about-us/upcoming-events/event/80

=== South America ===

Porto Alegre, Rio Grande do Sul, Brasil
Av. José Bonifácio 731, CEP 90040-130
Coletânea Ciber Café
[http://www.joomlatche.com.br/pizza-bugs-and-fun-2011.html JUGRS - Joomla User Group Rio Grande do Sul]

Iquique, Chile
Anibal Pinto 770, CP 1100744
[http://www.joomla.cl JUG Iquique]

=== Asia/Pacific ===
<pre>
Sydney, Australia 6pm-9pm
Hosted by Tim Plummer
InterfaceFLOR (usual Sydney JUG venue)
101 Chalmers Street, Surry Hills, NSW
http://www.meetup.com/Joomla-User-Group-Sydney/events/42114152/
</pre>

1-7, Signature Office,
The Boulevard Mid Valley City,
Lingkaran Syed Putra,
59200 Kuala Lumpur, Malaysia.
Event RSPV: https://www.facebook.com/events/309178112434616/

=== Africa ===

Algeria
Cyber Park Algérie
Sidi Abdellah, Rahmania zeralda,
http://community.joomla.org/user-groups/africa/algeria.html

=== Middle East ===
Tel Aviv, Israel
Hosted by Agron BC&C Ltd
Ramat Hayal, Ha'Barzel 31
[http://www.joomla.org.il Joomla! Israel]
Start at 18:00. Please contact via skype oc4666 or email info-at-joomla-dot-org-dot-il

===Virtual===
====Skype Chat====
We have set up a Skype chat for all attendees of the PBF. Skype is invitation only. To get an invitation, email your Skype name to Andy Tarr (andrea.tarr@joomla.org). To make sure you can get in, get your invitation and log in before the day of the PBF.

If you don't already have Skype, you can download it for free from [http://skype.com Skype].

== Registration ==
=== For write access to this wiki ===
To get write access to this wiki you will need to [[Special:Userlogin|register here first]]. Please be aware that the registration process requires a valid email address. This is the same login for updating Joomla documentation.

=== At a physical location ===
If you wish to be present at one of the physical locations listed above then you must register in advance because space most likely is limited. Registrations are the responsibility of the individual location organizers and you should click on the appropriate link above for more information.

=== Taking bugs, tasks and pizza ===

Please check the [http://docs.joomla.org/Pizza_Bugs_and_Fun_2011#Organization.2C_logistics_and_communications Organization, logistics and communications section] for detail on how to get involved in working on tasks.

==Requirements==
* All code must be made available under the [http://www.gnu.org/licenses/gpl-2.0.html General Public Licence version 2].
* All documentation contributions must be made available under the [[JEDL|Joomla! Electronic Documentation License]]. Further information on the JEDL is available in the [[JEDL/FAQ|JEDL Frequently Asked Questions]]
* No advertising or self-promotion will be allowed. This includes back links to your website or anyone else's. The one exception is that if you have made a contribution then feel free to add your name and an optional link to your website to the [[Pizza Bugs and Fun 2011/Contributors List|Contributors List]]
* All contributions must be in English. Note that the official language of the Joomla! project is British English.

== FAQ ==
Q: Where is the SVN for Joomla?

A: http://joomlacode.org/svn/joomla/development/trunk

Q: Which one is 2.5?

A: It is the main trunk

Q: Why does it still say 1.7.3?

A: The version number hasn't been changed yet.

Q: Any known issues with JForge and Chrome on Windows?

A: It have been seen that browsing the JForge tracker, Chrome may ask for a missing plugin (windows media player). No workaround for this is yet known.

Pizza Bugs and Fun 2011

2011-12-09T08:53:36Z

Littlejohn: /* Europe */

[[Category:Bug Squad]]
[[Category:Development]]
[[Image:pbf.png|right]]
{{RightTOC}}

We are announcing a Joomla! Pizza Bug and Fun 2011 event scheduled for Saturday, December 10, 2011. The event is global for virtual participants with local venues where ever they are organized. The official start time is 9am in each time zone. Help us prepare Joomla! 2.5 for release early in January 2012!

This wiki will be used as the central resource for coordinating efforts and accumulating results from this event.

The twitter hash tag is #jpbf11 and there is a Facebook page at http://www.facebook.com/events/208015399276419/

== Goals ==

* '''Bugs''' : We will be working through the [http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=8103 CMS Issue Tracker] where there are trackers needing patches and/or testing.

* '''Features''' : There are features that need some coding and/or testing before they will be ready for 2.5. Finder and the multi-database are two such features. The [http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=8549 CMS Feature Tracker] has trackers of testing and coding that needs to be done.

* '''Documentation''' : We still have documentation that needs to be done. If you want to help out writing documentation, you're also more than welcome.

== Organization, logistics and communications ==

Pizza: OSM is offering pizza and soda for pre-registered groups. We aren’t setting a specific maximum, but please don’t go crazy with it. Get enough so there’s plenty for everyone, but not a week’s worth of pizza and soda leftovers for everyone. Contact Andrea Tarr (andrea.tarr@joomla.org) before the event to register and get details.

Communication: We have set up a Skype chat for all attendees of the PBF. Skype is invitation only. To get an invitation, email your Skype name to Andy Tarr (andrea.tarr@joomla.org). To make sure you can get in, get your invitation and log in before the day of the PBF.

More information will be available here shortly. The main contact is Andy Tarr at andrea.tarr@joomla.org.

== Locations ==

If you want to get people together and have a venue to share, please add it below. Share as much as possible details like exact location, url for more information about the venue, ways to register, date and time the venue is available etc.

If you set up a location please send contact information to Andy Tarr (andrea.tarr@joomla.org). Feel free to contact her with any questions.

=== Europe ===
Lancaster UK
Hosted by Dean Marshall Consultancy Ltd
CityLab, Dalton Square, Lancaster, Lancashire, LA1 1PP
Tel: 01524 63492 or use our [http://www.deanmarshall.co.uk/contact-us.html | Online contact form]
RSVP: [http://www.meetup.com/LancasterJUG/ Lancaster JUG Meetup page]

Ringsted, Denmark
Hosted by Janich Rasmussen
Egevej 8, 4100 Ringsted
Tel: +45 3113 6101 or use our [http://dkjug.dk/details/23-Joomla-Pizza-Bugs-and-Fun-2011/Ringsted/2011-12-10/09-00.html | Online contact form]
RSVP: [http://dkjug.dk/userlist/JUG-Ringsted.html DKJUG Ringsted]

=== North America ===

Charlotte, NC
[http://joomlacharlotte.org/index.php/events/pizza-bugs-fun-2011 Charlotte Joomla! User Group]
Meetup Information posted shortly on event page

New England JUG
Marlboro College Graduate Center
28 Vernon Street
Brattleboro, VT 05301
http://www.joomlanewengland.org
Contact: Andy Tarr (andrea.tarr@joomla.org)

Portland, OR
[http://joomlapdx.com/events/pizza-bugs-and-fun-2011.html Portland Joomla! User Group]
Location to be posted on the page after Thursday meeting

Texas
HubAustin
4930 S. Congress Ave, Ste 307
Austin, TX 78745
http://www.meetup.com/joomlaaustin/events/41979952/

Washington, DC
PICnet
1605 Connecticut Ave, NW 3FL
Washington, DC 20009

=== South America ===

Porto Alegre, Rio Grande do Sul, Brasil
Av. José Bonifácio 731, CEP 90040-130
Coletânea Ciber Café
[http://www.joomlatche.com.br/pizza-bugs-and-fun-2011.html JUGRS - Joomla User Group Rio Grande do Sul]

=== Asia/Pacific ===
<pre>
Sydney, Australia 6pm-9pm
Hosted by Tim Plummer
InterfaceFLOR (usual Sydney JUG venue)
101 Chalmers Street, Surry Hills, NSW
http://www.meetup.com/Joomla-User-Group-Sydney/events/42114152/
</pre>

1-7, Signature Office,
The Boulevard Mid Valley City,
Lingkaran Syed Putra,
59200 Kuala Lumpur, Malaysia.
Event RSPV: https://www.facebook.com/events/309178112434616/

=== Africa ===

Algeria
Cyber Park Algérie
Sidi Abdellah, Rahmania zeralda,
http://community.joomla.org/user-groups/africa/algeria.html

=== Middle East ===
Tel Aviv, Israel
Hosted by Agron BC&C Ltd
Ramat Hayal, Ha'Barzel 31
[http://www.joomla.org.il Joomla! Israel]
More details to follow.

===Virtual===
====Skype Chat====
We have set up a Skype chat for all attendees of the PBF. Skype is invitation only. To get an invitation, email your Skype name to Andy Tarr (andrea.tarr@joomla.org). To make sure you can get in, get your invitation and log in before the day of the PBF.

If you don't already have Skype, you can download it for free from [http://skype.com Skype].

== Registration ==
=== For write access to this wiki ===
To get write access to this wiki you will need to [[Special:Userlogin|register here first]]. Please be aware that the registration process requires a valid email address. This is the same login for updating Joomla documentation.

=== At a physical location ===
If you wish to be present at one of the physical locations listed above then you must register in advance because space most likely is limited. Registrations are the responsibility of the individual location organizers and you should click on the appropriate link above for more information.

=== Taking bugs, tasks and pizza ===

Please check the [http://docs.joomla.org/Pizza_Bugs_and_Fun_2011#Organization.2C_logistics_and_communications Organization, logistics and communications section] for detail on how to get involved in working on tasks.

==Requirements==
* All code must be made available under the [http://www.gnu.org/licenses/gpl-2.0.html General Public Licence version 2].
* All documentation contributions must be made available under the [[JEDL|Joomla! Electronic Documentation License]]. Further information on the JEDL is available in the [[JEDL/FAQ|JEDL Frequently Asked Questions]]
* No advertising or self-promotion will be allowed. This includes back links to your website or anyone else's. The one exception is that if you have made a contribution then feel free to add your name and an optional link to your website to the [[Pizza Bugs and Fun 2011/Contributors List|Contributors List]]
* All contributions must be in English. Note that the official language of the Joomla! project is British English.

Pizza Bugs and Fun 2011

2011-12-09T08:53:15Z

Littlejohn: /* Europe */

[[Category:Bug Squad]]
[[Category:Development]]
[[Image:pbf.png|right]]
{{RightTOC}}

We are announcing a Joomla! Pizza Bug and Fun 2011 event scheduled for Saturday, December 10, 2011. The event is global for virtual participants with local venues where ever they are organized. The official start time is 9am in each time zone. Help us prepare Joomla! 2.5 for release early in January 2012!

This wiki will be used as the central resource for coordinating efforts and accumulating results from this event.

The twitter hash tag is #jpbf11 and there is a Facebook page at http://www.facebook.com/events/208015399276419/

== Goals ==

* '''Bugs''' : We will be working through the [http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=8103 CMS Issue Tracker] where there are trackers needing patches and/or testing.

* '''Features''' : There are features that need some coding and/or testing before they will be ready for 2.5. Finder and the multi-database are two such features. The [http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=8549 CMS Feature Tracker] has trackers of testing and coding that needs to be done.

* '''Documentation''' : We still have documentation that needs to be done. If you want to help out writing documentation, you're also more than welcome.

== Organization, logistics and communications ==

Pizza: OSM is offering pizza and soda for pre-registered groups. We aren’t setting a specific maximum, but please don’t go crazy with it. Get enough so there’s plenty for everyone, but not a week’s worth of pizza and soda leftovers for everyone. Contact Andrea Tarr (andrea.tarr@joomla.org) before the event to register and get details.

Communication: We have set up a Skype chat for all attendees of the PBF. Skype is invitation only. To get an invitation, email your Skype name to Andy Tarr (andrea.tarr@joomla.org). To make sure you can get in, get your invitation and log in before the day of the PBF.

More information will be available here shortly. The main contact is Andy Tarr at andrea.tarr@joomla.org.

== Locations ==

If you want to get people together and have a venue to share, please add it below. Share as much as possible details like exact location, url for more information about the venue, ways to register, date and time the venue is available etc.

If you set up a location please send contact information to Andy Tarr (andrea.tarr@joomla.org). Feel free to contact her with any questions.

=== Europe ===
Lancaster UK
Hosted by Dean Marshall Consultancy Ltd
CityLab, Dalton Square, Lancaster, Lancashire, LA1 1PP
Tel: 01524 63492 or use our [http://www.deanmarshall.co.uk/contact-us.html | Online contact form]
RSVP: [http://www.meetup.com/LancasterJUG/ Lancaster JUG Meetup page]

=== North America ===

Charlotte, NC
[http://joomlacharlotte.org/index.php/events/pizza-bugs-fun-2011 Charlotte Joomla! User Group]
Meetup Information posted shortly on event page

New England JUG
Marlboro College Graduate Center
28 Vernon Street
Brattleboro, VT 05301
http://www.joomlanewengland.org
Contact: Andy Tarr (andrea.tarr@joomla.org)

Portland, OR
[http://joomlapdx.com/events/pizza-bugs-and-fun-2011.html Portland Joomla! User Group]
Location to be posted on the page after Thursday meeting

Texas
HubAustin
4930 S. Congress Ave, Ste 307
Austin, TX 78745
http://www.meetup.com/joomlaaustin/events/41979952/

Washington, DC
PICnet
1605 Connecticut Ave, NW 3FL
Washington, DC 20009

=== South America ===

Porto Alegre, Rio Grande do Sul, Brasil
Av. José Bonifácio 731, CEP 90040-130
Coletânea Ciber Café
[http://www.joomlatche.com.br/pizza-bugs-and-fun-2011.html JUGRS - Joomla User Group Rio Grande do Sul]

=== Asia/Pacific ===
<pre>
Sydney, Australia 6pm-9pm
Hosted by Tim Plummer
InterfaceFLOR (usual Sydney JUG venue)
101 Chalmers Street, Surry Hills, NSW
http://www.meetup.com/Joomla-User-Group-Sydney/events/42114152/
</pre>

1-7, Signature Office,
The Boulevard Mid Valley City,
Lingkaran Syed Putra,
59200 Kuala Lumpur, Malaysia.
Event RSPV: https://www.facebook.com/events/309178112434616/

=== Africa ===

Algeria
Cyber Park Algérie
Sidi Abdellah, Rahmania zeralda,
http://community.joomla.org/user-groups/africa/algeria.html

=== Middle East ===
Tel Aviv, Israel
Hosted by Agron BC&C Ltd
Ramat Hayal, Ha'Barzel 31
[http://www.joomla.org.il Joomla! Israel]
More details to follow.

===Virtual===
====Skype Chat====
We have set up a Skype chat for all attendees of the PBF. Skype is invitation only. To get an invitation, email your Skype name to Andy Tarr (andrea.tarr@joomla.org). To make sure you can get in, get your invitation and log in before the day of the PBF.

If you don't already have Skype, you can download it for free from [http://skype.com Skype].

== Registration ==
=== For write access to this wiki ===
To get write access to this wiki you will need to [[Special:Userlogin|register here first]]. Please be aware that the registration process requires a valid email address. This is the same login for updating Joomla documentation.

=== At a physical location ===
If you wish to be present at one of the physical locations listed above then you must register in advance because space most likely is limited. Registrations are the responsibility of the individual location organizers and you should click on the appropriate link above for more information.

=== Taking bugs, tasks and pizza ===

Please check the [http://docs.joomla.org/Pizza_Bugs_and_Fun_2011#Organization.2C_logistics_and_communications Organization, logistics and communications section] for detail on how to get involved in working on tasks.

==Requirements==
* All code must be made available under the [http://www.gnu.org/licenses/gpl-2.0.html General Public Licence version 2].
* All documentation contributions must be made available under the [[JEDL|Joomla! Electronic Documentation License]]. Further information on the JEDL is available in the [[JEDL/FAQ|JEDL Frequently Asked Questions]]
* No advertising or self-promotion will be allowed. This includes back links to your website or anyone else's. The one exception is that if you have made a contribution then feel free to add your name and an optional link to your website to the [[Pizza Bugs and Fun 2011/Contributors List|Contributors List]]
* All contributions must be in English. Note that the official language of the Joomla! project is British English.

Pizza Bugs and Fun 2011

2011-12-09T08:53:02Z

Littlejohn: /* Europe */

[[Category:Bug Squad]]
[[Category:Development]]
[[Image:pbf.png|right]]
{{RightTOC}}

We are announcing a Joomla! Pizza Bug and Fun 2011 event scheduled for Saturday, December 10, 2011. The event is global for virtual participants with local venues where ever they are organized. The official start time is 9am in each time zone. Help us prepare Joomla! 2.5 for release early in January 2012!

This wiki will be used as the central resource for coordinating efforts and accumulating results from this event.

The twitter hash tag is #jpbf11 and there is a Facebook page at http://www.facebook.com/events/208015399276419/

== Goals ==

* '''Bugs''' : We will be working through the [http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=8103 CMS Issue Tracker] where there are trackers needing patches and/or testing.

* '''Features''' : There are features that need some coding and/or testing before they will be ready for 2.5. Finder and the multi-database are two such features. The [http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=8549 CMS Feature Tracker] has trackers of testing and coding that needs to be done.

* '''Documentation''' : We still have documentation that needs to be done. If you want to help out writing documentation, you're also more than welcome.

== Organization, logistics and communications ==

Pizza: OSM is offering pizza and soda for pre-registered groups. We aren’t setting a specific maximum, but please don’t go crazy with it. Get enough so there’s plenty for everyone, but not a week’s worth of pizza and soda leftovers for everyone. Contact Andrea Tarr (andrea.tarr@joomla.org) before the event to register and get details.

Communication: We have set up a Skype chat for all attendees of the PBF. Skype is invitation only. To get an invitation, email your Skype name to Andy Tarr (andrea.tarr@joomla.org). To make sure you can get in, get your invitation and log in before the day of the PBF.

More information will be available here shortly. The main contact is Andy Tarr at andrea.tarr@joomla.org.

== Locations ==

If you want to get people together and have a venue to share, please add it below. Share as much as possible details like exact location, url for more information about the venue, ways to register, date and time the venue is available etc.

If you set up a location please send contact information to Andy Tarr (andrea.tarr@joomla.org). Feel free to contact her with any questions.

=== Europe ===
Lancaster UK
Hosted by Dean Marshall Consultancy Ltd
CityLab, Dalton Square, Lancaster, Lancashire, LA1 1PP
Tel: 01524 63492 or use our [http://www.deanmarshall.co.uk/contact-us.html | Online contact form]
RSVP: [http://www.meetup.com/LancasterJUG/ Lancaster JUG Meetup page]

=== Europe ===
Ringsted, Denmark
Hosted by Janich Rasmussen
Egevej 8, 4100 Ringsted
Tel: +45 3113 6101 or use our [http://dkjug.dk/details/23-Joomla-Pizza-Bugs-and-Fun-2011/Ringsted/2011-12-10/09-00.html | Online contact form]
RSVP: [http://dkjug.dk/userlist/JUG-Ringsted.html DKJUG Ringsted]

=== North America ===

Charlotte, NC
[http://joomlacharlotte.org/index.php/events/pizza-bugs-fun-2011 Charlotte Joomla! User Group]
Meetup Information posted shortly on event page

New England JUG
Marlboro College Graduate Center
28 Vernon Street
Brattleboro, VT 05301
http://www.joomlanewengland.org
Contact: Andy Tarr (andrea.tarr@joomla.org)

Portland, OR
[http://joomlapdx.com/events/pizza-bugs-and-fun-2011.html Portland Joomla! User Group]
Location to be posted on the page after Thursday meeting

Texas
HubAustin
4930 S. Congress Ave, Ste 307
Austin, TX 78745
http://www.meetup.com/joomlaaustin/events/41979952/

Washington, DC
PICnet
1605 Connecticut Ave, NW 3FL
Washington, DC 20009

=== South America ===

Porto Alegre, Rio Grande do Sul, Brasil
Av. José Bonifácio 731, CEP 90040-130
Coletânea Ciber Café
[http://www.joomlatche.com.br/pizza-bugs-and-fun-2011.html JUGRS - Joomla User Group Rio Grande do Sul]

=== Asia/Pacific ===
<pre>
Sydney, Australia 6pm-9pm
Hosted by Tim Plummer
InterfaceFLOR (usual Sydney JUG venue)
101 Chalmers Street, Surry Hills, NSW
http://www.meetup.com/Joomla-User-Group-Sydney/events/42114152/
</pre>

1-7, Signature Office,
The Boulevard Mid Valley City,
Lingkaran Syed Putra,
59200 Kuala Lumpur, Malaysia.
Event RSPV: https://www.facebook.com/events/309178112434616/

=== Africa ===

Algeria
Cyber Park Algérie
Sidi Abdellah, Rahmania zeralda,
http://community.joomla.org/user-groups/africa/algeria.html

=== Middle East ===
Tel Aviv, Israel
Hosted by Agron BC&C Ltd
Ramat Hayal, Ha'Barzel 31
[http://www.joomla.org.il Joomla! Israel]
More details to follow.

===Virtual===
====Skype Chat====
We have set up a Skype chat for all attendees of the PBF. Skype is invitation only. To get an invitation, email your Skype name to Andy Tarr (andrea.tarr@joomla.org). To make sure you can get in, get your invitation and log in before the day of the PBF.

If you don't already have Skype, you can download it for free from [http://skype.com Skype].

== Registration ==
=== For write access to this wiki ===
To get write access to this wiki you will need to [[Special:Userlogin|register here first]]. Please be aware that the registration process requires a valid email address. This is the same login for updating Joomla documentation.

=== At a physical location ===
If you wish to be present at one of the physical locations listed above then you must register in advance because space most likely is limited. Registrations are the responsibility of the individual location organizers and you should click on the appropriate link above for more information.

=== Taking bugs, tasks and pizza ===

Please check the [http://docs.joomla.org/Pizza_Bugs_and_Fun_2011#Organization.2C_logistics_and_communications Organization, logistics and communications section] for detail on how to get involved in working on tasks.

==Requirements==
* All code must be made available under the [http://www.gnu.org/licenses/gpl-2.0.html General Public Licence version 2].
* All documentation contributions must be made available under the [[JEDL|Joomla! Electronic Documentation License]]. Further information on the JEDL is available in the [[JEDL/FAQ|JEDL Frequently Asked Questions]]
* No advertising or self-promotion will be allowed. This includes back links to your website or anyone else's. The one exception is that if you have made a contribution then feel free to add your name and an optional link to your website to the [[Pizza Bugs and Fun 2011/Contributors List|Contributors List]]
* All contributions must be in English. Note that the official language of the Joomla! project is British English.

J1.5:Creating a simple module

2010-10-27T10:53:46Z

Littlejohn: /* Joomla! 1.5 Database installation usage */

{{review}}
== Basic Hello World Module ==

A Joomla! 1.5 Module is in its most basic form two files: an XML configuration file and a PHP controller file. The XML configuration file contains general information about the module (as will be displayed in the Module Manager in the Joomla! administration interface), as well as module parameters which may be supplied to fine tune the appearance / functionality of the module. The PHP file provides the controlling logic for the module. A very simple "Hello World" module might looking something like this.

'''/modules/mod_hello_world/mod_hello_world.xml:'''

'''!!! Note:''' it is very important, that XML file name matches module name. Otherwise, installer will install the module, but Joomla wouldn't show parameters and additional info stored in XML.

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install type="module" version="1.5.0">

<name>Hello World - Hello</name>


<author>Ambitionality Software LLC</author>


<creationDate>2008-06-23</creationDate>


<copyright>All rights reserved by Ambitionality Software LLC 2008.</copyright>


<license>GPL 2.0</license>


<authorEmail>info@ambitionality.com</authorEmail>


<authorUrl>www.ambitionality.com</authorUrl>


<version>1.0.0</version>


<description>Provides a basic "Hello World" notice</description>


<files>

<filename module="mod_hello_world">mod_hello_world.php</filename>
<filename>index.html</filename>
</files>


<params />
</install>
</source>

Basically, this XML file just lines out basic information about the module such as the owner, version, etc. for identification by the Joomla! installer and then provides optional parameters which may be set in the Module Manager and accessed from within the module's logic to fine tune its behavior. Additionally, this file tells the installer which files should be copied and installed. Notice that we DO NOT include a reference in the files section for the XML file.

'''/modules/mod_hello_world/mod_hello_world.php:'''

<source lang="php">
<?php
//don't allow other scripts to grab and execute our file
defined('_JEXEC') or die('Direct Access to this location is not allowed.');
?>

Hello World

</source>

What happens when this module is loaded is that Joomla! includes (via the PHP include directive) the mod_hello_world.php file and stores the output into an output buffer which is then rendered onto the page output. This file would simply produce Hello World to the final page.

'''/modules/mod_hello_world/index.html:'''

<source lang="html4strict">
<html><body bgcolor="#FFFFFF"></body></html>
</source>

This really just helps to ensure that a default page is displayed if direct access to the directory is attempted without listing all of the other files in the directory. It's not necessary, but is good practice.

To package this module for distribution and installation, simply zip the files together, e.g.,

<source lang="text">
% cd mod_hello_world
% zip mod_hello_world.zip mod_hello_world.php mod_hello_world.xml index.html
</source>

The resulting mod_hello_world.zip file may be uploaded and installed through the standard Joomla! 1.5 Extension Manager.

== Real Joomla! 1.5 Style Module Implementation ==

Now that was easy...too easy. In fact, that was pretty much the simplest form of a module possible. In reality a module will probably be doing something much more substantial. Let's assume that our modules are going to be more complex - we need to take advantage of the MVC (Model View Controller) design pattern and consider using the following file layout for a "Hello World 2" module instead:

<source lang="text">
/modules/mod_hello_world2/index.html
/modules/mod_hello_world2/mod_hello_world2.php
/modules/mod_hello_world2/mod_hello_world2.xml
/modules/mod_hello_world2/helper.php
/modules/mod_hello_world2/en-GB.mod_hello_world2.ini
/modules/mod_hello_world2/tmpl/index.html
/modules/mod_hello_world2/tmpl/default.php
</source>

The differences to note here are that there are three additional files beyond what the "Hello World" module had, namely helper.php, tmpl/default.php, and the en-GB.mod_hello_world2.ini file. The purpose in adding the first two files is two-fold. Firstly, we separate the module's logic into the helper.php file to ensure that all of the thinking and data access is performed here and separate out the module's presentation / template into the tmpl/default.php file (the (X)HTML). I argue that this is just good programming - separating logic from presentation. There is a second advantage to this, however, which is that it will allow the HTML / presentation to be overridden easily by any Joomla! 1.5 template for optimal integration into any site. (Overriding module and component presentation in templates is beyond the scope of this article, however it should be addressed as it's really useful).

Let's take a look at what these files might look like and discuss what's going on.

'''/modules/mod_hello_world2/mod_hello_world2.php:'''

<source lang="php">
<?php
//no direct access
defined('_JEXEC') or die('Direct Access to this location is not allowed.');

// include the helper file
require_once(dirname(__FILE__).DS.'helper.php');

// get a parameter from the module's configuration
$userCount = $params->get('usercount');

// get the items to display from the helper
$items = ModHelloWorld2Helper::getItems($userCount);

// include the template for display
require(JModuleHelper::getLayoutPath('mod_hello_world2'));
?>
</source>

The important differences to note are that (1) we include a helper file which will be the work-horse of our logic and data access and (2) once we have our data, we just load a template which will use our data and render it as it sees fit.

'''/modules/mod_hello_world2/mod_hello_world2.xml'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install type="module" version="1.5.0">

<name>Hello World 2 - Hello</name>


<author>Ambitionality Software LLC</author>


<creationDate>2008-06-23</creationDate>


<copyright>All rights reserved by Ambitionality Software LLC 2008.</copyright>


<license>GPL 2.0</license>


<authorEmail>info@ambitionality.com</authorEmail>


<authorUrl>www.ambitionality.com</authorUrl>


<version>1.0.0</version>


<description>Provides a random listing of registered users</description>


<files>

<filename module="mod_hello_world2">mod_hello_world2.php</filename>
<filename>index.html</filename>
<filename>helper.php</filename>
<filename>tmpl/default.php</filename>
<filename>tmpl/index.html</filename>
</files>

<languages>

<language tag="en-GB">en-GB.mod_hello_world2.ini</language>
</languages>


<params>

<param name="moduleclass_sfx" type="text" default="" label="Module Class Suffix" description="PARAMMODULECLASSSUFFIX" />


<param name="@spacer" type="spacer" default="" label="" description="" />


<param name="usercount" type="text" default="5" label="LABEL USER COUNT" description="DESC USER COUNT" />
</params>
</install>
</source>

The main differences to note here are that we have added a language file reference (we could have added more) and we added some parameters.

'''/modules/mod_hello_world2/helper.php:'''

<source lang="php">
<?php
defined('_JEXEC') or die('Direct Access to this location is not allowed.');

class ModHelloWorld2Helper
{
/**
* Returns a list of post items
*/
public function getItems($userCount)
{
// get a reference to the database
$db = &JFactory::getDBO();

// get a list of $userCount randomly ordered users
$query = 'SELECT a.name FROM `#__users` AS a ORDER BY rand() LIMIT ' . $userCount . '';

$db->setQuery($query);
$items = ($items = $db->loadObjectList())?$items:array();

return $items;
} //end getItems

} //end ModHelloWorld2Helper
?>
</source>

This helper class (note that it is named for the module name so that it doesn't collide with other class names) simply retrieves a list of all users in the database and randomly selects a subset of those based upon the number supplied as $userCount.

'''/modules/mod_hello_world2/tmpl/default.php:'''

<source lang="php">
<?php defined('_JEXEC') or die('Restricted access'); // no direct access ?>
<?php echo JText::_('RANDOM USERS'); ?>
<ul>
<?php foreach ($items as $item) { ?>
<li>
<?php echo JText::sprintf('USER LABEL', $item->name); ?>
</li>
<?php } ?>
</ul>
</source>

Here we simply create an unordered HTML list and then iterate through the items returned by our helper (in mod_hello_world2.php), printing out a message with each user's name.

'''/modules/mod_hello_world2/en-GB.mod_hello_world2.ini:'''

<source lang="text">
LABEL USER COUNT=User Count
DESC USER COUNT=The number of users to display
RANDOM USERS=Random Users for Hello World2
USER LABEL=%s is a randomly selected user
</source>

Here we simply identify strings which appear in the module configuration file and the module template which appear in JText::_ or JText::sprintf statements. This allows someone to easily write a new language file without editing any of the HTML or code for the module.

Now all we have to do is zip up these files, as in:

<source lang="text">
% pwd
/somesite/modules/mod_hello_world2
% zip -r ../mod_hello_world2.zip *
% ls ..
mod_hello_world2.zip
</source>

The resulting mod_hello_world2.zip file is ready for installation and distribution. When the ZIP file is installed, the en-GB.mod_hello_world2.ini file is copied to /language/en-GB/en-GB.mod_hello_world2.ini and is loaded each time the module is loaded. All of the other files are copied to the /modules/mod_hello_world2 subfolder of the Joomla! installation.

== Joomla! 1.5 Database installation usage ==

Modules should in general not interact with the database except for normal operations (SELECT, UPDATE, INSERT, DELETE).
But in some cases it might be needed to ALTER or even CREATE tables, even though it is not recommended.
There is no common practice to this, but here is one way of doing just that:

Add a module parameter that to the manifest:
<source lang="xml">
<params group="advanced">
<param name="is_installed" type="radio" default="0" label="Is module installed?" description="Only use this if you know the consequences! Click No to recreate database">
<option value="0">No</option>
<option value="1">Yes</option>
</param>
</params>
</source>

Then you can use the parameter to switch the state.
Since the module parameters is already loaded from the database at this point, any overhead should not be noticable this way.
<source lang="php">
// put this in the module function.
function myModuleReInstall() {
if (!$params->get('is_installed')) {
$database =& JFactory::getDBO();
$query = "CREATE TABLE IF NOT EXISTS `example` ( `id` INT, `data` VARCHAR(100) );";

$database->setQuery($query);
$result = $database->query();

$params->set('is_installed', 1);
}
}
</source>

This is meant as an example and it can be extended in various ways.
However - If you do that, you should also ask yourself if this is the right way to do things. Components do have real installers and this could be the best solution even though a module can be quicker to do.

<noinclude>[[Category:Development]]</noinclude>
[[Category:Tutorials]] [[Category:Module Development]]

J1.5:Creating a simple module

2010-10-27T10:44:45Z

Littlejohn:

{{review}}
== Basic Hello World Module ==

A Joomla! 1.5 Module is in its most basic form two files: an XML configuration file and a PHP controller file. The XML configuration file contains general information about the module (as will be displayed in the Module Manager in the Joomla! administration interface), as well as module parameters which may be supplied to fine tune the appearance / functionality of the module. The PHP file provides the controlling logic for the module. A very simple "Hello World" module might looking something like this.

'''/modules/mod_hello_world/mod_hello_world.xml:'''

'''!!! Note:''' it is very important, that XML file name matches module name. Otherwise, installer will install the module, but Joomla wouldn't show parameters and additional info stored in XML.

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install type="module" version="1.5.0">

<name>Hello World - Hello</name>


<author>Ambitionality Software LLC</author>


<creationDate>2008-06-23</creationDate>


<copyright>All rights reserved by Ambitionality Software LLC 2008.</copyright>


<license>GPL 2.0</license>


<authorEmail>info@ambitionality.com</authorEmail>


<authorUrl>www.ambitionality.com</authorUrl>


<version>1.0.0</version>


<description>Provides a basic "Hello World" notice</description>


<files>

<filename module="mod_hello_world">mod_hello_world.php</filename>
<filename>index.html</filename>
</files>


<params />
</install>
</source>

Basically, this XML file just lines out basic information about the module such as the owner, version, etc. for identification by the Joomla! installer and then provides optional parameters which may be set in the Module Manager and accessed from within the module's logic to fine tune its behavior. Additionally, this file tells the installer which files should be copied and installed. Notice that we DO NOT include a reference in the files section for the XML file.

'''/modules/mod_hello_world/mod_hello_world.php:'''

<source lang="php">
<?php
//don't allow other scripts to grab and execute our file
defined('_JEXEC') or die('Direct Access to this location is not allowed.');
?>

Hello World

</source>

What happens when this module is loaded is that Joomla! includes (via the PHP include directive) the mod_hello_world.php file and stores the output into an output buffer which is then rendered onto the page output. This file would simply produce Hello World to the final page.

'''/modules/mod_hello_world/index.html:'''

<source lang="html4strict">
<html><body bgcolor="#FFFFFF"></body></html>
</source>

This really just helps to ensure that a default page is displayed if direct access to the directory is attempted without listing all of the other files in the directory. It's not necessary, but is good practice.

To package this module for distribution and installation, simply zip the files together, e.g.,

<source lang="text">
% cd mod_hello_world
% zip mod_hello_world.zip mod_hello_world.php mod_hello_world.xml index.html
</source>

The resulting mod_hello_world.zip file may be uploaded and installed through the standard Joomla! 1.5 Extension Manager.

== Real Joomla! 1.5 Style Module Implementation ==

Now that was easy...too easy. In fact, that was pretty much the simplest form of a module possible. In reality a module will probably be doing something much more substantial. Let's assume that our modules are going to be more complex - we need to take advantage of the MVC (Model View Controller) design pattern and consider using the following file layout for a "Hello World 2" module instead:

<source lang="text">
/modules/mod_hello_world2/index.html
/modules/mod_hello_world2/mod_hello_world2.php
/modules/mod_hello_world2/mod_hello_world2.xml
/modules/mod_hello_world2/helper.php
/modules/mod_hello_world2/en-GB.mod_hello_world2.ini
/modules/mod_hello_world2/tmpl/index.html
/modules/mod_hello_world2/tmpl/default.php
</source>

The differences to note here are that there are three additional files beyond what the "Hello World" module had, namely helper.php, tmpl/default.php, and the en-GB.mod_hello_world2.ini file. The purpose in adding the first two files is two-fold. Firstly, we separate the module's logic into the helper.php file to ensure that all of the thinking and data access is performed here and separate out the module's presentation / template into the tmpl/default.php file (the (X)HTML). I argue that this is just good programming - separating logic from presentation. There is a second advantage to this, however, which is that it will allow the HTML / presentation to be overridden easily by any Joomla! 1.5 template for optimal integration into any site. (Overriding module and component presentation in templates is beyond the scope of this article, however it should be addressed as it's really useful).

Let's take a look at what these files might look like and discuss what's going on.

'''/modules/mod_hello_world2/mod_hello_world2.php:'''

<source lang="php">
<?php
//no direct access
defined('_JEXEC') or die('Direct Access to this location is not allowed.');

// include the helper file
require_once(dirname(__FILE__).DS.'helper.php');

// get a parameter from the module's configuration
$userCount = $params->get('usercount');

// get the items to display from the helper
$items = ModHelloWorld2Helper::getItems($userCount);

// include the template for display
require(JModuleHelper::getLayoutPath('mod_hello_world2'));
?>
</source>

The important differences to note are that (1) we include a helper file which will be the work-horse of our logic and data access and (2) once we have our data, we just load a template which will use our data and render it as it sees fit.

'''/modules/mod_hello_world2/mod_hello_world2.xml'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install type="module" version="1.5.0">

<name>Hello World 2 - Hello</name>


<author>Ambitionality Software LLC</author>


<creationDate>2008-06-23</creationDate>


<copyright>All rights reserved by Ambitionality Software LLC 2008.</copyright>


<license>GPL 2.0</license>


<authorEmail>info@ambitionality.com</authorEmail>


<authorUrl>www.ambitionality.com</authorUrl>


<version>1.0.0</version>


<description>Provides a random listing of registered users</description>


<files>

<filename module="mod_hello_world2">mod_hello_world2.php</filename>
<filename>index.html</filename>
<filename>helper.php</filename>
<filename>tmpl/default.php</filename>
<filename>tmpl/index.html</filename>
</files>

<languages>

<language tag="en-GB">en-GB.mod_hello_world2.ini</language>
</languages>


<params>

<param name="moduleclass_sfx" type="text" default="" label="Module Class Suffix" description="PARAMMODULECLASSSUFFIX" />


<param name="@spacer" type="spacer" default="" label="" description="" />


<param name="usercount" type="text" default="5" label="LABEL USER COUNT" description="DESC USER COUNT" />
</params>
</install>
</source>

The main differences to note here are that we have added a language file reference (we could have added more) and we added some parameters.

'''/modules/mod_hello_world2/helper.php:'''

<source lang="php">
<?php
defined('_JEXEC') or die('Direct Access to this location is not allowed.');

class ModHelloWorld2Helper
{
/**
* Returns a list of post items
*/
public function getItems($userCount)
{
// get a reference to the database
$db = &JFactory::getDBO();

// get a list of $userCount randomly ordered users
$query = 'SELECT a.name FROM `#__users` AS a ORDER BY rand() LIMIT ' . $userCount . '';

$db->setQuery($query);
$items = ($items = $db->loadObjectList())?$items:array();

return $items;
} //end getItems

} //end ModHelloWorld2Helper
?>
</source>

This helper class (note that it is named for the module name so that it doesn't collide with other class names) simply retrieves a list of all users in the database and randomly selects a subset of those based upon the number supplied as $userCount.

'''/modules/mod_hello_world2/tmpl/default.php:'''

<source lang="php">
<?php defined('_JEXEC') or die('Restricted access'); // no direct access ?>
<?php echo JText::_('RANDOM USERS'); ?>
<ul>
<?php foreach ($items as $item) { ?>
<li>
<?php echo JText::sprintf('USER LABEL', $item->name); ?>
</li>
<?php } ?>
</ul>
</source>

Here we simply create an unordered HTML list and then iterate through the items returned by our helper (in mod_hello_world2.php), printing out a message with each user's name.

'''/modules/mod_hello_world2/en-GB.mod_hello_world2.ini:'''

<source lang="text">
LABEL USER COUNT=User Count
DESC USER COUNT=The number of users to display
RANDOM USERS=Random Users for Hello World2
USER LABEL=%s is a randomly selected user
</source>

Here we simply identify strings which appear in the module configuration file and the module template which appear in JText::_ or JText::sprintf statements. This allows someone to easily write a new language file without editing any of the HTML or code for the module.

Now all we have to do is zip up these files, as in:

<source lang="text">
% pwd
/somesite/modules/mod_hello_world2
% zip -r ../mod_hello_world2.zip *
% ls ..
mod_hello_world2.zip
</source>

The resulting mod_hello_world2.zip file is ready for installation and distribution. When the ZIP file is installed, the en-GB.mod_hello_world2.ini file is copied to /language/en-GB/en-GB.mod_hello_world2.ini and is loaded each time the module is loaded. All of the other files are copied to the /modules/mod_hello_world2 subfolder of the Joomla! installation.

== Joomla! 1.5 Database installation usage ==

Modules should in general not interact with the database except for normal operations (SELECT, UPDATE, INSERT, DELETE).
But in some cases it might be needed to ALTER or even CREATE tables, even though it is not recommended.
There is no common practice to this, but here is one way of doing just that:

Add a module parameter that to the manifest:
<source lang="xml">
<params group="advanced">
<param name="is_installed" type="radio" default="0" label="Is module installed?" description="Only use this if you know the consequences! Click No to recreate database">
<option value="0">No</option>
<option value="1">Yes</option>
</param>
</params>
</source>

Then you can use the parameter to switch the state and since parameters is already loaded from database, any overhead is not noticable.
<source lang="php">
// put this in the module function.
function myModuleReInstall() {
if (!$params->get('is_installed')) {
$database =& JFactory::getDBO();
$query = "CREATE TABLE example ( id INT, data VARCHAR(100) );";

$database->setQuery($query);
$result = $database->query();

$params->set('is_installed', 1);
}
}
</source>

<noinclude>[[Category:Development]]</noinclude>
[[Category:Tutorials]] [[Category:Module Development]]

J1.5:Creating a simple module

2010-10-27T10:42:36Z

Littlejohn: /* Basic Hello World Module */

{{review}}
== Basic Hello World Module ==

A Joomla! 1.5 Module is in its most basic form two files: an XML configuration file and a PHP controller file. The XML configuration file contains general information about the module (as will be displayed in the Module Manager in the Joomla! administration interface), as well as module parameters which may be supplied to fine tune the appearance / functionality of the module. The PHP file provides the controlling logic for the module. A very simple "Hello World" module might looking something like this.

'''/modules/mod_hello_world/mod_hello_world.xml:'''

'''!!! Note:''' it is very important, that XML file name matches module name. Otherwise, installer will install the module, but Joomla wouldn't show parameters and additional info stored in XML.

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install type="module" version="1.5.0">

<name>Hello World - Hello</name>


<author>Ambitionality Software LLC</author>


<creationDate>2008-06-23</creationDate>


<copyright>All rights reserved by Ambitionality Software LLC 2008.</copyright>


<license>GPL 2.0</license>


<authorEmail>info@ambitionality.com</authorEmail>


<authorUrl>www.ambitionality.com</authorUrl>


<version>1.0.0</version>


<description>Provides a basic "Hello World" notice</description>


<files>

<filename module="mod_hello_world">mod_hello_world.php</filename>
<filename>index.html</filename>
</files>


<params />
</install>
</source>

Basically, this XML file just lines out basic information about the module such as the owner, version, etc. for identification by the Joomla! installer and then provides optional parameters which may be set in the Module Manager and accessed from within the module's logic to fine tune its behavior. Additionally, this file tells the installer which files should be copied and installed. Notice that we DO NOT include a reference in the files section for the XML file.

'''/modules/mod_hello_world/mod_hello_world.php:'''

<source lang="php">
<?php
//don't allow other scripts to grab and execute our file
defined('_JEXEC') or die('Direct Access to this location is not allowed.');
?>

Hello World

</source>

What happens when this module is loaded is that Joomla! includes (via the PHP include directive) the mod_hello_world.php file and stores the output into an output buffer which is then rendered onto the page output. This file would simply produce Hello World to the final page.

'''/modules/mod_hello_world/index.html:'''

<source lang="html4strict">
<html><body bgcolor="#FFFFFF"></body></html>
</source>

This really just helps to ensure that a default page is displayed if direct access to the directory is attempted without listing all of the other files in the directory. It's not necessary, but is good practice.

To package this module for distribution and installation, simply zip the files together, e.g.,

<source lang="text">
% cd mod_hello_world
% zip mod_hello_world.zip mod_hello_world.php mod_hello_world.xml index.html
</source>

The resulting mod_hello_world.zip file may be uploaded and installed through the standard Joomla! 1.5 Extension Manager.

== Real Joomla! 1.5 Style Module Implementation ==

Now that was easy...too easy. In fact, that was pretty much the simplest form of a module possible. In reality a module will probably be doing something much more substantial. Let's assume that our modules are going to be more complex - we need to take advantage of the MVC (Model View Controller) design pattern and consider using the following file layout for a "Hello World 2" module instead:

<source lang="text">
/modules/mod_hello_world2/index.html
/modules/mod_hello_world2/mod_hello_world2.php
/modules/mod_hello_world2/mod_hello_world2.xml
/modules/mod_hello_world2/helper.php
/modules/mod_hello_world2/en-GB.mod_hello_world2.ini
/modules/mod_hello_world2/tmpl/index.html
/modules/mod_hello_world2/tmpl/default.php
</source>

The differences to note here are that there are three additional files beyond what the "Hello World" module had, namely helper.php, tmpl/default.php, and the en-GB.mod_hello_world2.ini file. The purpose in adding the first two files is two-fold. Firstly, we separate the module's logic into the helper.php file to ensure that all of the thinking and data access is performed here and separate out the module's presentation / template into the tmpl/default.php file (the (X)HTML). I argue that this is just good programming - separating logic from presentation. There is a second advantage to this, however, which is that it will allow the HTML / presentation to be overridden easily by any Joomla! 1.5 template for optimal integration into any site. (Overriding module and component presentation in templates is beyond the scope of this article, however it should be addressed as it's really useful).

Let's take a look at what these files might look like and discuss what's going on.

'''/modules/mod_hello_world2/mod_hello_world2.php:'''

<source lang="php">
<?php
//no direct access
defined('_JEXEC') or die('Direct Access to this location is not allowed.');

// include the helper file
require_once(dirname(__FILE__).DS.'helper.php');

// get a parameter from the module's configuration
$userCount = $params->get('usercount');

// get the items to display from the helper
$items = ModHelloWorld2Helper::getItems($userCount);

// include the template for display
require(JModuleHelper::getLayoutPath('mod_hello_world2'));
?>
</source>

The important differences to note are that (1) we include a helper file which will be the work-horse of our logic and data access and (2) once we have our data, we just load a template which will use our data and render it as it sees fit.

'''/modules/mod_hello_world2/mod_hello_world2.xml'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install type="module" version="1.5.0">

<name>Hello World 2 - Hello</name>


<author>Ambitionality Software LLC</author>


<creationDate>2008-06-23</creationDate>


<copyright>All rights reserved by Ambitionality Software LLC 2008.</copyright>


<license>GPL 2.0</license>


<authorEmail>info@ambitionality.com</authorEmail>


<authorUrl>www.ambitionality.com</authorUrl>


<version>1.0.0</version>


<description>Provides a random listing of registered users</description>


<files>

<filename module="mod_hello_world2">mod_hello_world2.php</filename>
<filename>index.html</filename>
<filename>helper.php</filename>
<filename>tmpl/default.php</filename>
<filename>tmpl/index.html</filename>
</files>

<languages>

<language tag="en-GB">en-GB.mod_hello_world2.ini</language>
</languages>


<params>

<param name="moduleclass_sfx" type="text" default="" label="Module Class Suffix" description="PARAMMODULECLASSSUFFIX" />


<param name="@spacer" type="spacer" default="" label="" description="" />


<param name="usercount" type="text" default="5" label="LABEL USER COUNT" description="DESC USER COUNT" />
</params>
</install>
</source>

The main differences to note here are that we have added a language file reference (we could have added more) and we added some parameters.

'''/modules/mod_hello_world2/helper.php:'''

<source lang="php">
<?php
defined('_JEXEC') or die('Direct Access to this location is not allowed.');

class ModHelloWorld2Helper
{
/**
* Returns a list of post items
*/
public function getItems($userCount)
{
// get a reference to the database
$db = &JFactory::getDBO();

// get a list of $userCount randomly ordered users
$query = 'SELECT a.name FROM `#__users` AS a ORDER BY rand() LIMIT ' . $userCount . '';

$db->setQuery($query);
$items = ($items = $db->loadObjectList())?$items:array();

return $items;
} //end getItems

} //end ModHelloWorld2Helper
?>
</source>

This helper class (note that it is named for the module name so that it doesn't collide with other class names) simply retrieves a list of all users in the database and randomly selects a subset of those based upon the number supplied as $userCount.

'''/modules/mod_hello_world2/tmpl/default.php:'''

<source lang="php">
<?php defined('_JEXEC') or die('Restricted access'); // no direct access ?>
<?php echo JText::_('RANDOM USERS'); ?>
<ul>
<?php foreach ($items as $item) { ?>
<li>
<?php echo JText::sprintf('USER LABEL', $item->name); ?>
</li>
<?php } ?>
</ul>
</source>

Here we simply create an unordered HTML list and then iterate through the items returned by our helper (in mod_hello_world2.php), printing out a message with each user's name.

'''/modules/mod_hello_world2/en-GB.mod_hello_world2.ini:'''

<source lang="text">
LABEL USER COUNT=User Count
DESC USER COUNT=The number of users to display
RANDOM USERS=Random Users for Hello World2
USER LABEL=%s is a randomly selected user
</source>

Here we simply identify strings which appear in the module configuration file and the module template which appear in JText::_ or JText::sprintf statements. This allows someone to easily write a new language file without editing any of the HTML or code for the module.

Now all we have to do is zip up these files, as in:

<source lang="text">
% pwd
/somesite/modules/mod_hello_world2
% zip -r ../mod_hello_world2.zip *
% ls ..
mod_hello_world2.zip
</source>

The resulting mod_hello_world2.zip file is ready for installation and distribution. When the ZIP file is installed, the en-GB.mod_hello_world2.ini file is copied to /language/en-GB/en-GB.mod_hello_world2.ini and is loaded each time the module is loaded. All of the other files are copied to the /modules/mod_hello_world2 subfolder of the Joomla! installation.
<noinclude>[[Category:Development]]</noinclude>
[[Category:Tutorials]] [[Category:Module Development]]

J1.5:Creating a simple module

2010-10-27T10:40:14Z

Littlejohn: /* Basic Hello World Module */

{{review}}
== Basic Hello World Module ==

A Joomla! 1.5 Module is in its most basic form two files: an XML configuration file and a PHP controller file. The XML configuration file contains general information about the module (as will be displayed in the Module Manager in the Joomla! administration interface), as well as module parameters which may be supplied to fine tune the appearance / functionality of the module. The PHP file provides the controlling logic for the module. A very simple "Hello World" module might looking something like this.

'''/modules/mod_hello_world/mod_hello_world.xml:'''

'''!!! Note:''' it is very important, that XML file name matches module name. Otherwise, installer will install the module, but Joomla wouldn't show parameters and additional info stored in XML.

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install type="module" version="1.5.0">

<name>Hello World - Hello</name>


<author>Ambitionality Software LLC</author>


<creationDate>2008-06-23</creationDate>


<copyright>All rights reserved by Ambitionality Software LLC 2008.</copyright>


<license>GPL 2.0</license>


<authorEmail>info@ambitionality.com</authorEmail>


<authorUrl>www.ambitionality.com</authorUrl>


<version>1.0.0</version>


<description>Provides a basic "Hello World" notice</description>


<files>

<filename module="mod_hello_world">mod_hello_world.php</filename>
<filename>index.html</filename>
</files>


<params />
</install>
</source>

Basically, this XML file just lines out basic information about the module such as the owner, version, etc. for identification by the Joomla! installer and then provides optional parameters which may be set in the Module Manager and accessed from within the module's logic to fine tune its behavior. Additionally, this file tells the installer which files should be copied and installed. Notice that we DO NOT include a reference in the files section for the XML file.

'''/modules/mod_hello_world/mod_hello_world.php:'''

<source lang="php">
<?php
//don't allow other scripts to grab and execute our file
defined('_JEXEC') or die('Direct Access to this location is not allowed.');
?>

Hello World

</source>

What happens when this module is loaded is that Joomla! includes (via the PHP include directive) the mod_hello_world.php file and stores the output into an output buffer which is then rendered onto the page output. This file would simply produce Hello World to the final page.

'''/modules/mod_hello_world/index.html:'''

<source lang="html4strict">
<html><body bgcolor="#FFFFFF"></body></html>
</source>

This really just helps to ensure that a default page is displayed if direct access to the directory is attempted without listing all of the other files in the directory. It's not necessary, but is good practice.

Modules should in general not interact with the database except for normal operations (SELECT, UPDATE, INSERT, DELETE).
But in some cases it might be needed to ALTER or even CREATE tables, even though it is not recommended.
There is no common practice to this, but here is one way of doing just that:

Add a module parameter that to the manifest:
<source lang="xml">
<params group="advanced">
<param name="is_installed" type="radio" default="0" label="Is module installed?" description="Only use this if you know the consequences! Click No to recreate database">
<option value="0">No</option>
<option value="1">Yes</option>
</param>
</params>
</source>

Then you can use the parameter to switch the state and since parameters is already loaded from database, any overhead is not noticable.
<source lang="php">
// put this in the module function.
function myModuleReInstall() {
if (!$params->get('is_installed')) {
$database =& JFactory::getDBO();
$query = "CREATE TABLE example ( id INT, data VARCHAR(100) );";

$database->setQuery($query);
$result = $database->query();

$params->set('is_installed', 1);
}
}
</source>

To package this module for distribution and installation, simply zip the files together, e.g.,

<source lang="text">
% cd mod_hello_world
% zip mod_hello_world.zip mod_hello_world.php mod_hello_world.xml index.html
</source>

The resulting mod_hello_world.zip file may be uploaded and installed through the standard Joomla! 1.5 Extension Manager.

== Real Joomla! 1.5 Style Module Implementation ==

Now that was easy...too easy. In fact, that was pretty much the simplest form of a module possible. In reality a module will probably be doing something much more substantial. Let's assume that our modules are going to be more complex - we need to take advantage of the MVC (Model View Controller) design pattern and consider using the following file layout for a "Hello World 2" module instead:

<source lang="text">
/modules/mod_hello_world2/index.html
/modules/mod_hello_world2/mod_hello_world2.php
/modules/mod_hello_world2/mod_hello_world2.xml
/modules/mod_hello_world2/helper.php
/modules/mod_hello_world2/en-GB.mod_hello_world2.ini
/modules/mod_hello_world2/tmpl/index.html
/modules/mod_hello_world2/tmpl/default.php
</source>

The differences to note here are that there are three additional files beyond what the "Hello World" module had, namely helper.php, tmpl/default.php, and the en-GB.mod_hello_world2.ini file. The purpose in adding the first two files is two-fold. Firstly, we separate the module's logic into the helper.php file to ensure that all of the thinking and data access is performed here and separate out the module's presentation / template into the tmpl/default.php file (the (X)HTML). I argue that this is just good programming - separating logic from presentation. There is a second advantage to this, however, which is that it will allow the HTML / presentation to be overridden easily by any Joomla! 1.5 template for optimal integration into any site. (Overriding module and component presentation in templates is beyond the scope of this article, however it should be addressed as it's really useful).

Let's take a look at what these files might look like and discuss what's going on.

'''/modules/mod_hello_world2/mod_hello_world2.php:'''

<source lang="php">
<?php
//no direct access
defined('_JEXEC') or die('Direct Access to this location is not allowed.');

// include the helper file
require_once(dirname(__FILE__).DS.'helper.php');

// get a parameter from the module's configuration
$userCount = $params->get('usercount');

// get the items to display from the helper
$items = ModHelloWorld2Helper::getItems($userCount);

// include the template for display
require(JModuleHelper::getLayoutPath('mod_hello_world2'));
?>
</source>

The important differences to note are that (1) we include a helper file which will be the work-horse of our logic and data access and (2) once we have our data, we just load a template which will use our data and render it as it sees fit.

'''/modules/mod_hello_world2/mod_hello_world2.xml'''

<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<install type="module" version="1.5.0">

<name>Hello World 2 - Hello</name>


<author>Ambitionality Software LLC</author>


<creationDate>2008-06-23</creationDate>


<copyright>All rights reserved by Ambitionality Software LLC 2008.</copyright>


<license>GPL 2.0</license>


<authorEmail>info@ambitionality.com</authorEmail>


<authorUrl>www.ambitionality.com</authorUrl>


<version>1.0.0</version>


<description>Provides a random listing of registered users</description>


<files>

<filename module="mod_hello_world2">mod_hello_world2.php</filename>
<filename>index.html</filename>
<filename>helper.php</filename>
<filename>tmpl/default.php</filename>
<filename>tmpl/index.html</filename>
</files>

<languages>

<language tag="en-GB">en-GB.mod_hello_world2.ini</language>
</languages>


<params>

<param name="moduleclass_sfx" type="text" default="" label="Module Class Suffix" description="PARAMMODULECLASSSUFFIX" />


<param name="@spacer" type="spacer" default="" label="" description="" />


<param name="usercount" type="text" default="5" label="LABEL USER COUNT" description="DESC USER COUNT" />
</params>
</install>
</source>

The main differences to note here are that we have added a language file reference (we could have added more) and we added some parameters.

'''/modules/mod_hello_world2/helper.php:'''

<source lang="php">
<?php
defined('_JEXEC') or die('Direct Access to this location is not allowed.');

class ModHelloWorld2Helper
{
/**
* Returns a list of post items
*/
public function getItems($userCount)
{
// get a reference to the database
$db = &JFactory::getDBO();

// get a list of $userCount randomly ordered users
$query = 'SELECT a.name FROM `#__users` AS a ORDER BY rand() LIMIT ' . $userCount . '';

$db->setQuery($query);
$items = ($items = $db->loadObjectList())?$items:array();

return $items;
} //end getItems

} //end ModHelloWorld2Helper
?>
</source>

This helper class (note that it is named for the module name so that it doesn't collide with other class names) simply retrieves a list of all users in the database and randomly selects a subset of those based upon the number supplied as $userCount.

'''/modules/mod_hello_world2/tmpl/default.php:'''

<source lang="php">
<?php defined('_JEXEC') or die('Restricted access'); // no direct access ?>
<?php echo JText::_('RANDOM USERS'); ?>
<ul>
<?php foreach ($items as $item) { ?>
<li>
<?php echo JText::sprintf('USER LABEL', $item->name); ?>
</li>
<?php } ?>
</ul>
</source>

Here we simply create an unordered HTML list and then iterate through the items returned by our helper (in mod_hello_world2.php), printing out a message with each user's name.

'''/modules/mod_hello_world2/en-GB.mod_hello_world2.ini:'''

<source lang="text">
LABEL USER COUNT=User Count
DESC USER COUNT=The number of users to display
RANDOM USERS=Random Users for Hello World2
USER LABEL=%s is a randomly selected user
</source>

Here we simply identify strings which appear in the module configuration file and the module template which appear in JText::_ or JText::sprintf statements. This allows someone to easily write a new language file without editing any of the HTML or code for the module.

Now all we have to do is zip up these files, as in:

<source lang="text">
% pwd
/somesite/modules/mod_hello_world2
% zip -r ../mod_hello_world2.zip *
% ls ..
mod_hello_world2.zip
</source>

The resulting mod_hello_world2.zip file is ready for installation and distribution. When the ZIP file is installed, the en-GB.mod_hello_world2.ini file is copied to /language/en-GB/en-GB.mod_hello_world2.ini and is loaded each time the module is loaded. All of the other files are copied to the /modules/mod_hello_world2 subfolder of the Joomla! installation.
<noinclude>[[Category:Development]]</noinclude>
[[Category:Tutorials]] [[Category:Module Development]]

J1.5:Plugin/Events/User

2010-06-29T11:01:14Z

Littlejohn: /* 5.3.1 Overview */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins.

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.

The most common use of this routine would be logging the user into a thirdparty application. If you need to abort the login process (authentication), you will need to use [http://docs.joomla.org/Reference:User_Events_for_Plugin_System#5.3.4_onAuthenticate onAuthenticate] instead.

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php

===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
* $user - An associative array of the columns in the user table.
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* $success - Boolean to identify if the store was successful
* $msg - Error message if store failed
Note; The old values that was just updated, is not available here/afterwards. In that case use onBeforeStoreUser()

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
* $user - An associative array of the columns in the user table.

====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
* $user - An associative array of the columns in the user table.
* $succes - Boolean to identify if the deletion was successful
* $msg - Error message if delete failed ([http://api.joomla.org/Joomla-Framework/Error/JError.html JError] object detailing the error, if any)

====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-29T11:00:12Z

Littlejohn: /* 5.3.2.1 Description */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.

The most common use of this routine would be logging the user into a thirdparty application. If you need to abort the login process (authentication), you will need to use [http://docs.joomla.org/Reference:User_Events_for_Plugin_System#5.3.4_onAuthenticate onAuthenticate] instead.

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php

===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
* $user - An associative array of the columns in the user table.
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* $success - Boolean to identify if the store was successful
* $msg - Error message if store failed
Note; The old values that was just updated, is not available here/afterwards. In that case use onBeforeStoreUser()

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
* $user - An associative array of the columns in the user table.

====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
* $user - An associative array of the columns in the user table.
* $succes - Boolean to identify if the deletion was successful
* $msg - Error message if delete failed ([http://api.joomla.org/Joomla-Framework/Error/JError.html JError] object detailing the error, if any)

====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-29T10:59:30Z

Littlejohn: /* 5.3.2.1 Description */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.

The most common use of this routine would be logging the user into a thirdparty application. If you need to abort the login process (authentication), you will need to use [[#5.3.4_onAuthenticate onAuthenticate]] instead.

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php

===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
* $user - An associative array of the columns in the user table.
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* $success - Boolean to identify if the store was successful
* $msg - Error message if store failed
Note; The old values that was just updated, is not available here/afterwards. In that case use onBeforeStoreUser()

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
* $user - An associative array of the columns in the user table.

====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
* $user - An associative array of the columns in the user table.
* $succes - Boolean to identify if the deletion was successful
* $msg - Error message if delete failed ([http://api.joomla.org/Joomla-Framework/Error/JError.html JError] object detailing the error, if any)

====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-29T10:58:46Z

Littlejohn: /* 5.3.2.1 Description */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered _after_ the user is authenticated against the Joomla! user-base.

The most common use of this routine would be logging the user into a thirdparty application. If you need to abort the login process (authentication), you will need to use [#5.3.4_onAuthenticate onAuthenticate] instead.

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php

===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
* $user - An associative array of the columns in the user table.
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* $success - Boolean to identify if the store was successful
* $msg - Error message if store failed
Note; The old values that was just updated, is not available here/afterwards. In that case use onBeforeStoreUser()

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
* $user - An associative array of the columns in the user table.

====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
* $user - An associative array of the columns in the user table.
* $succes - Boolean to identify if the deletion was successful
* $msg - Error message if delete failed ([http://api.joomla.org/Joomla-Framework/Error/JError.html JError] object detailing the error, if any)

====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

Archived:Joomla! 1.6 Development Status

2010-06-25T17:41:23Z

Littlejohn:

Note: This page is outdated.
Joomla 1.6 is currently in beta 3 (or above). Check the status in the [http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=8103 issuetracker]

{| class="wikitable" style="font-size: 95%; padding:4px; width: auto;"
!'''Task'''
!'''Blocker'''
!'''Status'''
!'''Contact person'''
!'''Description'''
|-
|Implement JForm library
|Alpha
|100%
|Rob Schley, Andrew Eddie
|This library allows to create forms from XML definition files. See the introduction at http://tinyurl.com/psj6c6
|-
|Implement new event triggers
|Alpha
|60%
|
|onBeforeRender, triggers in JForm, onContentDisplay etc.
|-
|Implement new controller dispatcher
|Alpha
|100%
|
|See the discussion at http://tinyurl.com/qlh5bg where Louis explained how this works in 1.6. See related article in wiki here: [[Xml-rpc changes in Joomla! 1.6]].
|-
|Upgrade to Mootools 1.2
|Alpha
|100%
|Louis Landry, Ercan Özkaya
|
|-
|Javascript translation
|Alpha
|100%
|
|This is implemented and finished. Take a look at JOpenID Javascript class and mod_login for details
|-
|New extension updater work
|Alpha
|100%
|Samuel Moffatt
|New extension updater is implemented, but not finished yet.
|-
|Conversion of INI to JSON
|Alpha
|100%
|
|We now use JSON format for storing parameters in the database. This is completed for core components.
|-
|Nested categories
|Alpha
|90%
|Hannes Papenberg
|
|-
|Access control list (ACL)
|Alpha
|80%
|Hannes Papenberg, Louis Landry
|
|-
|User management system
|Alpha
|75%
|
|The new com_members needs to be proof checked.
|-
|Documenting the triggers, finishing them
|
|10%
|Louis Landry, Rob Schley, Andrew Eddie
|The triggers for JForm need to be implemented in the respective extension, which has not happened yet. We need a plan for this one.
|-
|MVCing backend components
|
|90%
|
|Most of the back-end components have MVC file structure, but they are not fully MVC yet
|-
|Parameters for templates in the database
|
|100%
|Hannes Papenberg
|Especially the UI will take a lot of work, we might have to change the database for this one.
|-
|Add template parameter set to menu item creation
|
|10%
|Hannes Papenberg
|
|-
|Refactoring parameters
|
|80%
|
|A review of the current parameters and implementing new ones for the new category system.
|-
|Comments system
|
|80%
|Louis Landry, Andrew Eddie, Rob Schley
|It will be donated by JXtended and will be added to trunk somewhere in the beta phase.
|-
|Hooks for external authentication systems
|
|0%
|
|Need to be implemented in JUser and in the code where Usergroups are managed. Maybe we need a JUsergroupclass
|-
|Database driven install log
|
|0%
|Samuel Moffatt
|
|-
|Convert all layouts to semantic and XHTML strict
|
|0%
|Ron Severdia
|There are some efforts going on for this. See the topic at http://tinyurl.com/qrb39k
|-
|Timezones, JDate and Datetime (gregorian, julian, shamsi, hijri, jewish, buddhist, ethiopian, chinese and french calendar)
|
|0%
|Hannes Papenberg
|
|-
|Refactoring all components to use JForm
|
|80%
|
|
|-

|Localising invalid token message
|
|100%
|
|die('Invalid Token') will be replaced by jexit(JText::_('JInvalid_Token'))
|-
|Ability to select multiple categories for some views
|
|0%
|
|
|-
|New sample content
|
|80%
|Elin Waring
|
|-
|Reformat translation files to adhere to proper INI specs
|
|75%
|Ole Ottosen, JM Simonet
|In 1.6 we will use PHP's own INI parser and will namespace strings. For example "Weblinks_Category_Fieldname" or "Config_Application_Name"
|-
|Migration script from 1.5 to 1.6
|
|0%
|oc666
|[[Migration script from 1.5 to 1.6]]
|-
|Add module assignment to menu items creation
|
|100%
|
|
|-
|Ability to load additional layouts with a template
|
|0%
|Hannes Papenberg
|
|-
|[[Language switcher frontend]]
|
|0%
|Christophe Demko
|
|}
[[Category:Development Working Group]]

Archived:Joomla! 1.6 Development Status

2010-06-25T17:40:07Z

Littlejohn:

Note: This page is outdated and really needs an update.
Joomla 1.6 is currently in beta 3 (or above). [http://joomlacode.org/gf/project/joomla/tracker/?action=TrackerItemBrowse&tracker_id=8103 link Check the status in the tracker]

{| class="wikitable" style="font-size: 95%; padding:4px; width: auto;"
!'''Task'''
!'''Blocker'''
!'''Status'''
!'''Contact person'''
!'''Description'''
|-
|Implement JForm library
|Alpha
|100%
|Rob Schley, Andrew Eddie
|This library allows to create forms from XML definition files. See the introduction at http://tinyurl.com/psj6c6
|-
|Implement new event triggers
|Alpha
|60%
|
|onBeforeRender, triggers in JForm, onContentDisplay etc.
|-
|Implement new controller dispatcher
|Alpha
|100%
|
|See the discussion at http://tinyurl.com/qlh5bg where Louis explained how this works in 1.6. See related article in wiki here: [[Xml-rpc changes in Joomla! 1.6]].
|-
|Upgrade to Mootools 1.2
|Alpha
|100%
|Louis Landry, Ercan Özkaya
|
|-
|Javascript translation
|Alpha
|100%
|
|This is implemented and finished. Take a look at JOpenID Javascript class and mod_login for details
|-
|New extension updater work
|Alpha
|100%
|Samuel Moffatt
|New extension updater is implemented, but not finished yet.
|-
|Conversion of INI to JSON
|Alpha
|100%
|
|We now use JSON format for storing parameters in the database. This is completed for core components.
|-
|Nested categories
|Alpha
|90%
|Hannes Papenberg
|
|-
|Access control list (ACL)
|Alpha
|80%
|Hannes Papenberg, Louis Landry
|
|-
|User management system
|Alpha
|75%
|
|The new com_members needs to be proof checked.
|-
|Documenting the triggers, finishing them
|
|10%
|Louis Landry, Rob Schley, Andrew Eddie
|The triggers for JForm need to be implemented in the respective extension, which has not happened yet. We need a plan for this one.
|-
|MVCing backend components
|
|90%
|
|Most of the back-end components have MVC file structure, but they are not fully MVC yet
|-
|Parameters for templates in the database
|
|100%
|Hannes Papenberg
|Especially the UI will take a lot of work, we might have to change the database for this one.
|-
|Add template parameter set to menu item creation
|
|10%
|Hannes Papenberg
|
|-
|Refactoring parameters
|
|80%
|
|A review of the current parameters and implementing new ones for the new category system.
|-
|Comments system
|
|80%
|Louis Landry, Andrew Eddie, Rob Schley
|It will be donated by JXtended and will be added to trunk somewhere in the beta phase.
|-
|Hooks for external authentication systems
|
|0%
|
|Need to be implemented in JUser and in the code where Usergroups are managed. Maybe we need a JUsergroupclass
|-
|Database driven install log
|
|0%
|Samuel Moffatt
|
|-
|Convert all layouts to semantic and XHTML strict
|
|0%
|Ron Severdia
|There are some efforts going on for this. See the topic at http://tinyurl.com/qrb39k
|-
|Timezones, JDate and Datetime (gregorian, julian, shamsi, hijri, jewish, buddhist, ethiopian, chinese and french calendar)
|
|0%
|Hannes Papenberg
|
|-
|Refactoring all components to use JForm
|
|80%
|
|
|-

|Localising invalid token message
|
|100%
|
|die('Invalid Token') will be replaced by jexit(JText::_('JInvalid_Token'))
|-
|Ability to select multiple categories for some views
|
|0%
|
|
|-
|New sample content
|
|80%
|Elin Waring
|
|-
|Reformat translation files to adhere to proper INI specs
|
|75%
|Ole Ottosen, JM Simonet
|In 1.6 we will use PHP's own INI parser and will namespace strings. For example "Weblinks_Category_Fieldname" or "Config_Application_Name"
|-
|Migration script from 1.5 to 1.6
|
|0%
|oc666
|[[Migration script from 1.5 to 1.6]]
|-
|Add module assignment to menu items creation
|
|100%
|
|
|-
|Ability to load additional layouts with a template
|
|0%
|Hannes Papenberg
|
|-
|[[Language switcher frontend]]
|
|0%
|Christophe Demko
|
|}
[[Category:Development Working Group]]

Archived:Joomla! 1.6 Development Status

2010-06-25T17:37:53Z

Littlejohn:

Note: This page is outdated and really needs an update.

{| class="wikitable" style="font-size: 95%; padding:4px; width: auto;"
!'''Task'''
!'''Blocker'''
!'''Status'''
!'''Contact person'''
!'''Description'''
|-
|Implement JForm library
|Alpha
|100%
|Rob Schley, Andrew Eddie
|This library allows to create forms from XML definition files. See the introduction at http://tinyurl.com/psj6c6
|-
|Implement new event triggers
|Alpha
|60%
|
|onBeforeRender, triggers in JForm, onContentDisplay etc.
|-
|Implement new controller dispatcher
|Alpha
|100%
|
|See the discussion at http://tinyurl.com/qlh5bg where Louis explained how this works in 1.6. See related article in wiki here: [[Xml-rpc changes in Joomla! 1.6]].
|-
|Upgrade to Mootools 1.2
|Alpha
|100%
|Louis Landry, Ercan Özkaya
|
|-
|Javascript translation
|Alpha
|100%
|
|This is implemented and finished. Take a look at JOpenID Javascript class and mod_login for details
|-
|New extension updater work
|Alpha
|100%
|Samuel Moffatt
|New extension updater is implemented, but not finished yet.
|-
|Conversion of INI to JSON
|Alpha
|100%
|
|We now use JSON format for storing parameters in the database. This is completed for core components.
|-
|Nested categories
|Alpha
|90%
|Hannes Papenberg
|
|-
|Access control list (ACL)
|Alpha
|80%
|Hannes Papenberg, Louis Landry
|
|-
|User management system
|Alpha
|75%
|
|The new com_members needs to be proof checked.
|-
|Documenting the triggers, finishing them
|
|10%
|Louis Landry, Rob Schley, Andrew Eddie
|The triggers for JForm need to be implemented in the respective extension, which has not happened yet. We need a plan for this one.
|-
|MVCing backend components
|
|90%
|
|Most of the back-end components have MVC file structure, but they are not fully MVC yet
|-
|Parameters for templates in the database
|
|100%
|Hannes Papenberg
|Especially the UI will take a lot of work, we might have to change the database for this one.
|-
|Add template parameter set to menu item creation
|
|10%
|Hannes Papenberg
|
|-
|Refactoring parameters
|
|80%
|
|A review of the current parameters and implementing new ones for the new category system.
|-
|Comments system
|
|80%
|Louis Landry, Andrew Eddie, Rob Schley
|It will be donated by JXtended and will be added to trunk somewhere in the beta phase.
|-
|Hooks for external authentication systems
|
|0%
|
|Need to be implemented in JUser and in the code where Usergroups are managed. Maybe we need a JUsergroupclass
|-
|Database driven install log
|
|0%
|Samuel Moffatt
|
|-
|Convert all layouts to semantic and XHTML strict
|
|0%
|Ron Severdia
|There are some efforts going on for this. See the topic at http://tinyurl.com/qrb39k
|-
|Timezones, JDate and Datetime (gregorian, julian, shamsi, hijri, jewish, buddhist, ethiopian, chinese and french calendar)
|
|0%
|Hannes Papenberg
|
|-
|Refactoring all components to use JForm
|
|80%
|
|
|-

|Localising invalid token message
|
|100%
|
|die('Invalid Token') will be replaced by jexit(JText::_('JInvalid_Token'))
|-
|Ability to select multiple categories for some views
|
|0%
|
|
|-
|New sample content
|
|80%
|Elin Waring
|
|-
|Reformat translation files to adhere to proper INI specs
|
|75%
|Ole Ottosen, JM Simonet
|In 1.6 we will use PHP's own INI parser and will namespace strings. For example "Weblinks_Category_Fieldname" or "Config_Application_Name"
|-
|Migration script from 1.5 to 1.6
|
|0%
|oc666
|[[Migration script from 1.5 to 1.6]]
|-
|Add module assignment to menu items creation
|
|100%
|
|
|-
|Ability to load additional layouts with a template
|
|0%
|Hannes Papenberg
|
|-
|[[Language switcher frontend]]
|
|0%
|Christophe Demko
|
|}
[[Category:Development Working Group]]

J1.5:Plugin/Events/User

2010-06-14T09:11:09Z

Littlejohn: /* 5.3.9.2 Parameters */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php

===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
* $user - An associative array of the columns in the user table.
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* $success - Boolean to identify if the store was successful
* $msg - Error message if store failed
Note; The old values that was just updated, is not available here/afterwards. In that case use onBeforeStoreUser()

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
* $user - An associative array of the columns in the user table.

====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
* $user - An associative array of the columns in the user table.
* $succes - Boolean to identify if the deletion was successful
* $msg - Error message if delete failed ([http://api.joomla.org/Joomla-Framework/Error/JError.html JError] object detailing the error, if any)

====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-14T09:10:03Z

Littlejohn: /* 5.3.9.2 Parameters */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php

===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
* $user - An associative array of the columns in the user table.
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* $success - Boolean to identify if the store was successful
* $msg - Error message if store failed
Note; The old values that was just updated, is not available here/afterwards. In that case use onBeforeStoreUser()

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
* $user - An associative array of the columns in the user table.

====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
* $user - An associative array of the columns in the user table.
* $succes - Boolean to identify if the deletion was successful
* $msg - Error message if delete failed ([[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any)

====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-14T09:02:08Z

Littlejohn: /* 5.3.8.2 Parameters */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php

===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
* $user - An associative array of the columns in the user table.
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* $success - Boolean to identify if the store was successful
* $msg - Error message if store failed
Note; The old values that was just updated, is not available here/afterwards. In that case use onBeforeStoreUser()

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
* $user - An associative array of the columns in the user table.

====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-14T09:00:58Z

Littlejohn: /* 5.3.9 onAfterDeleteUser */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php

===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
* $user - An associative array of the columns in the user table.
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* $success - Boolean to identify if the store was successful
* $msg - Error message if store failed
Note; The old values that was just updated, is not available here/afterwards. In that case use onBeforeStoreUser()

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-14T09:00:54Z

Littlejohn: /* 5.3.8 onBeforeDeleteUser */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php

===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
* $user - An associative array of the columns in the user table.
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* $success - Boolean to identify if the store was successful
* $msg - Error message if store failed
Note; The old values that was just updated, is not available here/afterwards. In that case use onBeforeStoreUser()

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-14T09:00:46Z

Littlejohn: /* 5.3.6 onBeforeStoreUser */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php

===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
* $user - An associative array of the columns in the user table.
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* $success - Boolean to identify if the store was successful
* $msg - Error message if store failed
Note; The old values that was just updated, is not available here/afterwards. In that case use onBeforeStoreUser()

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-14T09:00:17Z

Littlejohn: /* 5.3.5 onLoginFailure */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
* $user - An associative array of the columns in the user table.
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* $success - Boolean to identify if the store was successful
* $msg - Error message if store failed
Note; The old values that was just updated, is not available here/afterwards. In that case use onBeforeStoreUser()

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-14T09:00:02Z

Littlejohn: /* 5.3.4 onAuthenticate */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
* $user - An associative array of the columns in the user table.
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* $success - Boolean to identify if the store was successful
* $msg - Error message if store failed
Note; The old values that was just updated, is not available here/afterwards. In that case use onBeforeStoreUser()

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-14T08:59:49Z

Littlejohn: /* 5.3.3 onLogoutUser */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
* $user - An associative array of the columns in the user table.
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* $success - Boolean to identify if the store was successful
* $msg - Error message if store failed
Note; The old values that was just updated, is not available here/afterwards. In that case use onBeforeStoreUser()

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-14T08:57:40Z

Littlejohn: /* 5.3.2 onLoginUser */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
* $user - An associative array of the columns in the user table.
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* $success - Boolean to identify if the store was successful
* $msg - Error message if store failed
Note; The old values that was just updated, is not available here/afterwards. In that case use onBeforeStoreUser()

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-10T22:31:53Z

Littlejohn: /* 5.3.7.2 Parameters */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
* $user - An associative array of the columns in the user table.
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* $success - Boolean to identify if the store was successful
* $msg - Error message if store failed
Note; The old values that was just updated, is not available here/afterwards. In that case use onBeforeStoreUser()

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-10T22:30:32Z

Littlejohn: /* 5.3.7.2 Parameters */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
Four parameters:
* $user - An associative array of the columns in the user table.
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
* $success - Boolean to identify if the store was successful
* $msg - Error message if store failed
Note; The old values that was just updated, is not available here/afterwards. In that case use onBeforeStore()

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-10T22:27:52Z

Littlejohn: /* 5.3.6.2 Parameters */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
Note; You can retrieve the values that are about to get updated with JFactory::getUser();

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
Four parameters:
*user - An associative array of the columns in the user table.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
*success - Boolean to identify if the store was successful
*msg - Error message if store failed

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-10T22:26:35Z

Littlejohn: /* 5.3.2.2 Parameters */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
* $user - an associative array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
* $options - an associative array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
Four parameters:
*user - An associative array of the columns in the user table.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
*success - Boolean to identify if the store was successful
*msg - Error message if store failed

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-10T22:25:27Z

Littlejohn: /* 5.3.3.2 Parameters */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
Two parameters: $user, and $options.

*User is an array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
*Options is an options array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
* $credentials - an associative array containing these keys: ["username"] => string, ["id"] => int
* $options - an associative array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
Four parameters:
*user - An associative array of the columns in the user table.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
*success - Boolean to identify if the store was successful
*msg - Error message if store failed

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-10T22:24:33Z

Littlejohn: /* 5.3.6.2 Parameters */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
Two parameters: $user, and $options.

*User is an array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
*Options is an options array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
Two parameters: $credentials, $options
* Credentials is an array containing these keys: ["username"] => string, ["id"] => int
* Options is an array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
Four parameters:
*user - An associative array of the columns in the user table.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
*success - Boolean to identify if the store was successful
*msg - Error message if store failed

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-10T22:24:10Z

Littlejohn: /* 5.3.6.2 Parameters */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
Two parameters: $user, and $options.

*User is an array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
*Options is an options array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
Two parameters: $credentials, $options
* Credentials is an array containing these keys: ["username"] => string, ["id"] => int
* Options is an array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
Two parameters:
* $user - An associative array of the columns in the user table (current values).
* $isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
Four parameters:
*user - An associative array of the columns in the user table.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
*success - Boolean to identify if the store was successful
*msg - Error message if store failed

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-10T22:23:54Z

Littlejohn: /* 5.3.6.2 Parameters */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
Two parameters: $user, and $options.

*User is an array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
*Options is an options array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
Two parameters: $credentials, $options
* Credentials is an array containing these keys: ["username"] => string, ["id"] => int
* Options is an array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
Two parameters:
* user - An associative array of the columns in the user table (current values).
* isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
Four parameters:
*user - An associative array of the columns in the user table.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
*success - Boolean to identify if the store was successful
*msg - Error message if store failed

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-10T22:19:57Z

Littlejohn: /* 5.3.3.2 Parameters */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
Two parameters: $user, and $options.

*User is an array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
*Options is an options array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
Two parameters: $credentials, $options
* Credentials is an array containing these keys: ["username"] => string, ["id"] => int
* Options is an array containing this key: ["clientid"] => int

====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
Three parameters:
*user - An associative array of the columns in the user table.
*id - A unique identifier for this user.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
Four parameters:
*user - An associative array of the columns in the user table.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
*success - Boolean to identify if the store was successful
*msg - Error message if store failed

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-10T22:15:46Z

Littlejohn: /* 5.3.2.1 Description */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
<del>If one plugin returns false, the entire authentication process fails.</del> (needs verification)

====5.3.2.2 Parameters====
Two parameters: $user, and $options.

*User is an array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
*Options is an options array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['id']\\
====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
Three parameters:
*user - An associative array of the columns in the user table.
*id - A unique identifier for this user.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
Four parameters:
*user - An associative array of the columns in the user table.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
*success - Boolean to identify if the store was successful
*msg - Error message if store failed

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-10T22:15:02Z

Littlejohn: /* 5.3.3.1 Description */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
If one plugin returns false, the entire authentication process fails.
====5.3.2.2 Parameters====
Two parameters: $user, and $options.

*User is an array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
*Options is an options array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. <del>If one plugin
returns false, the global logout fails.</del> (needs verification)

====5.3.3.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['id']\\
====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
Three parameters:
*user - An associative array of the columns in the user table.
*id - A unique identifier for this user.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
Four parameters:
*user - An associative array of the columns in the user table.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
*success - Boolean to identify if the store was successful
*msg - Error message if store failed

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-10T22:06:25Z

Littlejohn: /* 5.3.2.2 Parameters */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
If one plugin returns false, the entire authentication process fails.
====5.3.2.2 Parameters====
Two parameters: $user, and $options.

*User is an array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse] type (see link for array keys)
*Options is an options array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. If one plugin
returns false, the global logout fails.
====5.3.3.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['id']\\
====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
Three parameters:
*user - An associative array of the columns in the user table.
*id - A unique identifier for this user.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
Four parameters:
*user - An associative array of the columns in the user table.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
*success - Boolean to identify if the store was successful
*msg - Error message if store failed

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-10T22:05:17Z

Littlejohn: /* 5.3.2.2 Parameters */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
If one plugin returns false, the entire authentication process fails.
====5.3.2.2 Parameters====
Two parameters: $user, and $options.

*User is an array of [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html JAuthenticateResponse]
object type (see link for array variables)
*Options is an options array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. If one plugin
returns false, the global logout fails.
====5.3.3.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['id']\\
====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
Three parameters:
*user - An associative array of the columns in the user table.
*id - A unique identifier for this user.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
Four parameters:
*user - An associative array of the columns in the user table.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
*success - Boolean to identify if the store was successful
*msg - Error message if store failed

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-10T21:58:36Z

Littlejohn: /* 5.3.2.2 Parameters */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
If one plugin returns false, the entire authentication process fails.
====5.3.2.2 Parameters====
Two parameters: $user, and $options.

*User is an array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] object type (see api for variables)
*Options is an options array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. If one plugin
returns false, the global logout fails.
====5.3.3.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['id']\\
====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
Three parameters:
*user - An associative array of the columns in the user table.
*id - A unique identifier for this user.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
Four parameters:
*user - An associative array of the columns in the user table.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
*success - Boolean to identify if the store was successful
*msg - Error message if store failed

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Plugin/Events/User

2010-06-10T21:58:07Z

Littlejohn: /* 5.3.2.2 Parameters */

[[Category:Development]]
[[Category:Plugins]]
==5.3 User Events for Plugin System==

===5.3.1 Overview===
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins,
look [[plugins:create_plugin|here]].

The user events are divided into two parts. First we have the events used while
authentication of a user takes place:
*onLoginUser
*onLogoutUser
*onAuthenticate
*onAuthenticateFailure

Second we have the events triggered during user management:
*onBeforeStoreUser
*onAfterStoreUser
*onBeforeDeleteUser
*onAfterDeleteUser

===5.3.2 onLoginUser===
====5.3.2.1 Description====
This event is triggered after the user is authenticated against the Joomla! user-base.
If one plugin returns false, the entire authentication process fails.
====5.3.2.2 Parameters====
Two parameters: $user, and $options.

*User is an array of the [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] object type
*Options is an options array containing these keys: ["remember"] => bool, ["return"] => string, ["entry_url"] => string

====5.3.2.3 Return Value====
Boolean
====5.3.2.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.2.5 Examples====
*plugins/user/example.php

===5.3.3 onLogoutUser===
====5.3.3.1 Description====
This event is triggered before the user is logged out of the system. If one plugin
returns false, the global logout fails.
====5.3.3.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['id']\\
====5.3.3.3 Return Value====
Boolean
====5.3.3.4 Used in files====
*libraries/joomla/application/application.php
*plugins/user/joomla.php
====5.3.3.5 Examples====
*plugins/user/example.php

===5.3.4 onAuthenticate===
====5.3.4.1 Description====
This event is triggered to verify that a set of login credentials is valid.
====5.3.4.2 Parameters====
Array of credentials. Structure:\\
['username']\\
['password']\\
Alternative authentication mechanisms can supply additional credentials.

====5.3.4.3 Return Value====
An array of [[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] objects detailing the results of each called plugin, including success or failure.
====5.3.4.4 Used in files====
*libraries/joomla/application/user/authentication.php
*plugins/authentication/gmail.php
*plugins/authentication/joomla.php
*plugins/authentication/ldap.php
====5.3.4.5 Examples====
*plugins/authentication/example.php

===5.3.5 onLoginFailure===
====5.3.5.1 Description====
This event is triggered whenever a user authentication request is failed by any plugin.
====5.3.5.2 Parameters====
Two parameters. The credentials array for the user (see onAuthenticate), and the
[[references:joomla.framework:user:jauthenticateresponse|JAuthenticateResponse]] that caused the failure.
====5.3.5.3 Return Value====
Unknown. The return value appears to be ignored in any case.
====5.3.5.4 Used in files====
*libraries/joomla/application/user/authentication.php

===5.3.6 onBeforeStoreUser===
====5.3.6.1 Description====
This event is triggered before an update of a user record.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.6.2 Parameters====
Three parameters:
*user - An associative array of the columns in the user table.
*id - A unique identifier for this user.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)

====5.3.6.3 Return Value====
None
====5.3.6.4 Used in files====
*libraries/joomla/user/user.php
====5.3.6.5 Examples====
*plugins/user/example.php
===5.3.7 onAfterStoreUser===
====5.3.7.1 Description====
This event is triggered after an update of a user record, or when a new user has been stored in the database.

Password in $user array is already hashed at this point. You may retrieve the cleartext password using $_POST['password'].

====5.3.7.2 Parameters====
Four parameters:
*user - An associative array of the columns in the user table.
*isnew - Boolean to identify if this is a new user (true - insert) or an existing one (false - update)
*success - Boolean to identify if the store was successful
*msg - Error message if store failed

====5.3.7.3 Return Value====
None
====5.3.7.4 Used in files====
*libraries/joomla/user/user.php
====5.3.7.5 Examples====
*plugins/user/example.php

===5.3.8 onBeforeDeleteUser===
====5.3.8.1 Description====
The event is triggered when a user is about to be deleted from the system.
====5.3.8.2 Parameters====
An associative array containing user information. Structure:\\
['id']\\
====5.3.8.3 Return Value====
None.
====5.3.8.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.8.5 Examples====
*plugins/user/example.php

===5.3.9 onAfterDeleteUser===
====5.3.9.1 Description====
The event is triggered after a user has been deleted from the system.
====5.3.9.2 Parameters====
Three parameters: user information, delete result, and error result.
User information is an associative array. Structure:\\
['id']\\
Delete result is boolean true if the delete succeeded or an error message on failure.\\
Error result is a [[references:joomla.framework:utilities:jerror|JError]] object detailing the error, if any.
====5.3.9.3 Return Value====
None.
====5.3.9.4 Used in files====
*libraries/joomla/user/user.php
*plugins/user/joomla.php
====5.3.9.5 Examples====
*plugins/user/example.php

J1.5:Creating an Authentication Plugin for Joomla

2010-04-29T14:45:46Z

Littlejohn: /* The Complete myauth.php File */

[[Category:Development]]
[[Category:Plugins]]
====== Creating an Authentication Plugin for Joomla! 1.5 ======

===== Introduction =====

The new authentication plugin system for Joomla! 1.5 offers a great deal of flexibility and power to the system. Using the new system, it is possible to authenticate users from any source - the Joomla! internal database, the Open ID system, an LDAP directory, or any authentication system that can be accessed using PHP.

This HOWTO will present a really basic example of an authentication plugin that demonstrates how to create custom authentication plugins for the Joomla! framework.

===== The plgAuthenticationMyauth Class =====

Joomla! 1.5 plugins are created by creating a child class of the JPlugin class. The JPlugin class provides all the infrastructure and basic functionality that is required. All that is necessary is to provide the necessary methods to handle the desired event.

To create an authentication plugin, the name of the child class must begin with plgAuthentication, and must end with the name of the plugin that is being created. In our case, the plugin is called Myauth, so the class will be called plgAuthenticationMyauth.

The class will have two methods. The first method is the constructor. The second method is the onAuthenticate() method. These methods are actually very simple, as will be demonstrated.

==== The plgAuthenticationMyauth() Method ====

The constructor should take one parameter, which should be passed by reference. All it will do is pass this parameter onto the constructor of its parent class. We should note that this constructor method should have the same name as the class. The name '__construct' cannot be used because PHP4 does not support this mechanism and the fix that is used in the Joomla! core will not allow passing the arguments by reference. Therefore, our constructor looks like:

<source lang="php">function plgAuthenticationMyauth(& $subject) {
parent::__construct($subject);
}</source>

The parent constructor will handle attaching our event observer (plugin) to the subject (the event dispatcher).

==== The onAuthenticate() Method ====

The onAuthenticate() method is the method that will be called when the system is trying to use your plugin to authenticate the user. This method will be passed three parameters: the username, the password, and a reference to an object of type JAuthenticationResponse. This method needs to determine if the username and password are a valid combination for authentication and return the result in the JAuthenticationResponse object.

For our example, the authentication check that we are going to do is very simple. We will simply make sure that the specified username exists in the users table, and if it does, we will check to see if the username is the reverse of the password. So our authentication check will look like:

<source lang="php">$db =& JFactory::getDBO();
$query = 'SELECT `id`'
. ' FROM #__users'
. ' WHERE username=' . $db->quote( $credentials['username'] );
$db->setQuery( $query );
$result = $db->loadResult();

// to authenticate, the username must exist in the database, and the password should be equal
// to the reverse of the username (so user joeblow would have password wolbeoj)
if($result && ($credentials['username'] == strrev( $credentials['password'] )))</source>

Although this is very basic in our example, this code can be replaced with any code that is necessary to perform the authentication checking that is necessary for your plugin. The flexibility is only limited by what PHP can do.

Now that we have determined whether or not authentication was successful, we can now create our response:

<source lang="php">$db =& JFactory::getDBO();
$query = 'SELECT `id`'
. ' FROM #__users'
. ' WHERE username=' . $db->quote( $credentials['username'] );
$db->setQuery( $query );
$result = $db->loadResult();

if (!$result) {
$response->status = JAUTHENTICATE_STATUS_FAILURE;
$response->error_message = 'User does not exist';
}
// to authenticate, the username must exist in the database, and the password should be equal
// to the reverse of the username (so user joeblow would have password wolbeoj)
if($result && ($credentials['username'] == strrev( $credentials['password'] )))
{
$email = JUser::getInstance($result); // Bring this in line with the rest of the system
$response->email = $email->email;
$response->status = JAUTHENTICATE_STATUS_SUCCESS;
}
else
{
$response->status = JAUTHENTICATE_STATUS_FAILURE;
$response->error_message = 'Invalid username and password';
}</source>

For failed responses, we set two properties of the response object: the status property, and the error_message property. Currently there are three recognized response status value - JAUTHENTICATE_STATUS_SUCCESS, JAUTHENTICATE_STATUS_FAILURE, and JAUTHENTICATE_STATUS_CANCEL. For more information on these status values, consult the libraries/joomla/user/authentication.php file.

The error_message property is set in case the authentication is not successful. In our plugin, we set two possible values to this property: "User does not exist", which indicates that our query did not return any results, and "Invalid username and password", which indicates that the password was not the reverse of the username. It should be noted that these values are not returned to the user. For security reasons, the only thing the user will see is a successful login, or a message that says, "Username and password do not match." The Joomla! system can be configured so that these error messages can be stored in a log file for debugging purposes.

If authentication is successful, we can optionally add information from our authentication source to the response. In this case, we are retrieving the user information from the Joomla! database and storing the email address in the response object. For more information on what data can be stored in the response object, please consult [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html http://api.joomla.org]. This data can then be used by user plugins in the event it is desired to automatically create users or perform other login tasks.

==== The Complete myauth.php File ====

Now that we have completed the two methods that are necessary for our class, we put our class into a PHP file that has the same name as our plugin. Since our plugin is called Myauth, we call our file myauth.php. Here is the complete listing for this file:

<source lang="php"><?php
/**
* @version $Id: myauth.php 7180 2007-04-23 16:51:53Z jinx $
* @package Joomla.Tutorials
* @subpackage Plugins
* @license GNU/GPL
*/

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

jimport('joomla.event.plugin');

/**
* Example Authentication Plugin. Based on the example.php plugin in the Joomla! Core installation
*
* @package Joomla.Tutorials
* @subpackage Plugins
* @license GNU/GPL
*/
class plgAuthenticationMyauth extends JPlugin
{
/**
* Constructor
*
* For php4 compatability we must not use the __constructor as a constructor for plugins
* because func_get_args ( void ) returns a copy of all passed arguments NOT references.
* This causes problems with cross-referencing necessary for the observer design pattern.
*
* @param object $subject The object to observe
* @since 1.5
*/
function plgAuthenticationMyauth(& $subject) {
parent::__construct($subject);
}

/**
* This method should handle any authentication and report back to the subject
* This example uses simple authentication - it checks if the password is the reverse
* of the username (and the user exists in the database).
*
* @access public
* @param array $credentials Array holding the user credentials ('username' and 'password')
* @param array $options Array of extra options
* @param object $response Authentication response object
* @return boolean
* @since 1.5
*/
function onAuthenticate( $credentials, $options, &$response )
{
/*
* Here you would do whatever you need for an authentication routine with the credentials
*
* In this example the mixed variable $return would be set to false
* if the authentication routine fails or an integer userid of the authenticated
* user if the routine passes
*/
$db =& JFactory::getDBO();
$query = 'SELECT `id`'
. ' FROM #__users'
. ' WHERE username=' . $db->quote( $credentials['username'] );
$db->setQuery( $query );
$result = $db->loadResult();

if (!$result) {
$response->status = JAUTHENTICATE_STATUS_FAILURE;
$response->error_message = 'User does not exist';
}

// to authenticate, the username must exist in the database, and the password should be equal
// to the reverse of the username (so user joeblow would have password wolbeoj)
if($result && ($credentials['username'] == strrev( $credentials['password'] )))
{
$email = JUser::getInstance($result); // Bring this in line with the rest of the system
$response->email = $email->email;
$response->status = JAUTHENTICATE_STATUS_SUCCESS;
}
else
{
$response->status = JAUTHENTICATE_STATUS_FAILURE;
$response->error_message = 'Invalid username and password';
}
}
}
?></source>

You will notice that we have to add <source lang="php">jimport('joomla.event.plugin');</source>to the beginning of our file in order to load the JPlugin class definition.

===== The XML Install Manifest =====

Now that we have created our JPlugin class, all we have to do is create our XML install file that will tell the Joomla! installer how to install our plugin. This file is simple:

<source lang="php"><?xml version="1.0" encoding="utf-8"?>
<install version="1.5" type="plugin" group="authentication">
<name>Authentication - Myauth</name>
<author>Joomla! Documentation Project</author>
<creationDate>May 30, 2007</creationDate>
<copyright>(C) 2005 - 2007 Open Source Matters. All rights reserved.</copyright>
<license>http://www.gnu.org/copyleft/gpl.html GNU/GPL</license>
<authorEmail>ian.maclennan@help.joomla.org</authorEmail>
<authorUrl>www.joomla.org</authorUrl>
<version>1.5</version>
<description>An sample authentication plugin</description>
<files>
<filename plugin="myauth">myauth.php</filename>
</files>
<params/>
</install></source>

You will notice that this file looks very similar to any other Joomla! XML install manifest file. There are a few important things to notice.

The first thing to notice is the group attribute on the root element. For authentication plugins, the group attribute must have the value 'authentication'. This tells the Joomla! system to treat your plugin as an authentication plugin.

It is also important to note that the version attribute of the root element (install) should be 1.5. This will tell Joomla! that your plugin is written for Joomla! 1.5 and will operate without legacy mode.

We entered the name 'Authentication - Myauth' in the name field. Your plugin doesn't HAVE to follow this convention, but it looks better because then it will match the standard authentication plugins that are listed in the plugin manager.

Finally, notice that filename attribute that contains our plugin file has an attribute called plugin. The value of this should be the name of our plugin. In this case, it is myauth.

===== Wrapping it All Up and Using It =====

Now that we have created our two files, all we have to do is package them up into an archive file that can be read by the Joomla! installer system.

Once we package and install our plugin, it is ready to be used. The plugin is published using the Plugin Manager. All of the authentication plugins will be grouped together. Plugins are enabled by 'publishing them'. You can publish as many authentication plugins as you want. In order for successful authentication to occur, only one of the plugins needs to return a JAUTHENTICATE_STATUS_SUCCESS result.

===== Conclusion =====

We have now created a simple authentication plugin. We have demonstrated the basic process of doing an authentication check and return the results to the Joomla! system.

You can also easily test this plugin by packaging it yourself.

J1.5:Creating an Authentication Plugin for Joomla

2010-04-29T14:39:54Z

Littlejohn: /* The onAuthenticate() Method */

[[Category:Development]]
[[Category:Plugins]]
====== Creating an Authentication Plugin for Joomla! 1.5 ======

===== Introduction =====

The new authentication plugin system for Joomla! 1.5 offers a great deal of flexibility and power to the system. Using the new system, it is possible to authenticate users from any source - the Joomla! internal database, the Open ID system, an LDAP directory, or any authentication system that can be accessed using PHP.

This HOWTO will present a really basic example of an authentication plugin that demonstrates how to create custom authentication plugins for the Joomla! framework.

===== The plgAuthenticationMyauth Class =====

Joomla! 1.5 plugins are created by creating a child class of the JPlugin class. The JPlugin class provides all the infrastructure and basic functionality that is required. All that is necessary is to provide the necessary methods to handle the desired event.

To create an authentication plugin, the name of the child class must begin with plgAuthentication, and must end with the name of the plugin that is being created. In our case, the plugin is called Myauth, so the class will be called plgAuthenticationMyauth.

The class will have two methods. The first method is the constructor. The second method is the onAuthenticate() method. These methods are actually very simple, as will be demonstrated.

==== The plgAuthenticationMyauth() Method ====

The constructor should take one parameter, which should be passed by reference. All it will do is pass this parameter onto the constructor of its parent class. We should note that this constructor method should have the same name as the class. The name '__construct' cannot be used because PHP4 does not support this mechanism and the fix that is used in the Joomla! core will not allow passing the arguments by reference. Therefore, our constructor looks like:

<source lang="php">function plgAuthenticationMyauth(& $subject) {
parent::__construct($subject);
}</source>

The parent constructor will handle attaching our event observer (plugin) to the subject (the event dispatcher).

==== The onAuthenticate() Method ====

The onAuthenticate() method is the method that will be called when the system is trying to use your plugin to authenticate the user. This method will be passed three parameters: the username, the password, and a reference to an object of type JAuthenticationResponse. This method needs to determine if the username and password are a valid combination for authentication and return the result in the JAuthenticationResponse object.

For our example, the authentication check that we are going to do is very simple. We will simply make sure that the specified username exists in the users table, and if it does, we will check to see if the username is the reverse of the password. So our authentication check will look like:

<source lang="php">$db =& JFactory::getDBO();
$query = 'SELECT `id`'
. ' FROM #__users'
. ' WHERE username=' . $db->quote( $credentials['username'] );
$db->setQuery( $query );
$result = $db->loadResult();

// to authenticate, the username must exist in the database, and the password should be equal
// to the reverse of the username (so user joeblow would have password wolbeoj)
if($result && ($credentials['username'] == strrev( $credentials['password'] )))</source>

Although this is very basic in our example, this code can be replaced with any code that is necessary to perform the authentication checking that is necessary for your plugin. The flexibility is only limited by what PHP can do.

Now that we have determined whether or not authentication was successful, we can now create our response:

<source lang="php">$db =& JFactory::getDBO();
$query = 'SELECT `id`'
. ' FROM #__users'
. ' WHERE username=' . $db->quote( $credentials['username'] );
$db->setQuery( $query );
$result = $db->loadResult();

if (!$result) {
$response->status = JAUTHENTICATE_STATUS_FAILURE;
$response->error_message = 'User does not exist';
}
// to authenticate, the username must exist in the database, and the password should be equal
// to the reverse of the username (so user joeblow would have password wolbeoj)
if($result && ($credentials['username'] == strrev( $credentials['password'] )))
{
$email = JUser::getInstance($result); // Bring this in line with the rest of the system
$response->email = $email->email;
$response->status = JAUTHENTICATE_STATUS_SUCCESS;
}
else
{
$response->status = JAUTHENTICATE_STATUS_FAILURE;
$response->error_message = 'Invalid username and password';
}</source>

For failed responses, we set two properties of the response object: the status property, and the error_message property. Currently there are three recognized response status value - JAUTHENTICATE_STATUS_SUCCESS, JAUTHENTICATE_STATUS_FAILURE, and JAUTHENTICATE_STATUS_CANCEL. For more information on these status values, consult the libraries/joomla/user/authentication.php file.

The error_message property is set in case the authentication is not successful. In our plugin, we set two possible values to this property: "User does not exist", which indicates that our query did not return any results, and "Invalid username and password", which indicates that the password was not the reverse of the username. It should be noted that these values are not returned to the user. For security reasons, the only thing the user will see is a successful login, or a message that says, "Username and password do not match." The Joomla! system can be configured so that these error messages can be stored in a log file for debugging purposes.

If authentication is successful, we can optionally add information from our authentication source to the response. In this case, we are retrieving the user information from the Joomla! database and storing the email address in the response object. For more information on what data can be stored in the response object, please consult [http://api.joomla.org/Joomla-Framework/User/JAuthenticationResponse.html http://api.joomla.org]. This data can then be used by user plugins in the event it is desired to automatically create users or perform other login tasks.

==== The Complete myauth.php File ====

Now that we have completed the two methods that are necessary for our class, we put our class into a PHP file that has the same name as our plugin. Since our plugin is called Myauth, we call our file myauth.php. Here is the complete listing for this file:

<source lang="php"><?php
/**
* @version $Id: myauth.php 7180 2007-04-23 16:51:53Z jinx $
* @package Joomla.Tutorials
* @subpackage Plugins
* @license GNU/GPL
*/

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

jimport('joomla.event.plugin');

/**
* Example Authentication Plugin. Based on the example.php plugin in the Joomla! Core installation
*
* @package Joomla.Tutorials
* @subpackage Plugins
* @license GNU/GPL
*/
class plgAuthenticationMyauth extends JPlugin
{
/**
* Constructor
*
* For php4 compatability we must not use the __constructor as a constructor for plugins
* because func_get_args ( void ) returns a copy of all passed arguments NOT references.
* This causes problems with cross-referencing necessary for the observer design pattern.
*
* @param object $subject The object to observe
* @since 1.5
*/
function plgAuthenticationMyauth(& $subject) {
parent::__construct($subject);
}

/**
* This method should handle any authentication and report back to the subject
* This example uses simple authentication - it checks if the password is the reverse
* of the username (and the user exists in the database).
*
* @access public
* @param string $username Username for authentication
* @param string $password Password for authentication
* @param object $response Authentication response object
* @return boolean
* @since 1.5
*/
function onAuthenticate( $username, $password, &$response )
{
/*
* Here you would do whatever you need for an authentication routine with the credentials
*
* In this example the mixed variable $return would be set to false
* if the authentication routine fails or an integer userid of the authenticated
* user if the routine passes
*/
$db =& JFactory::getDBO();
$query = 'SELECT `id`'
. ' FROM #__users'
. ' WHERE username=' . $db->quote( $username );
$db->setQuery( $query );
$result = $db->loadResult();

if (!$result) {
$response->status = JAUTHENTICATE_STATUS_FAILURE;
$response->error_message = 'User does not exist';
}
// to authenticate, the username must exist in the database, and the password should be equal
// to the reverse of the username (so user joeblow would have password wolbeoj)
if($result && ($username == strrev( $password )))
{
$email = JUser::getInstance($result); // Bring this in line with the rest of the system
$response->email = $email->email;
$response->status = JAUTHENTICATE_STATUS_SUCCESS;
}
else
{
$response->status = JAUTHENTICATE_STATUS_FAILURE;
$response->error_message = 'Invalid username and password';
}
}
}
?></source>

You will notice that we have to add <source lang="php">jimport('joomla.event.plugin');</source>to the beginning of our file in order to load the JPlugin class definition.

===== The XML Install Manifest =====

Now that we have created our JPlugin class, all we have to do is create our XML install file that will tell the Joomla! installer how to install our plugin. This file is simple:

<source lang="php"><?xml version="1.0" encoding="utf-8"?>
<install version="1.5" type="plugin" group="authentication">
<name>Authentication - Myauth</name>
<author>Joomla! Documentation Project</author>
<creationDate>May 30, 2007</creationDate>
<copyright>(C) 2005 - 2007 Open Source Matters. All rights reserved.</copyright>
<license>http://www.gnu.org/copyleft/gpl.html GNU/GPL</license>
<authorEmail>ian.maclennan@help.joomla.org</authorEmail>
<authorUrl>www.joomla.org</authorUrl>
<version>1.5</version>
<description>An sample authentication plugin</description>
<files>
<filename plugin="myauth">myauth.php</filename>
</files>
<params/>
</install></source>

You will notice that this file looks very similar to any other Joomla! XML install manifest file. There are a few important things to notice.

The first thing to notice is the group attribute on the root element. For authentication plugins, the group attribute must have the value 'authentication'. This tells the Joomla! system to treat your plugin as an authentication plugin.

It is also important to note that the version attribute of the root element (install) should be 1.5. This will tell Joomla! that your plugin is written for Joomla! 1.5 and will operate without legacy mode.

We entered the name 'Authentication - Myauth' in the name field. Your plugin doesn't HAVE to follow this convention, but it looks better because then it will match the standard authentication plugins that are listed in the plugin manager.

Finally, notice that filename attribute that contains our plugin file has an attribute called plugin. The value of this should be the name of our plugin. In this case, it is myauth.

===== Wrapping it All Up and Using It =====

Now that we have created our two files, all we have to do is package them up into an archive file that can be read by the Joomla! installer system.

Once we package and install our plugin, it is ready to be used. The plugin is published using the Plugin Manager. All of the authentication plugins will be grouped together. Plugins are enabled by 'publishing them'. You can publish as many authentication plugins as you want. In order for successful authentication to occur, only one of the plugins needs to return a JAUTHENTICATE_STATUS_SUCCESS result.

===== Conclusion =====

We have now created a simple authentication plugin. We have demonstrated the basic process of doing an authentication check and return the results to the Joomla! system.

You can also easily test this plugin by packaging it yourself.