GSOC 2018 Project Ideas

2017-11-22T10:00:37Z

Yvesh: Updating links

GSOC 2018 Project Ideas

2017-11-22T09:57:47Z

Yvesh: Initial Submission of new ideas 2018

GSoC Student Selection Criteria

2017-11-22T08:44:57Z

Yvesh: Update to 2018

[[Image:Gsoc2016.png|50px|left|link=]]
==Want to become a Joomla! Google Summer of Code student?==
<br>We welcome all enthusiast students to work with Joomla for Google Summer of Code. We encourage you to “do your homework” studying about the GSoC program. This will help you to make an informed decision. :) Here are some resources for students to get familiar with the program:

*Learn about [https://developers.google.com/open-source/gsoc/faq GSoC]
*Go through the [https://developers.google.com/open-source/gsoc/resources/manual Student Manual] on GSoC Site
*Decide if you are [https://developers.google.com/open-source/gsoc/faq?hl=en#whos_eligible_to_participate_as_a_student_in_google_summer_of_code eligible]
*Read the [https://summerofcode.withgoogle.com/terms/student Student Participation Agreement] from Google.
*Go through the [https://summerofcode.withgoogle.com/rules/ Rules for 2016 Program] on GSoC Site
*Examine the list of available [https://docs.joomla.org/GSOC_2018_Project_Ideas project ideas] in Joomla for GSoC 2018
**If you do not see any interesting projects from the proposed ideas, we encourage you to contact [https://groups.google.com/forum/?hl=en#!forum/jgsoc/ Joomla GSoC mailing list] and propose a new idea.
*Start working on the project proposal.
*Community and mentors are waiting in the [https://groups.google.com/forum/?hl=en#!forum/jgsoc-2016/ Joomla GSoC mailing list] to help you with that!
*Register in [https://summerofcode.withgoogle.com/ GSoC] as a student (after student registrations open)
<br>
Over the years we have seen many successful student projects. Here are a few tips for students to get an edge over their proposal.

*Get familiar with Joomla Project.
**Setup Joomla on your computer (see [https://docs.joomla.org/Portal:Beginners Joomla for Beginners]).
**Setup Joomla [https://docs.joomla.org/Setting_up_your_workstation_for_Joomla_development development environment].
*Start contributing to the Project and engage with the Community.
**Contribute to [https://docs.joomla.org/JDOC:How_to_Contribute_to_Joomla!_Documentation documentation].
**Contribute to the development (see [https://issues.joomla.org/ Issue Tracker]).
***Fix some known issues.
***Support in verifying fixed issues.
***Help us in strengthening the unit test coverage.
**Help others by answering their questions (see [http://forum.joomla.org/ Joomla Forums]).
*Start early discussing your proposal with the community on the [https://groups.google.com/forum/#!forum/jgsoc-2016 Joomla GSoC Mailing list].
<br>
[[Image:Gsoc2016.png|50px|left|link=]]
==Selection Criteria==
<br><br>
We will select the best proposals based on the following criteria:<br>
''(The quantity of students depends on the number of Joomla projects accepted in GSoC)''<br>

*The quality of the proposal and its priority for Joomla Project.
*Engagement of the student with the community and potential mentors.
*Contributions by the student to the Joomla Project & Community.
*Contributing to other Open Source Projects is a plus.
<br>
::<big>'''We are waiting for your proposal! :)'''</big>

[[Category:Google Summer of Code]] [[Category:Google Summer of Code 2018]]

GSoC Student Selection Criteria

2017-11-22T08:04:50Z

Yvesh:

[[Image:Gsoc2016.png|50px|left|link=]]
==Want to become a Joomla! Google Summer of Code student?==
<br>We welcome all enthusiast students to work with Joomla for Google Summer of Code. We encourage you to “do your homework” studying about the GSoC program. This will help you to make an informed decision. :) Here are some resources for students to get familiar with the program:

*Learn about [https://developers.google.com/open-source/gsoc/faq GSoC]
*Go through the [https://developers.google.com/open-source/gsoc/resources/manual Student Manual] on GSoC Site
*Decide if you are [https://developers.google.com/open-source/gsoc/faq?hl=en#whos_eligible_to_participate_as_a_student_in_google_summer_of_code eligible]
*Read the [https://summerofcode.withgoogle.com/terms/student Student Participation Agreement] from Google.
*Go through the [https://summerofcode.withgoogle.com/rules/ Rules for 2016 Program] on GSoC Site
*Examine the list of available [https://docs.joomla.org/GSOC_2016_Project_Ideas project ideas] in Joomla for GSoC 2016
**If you do not see any interesting projects from the proposed ideas, we encourage you to contact [https://groups.google.com/forum/?hl=en#!forum/jgsoc-2016/ Joomla GSoC mailing list] and propose a new idea.
*Start working on the project proposal.
*Community and mentors are waiting in the [https://groups.google.com/forum/?hl=en#!forum/jgsoc-2016/ Joomla GSoC mailing list] to help you with that!
*Register in [https://summerofcode.withgoogle.com/ GSoC 2016] as a student (after student registrations open)
<br>
Over the years we have seen many successful student projects. Here are a few tips for students to get an edge over their proposal.

*Get familiar with Joomla Project.
**Setup Joomla on your computer (see [https://docs.joomla.org/Portal:Beginners Joomla for Beginners]).
**Setup Joomla [https://docs.joomla.org/Setting_up_your_workstation_for_Joomla_development development environment].
*Start contributing to the Project and engage with the Community.
**Contribute to [https://docs.joomla.org/JDOC:How_to_Contribute_to_Joomla!_Documentation documentation].
**Contribute to the development (see [https://issues.joomla.org/ Issue Tracker]).
***Fix some known issues.
***Support in verifying fixed issues.
***Help us in strengthening the unit test coverage.
**Help others by answering their questions (see [http://forum.joomla.org/ Joomla Forums]).
*Start early discussing your proposal with the community on the [https://groups.google.com/forum/#!forum/jgsoc-2016 Joomla GSoC Mailing list].
<br>
[[Image:Gsoc2016.png|50px|left|link=]]
==Selection Criteria==
<br><br>
We will select the best proposals based on the following criteria:<br>
''(The quantity of students depends on the number of Joomla projects accepted in GSoC)''<br>

*The quality of the proposal and its priority for Joomla Project.
*Engagement of the student with the community and potential mentors.
*Contributions by the student to the Joomla Project & Community.
*Contributing to other Open Source Projects is a plus.
<br>
::<big>'''We are waiting for your proposal! :)'''</big>

[[Category:Google Summer of Code]] [[Category:Google Summer of Code 2018]]

GSOC 2018

2017-11-22T08:03:32Z

Yvesh:

[[Image:Gsoc2016.png|250px|left|link=GSOC 2018]]
<br />
== Welcome to Google Summer of Code 2018 ==
This page will aim to be a general informational page for students, mentors and others interested in Joomla's Google Summer of Code Program.
=== What is GSoC? ===
Google Summer of Code is a program run by Google for college students interested in getting a stipend to contribute to FOSS projects. They will spend there summer with improving and writing new features for the project. [https://developers.google.com/open-source/gsoc/ Visit the Google Summer of Code site to learn more.]

*[https://developers.google.com/open-source/gsoc/timeline Google Summer of Code Timeline]
*[[GSOC_2016_Joomla_GIT_Workflow|Github Work Flow for GSoC Students and Mentors]]
*[https://volunteers.joomla.org/working-groups/google-summer-of-code-joomla-team GSoC Team on Joomla Volunteers Portal]

Last years projects:

*[https://summerofcode.withgoogle.com/organizations/5660160231997440/ Google Summer of Code for Joomla! Project 2016]

== Information For Students ==
* [[GSOC 2018 Project Ideas|Joomla's Idea List]]
* [[GSoC Student Selection Criteria]]
* [[GSoC Student Application Template]]
* [[GSOC Ideas Selection Criteria]]
* [https://goo.gl/forms/8cVeLPnehDQED1Ss2 GSoC 2018 Idea submission form]
* [https://groups.google.com/forum/?hl=en#!forum/jgsoc Joomla GSoC Mailing List]
* [https://groups.google.com/forum/#!forum/joomla-dev-cms General Joomla CMS Developer Mailing List]
* [https://groups.google.com/forum/#!forum/joomla-dev-framework Joomla Framework Mailing List]
* [https://docs.joomla.org/GSOC_2016_Joomla_GIT_Workflow Github Work Flow for GSoC Students and Mentors]
<br>

===== CMS or Framework? =====
Joomla developers are currently working on multiple projects: the Joomla CMS 3.x Version and 4.0.0 (2018-2019). Additionally there are many side projects related to testing, Docker, core extensions and other projects.

The CMS is the very popular and well known FOSS content management system powering 3.2% of the internet. The Framework existed within the CMS as a tightly coupled set of utility packages and classes. Eventually developers decided they wanted to work with just those utilities and write new applications not coupled to the CMS. The Joomla Issue Tracker is the first Application built on top of the new Joomla Framework and is currently nearing it's first stable release.

The project supports all of these initiatives, as does Google Summer of Code. On our [http://docs.joomla.org/GSOC_2018_Project_Ideas ideas list] you will find projects related. <br><br>

===== Project Timeline =====
GSoC 2018 time line is available on the GSoC Site, we suggest you to go through it [https://developers.google.com/open-source/gsoc/timeline?hl=en GSoC-18 Timelines]


<br>

===== Project Proposal =====
Please check the [[GSoC Student Application Template]] to understand what we are expecting from your proposal.

<br>

==Information for Mentors==
*Want to be a mentor? Please check the [[GSoC Mentor Guidelines]].
*[[GSoC 2018 Mentors Selection Criteria]]<br>

==Related Articles==

Last Google Summer of Code 2016:

*[https://magazine.joomla.org/issues/issue-sep-2016/item/3129-gsoc-every-story-has-an-ending-every-ending-is-a-new-beginning GSoC: Every Story Has An Ending. Every Ending Is A New Beginning.]
*[https://magazine.joomla.org/issues/issue-oct-2016/item/3143-the-brains-behind-joomla-gsoc The brains behind the Joomla! GSoC projects]
*[https://magazine.joomla.org/issues/issue-oct-2016/item/3152-gsoc-student-ruchiranga-wickramasinghe Interview with one of the 2016 students Ruchiranga Wickramasinghe]
*[http://magazine.joomla.org/issues/issue-feb-2016/item/2964-joomla-s-google-summer-of-code-gsoc-is-proud-to-announce-team-lead-puneet-kala Joomla's Google Summer of Code (GSoC) is Proud to Announce Team Lead: Puneet Kala]
*[http://community.joomla.org/blogs/community/1894-joomla-has-been-selected-as-a-google-summer-of-code-2016-mentor-organization.html Joomla! has been selected as a Google Summer of Code 2016 mentor organization]
*[https://community.joomla.org/gsoc-2016/3070-joomla-google-mentor-summit-gsoc16.html Joomla! is going to the 2016 Google Summer of Code Mentor Summit]
*[https://magazine.joomla.org/site/itemlist/tag/Google%20Summer%20of%20Code Articles on Joomla Community Magazine]

[[Category:Google Summer of Code 2018]]

GSOC 2018

2017-11-22T07:58:55Z

Yvesh: Initial Submit of the new GSoC Landing page

[[Image:Gsoc2016.png|250px|left|link=GSOC 2018]]
<br />
== Welcome to Google Summer of Code 2018 ==
This page will aim to be a general informational page for students, mentors and others interested in Joomla's Google Summer of Code Program.
=== What is GSoC? ===
Google Summer of Code is a program run by Google for college students interested in getting a stipend to contribute to FOSS projects. They will spend there summer with improving and writing new features for the project. [https://developers.google.com/open-source/gsoc/ Visit the Google Summer of Code site to learn more.]

*[https://developers.google.com/open-source/gsoc/timeline Google Summer of Code Timeline]
*[[GSOC_2016_Joomla_GIT_Workflow|Github Work Flow for GSoC Students and Mentors]]
*[https://volunteers.joomla.org/working-groups/google-summer-of-code-joomla-team GSoC Team on Joomla Volunteers Portal]

Last years projects:

*[https://summerofcode.withgoogle.com/organizations/5660160231997440/ Google Summer of Code for Joomla! Project 2016]

== Information For Students ==
* [[GSOC 2018 Project Ideas|Joomla's Idea List]]
* [[GSoC Student Selection Criteria]]
* [[GSoC Student Application Template]]
* [[GSOC Ideas Selection Criteria]]
* [https://docs.google.com/forms/d/e/1FAIpQLSd8up4QNOwkY9It0sHVJ-bfCXaam2p7OUuSZSCiW4U4Ywq-Rg/viewform GSoC 2018 Idea submission form]
* [https://groups.google.com/forum/?hl=en#!forum/jgsoc Joomla GSoC Mailing List]
* [https://groups.google.com/forum/#!forum/joomla-dev-cms General Joomla CMS Developer Mailing List]
* [https://groups.google.com/forum/#!forum/joomla-dev-framework Joomla Framework Mailing List]
* [https://docs.joomla.org/GSOC_2016_Joomla_GIT_Workflow Github Work Flow for GSoC Students and Mentors]
<br>

===== CMS or Framework? =====
Joomla developers are currently working on multiple projects: the Joomla CMS 3.x Version and 4.0.0 (2018-2019). Additionally there are many side projects related to testing, Docker, core extensions and other projects.

The CMS is the very popular and well known FOSS content management system powering 3.2% of the internet. The Framework existed within the CMS as a tightly coupled set of utility packages and classes. Eventually developers decided they wanted to work with just those utilities and write new applications not coupled to the CMS. The Joomla Issue Tracker is the first Application built on top of the new Joomla Framework and is currently nearing it's first stable release.

The project supports all of these initiatives, as does Google Summer of Code. On our [http://docs.joomla.org/GSOC_2018_Project_Ideas ideas list] you will find projects related. <br><br>

===== Project Timeline =====
GSoC 2018 time line is available on the GSoC Site, we suggest you to go through it [https://developers.google.com/open-source/gsoc/timeline?hl=en GSoC-18 Timelines]


<br>

===== Project Proposal =====
Please check the [[GSoC Student Application Template]] to understand what we are expecting from your proposal.

<br>

==Information for Mentors==
*Want to be a mentor? Please check the [[GSoC Mentor Guidelines]].
*[[GSoC 2018 Mentors Selection Criteria]]<br>

==Related Articles==

Last Google Summer of Code 2016:

*[https://magazine.joomla.org/issues/issue-sep-2016/item/3129-gsoc-every-story-has-an-ending-every-ending-is-a-new-beginning GSoC: Every Story Has An Ending. Every Ending Is A New Beginning.]
*[https://magazine.joomla.org/issues/issue-oct-2016/item/3143-the-brains-behind-joomla-gsoc The brains behind the Joomla! GSoC projects]
*[https://magazine.joomla.org/issues/issue-oct-2016/item/3152-gsoc-student-ruchiranga-wickramasinghe Interview with one of the 2016 students Ruchiranga Wickramasinghe]
*[http://magazine.joomla.org/issues/issue-feb-2016/item/2964-joomla-s-google-summer-of-code-gsoc-is-proud-to-announce-team-lead-puneet-kala Joomla's Google Summer of Code (GSoC) is Proud to Announce Team Lead: Puneet Kala]
*[http://community.joomla.org/blogs/community/1894-joomla-has-been-selected-as-a-google-summer-of-code-2016-mentor-organization.html Joomla! has been selected as a Google Summer of Code 2016 mentor organization]
*[https://community.joomla.org/gsoc-2016/3070-joomla-google-mentor-summit-gsoc16.html Joomla! is going to the 2016 Google Summer of Code Mentor Summit]
*[https://magazine.joomla.org/site/itemlist/tag/Google%20Summer%20of%20Code Articles on Joomla Community Magazine]

[[Category:Google Summer of Code 2018]]

Automated Tests Working Group

2017-06-24T10:32:47Z

Yvesh:

<noinclude><languages /></noinclude>
<translate>
The '''Automated Testing Team ''' falls under the responsibility of the [https://volunteers.joomla.org/departments/production Production Department], which oversees all aspects related to the code of all software lead by the Joomla! Project.</translate><br />

<translate>
This is the home page of the Automated Test Team. This team is the result of combining the old System Testing Working Group and the Unit Testing Working Group.</translate>

<translate>
== Team Members == 
</translate>
<translate>
Please visit the [https://volunteers.joomla.org/teams/automated-tests-working-group Volunteers Portal] to get an overview of the members of this team.</translate>

<translate>
== Goals == 
</translate>
<translate>
* Improve the Quality of Joomla CMS software
* Create learning material about "how to test" for the Joomla Community.</translate>
<translate>
== Roadmap== 
</translate>
<translate>
The next steps for 2017 / 2018 are:
* System test coverage for Joomla! CMS core
* Update PHPUnit to newest version
* Code Sniffer rules
* New docker based infrastructure
* Extension Tests for B/C.</translate>

<translate>
==History== 
</translate>

<translate>
=== 2017 === 
</translate>
<translate>
* Merge system tests into core (tests/codeception)</translate>

<translate>
=== Google Summer of Code === 
</translate>
<translate>
* JavaScript Tests for Joomla 4
* Parallel Testing setup
* PR Testing platform.</translate>

<translate>
=== 2016 === 
</translate>
<translate>
* System test architecture.</translate>

<translate>
=== Google Summer of Code === 
</translate>
<translate>
* JavaScript Tests with Karma and Jasmine
* focus on Joomla system Tests and test architecture for Joomla.</translate>

<translate>
=== GSoC 2014 === 
</translate>
<translate>
* Focus on [[S:MyLanguage/GSOC_2014_Project_Ideas#Project:_Webdriver_system_tests_for_CMS|Google Summer of Code 2014 Project: Webdriver system tests for CMS]].</translate>

<translate>

== Documents == 
</translate>
* <translate>
[[S:MyLanguage/Writing_System_Tests_for_Joomla!_-_Part_1|Writing System Tests for Joomla!]]</translate>
* <translate>
Writting system tests with Codeception: [[S:MyLanguage/Testing Joomla Extensions with Codeception|Testing Joomla Extensions with Codeception]]</translate>
* <translate>
Javier Gomez presentation of Joomla System Testing at Joomla World Conference 2014:</translate> http://prezi.com/qsf17leurgbe/automated-system-testing-in-joomla/
* <translate>
Joomla! Testing Overview 2016 session slides:</translate> https://www.slideshare.net/YvesHoppe/joomla-testing-jdd-germany-2016.

<translate>

== Projects == 
</translate>
* <translate>
Joomla System tests:</translate> https://github.com/joomla/joomla-cms/tree/staging/tests/codeception
* com_weblinks: https://github.com/joomla-extensions/weblinks - Extension testing project with Codeception
* <translate>
Old system tests repository:</translate> https://github.com/joomla-projects/gsoc16_browser-automated-tests
* <translate>
Basic steps and actions for Joomla Selenium / Codeception tests:</translate> https://github.com/joomla-projects/joomla-browser
* <translate>
JoRobo build scripts for building extensions:</translate> https://github.com/joomla-projects/jorobo
* <translate>
Joomla Robo.li testing scripts:</translate> https://github.com/joomla-projects/joomla-testing-robo
* <translate>
The Joomla [[S:MyLanguage/Docker Container for System Tests|Docker Container for System Tests]]</translate>
* <translate>
Docker system testing image:</translate> https://github.com/joomla-projects/docker-systemtests
* <translate>
JS Tests (merged in core):</translate> https://github.com/joomla-projects/gsoc16_js-unit-tests
* <translate>
Joomla vagrant testing box:</translate> https://github.com/joomla-projects/vagrant-joomla-testing Groups
* <translate>
Selenium package with webdrivers:</translate> https://github.com/joomla-projects/selenium-server-standalone

<noinclude>
<translate>

[[Category:Production_Department]]
[[Category:Automated Testing]]
[[Category:Active Working Groups]]
[[Category:Working Groups]]
</translate>
</noinclude>

Automated Tests Working Group

2017-06-24T09:47:09Z

Yvesh: Updated linkws

This is the home page of the Automated Test Working Group. This group is the result of combining the old System Testing Working Group and the Unit Testing Working Group.

== Team Members ==
See the full list at: http://volunteers.joomla.org/working-groups/automated-tests-working-group

== Goals ==
* Improve the Quality of Joomla CMS software
* Create learning material about "how to test" for the Joomla Community

== Roadmap==
The next steps for 2017 / 2018 are:

* System test coverage for Joomla! CMS core
* Update PHPUnit to newest version
* Code Sniffer rules
* New docker based infrastructure
* Extension Tests for B/C

==History==

=== 2017 ===
* Merge system tests into core (tests/codeception)

=== Google Summer of Code ===
* JavaScript Tests for Joomla 4
* Parallel Testing setup
* PR Testing platform

=== 2016 ===

* System test architecture

=== Google Summer of Code ===
* JavaScript Tests with Karma and Jasmine
* focus on Joomla system Tests and test architecture for Joomla

=== GSoC 2014 ===
* focus on [[GSOC_2014_Project_Ideas#Project:_Webdriver_system_tests_for_CMS|Google Summer of Code 2014 Project: Webdriver_system_tests_for_CMS]]

== Documents ==
* [[Writing_System_Tests_for_Joomla!_-_Part_1|Writing System Tests for Joomla!]]
* GSOC-Webdriver_system_tests_for_CMS repository: https://github.com/joomla-projects/GSOC-Webdriver_system_tests_for_CMS
* Writting system tests with Codeception: [[Testing Joomla Extensions with Codeception]]
* Javier Gomez presentation of Joomla System Testing at Joomla World Conference 2014: http://prezi.com/qsf17leurgbe/automated-system-testing-in-joomla/
* Joomla! Testing Overview 2016 session slides: https://www.slideshare.net/YvesHoppe/joomla-testing-jdd-germany-2016

== Projects ==
* Joomla System tests: https://github.com/joomla/joomla-cms/tree/staging/tests/codeception
* com_weblinks: https://github.com/joomla-extensions/weblinks - Extension testing project with Codeception
* Old system tests repository: https://github.com/joomla-projects/gsoc16_browser-automated-tests
* Basic steps and actions for Joomla Selenium / Codeception tests: https://github.com/joomla-projects/joomla-browser
* JoRobo build scripts for building extensions: https://github.com/joomla-projects/jorobo
* Joomla Robo.li testing scripts: https://github.com/joomla-projects/joomla-testing-robo
* The Joomla [[Docker Container for System Tests]]
* Docker system testing image: https://github.com/joomla-projects/docker-systemtests
* JS Tests (merged in core): https://github.com/joomla-projects/gsoc16_js-unit-tests
* Joomla vagrant testing box: https://github.com/joomla-projects/vagrant-joomla-testing Groups
* Selenium package with webdrivers: https://github.com/joomla-projects/selenium-server-standalone

[[Category:Production_Department]]
[[Category:Automated Testing]]

Automated Tests Working Group

2017-06-24T09:35:40Z

Yvesh: Minor update to history

This is the home page of the Automated Test Working Group, that is the result of combining the old System Testing Working Group and the Unit Testing Working Group.

== Team Members ==
See the full list at: http://volunteers.joomla.org/working-groups/automated-tests-working-group

== Goals ==
* to improve the Quality of Joomla CMS software
* to create learning material about "how to test" for the Joomla Community

== Roadmap==
The next steps for 2017 / 2018 are:

* System test coverage for Joomla! CMS core
* Update PHPUnit to newest version
* Code Sniffer rules
* New docker based infrastructure
* Extension Tests for B/C

==History==

=== 2017 ===
* Merge system tests into core (tests/codeception)

=== Google Summer of Code ===
* JavaScript Tests for Joomla 4
* Parallel Testing setup
* PR Testing platform

=== 2016 ===

* System test architecture

=== Google Summer of Code ===
* JavaScript Tests with Karma and Jasmine JS
* focus on Joomla system Tests and test architecture for Joomla

=== GSoC 2014 ===
* focus on [[GSOC_2014_Project_Ideas#Project:_Webdriver_system_tests_for_CMS|Google Summer of Code 2014 Project: Webdriver_system_tests_for_CMS]]

== Documents ==
* Joomla! Testing Overview session slides: https://www.slideshare.net/YvesHoppe/joomla-testing-jdd-germany-2016
* [[Writing_System_Tests_for_Joomla!_-_Part_1|Writing System Tests for Joomla!]]
* GSOC-Webdriver_system_tests_for_CMS repository: https://github.com/joomla-projects/GSOC-Webdriver_system_tests_for_CMS
* Writting system tests with Codeception: [[Testing Joomla Extensions with Codeception]]
* Javier Gomez presentation of Joomla System Testing at Joomla World Conference 2014: http://prezi.com/qsf17leurgbe/automated-system-testing-in-joomla/

== Projects ==
* com_weblinks: https://github.com/joomla-extensions/weblinks - Extension testing project with Codeception
* Joomla core system tests: https://github.com/joomla-projects/gsoc16_browser-automated-tests
* Basic steps and actions for Joomla Selenium / Codeception tests: https://github.com/joomla-projects/joomla-browser
* JoRobo build scripts for building extensions: https://github.com/joomla-projects/jorobo
* Joomla Robo.li testing scripts: https://github.com/joomla-projects/joomla-testing-robo
* The Joomla [[Docker Container for System Tests]]
* Docker system testing image: https://github.com/joomla-projects/docker-systemtests
* JS Tests (merged in core): https://github.com/joomla-projects/gsoc16_js-unit-tests
* Joomla vagrant testing box: https://github.com/joomla-projects/vagrant-joomla-testing Groups
* Selenium package with webdrivers: https://github.com/joomla-projects/selenium-server-standalone

[[Category:Production_Department]]
[[Category:Automated Testing]]

GSOC 2017 Project Ideas

2017-04-11T21:48:09Z

Yvesh: Added note that application has been closed

== Welcome to GSoC 2017 Ideas Page ==
Welcome to the [[GSOC_2017|Joomla! Google Summer of Code (GSoC) 2017 project]] ideas page. As we move forward with the 2017 version of the Joomla! GSoC, we will update this site with the ideas that have been submitted below.

{{tip|title= Please note application has been closed for 2017!}}

Please keep in mind that projects need to be realistic and something that is able to be functionally completed by a student working full time for about ten weeks.

If you are interested in participating as a student please review the materials on applying that are available at [https://developers.google.com/open-source/gsoc/faq Google]. We strongly encourage you to ask questions about process and ideas on our [https://groups.google.com/forum/#!forum/jgsoc2017 joomla-gsoc mailing list].

[[Image:Gsoc2016.png|250px|center|link=GSOC 2017]]

== Guidelines on Submitting Ideas ==

Everyone is invited to submit their ideas! You do not have to be a Google Summer of Code student or mentor to suggest one.
If you have ideas for the Joomla Google Summer of Code Program please send them to us at this form:
<br><br>
::'''* [https://docs.google.com/forms/d/e/1FAIpQLSd8up4QNOwkY9It0sHVJ-bfCXaam2p7OUuSZSCiW4U4Ywq-Rg/viewform GSoC 2017 Idea submission form]'''
<br>
There are some important guidelines to submit ideas, please read these carefully before adding your ideas:
* Ensure your idea is able to be completed in a fixed period of time. GSoC runs officially '''between May, 2017 and August 2017.''' This is a short period of actual coding time. Ideas should respect the time that students have available for the program.
* Keep ideas realistic. The ideas on this list should maintain a realistic amount of work for a single student, junior level-developer, who is working with a compressed timeline and a fixed completion ('pencils down') date.
* The purpose of GSoC is to improve Joomla. This is not the time to add ideas for new extensions or features that may not be included. If the idea is related to the framework, please consult the framework team directly about new ideas to ensure there is interest in having the package included as an official Joomla Framework package.
* When in doubt, reach out. If you're unsure if your idea belongs on this list, please post to the GSoC 2017 mailing list and ask about the community's interest.
* No documentation-focused projects. Google Summer of ''Code'' is a program about code. We expect our students to document their work, but writing documentation for Joomla as a project does not align with the goals of GSoC.

== Idea Pool ==

====Project I: Webservices in Joomla! ====
<table border="0" style="width:100%">
<tr>
<th>'''Project Description:'''</th>
</tr>
<tr>
<td>Integrating a rest api endpoint (like api/) into the Joomla Core. More information is going to follow in the next days.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Expected Results:'''</th>
</tr>
<tr>
<td>Working REST Api for core. Including com_content as reference.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Knowledge Prerequisite:'''</th>
</tr>
<tr>
<td>PHP, RESTful Webservices. '''Nice to have:''' Joomla MVC, Swagger, Knowledge of APIs</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Difficulty:'''</th>
</tr>
<tr>
<td>Medium to Hard</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Mentors:'''</th>
</tr>
<tr>
<td>[mailto:fastslack@gmail.com Matias Aguirre],[mailto:anibal.sanchez@gmail.com Anibal Sanchez],[mailto:george.wilson@community.joomla.org George Wilson] </td>
</tr>
</table>

[[Image:Gsoc2016.png|50px|center]]
----

====Project II: Improved Routing ====

<table border="0" style="width:100%">
<tr>
<th>'''Project Description:'''</th>
</tr>
<tr>
<td>Even with the new Router there is much room for improvement in the routing area. This project aims to improve the SEO capabilities of Joomla. This will be achieved by looking at a component by component option of disabling having duplicate URLs by only having one way to access an item from within a component. This will also require changes to modules to allow them to be assigned to orhan homepages.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Expected Results:'''</th>
</tr>
<tr>
<td>Improved Routing handling in components by only having a single url for each page (enabled on a per component basis for b/c)</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Knowledge Prerequisite:'''</th>
</tr>
<tr>
<td>PHP '''Nice to have:''' Joomla MVC, SEO experience</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Difficulty:'''</th>
</tr>
<tr>
<td>Medium to Hard</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Mentors:'''</th>
</tr>
<tr>
<td>[mailto:chris@1aseo.de Christopher Wagner],[mailto:rishivishwakarma24x7@gmail.com Rishi Vishwakarma],[mailto:gunjan.patel@community.joomla.org Gunjan Patel]</td>
</tr>
</table>

[[Image:Gsoc2016.png|50px|center]]
----
====Project III: Cloud filesystems for media manager ====

<table border="0" style="width:100%">
<tr>
<th>'''Project Description:'''</th>
</tr>
<tr>
<td>The new media manager for Joomla! 4 contains a rest like API to fetch the folder structure and file information. This is limited to the local filesystem. For Joomla! 4 it would be nice to break that API up and to allow extension developers to add cloud based filesystems through plugins.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Expected Results:'''</th>
</tr>
<tr>
<td>Media manager API rewrite to support the Joomla! plugins for cloud based filesystems.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Knowledge Prerequisite:'''</th>
</tr>
<tr>
<td>PHP, File system. '''Nice to have:''' Joomla! MVC, Rest, API/Framework integration</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Difficulty:'''</th>
</tr>
<tr>
<td>Medium</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Mentors:'''</th>
</tr>
<tr>
<td>[mailto:allon.moritz@community.joomla.org Allon Moritz],[mailto:david.neukirchen@community.joomla.org David Neukirchen]</td>
</tr>
</table>

[[Image:Gsoc2016.png|50px|center]]
----

====Project IV: Improvements and extended coverage for the parallel testing environment ====

<table border="0" style="width:100%">
<tr>
<th>'''Project Description:'''</th>
</tr>
<tr>
<td>Recently the new container-based automated testing environment was developed (final development stages ongoing when writing this proposal), supporting multiple Joomla and PHP versions and increasing speed for the current codeception-based testing system: https://github.com/joomla-projects/joomla-testing.

There are areas of opportunity that the current testing system is not covering right now, including covering the tests of the CMS itself, so I would like to propose improving 4 specific areas, explained in the expected results.</td>
</tr>
<th>'''Expected Results:'''</th>
</tr>
<tr>
<td>1. Right now it can test Joomla extensions, but it should also have support for testing the CMS itself, by assuming that it needs to start with the testing of the CMS installer (prerequisite), next the tests of the CMS itself and finally the uninstall process.<br>
2. The virtualisation package https://github.com/joomla-projects/virtualisation is unfinished and has little coverage. Right now it can handle basic Apache, PHP and MySQL installations. The goal is to support virtualisation environments including Postgres, Nginx and multiple Joomla versions including staging for extension testing. It also needs to be integrated to the new automated testing environment since it's not using it now.<br>
3. A better and codeception-based built-in testing selection system needs to be created, so that test order is selected not based in a configuration xml file but using the dependencies made in the codeception tests itself. This also means applying this new structure to the Weblinks extension repo and the CMS tests.<br>
4. An automated nightly builder of the staging version of Joomla so it can be used by the virtualisation package to test extensions against a pre-installed staging version.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Knowledge Prerequisite:'''</th>
</tr>
<tr>
<td>PHP and object-oriented programming. Knowledge of system deployment including basic server setup like Apache, PHP, MySQL, Postgres, Nginx. Container-based virtualisation concepts. '''Nice to have:''' Codeception</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Difficulty:'''</th>
</tr>
<tr>
<td>Hard</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Mentors:'''</th>
</tr>
<tr>
<td>[mailto:nbraczek@bsds.de Niels Braczek],[mailto:tito.alvarez@community.joomla.org Tito Alvarez]</td>
</tr>
</table>

[[Image:Gsoc2016.png|50px|center]]
----
====Project V: Testing Dashboard - A birds eye view on the state of testing ====

<table border="0" style="width:100%">
<tr>
<th>'''Project Description:'''</th>
</tr>
<tr>
<td>The Testing Dashboard should give people a compensative overview how the state of testing for our code base is. It collects data from the different testing areas and shows the actual result and some kind of historical data.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Expected Results:'''</th>
</tr>
<tr>
<td>
*Documentation what are the different testing areas
*Documentation how we get details about testing areas
*Developing scripts to get the information and save the data
*Developing a website to show the results (could be a Joomla! Extension)
</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Knowledge Prerequisite:'''</th>
</tr>
<tr>
<td>PHP, MySQL, JavaScript. '''Nice to have:''' Joomla MVC, PHPUnit, Basic Statistics knowledge, REST</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Difficulty:'''</th>
</tr>
<tr>
<td>Medium</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Mentors:'''</th>
</tr>
<tr>
<td>[mailto:nbraczek@bsds.de Niels Braczek],[mailto:robert.deutz@community.joomla.org Robert Deutz]</td>
</tr>
</table>

[[Image:Gsoc2016.png|50px|center]]
----

====Project VI: Publishing Workflow in Joomla! ====

<table border="0" style="width:100%">
<tr>
<th>'''Project Description:'''</th>
</tr>
<tr>
<td>The Joomla! Core offers at the moment a very static publishing workflow (namely: published, unpublished, archived and trashed). The idea of this project is to implement an unlimited workflow solution, so everyone can map his/her/its workflow for all supporting components.

The basic idea is, that we have 3 conditions: - the item is visible (published) - the item is not visible (unpublished) - the item is deleted (trashed)

("Archived" is not needed anymore because it could be achived with an individual state)

This conditions are not "direct publishing states" like at the moment (where you can set a item e.g. to publish), but more "features" of the future states.<br>

=====So how should the new system work?=====

- The user goes to the workflow component and clicks "new" - He/she/it insert a workflow title (let's say "my workflow") - Optional the user can set up different options like: description, publishing state, access level, ACL permissions etc. - After saving he comes to the workflow view, where he/she/it can define the new workflow - Here he has two options: create a new "workflow state" or create a "transition" (ofc. he can delete/edit existing ones, too.)<br>

=====Workflow state:=====

Workflow states are something like the current publishing states (published, unpublished, archived, trashed). That means, items will be set to this state and will be shown (or not) regarding to the property of the state.

Every state has one condition (from above), so a state could have the condition "published" (means, an item with this state will be visible in the frontend), "unpublished" (means, an item with this state will not be visible in the frontend) or "trashed" (means, an item with this state will neither be shown in front- nor backend (until a user filters for it))

So a "workflow state" is a very simple element which (in a basic version) needs only a title and a dropdown for the "condition" (ofc. there could also be parameters like a description).<br>

=====Transition=====

A transition defines the change from one "workflow state" to another one. So it holds the starting "workflow state" and the target "workflow state". Additional it has the requirements defined "who can execute the transition". That means, each transition has its ACL integration and a user can define who can execute this transition.

- The user creates now different "workflow states" and "transitions" to implement his/her/its workflow. For example:

Worflow states: 1. Needs review (condition: unpublished) 2. Needs rework (condition: unpublished) 3. Ready for publishing (condition: unpublished) 4. Online (condition: unpublished) 5. Not needed anymore (condition: trashed)

Transitions: a. From 1. => 2. b. From 2. => 1. c. From 1. => 3. d. From 3. => 4 e. From 1. => 5. f. From 2. => 5. g. From 3. => 5. h. From 4. => 5. i. From 5. => 1.

All transitions have ofc. individual ACL permissions where the user can define which user groups can execute the transition and change the "workflow state"

So as summary you could say: the main idea is to use the current publishing states as "conditions" and allow unlimited repeatable usage of this states.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Expected Results:'''</th>
</tr>
<tr>
<td>
*At the end of the project, there should be a new component in Joomla! in which a user can define unlimited own publishing workflows.
*As basic (none deleteable, none changeable) workflow, the current publishing workflow is implemented, to make sure, we have B/C.
*The workflows should respect the Joomla! ACL (Who can see, who can do actions (activtate)).
*The workflows should be assignable to all Joomla! core components, which could have a publishing workflow (Banners, Contacts, Contents, Menus, Categories and the worklfow component itself) via the configuration of the component.
*If the assigned workflow is changed, there should be a check, if there are no conflicts (like, before we have a publishing state "ready for review" and now not) and if so, offers a "resolve view".
*The publishing workflow should be respected by the components in the frontend. - The backend filters will show the states in the filter dropdown.<br>

=====Additional goals (if time left):=====
*The student could implement a drag&drop functionality to set up new workflows in a very smooth way.
*The student could implement different filter parameters to modules/menu link types where a Joomla! user can choose, which publishing states he want to show or for e.g. article commit, what is the starting state of new submissions.
*Multilingual</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Knowledge Prerequisite:'''</th>
</tr>
<tr>
<td>PHP, JavaScript. '''Nice to have:''' Joomla MVC</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Difficulty:'''</th>
</tr>
<tr>
<td>Medium to Hard</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Mentors:'''</th>
</tr>
<tr>
<td>[mailto:benjamin@benjamintrenkle.de Benjamin Trenkle],[mailto:shubhamnba2009@gmail.com Shubham Rajput], [mailto:kontakt@sven-hurt.de Sven Hurt], [mailto:parth.lawate@community.joomla.org Parth Lawate], [mailto:buddhimawijeweera@gmail.com Buddhima Wijeweera]</td>
</tr>
</table>
[[Image:Gsoc2016.png|50px|center]]
----

====Project VII: Issue Tracker Release Section ====

<table border="0" style="width:100%">
<tr>
<th>'''Important Note:'''</th>
</tr>
<tr>
<td> Note: This project will be merged with Project VIII Refactor the Issue Tracker Application</td>
</tr>

<tr>
<th>'''Project Description:'''</th>
</tr>
<tr>
<td>Create a new section for the Joomla! Issue Tracker that holds a summary of a project's activity during the release cycle. See https://github.com/joomla/jissues/issues/506 for additional discussion.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Expected Results:'''</th>
</tr>
<tr>
<td>A new section is added to the issue tracker.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Knowledge Prerequisite:'''</th>
</tr>
<tr>
<td>PHP, MVC, dependency injection. '''Nice to have:''' Joomla! Framework</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Difficulty:'''</th>
</tr>
<tr>
<td>Medium to Hard</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Mentors:'''</th>
</tr>
<tr>
<td>[mailto:nbraczek@bsds.de Niels Braczek],[mailto:michael.babker@joomla.org Michael Babker]</td>
</tr>
</table>
[[Image:Gsoc2016.png|50px|center]]
----

====Project VIII: Refactor the Issue Tracker Application ====

<table border="0" style="width:100%">
<tr>
<th>'''Important Note:'''</th>
</tr>
<tr>
<td> Note: This project will be merged with Project VII Issue Tracker Release Section</td>
</tr>
<tr>
<th>'''Project Description:'''</th>
</tr>
<tr>

<td>Work is started on refactoring the issue tracker application to use more modern development practices, to include proper dependency injection into various elements (reduced use of passing the DI container as a parameter into classes) and restructured classes have automated test coverage. At least three of the application's "apps" (loosely compared to a Joomla! CMS component) as well as the base application framework should be updated prior to the completion of the GSoC period.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Expected Results:'''</th>
</tr>
<tr>
<td>A new section is added to the issue tracker.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Knowledge Prerequisite:'''</th>
</tr>
<tr>
<td>PHP, MVC, dependency injection, Unit Testing. '''Nice to have:''' Joomla! Framework</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Difficulty:'''</th>
</tr>
<tr>
<td>Hard</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Mentors:'''</th>
</tr>
<tr>
<td>[mailto:nbraczek@bsds.de Niels Braczek],[mailto:michael.babker@joomla.org Michael Babker]</td>
</tr>
</table>
[[Image:Gsoc2016.png|50px|center]]
----

====Project IX: Expand the Extension Manager ====

<table border="0" style="width:100%">
<tr>
<th>'''Project Description:'''</th>
</tr>
<tr>
<td>
The extension manager can do with a few more features and a redesigned UI. The project would add the following features to the extension manager:<br>

*Option to remove the database tables upon un-installation of a component or package if user wants to
*Show the changelog for an update
*Add a field to enter a license key for a given extension.
*Database fix to also check the SQL update files of installed components. The fix now only checks the core database.
*Option to edit an update site
*Signed installation archives. This is to make sure only original archives are installed.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Expected Results:'''</th>
</tr>
<tr>
<td>These new features implemented in the extension manager part of Joomla.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Knowledge Prerequisite:'''</th>
</tr>
<tr>
<td>PHP, MVC, Javascript. '''Nice to have:''' Medium</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Difficulty:'''</th>
</tr>
<tr>
<td>Medium</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Mentors:'''</th>
</tr>
<tr>
<td>[mailto:llewellyn@vdm.io Llewellyn van der Merwe],[mailto:peter.martin@community.joomla.org Peter Martin], [mailto:roland.dalmulder@community.joomla.org Roland Dalmulder]</td>
</tr>
</table>
[[Image:Gsoc2016.png|50px|center]]
----

====Project X: JavaScript Tests for Joomla 4 ====

<table border="0" style="width:100%">
<tr>
<th>'''Project Description:'''</th>
</tr>
<tr>
<td>Increase and improve the JavaScript testing suite based on Jasmine and Karma for Joomla 4.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Expected Results:'''</th>
</tr>
<tr>
<td>Almost complete coverage of the Joomla 4 JavaScript code including the new media manager.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Knowledge Prerequisite:'''</th>
</tr>
<tr>
<td>JavaScript, Karma, Jasmine, jQuery. '''Nice to have:''' Travis and Drone (CI) experience, Vue, NPM, Node</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Difficulty:'''</th>
</tr>
<tr>
<td>Medium</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Mentors:'''</th>
</tr>
<tr>
<td>[mailto:truchiranga@gmail.com Thanuditha Ruchiranga],[mailto:ashan256@gmail.com Ashan Fernando]</td>
</tr>
</table>
[[Image:Gsoc2016.png|50px|center]]
----

====Project XI: Refactoring the Help Screens localised on JDocs and served in the Joomla! backend through the Help server to make them more manageable by volunteers ====

<table border="0" style="width:100%">
<tr>
<th>'''Project Description:'''</th>
</tr>
<tr>
<td>The Joomla! backend includes an integrated context-sensitive help system that accesses pages in HTML or XML served from a directory within the Joomla! installation, or more commonly, from an external help server. The documentation wiki contains the "master" help screens for all Joomla! versions.

The Help Screens are numerous (for the currently supported version: https://docs.joomla.org/Help36:Help_screens) and it became unmanageable, mainly because of the high number of new Joomla! Versions and the low number of volunteers to maintain them. Keeping them up to date (content as well as numerous screenshots of the backend) is important for our users but it has became an impossible goal, even more because they also need to be localised.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Expected Results:'''</th>
</tr>
<tr>
<td>A re-thought of the Help Screens to provide a more manageable and easier system that can require less time to keep the documentation up to date (on JDocs and so in the Joomla! backend).

For the display in the backend, a possibility could be to have a kind of guided system. Then making the help button Open up just a how to page that's based on whatever component you're using. The guidance system could run off of JavaScript and of course you can shut it off within a click. (ex: https://www.google.com/amp/s/webresourcesdepot.com/11-awesome-jquery-site-tour-plugins-for-guiding-users-with-style/amp/?client=safari) The original source of the Help Screens will need to stay on JDocs.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Knowledge Prerequisite:'''</th>
</tr>
<tr>
<td>PHP, JavaScript, JSON. '''Nice to have:''' MediaWiki</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Difficulty:'''</th>
</tr>
<tr>
<td>Medium</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Mentors:'''</th>
</tr>
<tr>
<td>[mailto:sandra.thevenet@community.joomla.org Sandra Thevenet], Tom Hutchison</td>
</tr>
</table>
[[Image:Gsoc2016.png|50px|center]]
----
====Project XII: Gherkin Editor ====

<table border="0" style="width:100%">
<tr>
<th>'''Project Description:'''</th>
</tr>
<tr>
<td>To ease the creation of new acceptance tests, an editor would be useful, that provides existing and suitable test routines in a select field (similar to the search field in a browser, or the address field in a mail client). That helps to find a wording, that utilises re-use of existing test code instead of forcing rewrites.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Expected Results:'''</th>
</tr>
<tr>
<td>A package that can be integrated into JTracker.</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Knowledge Prerequisite:'''</th>
</tr>
<tr>
<td>Joomla Deployment Setup, PHP, understanding of Gherkin based acceptance tests</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Difficulty:'''</th>
</tr>
<tr>
<td>Medium to Hard</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Mentors:'''</th>
</tr>
<tr>
<td>[mailto:nbraczek@bsds.de Niels Braczek],[mailto:astrid.guenther@community.joomla.org Astrid Guenther]</td>
</tr>
</table>
[[Image:Gsoc2016.png|50px|center]]

----
====Project XIII: Joomla PR Testing Platform ====

<table border="0" style="width:100%">
<tr>
<th>'''Project Description:'''</th>
</tr>
<tr>
<td>Today when a developer send a Pull Requests(PR) to Joomla Github Repository, a reviewer or a tester need to manually setup a environment with the PR code to test it. This project is to focus in building a basic platform using multi-container docker and integrating with Github, which allows to automatically get the code of the PR and build a running Joomla application and provide the link inside the PR itself (Similar to how Travis Build Happens). Since we are dealing with limited this solution should self manage efficiently utilizing available resources.

Use case
1) User makes a PR
2) Similar to Travis, a Build process occurs and a link will be available in the PR
3) This is used by a tester to test the functionality (Making regression testing and verification process faster)
4) This solution should self manage efficiently utilizing available resources
5) Based on Docker
</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Expected Results:'''</th>
</tr>
<tr>
<td>For each pull request, show a test link in build status to test the Pull Request</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Knowledge Prerequisite:'''</th>
</tr>
<tr>
<td>Joomla Deployment Setup, DevOps, Github API, Docker, Docker-Compose</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Difficulty:'''</th>
</tr>
<tr>
<td>Medium to Hard</td>
</tr>
</table>
<table border="0" style="width:100%">
<tr>
<th>'''Mentors:'''</th>
</tr>
<tr>
<td>[mailto:ashan256@gmail.com Ashan Fernando]</td>
</tr>
</table>
[[Image:Gsoc2016.png|50px|center]]

----
[[Category:Google Summer of Code 2017]]

Unit Testing

2017-04-10T17:22:20Z

Yvesh: At least some updates so people not contact wrong persons

{{JSplit}}
Note that this article is badly out of date.
== News and Updates ==
2011 10 26 Use version 3.5.15 of PHPUnit. Please see reference material on github.

2009 10 06: Tests now depend on the SVN version of PHPUnit 3.4.1.

2008 06 24: Update to reflect move of PHPUnit code from branch to trunk (former trunk now in /branches/old_simpletest).

2008 06 22: Add information on limiting tests by version.

2008 06 21: Added—class-exclude, --sequence-exclude, and—test-exclude options.

2008 06 21: PHPUnit has been updated to version 3.2.21 with SVN rev 10436. Please update.

== Unit Testing ==
Unit testing is not only an essential part of a good Quality Control program, it is an aid to development as well. Writing new tests before writing code helps focus the developer on the problem at hand. The practice also encourages writing smaller, more loosely coupled, more reusable, and more maintainable code units and these benefits often outweigh the benefits gained by treating unit tests solely as a QC tool. When used in this manner correctness becomes more a by-product of the process than the goal.
For a good general discussion of unit testing, visit the [http://en.wikipedia.org/wiki/Unit_test Wikipedia article].

=== Unit Testing in Open Source ===
Open source projects, with multiple developers working in parallel around the world, can greatly benefit from unit testing. The main benefits are:
* Unit tests help highlight cases where seemingly minor changes cause unexpected breakage.
* Unit tests help clearly specify how a class should behave.
* Unit tests can expose design flaws very early in development.
* Unit tests make great examples. They are a great place for developers to learn how to use the code.

=== The Testing Hierarchy: Unit, Subsystem, Integrated ===
Software testing systems usually run through a spectrum from "pure" unit tests through to fully integrated systems tests. We've described low level unit tests above. Integrated testing typically involves some sort of script that simulates user actions and then verifies that the result matches what's expected. This sort of "end to end" test verifies that all parts of the system are working correctly.

It's unfortunate that there is no clear nomenclature to describe all the intermediate stages of testing. The next stage beyond testing a single unit of code is subsystem testing. A subsystem test verifies that two or more units of code are interacting correctly to produce the desired result. In the simplest case, a subsystem test can be created simply by replacing mock objects with real objects and running unit tests on the top level module. In practise, this tends to not work as well as expected, because the original unit test data wasn't designed for a subsystem test, or because the nature of the test cases needs to be changed in order to fully test the subsystem. After all there is little point in simply repeating the unit test cases; the objective of a subsystem test should be to test boundary conditions and special cases that would be difficult to duplicate in unit tests.

Once a subsystem has been tested, it can be integrated into a larger system, which is still a subset of the whole product. Tests can be written for larger and larger subsystems, but at each stage the complexity of the tests increases. At some point, the effort required to hand craft tests exceeds the benefits of running them. This is where integrated testing comes in.

Integrated testing involves recording a user's interaction with the system into a script that can be replayed. The testing framework then compares the system's response with the expected response and passes or fails the test. The PHPUnit testing framework that we use has the ability to work with [http://seleniumhq.org/ Selenium], a browser based test automation tool. Writing a functional test using Selenium is documented [http://docs.joomla.org/Functional_Testing#Writing_Functional_Tests here].

==== Test Objects ====
The purpose of unit tests is to isolate a module of code. A test that tests only one thing provides better information than a test that involves several object interactions. But how do we isolate an object from its dependencies? By writing stub classes. [http://xunitpatterns.com/Mocks,%20Fakes,%20Stubs%20and%20Dummies.html xUnit Patterns] defines a the hierarchy of dummy classes, ranging from simple to complex:
* Dummy - Defines attributes and methods of a dummy class (not particularly useful in PHP).
* Fake - Provides canned responses to method calls and fixed attribute values. Good for speed.
* Stub - Allows the test to define responses to method calls (return values, exceptions) to simulate the dependent object.
* Spy - A Fake or Stub that records method calls and parameters for later analysis.
* Mock - A Fake or Stub with a set of expectations—method calls and parameters—that are automatically verified for correctness.

=== Unit Testing in Joomla! ===
Unit testing capabilities in Joomla are steadily developing. [Add note re amount of coverage for platform by unit tests.]

The [https://github.com/joomla/joomla-platform Joomla Platform GitHub repository] contains PHPUnit tests within the /tests subdirectory. See [http://docs.joomla.org/Running_Automated_Tests_for_Version_1.6 Running Automated Tests for Version 1.6] for instructions on setting up unit testing in your IDE.

==== The Unit Test Team ====
If you can commit to the Joomla code base, then you should consider yourself part of the automated testing team! There is also a public Glip group for questions around testing (Testing & CI General Public Group).

Writing tests concurrently with code (or even before) is a good way to not only save development time, but a great tool for defending against regressions. Writing tests early in the development cycle also helps identify and resolve design issues sooner, which reduces refactoring.

If you want to get started on unit testing, get in touch with Robert Deutz (rdeutz) or Yves Hoppe (yvesh). Either of us will be happy to help out.

==== Current Work ====
* There is no longer any need to patch the main code to enable unit tests.
* Basic techniques for mock objects are defined.
* Strategies for dealing with local configuration is not yet complete, but there is a plan.
* Files of the form class-sequence-type-Test.php, for example JObject-0000-class-Test.php use PHPUnit.
* The JDate tests present a good example of a data-driven test, but they won't run on the current 1.5 code base (there are some proposed API changes as a result of unit test development).
* Previously functional tests, such as JFTP, haven't been moved to the PHPUnit environment yet.
* The custom test runner is no longer needed. The current tests will run with the latest of PHPUnit 4.8.Thanks to Sebastian Bergmann for his excellent work on an excellent project!

==== Writing Unit Tests ====
At risk of stating the obvious, in the "purest" case the purpose of a unit test is to ''isolate a unit of code from its environment and to test the operation of that code''.

This isolation is usually achieved by writing dummy classes that emulate the code unit's environment. These dummy objects can be passive, by simply simulating the environment, or they can be more active, keeping track of how they are being used by the test unit and reporting any variations from the expected behaviour. See [[Unit Testing Mock Objects|Mock Objects in Joomla]] for a detailed example.

An interesting aspect of writing tests is that they become ''de facto'' detailed technical specifications of the interfaces between units of code. The fact that these specifications can be verified in an automated way makes them a superb resource when refactoring code.

The test code has a few templates designed to kick-start a test. They are:

/unittest/sample-datatest-php.txt
/unittest/sample-simpletest.php.txt

Here are some example tests: [[Unit Testing -- a Simple Example|Simple Example]], [[Unit Testing -- Data Driven Example|Data Driven Example]], [[Unit Testing -- Plugin Example|Plugin Example]], [[Unit Testing -- UI Example|UI Example]].

==== Running Unit Tests ====
Test files follow the form classnameTest.php, for example JObjectTest.php. For tests that are not class based, use the name of the file being tested.

Joomla unit tests use the standard PHPUnit test runner. See http://www.phpunit.de for documentation.

== How to Get it Running ==

Before you start make sure you have installed PHPUnit and of course PHP (5!) properly...

To get the unit tests to run on your Joomla! installation, perform the following steps:
* Create an instance of your Joomla! installation. Since you will be using SVN to check out the testing project, you don't want to check out the Joomla! with SVN. Instead, simply unpack a normal Joomla! archive. If you are using Eclipse, you can create a folder in your Eclipse workspace for the Joomla! installation, but don't create an Eclipse project yet.
* In the root checkout (or export) the latest version of the unit test code from SVN ''"/testing/trunk/1.5/unittest"'' or ''"/testing/trunk/1.6/unittest"'' to your installation base. This will create a ''"/unittest"'' sub-folder under your joomla installation. If you are using Eclipse, Import the project from the SVN and use the same folder in your Eclipse workspace you used above.
* From the command line, change to the unittest directory.
* Run the unit test from the command prompt using the following command: <code>phpunit tests</code>

The unit test will the run, and the results are rendered. You will see a series of dots for each passed test and other letters for failed tests.

See http://www.phpunit.de/manual/current/en/textui.html for help using the—filter switch to run only certain tests. There are also many other command line switches you can use to get results in various formats.

== Troubleshooting ==

The provided configurations should work out of the box. We have seen problems with it (currently the cause is unknown). If you get an error like below, the solution is pretty easy.

file=/var/www/unittest/runtests.php
posn=17
base=runtests.php
/var/www
JPATH_BASE does not point to a valid Joomla! installation:
JPATH_BASE = /var/www
Please modify your copy of "TestConfiguration.php"

Modify the ''"TestConfiguration.php"'' file and change the definition of the JPATH_BASE so it points to the path of you Joomla! installation, in the example below the Joomla! installation is installed at "''/var/www/update''".

define('JPATH_BASE', '/var/www/update');

== Frequently Asked Questions ==
'''Why can't I use "phpunit ''testname.php''" to run my tests?'''

The test facility has to do some work to be able to load the "Joomla!" framework and to be able to inject mock classes. It's difficult to do this from the PHPUnit test runner, so we built our own. Also, the Joomla test runner has specific options designed to make it easy to select specific tests. Over time we will add more functionality to the test runner so it has many of the capabilities of the phpunit command.

==See also==
[http://www.phpunit.de/manual/current/en/ PHPUnit Manual]

[[Category:Bug Squad]]
[[Category:Development]]
[[Category:Testing]]
[[Category:Automated Testing]]

Joomla CodeSniffer

2017-03-16T18:39:29Z

Yvesh: Added doc on how to add the composer bin directory to the path

== A Nose For Joomla ==
This is a custom coding standard for the PHP CodeSniffer that attempts to codify and enforce the Joomla coding standards. This article covers how to set the automatic code style checker. It consists of three steps:
# Install PHP CodeSniffer (phpcs).
# Clone the Joomla Code Style (for use with for phpcs).
# Configure your IDE to work with PHP CodeSniffer and Joomla Code Style.

[[File:CodeSnifferInAction.jpg|center|thumb|300px|PHP Code Sniffer in action]]

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

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

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

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

==1. Installation of PHP Code Sniffer (phpcs)==
===Composer (recommended)===
PHP Code Sniffer is available via Composer. It can be installed system-wide with the following command:

<code>composer global require 'squizlabs/php_codesniffer=1.*'</code>

On '''Linux''' PHP Code Sniffer (phpcs) will be installed under your user folder:
* Symbolic Link: '''~/.composer/vendor/bin/phpcs'''
* The file: '''~/.composer/vendor/squizlabs/php_codesniffer/scripts/phpcs'''
or (for example OpenSuse)
* Symbolic Link: '''~/.config/composer/vendor/bin/phpcs'''
* The file: '''~/.config/composer/vendor/squizlabs/php_codesniffer/scripts/phpcs'''

On '''Windows''' PHP Code Sniffer (phpcs) will be installed under your user folder:
* Symbolic Link: c:\Users\Username\AppData\Roaming\Composer\vendor\bin\phpcs
* The file: c:\Users\Username\AppData\Roaming\Composer\vendor\squizlabs\php_codesniffer\scripts\phpcs

=== Add composer bin directory to your $PATH ===

In order to execute PHP Code sniffer from anywhere on Linux or Mac command line you have to add .composer/vendor/bin to your $PATH variable.

To do this persistant edit your shells start file, like your .profile or .bash_profile file depending which shell you are using (echo $SHELL shows you which one you are using).

Add the following line to the file:

<tt>export PATH=$PATH:~/.composer/vendor/bin</tt>

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

<code>pear install PHP_CodeSniffer</code>

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

<code>pear install PHP_CodeSniffer-1.5.x</code> (specify a number for x, in June 2016 was 1.5.6)

'''Important note:''' currently the latest PHPcs is the 2.x series. But they are under development so '''Joomla Sniffers are not yet compatible with this 2.x version'''. PEAR gives you the option to install it by default but since Joomla sniffers will not work, always install PHPCS 1.5. version not 2.0.

PEAR will handle the whole installation by itself.

'''A note for windows users:''' If you are using XAMPP, while installing the PHPCS make sure in cmd.exe the path is set to <path-to-xampp>xampp/php. After that use codeː <code>pear install PHP_CodeSniffer-1.5.x</code> to install PHPCS.
Sometimes while running the command <code>pear install PHP_CodeSniffer-1.5.x</code> in cmd.exe user may get these 2 error like:<br />
1. <code>C:\xampp\php>pear install PHP_CodeSniffer-1.5.6 No releases available for package "pear.php.net/PHP_CodeSniffer"install failed</code><br />
Just clear the cache using the command: <code>pear clear-cache</code><br />
After that you are good to go.<br />
2. <code>ERROR: failed to mkdir C:\php\pear\tests\PHP_CodeSniffer\CodeSniffer\Core\File</code><br />
This error arises because config values set for different pear related directories are wrong.<br />
Use the following command one by oneː<br />
1. <code>pear config-set doc_dir <PATH-TO-XAMPP>\xampp\php\pear</code>(e.g.pear config-set doc_dir C:\xampp\php\pear)<br />
2. <code>pear config-set cfg_dir <PATH-TO-XAMPP>\xampp\php\pear</code><br />
3. <code>pear config-set data_dir <PATH-TO-XAMPP>\xampp\php\pear</code><br />
4. <code>pear config-set test_dir <PATH-TO-XAMPP>\xampp\php\pear</code><br />
5. <code>pear config-set www_dir <PATH-TO-XAMPP>\xampp\php\pear </code><br />

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

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

Use

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

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

==2. Clone Joomla Codestyle==
In order to have PHP Code Sniffer (phpcs) sniffing your Joomla projects for the right code style, you have to clone the Joomla Codestyle '''into the /CodeSniffer/Standards/''' folder of Code Sniffer. That folder already has other folders for styles like PSR1, PSR2, Squiz & Zend.

The location of this folder depends on both your operating system as well as your LAMP/WAMP/MAMP/XAMP/AMP stack. Some popular locations are:

'''Mac'''
/Applications/MAMP/bin/php/php7.0.0/lib/php/PHP/CodeSniffer/Standards/
This is for PHP 7.0.0 but this can be another PHP version folder as well.

'''Linux'''
~/.composer/vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/

~/.config/composer/vendor/squizlabs/php_codesniffer/CodeSniffer/Standards
'''Windows'''
c:\Users\Username\AppData\Roaming\Composer\vendor\squizlabs\php_codesniffer\CodeSniffer\Standards\
This is using Composer on Windows.

If you can't find it in any of the above folders, note that the folder you are looking for ends with '''\CodeSniffer\Standards\'''

On Linux, go to the Standards folder of CodeSniffer and git clone from https://github.com/joomla/coding-standards:
$ cd ~/.composer/vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/
or (for example on OpenSuse)
$ cd ~/.config/composer/vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/
and then
$ git clone https://github.com/joomla/coding-standards.git Joomla

You'll end up with a folder like ~/.composer/vendor/squizlabs/php_codesniffer/CodeSniffer/Standards/Joomla/

== Usage ==
You invoke the custom standard by

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

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

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

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

==3. IDE Integration==
Everybody loves the console. It is, with no doubt, the most effective way to do whatever you need to do. Sometimes even Linux gurus need a little bit of comfort.

Fortunately there is a plug-in available for PhpStorm, Eclipse and Netbeans that integrates the CodeSniffer into your favourite IDE, so any coding standard violations are shown like "normal" errors.

=== PhpStorm ===
Code Sniffer is supported out of the box in PhpStorm. Go to Settings and under Editor -> Inspections you will see the list of sniffers you have installed.

==== Set Path to Code Sniffer ====
# Open Settings (CTRL-ALT-S / CMD-,)
# Go to Languages & Frameworks
# Click on PHP
# Click on Code Sniffer
# The configuration is set to Local by default
# Click on the 3 dots behind it to open the configuration screen
# The first option is the PHP Code Sniffer (phpcs) path
# Click on the 3 dots behind the path to select the location of the phpcs file. See above on where phpcs may be installed on your site
# Click on Validate to make sure the path is correct and phpcs is working
# Click OK

===== Activating the Joomla Code Style =====
# Open Settings (CTRL-ALT-S / CMD-,)
# Go to Editor
# Click on Inspections
# In the list, go to PHP
# Click on PHP Code Sniffer Validation
# Click on the check box behind it to activate it
# Click the Reload button (2 arrows) to force a reload of rules from disk
# Joomla should now be available in the list. See following image:
<gallery>
File:PhpStorm8CodeSniffer.png|PHPStorm CodeSniffer
</gallery>
<div style="clear: both"></div>
9. Click OK

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

===== Using PHP PSR-1 and PSR-2 Sniff =====
A CodeSniffer sniff to check against the PSR-x Coding Standard can be used as well. In that case you can select a different standard than Joomla.

===== Using Joomla Code style =====
It's nice to be able to check that the standards are respected. It's even nicer if PhpStorm helps you format properly too as you are coding.
To use the Joomla code style in PhpStorm
# Open Settings (CTRL-ALT-S / CMD-,)
# Go to Editor
# Click on Code Style
# Select Joomla from the Scheme select box

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

The Code Sniffer can also be integrated easily as an external tool. PhpStorm will display the output in the console, including click-able links containing line and column numbers to the files that contain errors.

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

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

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

=== Netbeans ===
Netbeans has the sniffer functionality integrated into the core system.

# Start your Netbeans IDE
# Open Tools => Options => PHP => Code Analysis => Code Sniffer
# You have to set the path to ''phpcs.bat'' from the installed PHP_CodeSniffer PEAR package
#* For Unix based systems the path is something like /usr/bin/phpcs
#* In XAMPP (windows) you can find the file in the PHP root folder (e.g. C:\xampp\php\phpcs.bat)
# As "Default Standard," choose "Joomla" to use the Joomla! standard
# Now you can click ''OK'' to start sniffing
# Open from the top menu Source => Inspect...
# Enjoy

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

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

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

To sniff against your own standards, specify their location and activate them (see screen shot 2)

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

Happy sniffing.

==== PHP Tools Compatibility Issue ====
PHP Tools does not directly support PHP_CodeSniffer-1.5.x. It reports this error:

<tt>PHP Fatal error: Uncaught exception 'PHP_CodeSniffer_Exception' with message 'Class PHP_CodeSniffer_CommentParser_ClassCommentParser not found' in /usr/share/php5/PEAR/PHP/CodeSniffer/Standards/Joomla/Sniffs/Commenting/FileCommentSniff.php:18</tt>

It comes with a pre-packaged CodeSniffer version located in eclipse/plugins/org.phpsrc.eclipse.pti.library.pear_.../php/library/PEAR/PHP. To fix the issue, just remove the pre-packaged CodeSniffer version and link the local version. For example, /usr/share/php/PHP.

<tt>ln -s /usr/share/php/PHP /home/.../eclipse/plugins/org.phpsrc.eclipse.pti.library.pear_.../php/library/PEAR/PHP</tt>

In any case, you can also debug a PHP Tools issue, enabling the debug mode to show the internal commands in Eclipse console:

# <tt>Window => Preferences</tt>
# <tt>PHP Tools => PHP CodeSniffer</tt>
# <tt>Debug: print PHP output to console</tt>

Command example:

<tt>/usr/bin/php -c /tmp/zend_debug/session8314597725413224814.tmp -d asp_tags=off -d short_open_tag=on /home/.../eclipse/plugins/org.phpsrc.eclipse.pti.tools.codesniffer_1.3.0.R20111119000000/php/tools/phpcs.php --report=xml --standard=/home/.../Joomla /home/..../myphpfile.php</tt>

=== Geany ===
* Open a PHP file. (Otherwise the build menu is not accessible.) See this [http://static.xscreenshot.com/2016/07/13/08/screen_6bc0692cf995702a1e379b39643d0c2d Screenshot]
* On the top menu, select Build->Set Build Commands.
* Select the second field and name it as you wish. Enter this code in the Command: <code>phpcs --standard=Joomla "%f" | sed -e 's/^/%f |/' | egrep 'WARNING|ERROR'</code>
* Enter this code in the Error Regular Expression field: <code>(.+) [|]\s+([0-9]+)</code> See this [http://view.xscreenshot.com/ef00820cf7c017ce659c8e9f0b02d3ae Screenshot]
* Select OK.
* If the Message Window is not open, display it by selecting it in the top View menu.
* When viewing any PHP file, press F9 to see the errors found. [http://view.xscreenshot.com/8704b9fd1bda3f841364a0ffa28a54ae Screenshot]

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

[[Category:Development]][[Category:Bug Squad]]
[[Category:IDE (Integrated development environment)]]

JHelp:Cheatsheet

2017-03-16T18:06:24Z

Yvesh: Added display text as code (tt) -- 2017-03-16 -yh

<div align="center">

{|align="center" style="width:100%; border:2px #a3b1bf solid; background:#f5faff; text-align:left;"
|colspan="3" align="center" style="background:#5091cd; text-align:center;" | {{shortcut|JDOC:CHEAT|JDOC:EDIT}}
{{section portal heading|icon=magic|title=Joomla Documentation Wiki Cheatsheet}}
|-
| colspan="3" style="background:#c5d6e8; border-top:2px #a3b1bf solid; font-size:1.4em" |
<center>'''Works only at the beginning of lines'''    
|- style="background:#c5d6e8; padding:0.3em; font-size: 0.9em; text-align:center;"
| style="border-bottom:2px #a3b1bf solid" width="30%" | Description
| style="border-bottom:2px #a3b1bf solid" | You type
| style="border-bottom:2px #a3b1bf solid" width="30%" | You get
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|'''Section headings'''{{Anchor|Section headings}}<br />
<div style="padding: 0.7em .5em; font-size:0.9em;">These are equivalent to using <nowiki><h2>, <h3>, <h4>, etc.. header tags</nowiki><br/></nowiki>''a Table of Contents will automatically be generated when four headings are added to an article''</div>
|
<tt><nowiki>==Level 2==</nowiki></tt><br />
<tt><nowiki>===Level 3===</nowiki></tt><br />
<tt><nowiki>====Level 4====</nowiki></tt><br />
<tt><nowiki>=====Level 5=====</nowiki></tt><br />
<tt><nowiki>======Level 6======</nowiki></tt><br /><br />
<span style="font-size:0.9em">''do not use''  =Level 1=  ''as it is for page titles''</span>
|

==Level 2==
===Level 3===
====Level 4====
=====Level 5=====
======Level 6======
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|'''Nonindexed headers'''<div style="font-size:0.9em;">
<div style="padding: 0.7em .5em; font-size:0.9em;">''left out of Table of Contents''</div>
|
<tt><nowiki>; Header name</nowiki></tt><br />
<div style="font-size:0.9em;">''has a leading semicolon'' ";" ''in front''</div>
|
'''Header name'''<br />
<div style="padding: 0.7em .5em; font-size:0.9em;">''will not appear in Table of Contents''</div>

|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|'''Bulleted list'''<br/>Use the asterisk(*){{Anchor|Bulleted list}}
|
<tt>* One</tt><br />
<tt>* Two</tt><br />
<tt>** Two point one</tt><br />
<tt>* Three</tt>
|
* One
* Two
** Two point one
* Three
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|'''Numbered list'''<br/>Use the hash tag(number sign-(#)){{Anchor|Numbered list}}
|
<tt># One</tt><br />
<tt># Two</tt><br />
<tt>## Two point one</tt><br />
<tt># Three</tt>
|
# One
# Two
## Two point one
# Three
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|'''Indenting text'''{{Anchor|Indenting text}}
<div style="padding: 0.7em .5em; font-size:0.9em;">''this is used when replying on a [[JDOC:Tutorial (Talk pages)|talk page]], to make it easier to follow conversations''</div>
|
<tt><nowiki>no indent (normal)</nowiki></tt><br />
<tt><nowiki>:first indent</nowiki></tt><br />
<tt><nowiki>::second indent</nowiki></tt><br />
<tt><nowiki>:::third indent</nowiki></tt>
|
no indent (normal)<br />
:first indent
::second indent
:::third indent
|-
| colspan=3 style="background:#c5d6e8; border-top:2px #a3b1bf solid; font-size:1.4em" |
<center>'''Works anywhere in the text'''        
|- style="background:#c5d6e8; padding:0.3em; font-size: 0.9em; text-align:center;"
| style="border-bottom:2px #a3b1bf solid" width="30%" | Description
| style="border-bottom:2px #a3b1bf solid" | You type
| style="border-bottom:2px #a3b1bf solid" width="30%" | You get
|-
|Italics{{Anchor|Italic text}}, bold{{Anchor|Bold text}}, and both{{Anchor|bold and italic}}
|
<tt><nowiki>''italics'', '''bold''', and '''''both'''''</nowiki></tt>
|
''italics'', '''bold''', and '''''both'''''
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|'''Link'''{{Anchor|Internal link}} to another page
|
<tt><nowiki>[[glossary]]</nowiki></tt><br />
<tt><nowiki>[[glossary]] terms</nowiki></tt>
|
[[glossary]]<br />
[[glossary]] terms
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|
"'''Pipe'''" a link to change the link's text
|
<tt><nowiki>[[Administrators|Joomla! Administrator]]</nowiki></tt>
|
[[Administrators|Joomla! Administrator]]
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|
'''Link to a section'''
|
<tt><nowiki>[[Glossary#Component]]</nowiki></tt><br />
<tt><nowiki>[[Glossary#Component|Joomla! Component]]</nowiki></tt>
|
[[Glossary#Component]]<br />
[[Glossary#Component|Joomla! Component]]
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|'''[[WP:RED|Red link]]'''
<div style="padding: 0.7em .5em; font-size:0.9em;">''red links in articles help by showing desired [[WP:REDIRECT|redirects]] or '''Needed''' pages''</div>
|
<tt><nowiki>[[something missing]]</nowiki></tt>
|
[[something missing]]
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|'''References and footnotes'''
<div style="padding: 0.7em .5em; font-size:0.9em;">''sources in the article will appear where <nowiki>{{reflist}}</nowiki> is put, typically under a level 2 section heading (see below) towards the bottom of the page.''</div>
<div style="padding: 0.7em .5em; font-size:0.9em;"></div>
|
<tt><nowiki>Hello,<ref></nowiki></tt>Library of Congress<tt><nowiki></ref> World.<ref>http://www.w3.org/</ref></nowiki></tt>
<br /><br />
<tt><nowiki>
References:

<references/></nowiki>

</tt>
|
Hello,<ref>Library of Congress</ref> World.<ref>http://www.w3.org/</ref>

References:

<references/>
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|'''Signature'''{{Anchor|Signature}}
<div style="padding: 0.7em .5em; font-size:0.9em;">''sign your contributions when posting to a [[JDOC:Tutorial (Talk pages)|talk page]]''</div>
|
<tt><nowiki>~~~~</nowiki></tt><br /><br /><span style="font-size:0.9em;">''do not sign in an article, only on talk pages''</span>
|
[[Special:Mypage|Username]] ([[Special:Mytalk|talk]]) {{CURRENTTIME}}, {{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}} (UTC)
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|'''Display as Code'''
|
<tt><nowiki><tt>JFactory::getApplication()</tt></nowiki></tt>
|
<tt>JFactory::getApplication()</tt>
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|'''Plain website link'''
|
<tt><nowiki>http://docs.joomla.org</nowiki></tt>
|
http://docs.joomla.org
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|'''Link a website'''
|
<tt><nowiki>[http://docs.joomla.org]</nowiki></tt>
|
[http://docs.joomla.org]
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|'''Link and name a website'''
|
<tt><nowiki>[http://docs.joomla.org Joomla Documentation Wiki]</nowiki></tt>
|
[http://docs.joomla.org Joomla Documentation Wiki]
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|'''Strike''' your talk page comment or a list
<div style="padding: 0.7em .5em; font-size:0.9em;">''to show your previous comment is outdated''</div>
|
<tt><nowiki><s>This topic isn't notable.</s></nowiki></tt>
|
<s>This topic isn't notable.</s>
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|'''[[JDOC:Picture tutorial|Show an image]]'''
<div style="padding: 0.7em .5em; font-size:0.9em;">''for uploading, see the [[Help:Uploading a File|intro to uploading images]]
''</div>
{{Anchor|Thumbnail image}}
|
<tt><nowiki>[[</nowiki></tt>File:Documentation_all_together_transparent.png<tt>|thumb|</tt>Caption<tt><nowiki>]]</nowiki></tt>
|
[[File:Documentation_all_together_transparent.png|thumb|Caption]]
|-
|'''[[JDOC:Picture tutorial|Float an image]]'''
<div style="padding: 0.7em .5em; font-size:0.9em;">''for uploading, see the [[Help:Uploading Files#Images|intro to uploading images]]
''</div>
{{Anchor|Thumbnail image}}
|
<nowiki>[[</nowiki>File:Documentation_all_together_transparent.png|left<nowiki>]]</nowiki><br/><br/><nowiki>[[</nowiki>File:Documentation_all_together_transparent.png|right<nowiki>]]</nowiki>
|
[[File:Documentation_all_together_transparent.png|75px|left]]{{-}}
[[File:Documentation_all_together_transparent.png|75px|right]]{{-}}
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
|-
|Add a page to a '''category'''{{Anchor|Add a page to a category}}
|<tt><nowiki>[[Category:Category name]]</nowiki></tt><br /><br /><span style="font-size:0.9em;">''place near the bottom of a page''</span>
|<span style="font-size:0.9em;">''shows''</span> "Category name" <span style="font-size:0.9em;">''in a bar at bottom when the page is previewed or saved''</span>

|}
</div>

<noinclude>
__NOTOC__ __NOEDITSECTION__
[[Category:Documentation Wiki Information|Documentation Wiki Information]]
</noinclude>

User:Yvesh

2017-03-16T17:46:08Z

Yvesh: Create profile

{{top portal heading|icon=users|size=2x|title=Yves Hoppe - yvesh}}

* yves.hoppe@community.joomla.org
* yves@compojoom.com

{{section portal heading|icon=users|title=Social media profiles}}
* '''Twitter:''' [https://twitter.com/yveshoppe @yveshoppe]
* '''Facebook:''' [https://www.facebook.com/yves.hoppe yves.hoppe]

J3.x:Discover on which client your extension code is running

2017-03-16T11:57:37Z

Yvesh:

{{Joomla version|version=3.7|time=and after|comment=<translate>
version</translate>}}

This article gives an overview of the <code>JFactory::getApplication()->isClient()</code> method introduced in Joomla 3.7

It replaces the <code>JFactory::getApplication()->isSite()</code> and <code>JFactory::getApplication()->isAdmin()</code> methods.

=== Frontend ===

<code>JFactory::getApplication()->isClient('site')</code>

Returns true if executed in the Joomla web frontend.

=== Administrator / Backend ===

<code>JFactory::getApplication()->isClient('administrator')</code>

Returns true if executed in the Joomla web backend / Administrator area

=== Administrator / Backed ===

<code>JFactory::getApplication()->isClient('installation')</code>

Returns true if executed in the Joomla installation

<noinclude>
[[Category:Development]]
[[Category:Extension development]]
[[Category:Component Development]]
[[Category:JFactory]]
</noinclude>

J3.x:Discover on which client your extension code is running

2017-03-16T11:53:43Z

Yvesh:

J3.x:Discover on which client your extension code is running

2017-03-16T11:49:44Z

Yvesh:

{{Joomla version|version=3.7|time=and after|comment=<translate>
version</translate>}}

This article gives an overview of the <code>JFactory::getApplication()->isClient()</code> method introduced in Joomla 3.7

It replaces the <code>JFactory::getApplication()->isSite()</code> and <code>JFactory::getApplication()->isAdmin()</code> methods.

=== Frontend ===

<code>JFactory::getApplication()->isClient('site')</code>

Returns true if executed in the Joomla web frontend.

=== Administrator / Backend ===

<code>JFactory::getApplication()->isClient('administrator')</code>

Returns true if executed in the Joomla web backend / Administrator area

=== Administrator / Backed ===

<code>JFactory::getApplication()->isClient('installation')</code>

Returns true if executed in the Joomla installation

[[Category:Development]]
[[Category:Extension development]]
[[Category:Component Development]]

J3.x:Discover on which client your extension code is running

2017-03-16T11:48:43Z

Yvesh: Initial creation -- 2017-03-16 YH

{{Joomla version|version=3.7|time=and after|comment=<translate>
version</translate>}}

This article gives an overview of the <code>JFactory::getApplication()->isClient()</code> method introduced in Joomla 3.7

It replaces the <code>JFactory::getApplication()->isSite()</code> and <code>JFactory::getApplication()->isAdmin()</code> methods.

=== Frontend ===

<code>JFactory::getApplication()->isClient('site')</code>

Returns true if executed in the Joomla web frontend.

=== Administrator / Backend ===

<code>JFactory::getApplication()->isClient('administrator')</code>

Returns true if executed in the Joomla web backend / Administrator area

=== Administrator / Backed ===

<code>JFactory::getApplication()->isClient('installation')</code>

Returns true if executed in the Joomla installation

[[Category:Development]]
[[Category:Extension development]]
[[Category:Template Development]]
[[Category:Component Development]]

Using the JFactory class

2017-03-15T00:06:22Z

Yvesh: Creation of JFactory class usage Boilerplate WIP -- 2017-03-15

{{version/tutor|3.x}}
== Introduction ==

JFactory is the Joomla Platform class, giving you access to the most important (mostly singletons) parts in Joomla. It contains multiple other objects, like the application one or the Joomla! global configuration.

== JFactory::getApplication() ==

Returns the JApplicationCMS, through it you can access for the example do redirects, access the configuration and the input variables, the Menu or enqueue messages which are shown to the user.

See [[Using the JApplication class]] for more details.

== JFactory::getDocument() ==

Provides access to the current JDocument, with it you can set Meta data, add styles and scripts and more related to the document.

See [[Adding JavaScript and CSS to the page]]

== JFactory::getDbo() ==

Returns a database object, with it you query to the database ($query = JFactory::getDbo()->getQuery(true)), secure your input before sending it and load entries.

See also [[Selecting data using JDatabase]]

== JFactory::getUser() ==

Returns the current Joomla! user object (JUser), with it you can access information and methods related to users. It is also created for guests, where the id is zero.

See [[Accessing the current user object]]

== JFactory::getDate() ==

Returns a [[How to use JDate]] instance, you can also add a time and a timezone offset to it. Without parameters it uses the current time.

== JFactory::getMailer() ==

Provides access to the Joomla Mailer (wrapper around PHPMailer) for sending emails with Joomla.

See also [[Sending email from extensions]]

== JFactory::getConfig() ==

Returns a registry with the Joomla! configuration file (configuration.php), see [[JConfig]] for more details. To access single values you can use JFactory::getApplication()->get('configValue')

See also [[Getting global configuration parameters]]

== JFactory::getSession() ==

Returns the current visitors session. (Make sure Joomla is called as Webapplication)

== External Links ==

[https://api.joomla.org/cms-3/classes/JFactory.html API Docs for JFactory]

[[Category:JFactory]]
[[Category:Tutorials]][[Category:Framework]]
[[Category:Module Development]]
[[Category:Plugin Development]][[Category:Component Development]]

How to use the filesystem package

2017-03-12T11:42:06Z

Yvesh: Cleanup, J3.x and trying to remove the most worse codestyle and security issues.. WIP -- 2017-03-12

{{version|1.5,2.5,3.x}}
=Using the JFILE:: class=

There are 4 classes in the filesystem library.

* JFile:: (file.php)
* JFolder:: (folder.php)
* JPath:: (path.php)
* JArchive:: (archive.php)

This tutorial focuses on the JFile:: class.

The base for filehandling is the JFile class, found in libraries/joomla/filesystem/file.php
Below you can see the most common options from this library file. At the end of this post you can find a very simple script for file upload.

==Get file extension==
Syntax:
<source lang=php>
$ext = JFile::getExt($filename);
</source>

Pretty clear, just feed the function with a filename and it will return the extension of the file you selected.

==Strip file extension==
Syntax:
<source lang=php>
$name = JFile::stripExt($filename);
</source>
This will return the filename without the extension.

==Clean filename==
Syntax:
<source lang=php>
$safefilename = JFile::makeSafe($filename);
</source>
It cleans out all odd characters from a filename and returns a safe filename.

==Copy a file==
Syntax:
<source lang=php>
JFile::copy($src, $dest);
</source>
It is basically a wrapper for the PHP copy() function, but also checks if the file you want to copy exists and the destination really is available. Great thing is that this function also makes use of the FTP-layer in J15 if necessary.

==Delete a file==
Syntax:
<source lang=php>
JFile::delete($path.$file);
</source>
It tries to delete the file, making sure it is actually existing, but also checks permissions. If permissions are not set up properly, it tries to change them and delete the file. It also uses the FTP-layer when necessary.

==Upload a file==
Syntax:
<source lang=php>
JFile::upload($src, $dest);
</source>
It is basically the wrapper for the PHP move_uploaded_file() function, but also does checks availability and permissions on both source and destination path.

==Example==
So how does that look in a script? I put up a small code snippet of an upload script. Some of the functions are used.
The script is fired from an upload form. That form has a file element, called file_upload (see below).
<source lang=php>
<form name="upload" method="post" enctype="multipart/form-data">
<input type="file" name="file_upload" />
<input type="submit" />
</form>
</source>

Note:
If you didn´t add the part: enctype="multipart/form-data" then you are unable to upload a file!

Upload code looks like this:
<source lang=php>
<?php
/*
* File upload example
*/
//Retrieve file details from uploaded file, sent from upload form
$file = JFactory::getApplication()->input->get('file_upload');

//Import filesystem libraries. Perhaps not necessary, but does not hurt
jimport('joomla.filesystem.file');

//Clean up filename to get rid of strange characters like spaces etc
$filename = JFile::makeSafe($file['name']);

//Set up the source and destination of the file
$src = $file['tmp_name'];
$dest = JPATH_COMPONENT . DS . "uploads" . DS . $filename;

//First check if the file has the right extension, we need jpg only
if (strtolower(JFile::getExt($filename)) == 'jpg')
{
// TODO: Add security checks

if (JFile::upload($src, $dest))
{
//Redirect to a page of your choice
}
else
{
//Redirect and throw an error message
}
}
else
{
//Redirect and notify user file is not right extension
}
?>
</source>

=Using the JFolder:: class=
The base for folder handling is the JFolder class, found in libraries/joomla/filesystem/folder.php
Below I will discuss the most common options from this library file. At the end of this post, I put it together in a very simple script as an exmaple

==Copy folder==
Syntax:
<source lang=php>
JFolder::copy($src, $dest, $path, $force);
</source>
This will copy a complete folder and all of it’s contents to another location on the server. It does permission and availability checking on both source and destination. By using $path you can enter a basepath to prefix to the filename and by setting the $force parameter to true, you can force the overwriting of already existing files. If set in the configuration, the FTP-layer will be used.

==Create folder==
Syntax:
<source lang=php>
JFolder::create($path, $mode);
</source>
This is basically a wrapper for the php mkdir() function, but with error permissions and availability checking. This one also uses the FTP-layer when set in the configuration. $mode will set the default permission, once copied and defaults to 0755.

==Move folder==
Syntax:
<source lang=php>
JFolder::move($src, $dest);
</source>
Basically a wrapper for the php rename() function, but with permissions and availability checking. This one also uses the FTP-layer when set in the configuration.

==Check if folder exists==
Syntax:
<source lang=php>
JFolder::exists($path);
</source>
Wrapper for the php is_dir() function. Pretty straightforward, returns true if folder exists.

==Read files from folder==
Syntax:
<source lang=php>
JFolder::files($path, $filter = '.', $recurse, $fullpath , $exclude);
</source>
Function to read files from a folder. When setting $recurse to true, also subfolders will be searched. $fullpath set to true returns the full path in the array. With $exclude, you can offer an array of extensions, not to include in the search for files. It returns an array with all filenames.

==Read folders from filesystem==
Syntax:
<source lang=php>
JFolder::folders($path, $filter = '.', $recurse, $fullpath , $exclude);
</source>
Exactly the same as JFolder::files(), except this does only return an array with foldernames.

==Make a tree like list from a folder structure==
Syntax:
<source lang=php>
JFolder::listFolderTree($path, $filter, $maxLevel = 3, $level = 0, $parent = 0);
</source>
It will read a folder, specified in $path and will return all folders in an array, suitable for tree display. You can specify the number of levels. The folder array looks like this:
<source lang=php>
Array
(
[0] => Array
(
[id] => 1
[parent] => 0
[name] => administrator
[fullname] => g:/joomla_1012/administrator
[relname] => g:/joomla_1012/administrator
)

[1] => Array
(
[id] => 2
[parent] => 1
[name] => backups
[fullname] => g:/joomla_1012/administrator/backups
[relname] => g:/joomla_1012/administrator/backups
)

[2] => Array
(
[id] => 3
[parent] => 1
[name] => components
[fullname] => g:/joomla_1012/administrator/components
[relname] => g:/joomla_1012/administrator/components
)
)
</source>

==Clean a path string==
Syntax:
<source lang=php>
JFolder::makeSafe($path);
</source>
Identically to the JFile::makeSafe() function. It cleans all odd characters out of the string and returns a clean path.

==Example==
Ok, and how does this look in actual code. We are going to read the contents of a folder called images. In it, al large number of files are placed. We want to create a subfolder, called jpg and filter all jpg files out and move them to the jpg subfolder. After that, we will move the complete subfolder to another place on the server.
<source lang=php>
<?php
// First we set up parameters
$searchpath = JPATH_COMPONENT . '/images';

// Import the folder system library
jimport('joomla.filesystem.folder');

// Then we create the subfolder called jpg
if (!JFolder::create($searchpath . "/jpg"))
{
// Throw error message and stop script
}

// Now we read all jpg files and put them in an array.
$jpgFiles = JFolder::files($searchpath, '.jpg');

// Now we need some stuff from the JFile:: class to move all files into the new folder
foreach ($jpgFiles as $file)
{
JFile::move($searchpath . '/' . $file, $searchpath . '/' . 'jpg' . $file);
}

//Lastly, we are moving the complete subdir to the root of the component.
if (JFolder::move($searchpath . '/'. 'jpg', JPATH_COMPONENT))
{
//Redirect with perhaps a happy message
}
else
{
//Throw an error
}
?>
</source>

This is example script only, but gives a general idea of the possibilities.

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